RoomlePlanner.Internal.default-7

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

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

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

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

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

eulerAngles

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

componentRotation

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

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

material

any

vertices

Float32Array

indices

Int32Array

uvCoords

Float32Array

normals

Float32Array

Returns

void

Implementation of

PlannerKernelCallbackI.addMesh


addPlanElementViewModel

â–¸ addPlanElementViewModel(planElementViewModel): void

Parameters

Name
Type

planElementViewModel

Returns

void


addPlanMesh

â–¸ addPlanMesh(_plan, _material, _vertices, _indices, _uvCoords, _normals, _type): void

Parameters

Name
Type

_plan

_material

any

_vertices

Float32Array

_indices

Int32Array

_uvCoords

Float32Array

_normals

Float32Array

Returns

void

Implementation of

PlannerKernelCallbackI.addPlanMesh


addPlanObjectToScene

â–¸ addPlanObjectToScene(_planViewModel): void

Parameters

Name
Type

_planViewModel

Returns

void

Implementation of

PlannerKernelCallbackI.addPlanObjectToScene


beginPlanConstruction

â–¸ beginPlanConstruction(_plan): void

Parameters

Name
Type

_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

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

component?

Returns

void

Inherited from

default.dockComponentWithPosition


endPlanConstruction

â–¸ endPlanConstruction(_plan): void

Parameters

Name
Type

_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

_toPlan

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

Returns

boolean

Inherited from

default.isPreview


isPreviewLine

â–¸ isPreviewLine(obj): boolean

Parameters

Name
Type

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

Returns

void

Implementation of

PlannerKernelCallbackI.planCompletelyLoaded


planElementChanged

â–¸ planElementChanged(_plan, _planObject): void

Parameters

Name
Type

_plan

_planObject

Returns

void

Implementation of

PlannerKernelCallbackI.planElementChanged


planElementRemoved

â–¸ planElementRemoved(element): void

Parameters

Name
Type

Returns

void

Implementation of

PlannerKernelCallbackI.planElementRemoved


planHistoryStateChanged

â–¸ planHistoryStateChanged(): void

Returns

void

Implementation of

PlannerKernelCallbackI.planHistoryStateChanged


planObjectConfigurationChanged

â–¸ planObjectConfigurationChanged(_plan, _element): void

Parameters

Name
Type

_plan

_element

Returns

void

Implementation of

PlannerKernelCallbackI.planObjectConfigurationChanged


planObjectConfigurationLoaded

â–¸ planObjectConfigurationLoaded(_plan, planElement, success): void

Parameters

Name
Type

_plan

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

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

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

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

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

Returns

void

Inherited from

default.updateAnimationParameters

Last updated