API ReferenceGlobalsPlanViewModel

# Class: PlanViewModel

# Hierarchy

# Implements

# Index

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

+ new PlanViewModel(creator: string): PlanViewModel

Overrides ConfiguratorViewModel.constructor

Defined in packages/planner-core/src/view-model/plan-view-model.ts:46

Parameters:

Name Type
creator string

Returns: PlanViewModel

# Properties

# creator

creator: string

Implementation of Context.creator

Inherited from ConfiguratorViewModel.creator

Defined in packages/common-core/src/view-model/configurator-view-model.ts:58

# Accessors

# materialQueue

get materialQueue(): PromiseQueue‹void›

Inherited from ConfiguratorViewModel.materialQueue

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, uvTransform: Float32Array): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3ChangedNamedMesh

Defined in packages/common-core/src/view-model/configurator-view-model.ts:373

Parameters:

Name Type
runtimeComponentId number
meshId string
geometryId string
materialId string
transform Float32Array
uvTransform Float32Array

Returns: void


# Editor3dAddBakedMesh

Editor3dAddBakedMesh(runtimeComponentId: number, materialId: string, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, environmentGeometry: boolean): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dAddBakedMesh

Defined in packages/common-core/src/view-model/configurator-view-model.ts:360

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

Inherited from ConfiguratorViewModel.Editor3dAddDockPreview

Defined in packages/common-core/src/view-model/configurator-view-model.ts:364

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, uvTransform: Float32Array): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dAddNamedMesh

Defined in packages/common-core/src/view-model/configurator-view-model.ts:369

Parameters:

Name Type
runtimeComponentId number
meshId string
geometryId string
materialId string
transform Float32Array
vertices Int32Array
indices Int32Array
uvCoords Float32Array
normals Float32Array
environmentGeometry boolean
uvTransform Float32Array

Returns: void


# Editor3dBeginConstruction

Editor3dBeginConstruction(componentId: number, isDeltaUpdate: boolean): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dBeginConstruction

Defined in packages/common-core/src/view-model/configurator-view-model.ts:381

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

Overrides ConfiguratorViewModel.Editor3dComponentCreated

Defined in packages/planner-core/src/view-model/plan-view-model.ts:255

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

Inherited from ConfiguratorViewModel.Editor3dComponentDocked

Defined in packages/common-core/src/view-model/configurator-view-model.ts:412

Parameters:

Name Type
componentId number
parentId number
componentPosition KernelVector3
componentRotation KernelVector3

Returns: void


# Editor3dEndConstruction

