API Reference › Globals › ConfiguratorViewModel
# Class: ConfiguratorViewModel
# Hierarchy
ConfiguratorViewModel
# Implements
# Index
# Constructors
# Properties
# Accessors
# Methods
- Editor3ChangedNamedMesh
- Editor3dAddBakedMesh
- Editor3dAddDockPreview
- Editor3dAddNamedMesh
- Editor3dBeginConstruction
- Editor3dComponentCreated
- Editor3dComponentDocked
- Editor3dEndConstruction
- Editor3dGeometryNotReady
- Editor3dGeometryReady
- Editor3dPlanObjectConstructionDone
- Editor3dPreviewConstructionDone
- Editor3dRemoveNamedMesh
- Editor3dSetPreviewLineAssociations
- Editor3dSetPreviewPointAssociations
- clearReference
- clearRootComponent
- componentConfigurationUpdated
- componentDeleted
- componentMetaUpdated
- configurationLoaded
- constructComponents
- debugSceneGraph
- dockComponentWithPosition
- finishParameterChange
- getBoundingBox
- getBoundingBoxWithPreviews
- getComponent
- getComponents
- getComponentsForIds
- getNumberOfPossibleChildrenForComponent
- getPreviews
- hasPreviews
- isPreview
- isPreviewLine
- planObjectConfigurationUpdated
- planObjectCreated
- planObjectUpdated
- removeDockingComponent
- removeGeometriesMergedListener
- removePreviews
- requestSubPartConstruction
- sceneCleared
- setGeometriesMergedListener
- setListener
- setMergeThreshold
- tryToMergeComponents
# Constructors
# constructor
+ new ConfiguratorViewModel(creator: string): ConfiguratorViewModel
Defined in packages/common-core/src/view-model/configurator-view-model.ts:85
Parameters:
| Name | Type |
|---|---|
creator | string |
Returns: ConfiguratorViewModel
# Properties
# creator
• creator: string
_Implementation of Context.creator_
Defined in packages/common-core/src/view-model/configurator-view-model.ts:58
# Accessors
# materialQueue
• get materialQueue(): PromiseQueue‹void›
Defined in packages/common-core/src/view-model/configurator-view-model.ts:93
Returns: PromiseQueue‹void›
# Methods
# Editor3ChangedNamedMesh
▸ Editor3ChangedNamedMesh(runtimeComponentId: number, meshId: string, geometryId: string, materialId: string, transform: Float32Array): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:352
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
geometryId | string |
materialId | string |
transform | Float32Array |
Returns: void
# Editor3dAddBakedMesh
▸ Editor3dAddBakedMesh(runtimeComponentId: number, materialId: string, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, environmentGeometry: boolean): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:339
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
materialId | string |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
environmentGeometry | boolean |
Returns: void
# Editor3dAddDockPreview
▸ Editor3dAddDockPreview(componentId: number, previewId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:343
Parameters:
| Name | Type |
|---|---|
componentId | number |
previewId | number |
Returns: void
# Editor3dAddNamedMesh
▸ Editor3dAddNamedMesh(runtimeComponentId: number, meshId: string, geometryId: string, materialId: string, transform: Float32Array, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, environmentGeometry: boolean): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:348
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
geometryId | string |
materialId | string |
transform | Float32Array |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
environmentGeometry | boolean |
Returns: void
# Editor3dBeginConstruction
▸ Editor3dBeginConstruction(componentId: number, isDeltaUpdate: boolean): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:360
Parameters:
| Name | Type |
|---|---|
componentId | number |
isDeltaUpdate | boolean |
Returns: void
# Editor3dComponentCreated
▸ Editor3dComponentCreated(id: number, position: KernelVector3, eulerAngles: KernelVector3, parentObjectRuntimeId: number, isRootComponent: boolean): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:372
Parameters:
| Name | Type |
|---|---|
id | number |
position | KernelVector3 |
eulerAngles | KernelVector3 |
parentObjectRuntimeId | number |
isRootComponent | boolean |
Returns: void
# Editor3dComponentDocked
▸ Editor3dComponentDocked(componentId: number, parentId: number, componentPosition: KernelVector3, componentRotation: KernelVector3): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:391
Parameters:
| Name | Type |
|---|---|
componentId | number |
parentId | number |
componentPosition | KernelVector3 |
componentRotation | KernelVector3 |
Returns: void
# Editor3dEndConstruction
▸ Editor3dEndConstruction(id: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:395
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dGeometryNotReady
▸ Editor3dGeometryNotReady(id: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:422
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dGeometryReady
▸ Editor3dGeometryReady(id: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:415
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dPlanObjectConstructionDone
▸ Editor3dPlanObjectConstructionDone(planObjectId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:429
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: void
# Editor3dPreviewConstructionDone
▸ Editor3dPreviewConstructionDone(componentId: number, _objectId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:443
Parameters:
| Name | Type |
|---|---|
componentId | number |
_objectId | number |
Returns: void
# Editor3dRemoveNamedMesh
▸ Editor3dRemoveNamedMesh(runtimeComponentId: number, meshId: string): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:356
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
Returns: void
# Editor3dSetPreviewLineAssociations
▸ Editor3dSetPreviewLineAssociations(dockLines: any, previewId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:464
Parameters:
| Name | Type |
|---|---|
dockLines | any |
previewId | number |
Returns: void
# Editor3dSetPreviewPointAssociations
▸ Editor3dSetPreviewPointAssociations(dockPairs: any, previewId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:512
Parameters:
| Name | Type |
|---|---|
dockPairs | any |
previewId | number |
Returns: void
# clearReference
▸ clearReference(): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:101
Returns: void
# clearRootComponent
▸ clearRootComponent(): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:679
Returns: void
# componentConfigurationUpdated
▸ componentConfigurationUpdated(runtimeComponentId: number, geometryChanged: boolean): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:573
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
geometryChanged | boolean |
Returns: void
# componentDeleted
▸ componentDeleted(componentId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:542
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# componentMetaUpdated
▸ componentMetaUpdated(kernelComponent: KernelComponent): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:557
Parameters:
| Name | Type |
|---|---|
kernelComponent | KernelComponent |
Returns: void
# configurationLoaded
▸ configurationLoaded(conversationId: number, objectId: number, componentId: number, _hash: string, _errors: any): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:592
Parameters:
| Name | Type |
|---|---|
conversationId | number |
objectId | number |
componentId | number |
_hash | string |
_errors | any |
Returns: void
# constructComponents
▸ constructComponents(planObjectId: number): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:742
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: void
# debugSceneGraph
▸ debugSceneGraph(id?: number): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:683
Parameters:
| Name | Type |
|---|---|
id? | number |
Returns: void
# dockComponentWithPosition
▸ dockComponentWithPosition(previewComponent: PreviewLineComponent, component?: RoomleComponent): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:303
Parameters:
| Name | Type |
|---|---|
previewComponent | PreviewLineComponent |
component? | RoomleComponent |
Returns: void
# finishParameterChange
▸ finishParameterChange(resolve: function, _reject: function): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:614
Parameters:
▪ resolve: function
▸ (): void
▪ _reject: function
▸ (): void
Returns: void
# getBoundingBox
▸ getBoundingBox(): Box3
Defined in packages/common-core/src/view-model/configurator-view-model.ts:654
Returns: Box3
# getBoundingBoxWithPreviews
▸ getBoundingBoxWithPreviews(): Box3
Defined in packages/common-core/src/view-model/configurator-view-model.ts:667
Returns: Box3
# getComponent
▸ getComponent(componentId: number): RoomleComponent‹›
Defined in packages/common-core/src/view-model/configurator-view-model.ts:178
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: RoomleComponent‹›
# getComponents
▸ getComponents(): RoomleComponent[]
Defined in packages/common-core/src/view-model/configurator-view-model.ts:706
Returns: RoomleComponent[]
# getComponentsForIds
▸ getComponentsForIds(ids: number[]): RoomleComponent[]
Defined in packages/common-core/src/view-model/configurator-view-model.ts:695
Parameters:
| Name | Type |
|---|---|
ids | number[] |
Returns: RoomleComponent[]
# getNumberOfPossibleChildrenForComponent
▸ getNumberOfPossibleChildrenForComponent(componentId: number): number
Defined in packages/common-core/src/view-model/configurator-view-model.ts:190
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: number
# getPreviews
▸ getPreviews(): PreviewComponent[]
Defined in packages/common-core/src/view-model/configurator-view-model.ts:710
Returns: PreviewComponent[]
# hasPreviews
▸ hasPreviews(): boolean
Defined in packages/common-core/src/view-model/configurator-view-model.ts:675
Returns: boolean
# isPreview
▸ isPreview(obj: RoomleComponent): boolean
Defined in packages/common-core/src/view-model/configurator-view-model.ts:718
Parameters:
| Name | Type |
|---|---|
obj | RoomleComponent |
Returns: boolean
# isPreviewLine
▸ isPreviewLine(obj: RoomleComponent): boolean
Defined in packages/common-core/src/view-model/configurator-view-model.ts:714
Parameters:
| Name | Type |
|---|---|
obj | RoomleComponent |
Returns: boolean
# planObjectConfigurationUpdated
▸ planObjectConfigurationUpdated(planObjectId: number, _configuration: ConfigurationString, _hash: string): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:618
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
_configuration | ConfigurationString |
_hash | string |
Returns: void
# planObjectCreated
▸ planObjectCreated(conversationId: number, planObjectId: number): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:624
Parameters:
| Name | Type |
|---|---|
conversationId | number |
planObjectId | number |
Returns: void
# planObjectUpdated
▸ planObjectUpdated(planObject: PlanObject): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:632
Parameters:
| Name | Type |
|---|---|
planObject | PlanObject |
Returns: void
# removeDockingComponent
▸ removeDockingComponent(): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:284
Returns: void
# removeGeometriesMergedListener
▸ removeGeometriesMergedListener(): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:726
Returns: void
# removePreviews
▸ removePreviews(): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:318
Returns: void
# requestSubPartConstruction
▸ requestSubPartConstruction(partId: number): Promise‹Mesh›
Defined in packages/common-core/src/view-model/configurator-view-model.ts:748
Parameters:
| Name | Type |
|---|---|
partId | number |
Returns: Promise‹Mesh›
# sceneCleared
▸ sceneCleared(): void
Implementation of ConfiguratorKernelCallbackI
Defined in packages/common-core/src/view-model/configurator-view-model.ts:636
Returns: void
# setGeometriesMergedListener
▸ setGeometriesMergedListener(fun: function): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:722
Parameters:
▪ fun: function
▸ (): void
Returns: void
# setListener
▸ setListener(listener: ConfiguratorViewModelCallbackI): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:650
Parameters:
| Name | Type |
|---|---|
listener | ConfiguratorViewModelCallbackI |
Returns: void
# setMergeThreshold
▸ setMergeThreshold(threshold: number): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:730
Parameters:
| Name | Type |
|---|---|
threshold | number |
Returns: void
# tryToMergeComponents
▸ tryToMergeComponents(): void
Defined in packages/common-core/src/view-model/configurator-view-model.ts:199
Returns: void