RoomlePlanner.Internal.default-7

planner-core/src/roomle-planner.internal.default

Hierarchy

• default

  ↳ default

Implements

• PlannerKernelCallbackI

Table of contents

Constructors

• constructor

Properties

• _creator_

Accessors

• cameraType
• latestNodePlanObjectViewModel
• latestWallPlanObjectViewModel
• materialQueue

Methods

• Editor3ChangedMesh
• Editor3dAddDockPreview
• Editor3dAddMesh
• Editor3dBeginConstruction
• Editor3dComponentCreated
• Editor3dComponentDocked
• Editor3dEndConstruction
• Editor3dGeometryNotReady
• Editor3dGeometryReady
• Editor3dPlanObjectConstructionDone
• Editor3dPreviewConstructionDone
• Editor3dRemoveMesh
• Editor3dSetPreviewLineAssociations
• Editor3dSetPreviewPointAssociations
• _changeAnimationValue
• addMesh
• addPlanElementViewModel
• addPlanMesh
• addPlanObjectToScene
• beginPlanConstruction
• changeAnimationValue
• clearReference
• clearRootComponent
• componentConfigurationUpdated
• componentDeleted
• componentMetaUpdated
• configurationLoaded
• constructComponents
• debugSceneGraph
• dockComponentWithPosition
• endPlanConstruction
• finishParameterChange
• getBoundingBox
• getBoundingBoxOfGeometry
• getBoundingBoxWithPreviews
• getCeilingGroup
• getComponent
• getComponents
• getComponentsForIds
• getConfigurableConstructionPlanObjectViewModels
• getConfigurablePlanObjectForId
• getConfigurablePlanObjectViewModels
• getConstructionGroup
• getConstructionObjectForId
• getConstructionPlanObjectViewModels
• getCorePlan
• getFloorGroup
• getFloorPlanObjectViewModels
• getMeasurementLineGroup
• getMeasurementLineObjectViewModels
• getNodePlanObjectViewModels
• getNumberOfPossibleChildrenForComponent
• getPlanObjectCount
• getPlanObjectForId
• getPlanObjectViewModelsFromRapiId
• getPreviews
• getStaticPlanObjectForId
• getStaticPlanObjectViewModelForId
• getStaticPlanObjectViewModels
• getWallAtticsGroup
• getWallAtticsObjectViewModels
• getWallPlanObjectViewModels
• handlerSwitchedPlans
• hasPreviewLines
• hasPreviews
• hideAllExcept
• isPreview
• isPreviewLine
• planBoundsChanged
• planCleared
• planCompletelyLoaded
• planElementChanged
• planElementRemoved
• planHistoryStateChanged
• planObjectConfigurationChanged
• planObjectConfigurationLoaded
• planObjectConfigurationUpdated
• planObjectCreated
• planObjectUpdated
• removeDockingComponent
• removeGeometriesMergedListener
• removePlanObjectFromScene
• removePreviews
• requestCatalogItem
• requestSubPartConstruction
• sceneCleared
• setCameraType
• setGeometriesMergedListener
• setInvalidateRenderCallback
• setListener
• setMergeThreshold
• setNodeVisibility
• setNodeZoom
• setReference
• setRequestRenderCallback
• setRequestRenderSceneUpdateCallback
• showAll
• startedDrawing
• stoppedDrawing
• tryToMergeComponents
• updateAnimationParameters

Constructors

constructor

• new default(creator)

Parameters

Name	Type
creator	string

Overrides

default.constructor

Properties

_creator_

• _creator_: string

Inherited from

default.creator

Accessors

cameraType

• get cameraType(): Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

Returns

Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

---

latestNodePlanObjectViewModel

• get latestNodePlanObjectViewModel(): default

Returns

default

---

latestWallPlanObjectViewModel

• get latestWallPlanObjectViewModel(): default

Returns

default

---

materialQueue

• get materialQueue(): PromiseQueue<void>

Returns

PromiseQueue<void>

Inherited from

ConfiguratorViewModel.materialQueue

Methods

Editor3ChangedMesh

▸ Editor3ChangedMesh(runtimeComponentId, meshId, geometryName, meshAttributes): void

Parameters

Name	Type
runtimeComponentId	number
meshId	number
geometryName	string
meshAttributes	KernelMeshAttributes

Returns

void

Inherited from

default.Editor3ChangedMesh

---

Editor3dAddDockPreview

▸ Editor3dAddDockPreview(componentId, previewId): void

Parameters