Editor3dEndConstruction(id: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dEndConstruction

Defined in packages/common-core/src/view-model/configurator-view-model.ts:416

Parameters:

Name Type
id number

Returns: void


# Editor3dGeometryNotReady

Editor3dGeometryNotReady(id: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dGeometryNotReady

Defined in packages/common-core/src/view-model/configurator-view-model.ts:443

Parameters:

Name Type
id number

Returns: void


# Editor3dGeometryReady

Editor3dGeometryReady(id: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dGeometryReady

Defined in packages/common-core/src/view-model/configurator-view-model.ts:436

Parameters:

Name Type
id number

Returns: void


# Editor3dPlanObjectConstructionDone

Editor3dPlanObjectConstructionDone(planObjectId: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dPlanObjectConstructionDone

Defined in packages/common-core/src/view-model/configurator-view-model.ts:450

Parameters:

Name Type
planObjectId number

Returns: void


# Editor3dPreviewConstructionDone

Editor3dPreviewConstructionDone(componentId: number, _objectId: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dPreviewConstructionDone

Defined in packages/common-core/src/view-model/configurator-view-model.ts:464

Parameters:

Name Type
componentId number
_objectId number

Returns: void


# Editor3dRemoveNamedMesh

Editor3dRemoveNamedMesh(runtimeComponentId: number, meshId: string): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dRemoveNamedMesh

Defined in packages/common-core/src/view-model/configurator-view-model.ts:377

Parameters:

Name Type
runtimeComponentId number
meshId string

Returns: void


# Editor3dSetPreviewLineAssociations

Editor3dSetPreviewLineAssociations(dockLines: any, previewId: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dSetPreviewLineAssociations

Defined in packages/common-core/src/view-model/configurator-view-model.ts:485

Parameters:

Name Type
dockLines any
previewId number

Returns: void


# Editor3dSetPreviewPointAssociations

Editor3dSetPreviewPointAssociations(dockPairs: any, previewId: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.Editor3dSetPreviewPointAssociations

Defined in packages/common-core/src/view-model/configurator-view-model.ts:533

Parameters:

Name Type
dockPairs any
previewId number

Returns: void


# addMesh

addMesh(planElement: PlanElement, material: any, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:298

Parameters:

Name Type
planElement PlanElement
material any
vertices Int32Array
indices Int32Array
uvCoords Float32Array
normals Float32Array

Returns: void


# addPlanElementViewModel

addPlanElementViewModel(planElementViewModel: PlanElementViewModel): void

Defined in packages/planner-core/src/view-model/plan-view-model.ts:78

Parameters:

Name Type
planElementViewModel PlanElementViewModel

Returns: void


# addPlanMesh

addPlanMesh(_plan: Plan, _material: any, _vertices: Int32Array, _indices: Int32Array, _uvCoords: Float32Array, _normals: Float32Array, _type: KernelEnum): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:282

Parameters:

Name Type
_plan Plan
_material any
_vertices Int32Array
_indices Int32Array
_uvCoords Float32Array
_normals Float32Array
_type KernelEnum

Returns: void


# addPlanObjectToScene

addPlanObjectToScene(_planViewModel: PlanElementViewModel): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:264

Parameters:

Name Type
_planViewModel PlanElementViewModel

Returns: void


# beginPlanConstruction

beginPlanConstruction(_plan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:278

Parameters:

Name Type
_plan Plan

Returns: void


# clearReference

clearReference(): void

Overrides ConfiguratorViewModel.clearReference

Defined in packages/planner-core/src/view-model/plan-view-model.ts:68

Returns: void


# clearRootComponent

clearRootComponent(): void

Inherited from ConfiguratorViewModel.clearRootComponent

Defined in packages/common-core/src/view-model/configurator-view-model.ts:700

Returns: void


# componentConfigurationUpdated

componentConfigurationUpdated(runtimeComponentId: number, geometryChanged: boolean): void

Implementation of ConfiguratorKernelCallbackI

Overrides ConfiguratorViewModel.componentConfigurationUpdated

Defined in packages/planner-core/src/view-model/plan-view-model.ts:365

Parameters:

Name Type
runtimeComponentId number
geometryChanged boolean

Returns: void


# componentDeleted

componentDeleted(componentId: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.componentDeleted

Defined in packages/common-core/src/view-model/configurator-view-model.ts:563

Parameters:

Name Type
componentId number

Returns: void


# componentMetaUpdated

componentMetaUpdated(kernelComponent: KernelComponent): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.componentMetaUpdated

Defined in packages/common-core/src/view-model/configurator-view-model.ts:578

Parameters:

Name Type
kernelComponent KernelComponent

Returns: void


# configurationLoaded

configurationLoaded(conversationId: number, objectId: number, componentId: number, _hash: string, _errors: any): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.configurationLoaded

Defined in packages/common-core/src/view-model/configurator-view-model.ts:613

Parameters:

Name Type
conversationId number
objectId number
componentId number
_hash string
_errors any

Returns: void


# constructComponents

constructComponents(planObjectId: number): void

Inherited from ConfiguratorViewModel.constructComponents

Defined in packages/common-core/src/view-model/configurator-view-model.ts:763

Parameters:

Name Type
planObjectId number

Returns: void


# debugSceneGraph

debugSceneGraph(id?: number): void

Inherited from ConfiguratorViewModel.debugSceneGraph

Defined in packages/common-core/src/view-model/configurator-view-model.ts:704

Parameters:

Name Type
id? number

Returns: void


# dockComponentWithPosition

dockComponentWithPosition(previewComponent: PreviewLineComponent, component?: RoomleComponent): void

Inherited from ConfiguratorViewModel.dockComponentWithPosition

Defined in packages/common-core/src/view-model/configurator-view-model.ts:324

Parameters:

Name Type
previewComponent PreviewLineComponent
component? RoomleComponent

Returns: void


# endPlanConstruction

endPlanConstruction(_plan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:286

Parameters:

Name Type
_plan Plan

Returns: void


# finishParameterChange

finishParameterChange(resolve: function, _reject: function): void

Inherited from ConfiguratorViewModel.finishParameterChange

Defined in packages/common-core/src/view-model/configurator-view-model.ts:635

Parameters:

resolve: function

▸ (): void

_reject: function

▸ (): void

Returns: void


# getBoundingBox

getBoundingBox(): Box3

Overrides ConfiguratorViewModel.getBoundingBox

Defined in packages/planner-core/src/view-model/plan-view-model.ts:166

Returns: Box3


# getBoundingBoxWithPreviews

getBoundingBoxWithPreviews(): Box3

Inherited from ConfiguratorViewModel.getBoundingBoxWithPreviews

Defined in packages/common-core/src/view-model/configurator-view-model.ts:688

Returns: Box3


# getCeilingGroup

getCeilingGroup(): Group

Defined in packages/planner-core/src/view-model/plan-view-model.ts:158

Returns: Group


# getComponent

getComponent(componentId: number): RoomleComponent‹›

Inherited from ConfiguratorViewModel.getComponent

Defined in packages/common-core/src/view-model/configurator-view-model.ts:199

Parameters:

Name Type
componentId number

Returns: RoomleComponent‹›


# getComponents

getComponents(): RoomleComponent[]

Inherited from ConfiguratorViewModel.getComponents

Defined in packages/common-core/src/view-model/configurator-view-model.ts:727

Returns: RoomleComponent[]


# getComponentsForIds

getComponentsForIds(ids: number[]): RoomleComponent[]

Inherited from ConfiguratorViewModel.getComponentsForIds

Defined in packages/common-core/src/view-model/configurator-view-model.ts:716

Parameters:

Name Type
ids number[]

Returns: RoomleComponent[]


# getConfigurablePlanObjectViewModels

getConfigurablePlanObjectViewModels(): ConfiguratorPlanObjectViewModel[]

Defined in packages/planner-core/src/view-model/plan-view-model.ts:235

Returns: ConfiguratorPlanObjectViewModel[]


# getConstructionGroup

getConstructionGroup(): Group

Defined in packages/planner-core/src/view-model/plan-view-model.ts:154

Returns: Group


# getCorePlan

getCorePlan(): Plan

Defined in packages/planner-core/src/view-model/plan-view-model.ts:74

Returns: Plan


# getFloorGroup

getFloorGroup(): Group

Defined in packages/planner-core/src/view-model/plan-view-model.ts:162

Returns: Group


# getNodePlanObjectViewModels

getNodePlanObjectViewModels(): NodePlanElementViewModel[]

Defined in packages/planner-core/src/view-model/plan-view-model.ts:243

Returns: NodePlanElementViewModel[]


# getNumberOfPossibleChildrenForComponent

getNumberOfPossibleChildrenForComponent(componentId: number): number

Inherited from ConfiguratorViewModel.getNumberOfPossibleChildrenForComponent

Defined in packages/common-core/src/view-model/configurator-view-model.ts:211

Parameters:

Name Type
componentId number

Returns: number


# getPlanObjectForId

getPlanObjectForId(id: number): PlanElementViewModel

Defined in packages/planner-core/src/view-model/plan-view-model.ts:130

Parameters:

Name Type
id number

Returns: PlanElementViewModel


# getPreviews

getPreviews(): PreviewComponent[]

Inherited from ConfiguratorViewModel.getPreviews

Defined in packages/common-core/src/view-model/configurator-view-model.ts:731

Returns: PreviewComponent[]


# getStaticPlanObjectViewModels

getStaticPlanObjectViewModels(): StaticPlanObjectViewModel[]

Defined in packages/planner-core/src/view-model/plan-view-model.ts:231

Returns: StaticPlanObjectViewModel[]


# getWallPlanObjectViewModels

getWallPlanObjectViewModels(): WallPlanElementViewModel[]

Defined in packages/planner-core/src/view-model/plan-view-model.ts:239

Returns: WallPlanElementViewModel[]


# handlerSwitchedPlans

handlerSwitchedPlans(_fromPlan: Plan, _toPlan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:268

Parameters:

Name Type
_fromPlan Plan
_toPlan Plan

Returns: void


# hasPreviews

hasPreviews(): boolean

Inherited from ConfiguratorViewModel.hasPreviews

Defined in packages/common-core/src/view-model/configurator-view-model.ts:696

Returns: boolean


# hideAllExcept

hideAllExcept(planObjectId: number): void

Defined in packages/planner-core/src/view-model/plan-view-model.ts:370

Parameters:

Name Type
planObjectId number

Returns: void


# isPreview

isPreview(obj: RoomleComponent): boolean

Inherited from ConfiguratorViewModel.isPreview

Defined in packages/common-core/src/view-model/configurator-view-model.ts:739

Parameters:

Name Type
obj RoomleComponent

Returns: boolean


# isPreviewLine

isPreviewLine(obj: RoomleComponent): boolean

Inherited from ConfiguratorViewModel.isPreviewLine

Defined in packages/common-core/src/view-model/configurator-view-model.ts:735

Parameters:

Name Type
obj RoomleComponent

Returns: boolean


# planBoundsChanged

planBoundsChanged(): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:60

Returns: void


# planCleared

planCleared(): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:406

Returns: void


# planCompletelyLoaded

planCompletelyLoaded(_plan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:274

Parameters:

Name Type
_plan Plan

Returns: void


# planElementChanged

planElementChanged(_plan: Plan, _planObject: PlanElementViewModel): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:290

Parameters:

Name Type
_plan Plan
_planObject PlanElementViewModel

Returns: void


# planElementRemoved

planElementRemoved(element: PlanElement): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:326

Parameters:

Name Type
element PlanElement

Returns: void


# planHistoryStateChanged

planHistoryStateChanged(): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:396

Returns: void


# planObjectConfigurationLoaded

planObjectConfigurationLoaded(_plan: Plan, _element: PlanElement, _success: boolean): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:294

Parameters:

Name Type
_plan Plan
_element PlanElement
_success boolean

Returns: void


# planObjectConfigurationUpdated

planObjectConfigurationUpdated(planObjectId: number, _configuration: ConfigurationString, _hash: string): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.planObjectConfigurationUpdated

Defined in packages/common-core/src/view-model/configurator-view-model.ts:639

Parameters:

Name Type
planObjectId number
_configuration ConfigurationString
_hash string

Returns: void


# planObjectCreated

planObjectCreated(conversationId: number, planObjectId: number): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.planObjectCreated

Defined in packages/common-core/src/view-model/configurator-view-model.ts:645

Parameters:

Name Type
conversationId number
planObjectId number

Returns: void


# planObjectUpdated

planObjectUpdated(planObject: PlanObject): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.planObjectUpdated

Defined in packages/common-core/src/view-model/configurator-view-model.ts:653

Parameters:

Name Type
planObject PlanObject

Returns: void


# removeDockingComponent

removeDockingComponent(): void

Inherited from ConfiguratorViewModel.removeDockingComponent

Defined in packages/common-core/src/view-model/configurator-view-model.ts:305

Returns: void


# removeGeometriesMergedListener

removeGeometriesMergedListener(): void

Inherited from ConfiguratorViewModel.removeGeometriesMergedListener

Defined in packages/common-core/src/view-model/configurator-view-model.ts:747

Returns: void


# removePlanObjectFromScene

removePlanObjectFromScene(planElementViewModel: PlanElementViewModel): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/view-model/plan-view-model.ts:309

Parameters:

Name Type
planElementViewModel PlanElementViewModel

Returns: void


# removePreviews

removePreviews(): void

Inherited from ConfiguratorViewModel.removePreviews

Defined in packages/common-core/src/view-model/configurator-view-model.ts:339

Returns: void


# requestSubPartConstruction

requestSubPartConstruction(partId: number): Promise‹Mesh›

Inherited from ConfiguratorViewModel.requestSubPartConstruction

Defined in packages/common-core/src/view-model/configurator-view-model.ts:769

Parameters:

Name Type
partId number

Returns: Promise‹Mesh›


# sceneCleared

sceneCleared(): void

Implementation of ConfiguratorKernelCallbackI

Inherited from ConfiguratorViewModel.sceneCleared

Defined in packages/common-core/src/view-model/configurator-view-model.ts:657

Returns: void


# setCameraType

setCameraType(cameraType: CAMERA_TYPE): void

Defined in packages/planner-core/src/view-model/plan-view-model.ts:400

Parameters:

Name Type
cameraType CAMERA_TYPE

Returns: void


# setGeometriesMergedListener

setGeometriesMergedListener(fun: function): void

Inherited from ConfiguratorViewModel.setGeometriesMergedListener

Defined in packages/common-core/src/view-model/configurator-view-model.ts:743

Parameters:

fun: function

▸ (): void

Returns: void


# setListener

setListener(listener: ConfiguratorViewModelCallbackI): void

Inherited from ConfiguratorViewModel.setListener

Defined in packages/common-core/src/view-model/configurator-view-model.ts:671

Parameters:

Name Type
listener ConfiguratorViewModelCallbackI

Returns: void


# setMergeThreshold

setMergeThreshold(threshold: number): void

Inherited from ConfiguratorViewModel.setMergeThreshold

Defined in packages/common-core/src/view-model/configurator-view-model.ts:751

Parameters:

Name Type
threshold number

Returns: void


# Private setPlannerSceneEventHandler

setPlannerSceneEventHandler(plannerSceneEventHandler: PlannerSceneEventHandler): void

Defined in packages/planner-core/src/view-model/plan-view-model.ts:227

Merges geometries on the fly when creating them

Parameters:

Name Type
plannerSceneEventHandler PlannerSceneEventHandler

Returns: void


# setReference

setReference(plan: Plan): void

Defined in packages/planner-core/src/view-model/plan-view-model.ts:64

Parameters:

Name Type
plan Plan

Returns: void


# showAll

showAll(): void

Defined in packages/planner-core/src/view-model/plan-view-model.ts:388

Returns: void


# tryToMergeComponents

tryToMergeComponents(): void

Inherited from ConfiguratorViewModel.tryToMergeComponents

Defined in packages/common-core/src/view-model/configurator-view-model.ts:220

Returns: void