editor › Globals › AssemblyComponent
Class: AssemblyComponent
An AssemblyComponent is a component attached to one assembly.
Hierarchy
↳ AssemblyComponent
Index
Properties
Methods
- _setAssembly
- afterRealization
- beforeExport
- beforeInteractionStart
- beforeUpdateVisualizedModel
- getAssembly
Properties
Protected assembly
• assembly: Assembly | null = null
Defined in src/model/data/Component/AssemblyComponent.ts:8
Methods
_setAssembly
▸ _setAssembly(assembly: Assembly): void
Defined in src/model/data/Component/AssemblyComponent.ts:22
Only to be called by the assembly when adding the component to it
Parameters:
| Name | Type | Description |
|---|---|---|
assembly |
Assembly | - |
Returns: void
afterRealization
▸ afterRealization(): Promise‹void›
Defined in src/model/data/Component/AssemblyComponent.ts:10
Returns: Promise‹void›
beforeExport
▸ beforeExport(): Promise‹void›
Inherited from Component.beforeExport
Defined in src/model/data/Component/Component.ts:12
Entrypoint for subclasses to modify the assembly before all plates in compositeModel are exported to SVG.
Returns: Promise‹void›
promise that should resolve when the component has done all its work
beforeInteractionStart
▸ beforeInteractionStart(tool: any, visualizationManager: any): Promise‹Assembly[]› | void
Inherited from Component.beforeInteractionStart
Defined in src/model/data/Component/Component.ts:29
is called on the Assembly's components of the interacted physical object before the tool interaction is started.
Parameters:
| Name | Type | Description |
|---|---|---|
tool |
any | the tool the user has currently selected |
visualizationManager |
any | to wake up the editor after creating new objects |
Returns: Promise‹Assembly[]› | void
promise that resolves to the newly created assemblies
beforeUpdateVisualizedModel
▸ beforeUpdateVisualizedModel(): void
Inherited from Component.beforeUpdateVisualizedModel
Defined in src/model/data/Component/Component.ts:19
Entrypoint for subclasses to modify the assembly before rendering a frame.
Returns: void
getAssembly
▸ getAssembly(): Assembly
Defined in src/model/data/Component/AssemblyComponent.ts:14
Returns: Assembly