API ReferenceGlobalsPlannerSceneManager

# Class: PlannerSceneManager

# Hierarchy

# Implements

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new PlannerSceneManager(creator: string, offset: CanvasOffset, plannerCallback: RoomlePlannerCallback, mode?: CAMERA_TYPE): PlannerSceneManager

Overrides SceneManager.constructor

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:87

Parameters:

Name Type
creator string
offset CanvasOffset
plannerCallback RoomlePlannerCallback
mode? CAMERA_TYPE

Returns: PlannerSceneManager

# Properties

# creator

creator: string

Implementation of Context.creator

Inherited from SceneManager.creator

Defined in packages/common-core/src/webgl/scene-manager.ts:37

# Methods

# addMesh

addMesh(_planElement: PlanElement, _material: any, _vertices: Int32Array, _indices: Int32Array, _uvCoords: Float32Array, _normals: Float32Array): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:793

Parameters:

Name Type
_planElement PlanElement
_material any
_vertices Int32Array
_indices Int32Array
_uvCoords Float32Array
_normals Float32Array

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/webgl/planner-scene-manager.ts:421

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/webgl/planner-scene-manager.ts:436

Parameters:

Name Type
planViewModel PlanElementViewModel

Returns: void


# beginPlanConstruction

beginPlanConstruction(_plan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:417

Parameters:

Name Type
_plan Plan

Returns: void


# cameraControlChanged

cameraControlChanged(): void

Overrides SceneManager.cameraControlChanged

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:590

Returns: void


# cancelSelection

cancelSelection(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:839

Returns: void


# cleanUp

cleanUp(): void

Inherited from SceneManager.cleanUp

Defined in packages/common-core/src/webgl/scene-manager.ts:335

Returns: void


# clearScene

clearScene(): void

Overrides SceneManager.clearScene

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:496

Returns: void


# closeHSC

closeHSC(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:606

Returns: void


# deleteSelection

deleteSelection(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:845

Returns: void


# destroy

destroy(): void

Overrides SceneManager.destroy

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:726

Returns: void


# disableRotation

disableRotation(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:931

Returns: void


# dragIn

dragIn(dragEvent: DragEvent): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:935

Parameters:

Name Type
dragEvent DragEvent

Returns: void


# enableHD

enableHD(): void

Inherited from SceneManager.enableHD

Defined in packages/common-core/src/webgl/scene-manager.ts:357

Returns: void


# enableRotation

enableRotation(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:927

Returns: void


# endPlanConstruction

endPlanConstruction(_plan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:425

Parameters:

Name Type
_plan Plan

Returns: void


# exportGLB

exportGLB(exportObjects?: Object3D[], id?: string): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:460

Parameters:

Name Type
exportObjects? Object3D[]
id? string

Returns: void


# getBakedShadowParams

getBakedShadowParams(): BakedShadowParams

Overrides SceneManager.getBakedShadowParams

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:766

Returns: BakedShadowParams


# getBounds

getBounds(): Box3

Overrides SceneManager.getBounds

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:832

Returns: Box3


# getCameraOffset

getCameraOffset(): CanvasOffset

Inherited from SceneManager.getCameraOffset

Defined in packages/common-core/src/webgl/scene-manager.ts:624

Returns: CanvasOffset


# getPerspectiveOffsetCamera

getPerspectiveOffsetCamera(): PerspectiveOffsetCamera

Inherited from SceneManager.getPerspectiveOffsetCamera

Defined in packages/common-core/src/webgl/scene-manager.ts:632

Returns: PerspectiveOffsetCamera


# getPixotronParams

getPixotronParams(): any

Overrides SceneManager.getPixotronParams

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:732

Returns: any


# getPlannerSceneEventHandler

getPlannerSceneEventHandler(): PlannerSceneEventHandler‹›

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:939

Returns: PlannerSceneEventHandler‹›


# getScene

getScene(): Scene

Inherited from SceneManager.getScene

Defined in packages/common-core/src/webgl/scene-manager.ts:589

Returns: Scene


# handleEvent

handleEvent(evt: Event): void

Inherited from SceneManager.handleEvent

Defined in packages/common-core/src/webgl/scene-manager.ts:506

Parameters:

Name Type
evt Event

Returns: void


# handlerSwitchedPlans

handlerSwitchedPlans(planViewModel: PlanViewModel): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:366

Parameters:

Name Type
planViewModel PlanViewModel

Returns: void


# importGLB

importGLB(url: string): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:492

Parameters:

Name Type
url string

Returns: void


# loadDynamicLightSetting

loadDynamicLightSetting(source: DynamicLightSettingSource): Promise‹void›

Inherited from SceneManager.loadDynamicLightSetting

Defined in packages/common-core/src/webgl/scene-manager.ts:565

Parameters:

Name Type
source DynamicLightSettingSource

Returns: Promise‹void›


# loadQualitySetting

loadQualitySetting(qualitySetting: QualitySetting): void

Inherited from SceneManager.loadQualitySetting

Defined in packages/common-core/src/webgl/scene-manager.ts:558

Parameters:

Name Type
qualitySetting QualitySetting

Returns: void


# loadSceneSettings

loadSceneSettings(sceneSetting: SceneSettings): Promise‹void›

Inherited from SceneManager.loadSceneSettings

Defined in packages/common-core/src/webgl/scene-manager.ts:520

Parameters:

Name Type
sceneSetting SceneSettings

Returns: Promise‹void›


# loadStaticPlanObjects

loadStaticPlanObjects(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:305

Returns: void


# pause

pause(): void

Inherited from SceneManager.pause

Defined in packages/common-core/src/webgl/scene-manager.ts:480

Returns: void


# planBoundsChanged

planBoundsChanged(): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:871

Returns: void


# planCompletelyLoaded

planCompletelyLoaded(_plan: Plan): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:362

Parameters:

Name Type
_plan Plan

Returns: void


# planElementChanged

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

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:454

Parameters:

Name Type
_plan Plan
_planObject PlanElementViewModel

Returns: void


# planElementRemoved

planElementRemoved(_element: PlanElement): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:876

Parameters:

Name Type
_element PlanElement

Returns: void


# planObjectConfigurationLoaded

planObjectConfigurationLoaded(plan: Plan, element: PlanElement, _success: boolean): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:783

Parameters:

Name Type
plan Plan
element PlanElement
_success boolean

Returns: void


# planXMLLoaded

planXMLLoaded(plan: Plan): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:354

Parameters:

Name Type
plan Plan

Returns: void


# preload

preload(id: string): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:340

Parameters:

Name Type
id string

Returns: void


# preparePerspectiveImage

preparePerspectiveImage(options: PrepareImageOptions): Promise‹Base64Image

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:900

Parameters:

Name Type Default
options PrepareImageOptions {}

Returns: Promise‹Base64Image


# prepareTopImage

prepareTopImage(options: PrepareImageOptions): Promise‹Base64Image

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:884

Parameters:

Name Type Default
options PrepareImageOptions {}

Returns: Promise‹Base64Image


# removePlanObjectFromScene

removePlanObjectFromScene(planViewModel: PlanElementViewModel): void

Implementation of PlannerKernelCallbackI

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:448

Parameters:

Name Type
planViewModel PlanElementViewModel

Returns: void


# resetCamera

resetCamera(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:269

Returns: void


# resetCameraPositionToStart

resetCameraPositionToStart(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:281

Returns: void


# resetCameraToState

resetCameraToState(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:277

Returns: void


# resume

resume(): void

Inherited from SceneManager.resume

Defined in packages/common-core/src/webgl/scene-manager.ts:488

Returns: void


# rotateSelection

rotateSelection(rotateBy: number): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:856

Parameters:

Name Type
rotateBy number

Returns: void


# sceneChanged

sceneChanged(): void

Overrides SceneManager.sceneChanged

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:597

Returns: void


# setCameraOffset

setCameraOffset(offset: CanvasOffset): void

Inherited from SceneManager.setCameraOffset

Defined in packages/common-core/src/webgl/scene-manager.ts:614

Parameters:

Name Type
offset CanvasOffset

Returns: void


# setMode

setMode(mode: CAMERA_TYPE): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:694

Parameters:

Name Type
mode CAMERA_TYPE

Returns: void


# setupScene

setupScene(offset?: CanvasOffset, transparent?: boolean): void

Inherited from SceneManager.setupScene

Defined in packages/common-core/src/webgl/scene-manager.ts:294

Parameters:

Name Type
offset? CanvasOffset
transparent? boolean

Returns: void


# showGUI

showGUI(): void

Inherited from SceneManager.showGUI

Defined in packages/common-core/src/webgl/scene-manager.ts:409

Returns: void


# showStats

showStats(): void

Inherited from SceneManager.showStats

Defined in packages/common-core/src/webgl/scene-manager.ts:468

Returns: void


# switchTo2D

switchTo2D(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:553

Returns: void


# switchTo3D

switchTo3D(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:567

Returns: void


# switchToFirstPerson

switchToFirstPerson(): void

Defined in packages/planner-core/src/webgl/planner-scene-manager.ts:613

Returns: void


# updateCamera

updateCamera(): void

Inherited from SceneManager.updateCamera

Defined in packages/common-core/src/webgl/scene-manager.ts:298

Returns: void


# updateScene

updateScene(): void

Inherited from SceneManager.updateScene

Defined in packages/common-core/src/webgl/scene-manager.ts:593

Returns: void