Name	Type
componentId	number
previewId	number

Returns

void

Inherited from

default.Editor3dAddDockPreview

---

Editor3dAddMesh

▸ Editor3dAddMesh(runtimeComponentId, meshId, geometryName, environmentGeometry, meshAttributes, meshBuffer): void

Parameters

Name	Type
runtimeComponentId	number
meshId	number
geometryName	string
environmentGeometry	boolean
meshAttributes	KernelMeshAttributes
meshBuffer	KernelMeshBuffer

Returns

void

Inherited from

default.Editor3dAddMesh

---

Editor3dBeginConstruction

▸ Editor3dBeginConstruction(componentId, isDeltaUpdate): void

Parameters

Name	Type
componentId	number
isDeltaUpdate	boolean

Returns

void

Inherited from

default.Editor3dBeginConstruction

---

Editor3dComponentCreated

▸ Editor3dComponentCreated(id, position, eulerAngles, isRootComponent, parentObjectRuntimeId): void

Parameters

Name	Type
id	number
position	KernelVector3
eulerAngles	KernelVector3
isRootComponent	boolean
parentObjectRuntimeId	number

Returns

void

Overrides

default.Editor3dComponentCreated

---

Editor3dComponentDocked

▸ Editor3dComponentDocked(componentId, isRootComponent, parentId, componentPosition, componentRotation): void

Parameters

Name	Type
componentId	number
isRootComponent	boolean
parentId	number
componentPosition	KernelVector3
componentRotation	KernelVector3

Returns

void

Inherited from

default.Editor3dComponentDocked

---

Editor3dEndConstruction

▸ Editor3dEndConstruction(id): void

Parameters

Name	Type
id	number

Returns

void

Inherited from

default.Editor3dEndConstruction

---

Editor3dGeometryNotReady

▸ Editor3dGeometryNotReady(id): void

Parameters

Name	Type
id	number

Returns

void

Inherited from

default.Editor3dGeometryNotReady

---

Editor3dGeometryReady

▸ Editor3dGeometryReady(id): void

Parameters

Name	Type
id	number

Returns

void

Inherited from

default.Editor3dGeometryReady

---

Editor3dPlanObjectConstructionDone

▸ Editor3dPlanObjectConstructionDone(planObjectId): void

Parameters

Name	Type
planObjectId	number

Returns

void

Inherited from

default.Editor3dPlanObjectConstructionDone

---

Editor3dPreviewConstructionDone

▸ Editor3dPreviewConstructionDone(componentId, _objectId): void

Parameters

Name	Type
componentId	number
_objectId	number

Returns

void

Inherited from

default.Editor3dPreviewConstructionDone

---

Editor3dRemoveMesh

▸ Editor3dRemoveMesh(runtimeComponentId, meshId): void

Parameters

Name	Type
runtimeComponentId	number
meshId	number

Returns

void

Inherited from

default.Editor3dRemoveMesh

---

Editor3dSetPreviewLineAssociations

▸ Editor3dSetPreviewLineAssociations(dockLines, previewId): void

Parameters

Name	Type
dockLines	any
previewId	number

Returns

void

Inherited from

default.Editor3dSetPreviewLineAssociations

---

Editor3dSetPreviewPointAssociations

▸ Editor3dSetPreviewPointAssociations(dockPairs, previewId): void

Parameters

Name	Type
dockPairs	any
previewId	number

Returns

void

Inherited from

default.Editor3dSetPreviewPointAssociations

---

_changeAnimationValue

▸ _changeAnimationValue(component, parameterKey, value, animate): void

Parameters

Name	Type
component	RoomleComponent
parameterKey	string
value	string
animate	boolean

Returns

void

Inherited from

default._changeAnimationValue

---

addMesh

▸ addMesh(planElement, material, vertices, indices, uvCoords, normals): void

Parameters

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

Returns

void

Implementation of

PlannerKernelCallbackI.addMesh

---

addPlanElementViewModel

▸ addPlanElementViewModel(planElementViewModel): void

Parameters

Name	Type
planElementViewModel	default

Returns

void

---

addPlanMesh

▸ addPlanMesh(_plan, _material, _vertices, _indices, _uvCoords, _normals, _type): void

Parameters

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

Returns

void

Implementation of

PlannerKernelCallbackI.addPlanMesh

---

addPlanObjectToScene

▸ addPlanObjectToScene(_planViewModel): void

Parameters

Name	Type
_planViewModel	default

Returns

void

Implementation of

