API Reference › Globals › ConfiguratorSceneManager
# Class: ConfiguratorSceneManager
# Hierarchy
-
↳ ConfiguratorSceneManager
# Implements
- Context
- LifeCycleCallbacks
- EventListenerObject
- ConfiguratorViewModelCallbackI
# Index
# Constructors
# Properties
# Methods
- addComponentHandlers
- addPreviewHandlers
- addPreviewLineHandlers
- cameraControlChanged
- cancelComponentSelection
- cancelDockings
- cancelPreviousDockings
- changeFloorMaterial
- changeOffset
- cleanUp
- clearScene
- componentDeleted
- componentUpdated
- configurationLoaded
- debugScene
- debugSceneGraph
- destroy
- disableConfiguratorEvents
- display
- enableConfiguratorEvents
- enableDragIn
- enableHD
- exportGLB
- getBakedShadowParams
- getBounds
- getCameraOffset
- getPerspectiveOffsetCamera
- getPixotronParams
- getScene
- getScreenXY
- handleEvent
- hideDimensions
- highlightParts
- loadDynamicLightSetting
- loadQualitySetting
- loadSceneSettings
- moveCamera
- pause
- planObjectConstructionDone
- planObjectUpdated
- preparePartImage
- preparePerspectiveImage
- prepareTopImage
- previewConstructionDone
- renderImage
- requestDeleteSelectedComponent
- requestDockingsPreview
- resetCamera
- resetCameraPositionToStart
- resetCameraToState
- resetPreviews
- resume
- sceneChanged
- sceneCleared
- selectComponent
- setBackgroundColor
- setBackgroundImage
- setBakedShadow
- setCameraOffset
- setSelectionMode
- showDimensions
- showGUI
- showStats
- updateCamera
- updateScene
- zoomIn
- zoomOut
- zoomToComponent
# Constructors
# constructor
+ new ConfiguratorSceneManager(creator: string, offset: CanvasOffset, mode: CAMERA_TYPE): ConfiguratorSceneManager
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:104
Parameters:
| Name | Type | Default |
|---|---|---|
creator | string | - |
offset | CanvasOffset | - |
mode | CAMERA_TYPE | CAMERA_TYPE.CAMERA_3D |
Returns: ConfiguratorSceneManager
# Properties
# creator
• creator: string
_Implementation of Context.creator_
_Overrides SceneManager.creator_
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:66
# Methods
# addComponentHandlers
▸ addComponentHandlers(component: RoomleComponent): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1068
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
Returns: void
# addPreviewHandlers
▸ addPreviewHandlers(previewComponent: PreviewComponent): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1072
Parameters:
| Name | Type |
|---|---|
previewComponent | PreviewComponent |
Returns: void
# addPreviewLineHandlers
▸ addPreviewLineHandlers(previewLineComponent: PreviewLineComponent): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1076
Parameters:
| Name | Type |
|---|---|
previewLineComponent | PreviewLineComponent |
Returns: void
# cameraControlChanged
▸ cameraControlChanged(): void
Inherited from SceneManager.cameraControlChanged
Defined in packages/common-core/src/webgl/scene-manager.ts:135
Returns: void
# cancelComponentSelection
▸ cancelComponentSelection(resetCamera?: boolean): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:741
Parameters:
| Name | Type |
|---|---|
resetCamera? | boolean |
Returns: void
# cancelDockings
▸ cancelDockings(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:272
Returns: void
# cancelPreviousDockings
▸ cancelPreviousDockings(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:737
Returns: void
# changeFloorMaterial
▸ changeFloorMaterial(material: RapiMaterial): Promise‹void›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:804
Parameters:
| Name | Type |
|---|---|
material | RapiMaterial |
Returns: Promise‹void›
# changeOffset
▸ changeOffset(offset: CanvasOffset): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:687
Parameters:
| Name | Type |
|---|---|
offset | CanvasOffset |
Returns: void
# cleanUp
▸ cleanUp(): void
Inherited from SceneManager.cleanUp
Defined in packages/common-core/src/webgl/scene-manager.ts:371
Returns: void
# clearScene
▸ clearScene(): void
Implementation of ConfiguratorViewModelCallbackI
Overrides SceneManager.clearScene
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:459
Returns: void
# componentDeleted
▸ componentDeleted(component: RoomleComponent): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1013
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
Returns: void
# componentUpdated
▸ componentUpdated(component: RoomleComponent, _kernelComponent: KernelComponent): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:984
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
_kernelComponent | KernelComponent |
Returns: void
# configurationLoaded
▸ configurationLoaded(component: RoomleComponent, isFreeFlying: boolean): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1046
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
isFreeFlying | boolean |
Returns: void
# debugScene
▸ debugScene(): Scene‹›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:444
Returns: Scene‹›
# debugSceneGraph
▸ debugSceneGraph(id?: number): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:439
Parameters:
| Name | Type |
|---|---|
id? | number |
Returns: void
# destroy
▸ destroy(): void
Inherited from SceneManager.destroy
Defined in packages/common-core/src/webgl/scene-manager.ts:607
Returns: void
# disableConfiguratorEvents
▸ disableConfiguratorEvents(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:253
Returns: void
# display
▸ display(component: RoomleComponent): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:433
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
Returns: void
# enableConfiguratorEvents
▸ enableConfiguratorEvents(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:249
Returns: void
# enableDragIn
▸ enableDragIn(dragEvent: DragEvent): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:634
Parameters:
| Name | Type |
|---|---|
dragEvent | DragEvent |
Returns: void
# enableHD
▸ enableHD(source?: DynamicLightSettingSource): void
Inherited from SceneManager.enableHD
Defined in packages/common-core/src/webgl/scene-manager.ts:394
Parameters:
| Name | Type |
|---|---|
source? | DynamicLightSettingSource |
Returns: void
# exportGLB
▸ exportGLB(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:821
Returns: void
# getBakedShadowParams
▸ getBakedShadowParams(): BakedShadowParams
Overrides SceneManager.getBakedShadowParams
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1185
Returns: BakedShadowParams
# getBounds
▸ getBounds(): Box3
Overrides SceneManager.getBounds
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1202
Returns: Box3
# getCameraOffset
▸ getCameraOffset(): CanvasOffset
Overrides SceneManager.getCameraOffset
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:706
Returns: CanvasOffset
# getPerspectiveOffsetCamera
▸ getPerspectiveOffsetCamera(): PerspectiveOffsetCamera
Inherited from SceneManager.getPerspectiveOffsetCamera
Defined in packages/common-core/src/webgl/scene-manager.ts:764
Returns: PerspectiveOffsetCamera
# getPixotronParams
▸ getPixotronParams(): any
Overrides SceneManager.getPixotronParams
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1206
Returns: any
# getScene
▸ getScene(): Scene
Inherited from SceneManager.getScene
Defined in packages/common-core/src/webgl/scene-manager.ts:719
Returns: Scene
# getScreenXY
▸ getScreenXY(position: Vector3): Vector3‹›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:796
Parameters:
| Name | Type |
|---|---|
position | Vector3 |
Returns: Vector3‹›
# handleEvent
▸ handleEvent(evt: Event): void
Inherited from SceneManager.handleEvent
Defined in packages/common-core/src/webgl/scene-manager.ts:612
Parameters:
| Name | Type |
|---|---|
evt | Event |
Returns: void
# hideDimensions
▸ hideDimensions(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:881
Returns: void
# highlightParts
▸ highlightParts(ids: number[]): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1152
Parameters:
| Name | Type |
|---|---|
ids | number[] |
Returns: void
# loadDynamicLightSetting
▸ loadDynamicLightSetting(source: DynamicLightSettingSource): Promise‹void›
Inherited from SceneManager.loadDynamicLightSetting
Defined in packages/common-core/src/webgl/scene-manager.ts:695
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:688
Parameters:
| Name | Type |
|---|---|
qualitySetting | QualitySetting |
Returns: void
# loadSceneSettings
▸ loadSceneSettings(sceneSetting: SceneSettings): Promise‹void›
Overrides SceneManager.loadSceneSettings
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:891
Parameters:
| Name | Type |
|---|---|
sceneSetting | SceneSettings |
Returns: Promise‹void›
# moveCamera
▸ moveCamera(cameraParameter: CameraParameter): Promise‹void›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1135
Parameters:
| Name | Type |
|---|---|
cameraParameter | CameraParameter |
Returns: Promise‹void›
# pause
▸ pause(): void
Overrides SceneManager.pause
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:391
Returns: void
# planObjectConstructionDone
▸ planObjectConstructionDone(_planObject: PlanObject): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:469
Parameters:
| Name | Type |
|---|---|
_planObject | PlanObject |
Returns: void
# planObjectUpdated
▸ planObjectUpdated(planObject: PlanObject, geometryChanged: boolean): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:998
Parameters:
| Name | Type |
|---|---|
planObject | PlanObject |
geometryChanged | boolean |
Returns: void
# preparePartImage
▸ preparePartImage(partId: number, options: PrepareImageOptions): Promise‹any›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:570
Parameters:
| Name | Type |
|---|---|
partId | number |
options | PrepareImageOptions |
Returns: Promise‹any›
# preparePerspectiveImage
▸ preparePerspectiveImage(options: PrepareImageOptions): Promise‹Base64Image›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:497
Parameters:
| Name | Type | Default |
|---|---|---|
options | PrepareImageOptions | {} |
Returns: Promise‹Base64Image›
# prepareTopImage
▸ prepareTopImage(options: PrepareImageOptions): Promise‹Base64Image›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:606
Parameters:
| Name | Type | Default |
|---|---|---|
options | PrepareImageOptions | {} |
Returns: Promise‹Base64Image›
# previewConstructionDone
▸ previewConstructionDone(component: RoomleComponent, hasPreviews: boolean): void
Implementation of ConfiguratorViewModelCallbackI
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1019
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
hasPreviews | boolean |
Returns: void
# renderImage
▸ renderImage(renderOptions: RenderOptions): Promise‹Base64Image›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:538
Parameters:
| Name | Type |
|---|---|
renderOptions | RenderOptions |
Returns: Promise‹Base64Image›
# requestDeleteSelectedComponent
▸ requestDeleteSelectedComponent(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:964
Returns: void
# requestDockingsPreview
▸ requestDockingsPreview(userInitiated: boolean, possibleChild?: UiPossibleChild, dragEvent?: DragEvent, dragIn?: boolean): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:910
Parameters:
| Name | Type |
|---|---|
userInitiated | boolean |
possibleChild? | UiPossibleChild |
dragEvent? | DragEvent |
dragIn? | boolean |
Returns: void
# resetCamera
▸ resetCamera(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:652
Returns: void
# resetCameraPositionToStart
▸ resetCameraPositionToStart(animate: boolean): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:666
Parameters:
| Name | Type | Default |
|---|---|---|
animate | boolean | true |
Returns: void
# resetCameraToState
▸ resetCameraToState(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:660
Returns: void
# resetPreviews
▸ resetPreviews(): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:682
Returns: void
# resume
▸ resume(): void
Overrides SceneManager.resume
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:360
Returns: void
# sceneChanged
▸ sceneChanged(): void
Overrides SceneManager.sceneChanged
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1240
Returns: void
# sceneCleared
▸ sceneCleared(shouldHardReset: boolean): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:429
Parameters:
| Name | Type |
|---|---|
shouldHardReset | boolean |
Returns: void
# selectComponent
▸ selectComponent(runtimeId: number): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:1139
Parameters:
| Name | Type |
|---|---|
runtimeId | number |
Returns: void
# setBackgroundColor
▸ setBackgroundColor(hex: string): void
Inherited from SceneManager.setBackgroundColor
Defined in packages/common-core/src/webgl/scene-manager.ts:665
Parameters:
| Name | Type |
|---|---|
hex | string |
Returns: void
# setBackgroundImage
▸ setBackgroundImage(url: string): void
Inherited from SceneManager.setBackgroundImage
Defined in packages/common-core/src/webgl/scene-manager.ts:669
Parameters:
| Name | Type |
|---|---|
url | string |
Returns: void
# setBakedShadow
▸ setBakedShadow(hex: string, url: string): void
Inherited from SceneManager.setBakedShadow
Defined in packages/common-core/src/webgl/scene-manager.ts:673
Parameters:
| Name | Type |
|---|---|
hex | string |
url | string |
Returns: void
# setCameraOffset
▸ setCameraOffset(offset: CanvasOffset): void
Overrides SceneManager.setCameraOffset
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:699
Parameters:
| Name | Type |
|---|---|
offset | CanvasOffset |
Returns: void
# setSelectionMode
▸ setSelectionMode(mode: SELECTION_MODE): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:800
Parameters:
| Name | Type |
|---|---|
mode | SELECTION_MODE |
Returns: void
# showDimensions
▸ showDimensions(): Promise‹void›
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:860
Returns: Promise‹void›
# showGUI
▸ showGUI(): Promise‹void›
Inherited from SceneManager.showGUI
Defined in packages/common-core/src/webgl/scene-manager.ts:505
Returns: Promise‹void›
# showStats
▸ showStats(): void
Inherited from SceneManager.showStats
Defined in packages/common-core/src/webgl/scene-manager.ts:563
Returns: void
# updateCamera
▸ updateCamera(changeCamera: boolean): void
Overrides SceneManager.updateCamera
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:694
Parameters:
| Name | Type | Default |
|---|---|---|
changeCamera | boolean | true |
Returns: void
# updateScene
▸ updateScene(): void
Inherited from SceneManager.updateScene
Defined in packages/common-core/src/webgl/scene-manager.ts:723
Returns: void
# zoomIn
▸ zoomIn(value?: number): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:850
Parameters:
| Name | Type |
|---|---|
value? | number |
Returns: void
# zoomOut
▸ zoomOut(value?: number): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:855
Parameters:
| Name | Type |
|---|---|
value? | number |
Returns: void
# zoomToComponent
▸ zoomToComponent(component: RoomleComponent): void
Defined in packages/configurator-core/src/webgl/configurator-scene-manager.ts:639
Parameters:
| Name | Type |
|---|---|
component | RoomleComponent |
Returns: void