PlannerKernelCallbackI.addPlanObjectToScene

---

beginPlanConstruction

▸ beginPlanConstruction(_plan): void

Parameters

Name	Type
_plan	Plan

Returns

void

Implementation of

PlannerKernelCallbackI.beginPlanConstruction

---

changeAnimationValue

▸ changeAnimationValue(elementId, parameterKey, value, applyToChildren, animate): void

Parameters

Name	Type
elementId	number
parameterKey	string
value	string
applyToChildren	boolean
animate	boolean

Returns

void

Inherited from

default.changeAnimationValue

---

clearReference

▸ clearReference(): void

Returns

void

---

clearRootComponent

▸ clearRootComponent(): void

Returns

void

Inherited from

default.clearRootComponent

---

componentConfigurationUpdated

▸ componentConfigurationUpdated(runtimeComponentId, geometryChanged): void

Parameters

Name	Type
runtimeComponentId	number
geometryChanged	boolean

Returns

void

Overrides

default.componentConfigurationUpdated

---

componentDeleted

▸ componentDeleted(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Inherited from

default.componentDeleted

---

componentMetaUpdated

▸ componentMetaUpdated(kernelComponent): void

Parameters

Name	Type
kernelComponent	KernelComponent

Returns

void

Inherited from

default.componentMetaUpdated

---

configurationLoaded

▸ configurationLoaded(conversationId, objectId, componentId, _hash, _errors): void

Parameters

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

Returns

void

Inherited from

default.configurationLoaded

---

constructComponents

▸ constructComponents(planObjectId): void

Parameters

Name	Type
planObjectId	number

Returns

void

Inherited from

default.constructComponents

---

debugSceneGraph

▸ debugSceneGraph(id?): void

Parameters

Name	Type
id?	number

Returns

void

Inherited from

default.debugSceneGraph

---

dockComponentWithPosition

▸ dockComponentWithPosition(previewComponent, component?): void

Parameters

Name	Type
previewComponent	PreviewLineComponent
component?	RoomleComponent

Returns

void

Inherited from

default.dockComponentWithPosition

---

endPlanConstruction

▸ endPlanConstruction(_plan): void

Parameters

Name	Type
_plan	Plan

Returns

void

Implementation of

PlannerKernelCallbackI.endPlanConstruction

---

finishParameterChange

▸ finishParameterChange(resolve, _reject): void

Parameters

Name	Type
resolve	() => void
_reject	() => void

Returns

void

Inherited from

default.finishParameterChange

---

getBoundingBox

▸ getBoundingBox(): Box3

Returns

Box3

Overrides

default.getBoundingBox

---

getBoundingBoxOfGeometry

▸ getBoundingBoxOfGeometry(): Box3

Returns

Box3

Overrides

default.getBoundingBoxOfGeometry

---

getBoundingBoxWithPreviews

▸ getBoundingBoxWithPreviews(): Box3

Returns

Box3

Inherited from

default.getBoundingBoxWithPreviews

---

getCeilingGroup

▸ getCeilingGroup(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

getComponent

▸ getComponent(componentId): RoomleComponent

Parameters

Name	Type
componentId	number

Returns

RoomleComponent

Inherited from

default.getComponent

---

getComponents

▸ getComponents(): RoomleComponent[]

Returns

RoomleComponent[]

Inherited from

default.getComponents

---

getComponentsForIds

▸ getComponentsForIds(ids): RoomleComponent[]

Parameters

Name	Type
ids	number[]

Returns

RoomleComponent[]

Inherited from

default.getComponentsForIds

---

getConfigurableConstructionPlanObjectViewModels

▸ getConfigurableConstructionPlanObjectViewModels(): default[]

Returns

default[]

---

getConfigurablePlanObjectForId

▸ getConfigurablePlanObjectForId(id): default

Parameters

Name	Type
id	number

Returns

default

---

getConfigurablePlanObjectViewModels

▸ getConfigurablePlanObjectViewModels(): default[]

Returns

default[]

---

getConstructionGroup

▸ getConstructionGroup(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

getConstructionObjectForId

▸ getConstructionObjectForId(id): default

Parameters

Name	Type
id	number

Returns

default

---

getConstructionPlanObjectViewModels

▸ getConstructionPlanObjectViewModels(): default[]

Returns

default[]

---

getCorePlan

▸ getCorePlan(): Plan

Returns

Plan

---

getFloorGroup

▸ getFloorGroup(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

getFloorPlanObjectViewModels

▸ getFloorPlanObjectViewModels(): default[]

Returns

default[]

---

getMeasurementLineGroup

▸ getMeasurementLineGroup(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

getMeasurementLineObjectViewModels

▸ getMeasurementLineObjectViewModels(): default[]

Returns

default[]

---

getNodePlanObjectViewModels

▸ getNodePlanObjectViewModels(): default[]

Returns

default[]

---

getNumberOfPossibleChildrenForComponent

▸ getNumberOfPossibleChildrenForComponent(componentId): number

Parameters

Name	Type
componentId	number

Returns

number

Inherited from

default.getNumberOfPossibleChildrenForComponent

---

getPlanObjectCount

▸ getPlanObjectCount(): number

Returns

number

---

getPlanObjectForId

▸ getPlanObjectForId(id): default

Parameters

Name	Type
id	number

Returns

default

---

getPlanObjectViewModelsFromRapiId

▸ getPlanObjectViewModelsFromRapiId(): (default | default)[]

Returns

(default | default)[]

---

getPreviews

▸ getPreviews(): PreviewComponent[]

Returns

PreviewComponent[]

Inherited from

default.getPreviews

---

getStaticPlanObjectForId

▸ getStaticPlanObjectForId(id): default

Parameters

Name	Type
id	number

Returns

default

---

getStaticPlanObjectViewModelForId

▸ getStaticPlanObjectViewModelForId(id): default

Parameters

Name	Type
id	number

Returns

default

---

getStaticPlanObjectViewModels

▸ getStaticPlanObjectViewModels(): default[]

Returns

default[]

---

getWallAtticsGroup

▸ getWallAtticsGroup(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

getWallAtticsObjectViewModels

▸ getWallAtticsObjectViewModels(): default[]

Returns

default[]

---

getWallPlanObjectViewModels

▸ getWallPlanObjectViewModels(): default[]

Returns

default[]

---

handlerSwitchedPlans

▸ handlerSwitchedPlans(_fromPlan, _toPlan): void

Parameters

Name	Type
_fromPlan	Plan
_toPlan	Plan

Returns

void

Implementation of

PlannerKernelCallbackI.handlerSwitchedPlans

---

hasPreviewLines

▸ hasPreviewLines(): boolean

Returns

boolean

Inherited from

default.hasPreviewLines

---

hasPreviews

▸ hasPreviews(): boolean

Returns

boolean

Inherited from

default.hasPreviews

---

hideAllExcept

▸ hideAllExcept(planObjectId): void

Parameters

Name	Type
planObjectId	number

Returns

void

---

isPreview

▸ isPreview(obj): boolean

Parameters

Name	Type
obj	RoomleComponent

Returns

boolean

Inherited from

default.isPreview

---

isPreviewLine

▸ isPreviewLine(obj): boolean

Parameters

Name	Type
obj	RoomleComponent

Returns

boolean

Inherited from

default.isPreviewLine

---

planBoundsChanged

▸ planBoundsChanged(): void

Returns

void

Implementation of

PlannerKernelCallbackI.planBoundsChanged

---

planCleared

▸ planCleared(): void

Returns

void

Implementation of

PlannerKernelCallbackI.planCleared

---

planCompletelyLoaded

▸ planCompletelyLoaded(_plan): void

Parameters

Name	Type
_plan	Plan

Returns

void

Implementation of

PlannerKernelCallbackI.planCompletelyLoaded

---

planElementChanged

▸ planElementChanged(_plan, _planObject): void

Parameters

Name	Type
_plan	Plan
_planObject	default

Returns

void

Implementation of

PlannerKernelCallbackI.planElementChanged

---

planElementRemoved

▸ planElementRemoved(element): void

Parameters

Name	Type
element	PlanElement

Returns

void

Implementation of

PlannerKernelCallbackI.planElementRemoved

---

planHistoryStateChanged

▸ planHistoryStateChanged(): void

Returns

void

Implementation of

PlannerKernelCallbackI.planHistoryStateChanged

---

planObjectConfigurationChanged

▸ planObjectConfigurationChanged(_plan, _element): void

Parameters

Name	Type
_plan	Plan
_element	default

Returns

void

Implementation of

PlannerKernelCallbackI.planObjectConfigurationChanged

---

planObjectConfigurationLoaded

▸ planObjectConfigurationLoaded(_plan, planElement, success): void

Parameters

Name	Type
_plan	Plan
planElement	PlanElement
success	boolean

Returns

void

Implementation of

PlannerKernelCallbackI.planObjectConfigurationLoaded

---

planObjectConfigurationUpdated

▸ planObjectConfigurationUpdated(planObjectId, _configuration, _hash, pendingDocking): void

Parameters

Name	Type
planObjectId	number
_configuration	string
_hash	string
pendingDocking	boolean

Returns

void

Inherited from

default.planObjectConfigurationUpdated

---

planObjectCreated

▸ planObjectCreated(conversationId, planObjectId): void

Parameters

Name	Type
conversationId	number
planObjectId	number

Returns

void

Inherited from

default.planObjectCreated

---

planObjectUpdated

▸ planObjectUpdated(planObject, pendingDocking): void

Parameters

Name	Type
planObject	PlanObject
pendingDocking	boolean

Returns

void

Inherited from

default.planObjectUpdated

---

removeDockingComponent

▸ removeDockingComponent(): void

Returns

void

Inherited from

default.removeDockingComponent

---

removeGeometriesMergedListener

▸ removeGeometriesMergedListener(): void

Returns

void

Inherited from

default.removeGeometriesMergedListener

---

removePlanObjectFromScene

▸ removePlanObjectFromScene(planElementViewModel): void

Parameters

Name	Type
planElementViewModel	default

Returns

void

Implementation of

PlannerKernelCallbackI.removePlanObjectFromScene

---

removePreviews

▸ removePreviews(): void

Returns

void

Inherited from

default.removePreviews

---

requestCatalogItem

▸ requestCatalogItem(_catalogItemId): void

Parameters

Name	Type
_catalogItemId	string

Returns

void

Implementation of

PlannerKernelCallbackI.requestCatalogItem

---

requestSubPartConstruction

▸ requestSubPartConstruction(partId): Promise<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

Parameters

Name	Type
partId	number

Returns

Promise<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

Inherited from

default.requestSubPartConstruction

---

sceneCleared

▸ sceneCleared(): void

Returns

void

Inherited from

default.sceneCleared

---

setCameraType

▸ setCameraType(cameraType): Promise<void>

Parameters

Name	Type
cameraType	Enumify<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

Returns

Promise<void>

---

setGeometriesMergedListener

▸ setGeometriesMergedListener(fun): void

Parameters

Name	Type
fun	() => void

Returns

void

Inherited from

default.setGeometriesMergedListener

---

setInvalidateRenderCallback

▸ setInvalidateRenderCallback(invalidateRenderCallback): void

Parameters

Name	Type
invalidateRenderCallback	() => void

Returns

void

Inherited from

default.setInvalidateRenderCallback

---

setListener

▸ setListener(listener): void

Parameters

Name	Type
listener	ConfiguratorViewModelCallbackI

Returns

void

Inherited from

default.setListener

---

setMergeThreshold

▸ setMergeThreshold(threshold): void

Parameters

Name	Type
threshold	number

Returns

void

Inherited from

default.setMergeThreshold

---

setNodeVisibility

▸ setNodeVisibility(visible): void

Parameters

Name	Type
visible	boolean

Returns

void

---

setNodeZoom

▸ setNodeZoom(zoom): void

Parameters

Name	Type
zoom	number

Returns

void

---

setReference

▸ setReference(plan): void

Parameters

Name	Type
plan	Plan

Returns

void

---

setRequestRenderCallback

▸ setRequestRenderCallback(requestRenderCallback): void

Parameters

Name	Type
requestRenderCallback	() => void

Returns

void

Inherited from

default.setRequestRenderCallback

---

setRequestRenderSceneUpdateCallback

▸ setRequestRenderSceneUpdateCallback(requestRenderSceneUpdateCallback): void

Parameters

Name	Type
requestRenderSceneUpdateCallback	() => void

Returns

void

Inherited from

default.setRequestRenderSceneUpdateCallback

---

showAll

▸ showAll(): void

Returns

void

---

startedDrawing

▸ startedDrawing(): void

Returns

void

Implementation of

PlannerKernelCallbackI.startedDrawing

---

stoppedDrawing

▸ stoppedDrawing(): void

Returns

void

Implementation of

PlannerKernelCallbackI.stoppedDrawing

---

tryToMergeComponents

▸ tryToMergeComponents(): void

Returns

void

Inherited from

default.tryToMergeComponents

---

updateAnimationParameters

▸ updateAnimationParameters(elementId, parameters): void

Parameters

Name	Type
elementId	number | number[]
parameters	KernelParameter[]

Returns

void

Inherited from

default.updateAnimationParameters