API ReferenceGlobalsSceneHelper

# Class: SceneHelper

# Hierarchy

  • SceneHelper

# Implements

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new SceneHelper(creator: string, offset: CanvasOffset): SceneHelper

Defined in packages/configurator-core/src/webgl/scene-helper.ts:161

Parameters:

Name Type
creator string
offset CanvasOffset

Returns: SceneHelper

# Properties

# creator

creator: string

Implementation of Context.creator

Defined in packages/configurator-core/src/webgl/scene-helper.ts:79

# Methods

# addComponentHandlers

addComponentHandlers(component: RoomleComponent): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1659

Parameters:

Name Type
component RoomleComponent

Returns: void


# addPreviewHandlers

addPreviewHandlers(previewComponent: PreviewComponent): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1663

Parameters:

Name Type
previewComponent PreviewComponent

Returns: void


# addPreviewLineHandlers

addPreviewLineHandlers(previewLineComponent: PreviewLineComponent): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1667

Parameters:

Name Type
previewLineComponent PreviewLineComponent

Returns: void


# cancelDockings

cancelDockings(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:336

Returns: void


# cancelPreviousDockings

cancelPreviousDockings(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1076

Returns: void


# cancelSelection

cancelSelection(resetCamera?: boolean): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1080

Parameters:

Name Type
resetCamera? boolean

Returns: void


# changeFloorMaterial

changeFloorMaterial(material: RapiMaterial): Promise‹void›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1147

Parameters:

Name Type
material RapiMaterial

Returns: Promise‹void›


# changeOffset

changeOffset(offset: CanvasOffset): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1004

Parameters:

Name Type
offset CanvasOffset

Returns: void


# cleanUp

cleanUp(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1139

Returns: void


# clearScene

clearScene(): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:767

Returns: void


# componentDeleted

componentDeleted(component: RoomleComponent): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1601

Parameters:

Name Type
component RoomleComponent

Returns: void


# componentUpdated

componentUpdated(component: RoomleComponent, kernelComponent: KernelComponent): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1572

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/scene-helper.ts:1638

Parameters:

Name Type
component RoomleComponent
isFreeFlying boolean

Returns: void


# debugScene

debugScene(): Scene‹›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:752

Returns: Scene‹›


# debugSceneGraph

debugSceneGraph(id?: number): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:747

Parameters:

Name Type
id? number

Returns: void


# destroy

destroy(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:634

Returns: void


# display

display(component: RoomleComponent): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:741

Parameters:

Name Type
component RoomleComponent

Returns: void


# enableDragIn

enableDragIn(dragEvent: DragEvent): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:927

Parameters:

Name Type
dragEvent DragEvent

Returns: void


# enableHD

enableHD(source?: DynamicLightSettingSource): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1163

Parameters:

Name Type
source? DynamicLightSettingSource

Returns: void


# exportGLB

exportGLB(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1304

Returns: void


# getCameraOffset

getCameraOffset(): CanvasOffset

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1047

Returns: CanvasOffset


# getScene

getScene(): Scene

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1706

Returns: Scene


# getScreenXY

getScreenXY(position: Vector3): Vector3‹›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1135

Parameters:

Name Type
position Vector3

Returns: Vector3‹›


# handleEvent

handleEvent(evt: Event): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1461

Parameters:

Name Type
evt Event

Returns: void


# hideDimensions

hideDimensions(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1406

Returns: void


# highlightParts

highlightParts(ids: number[]): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1762

Parameters:

Name Type
ids number[]

Returns: void


# loadDynamicLightSetting

loadDynamicLightSetting(source: DynamicLightSettingSource): Promise‹void›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1279

Parameters:

Name Type
source DynamicLightSettingSource

Returns: Promise‹void›


# loadSceneSettings

loadSceneSettings(sceneSetting: SceneSettings): Promise‹void›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1416

Parameters:

Name Type
sceneSetting SceneSettings

Returns: Promise‹void›


# moveCamera

moveCamera(cameraParameter: CameraParameter): Promise‹void›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1745

Parameters:

Name Type
cameraParameter CameraParameter

Returns: Promise‹void›


# pause

pause(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:622

Returns: void


# planObjectConstructionDone

planObjectConstructionDone(_planObject: PlanObject): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:777

Parameters:

Name Type
_planObject PlanObject

Returns: void


# planObjectUpdated

planObjectUpdated(planObject: PlanObject, geometryChanged: boolean): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1588

Parameters:

Name Type
planObject PlanObject
geometryChanged boolean

Returns: void


# preparePartImage

preparePartImage(partId: number, options: PrepareImageOptions): Promise‹any›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:863

Parameters:

Name Type
partId number
options PrepareImageOptions

Returns: Promise‹any›


# preparePerspectiveImage

preparePerspectiveImage(options: PrepareImageOptions): Promise‹Base64Image

Defined in packages/configurator-core/src/webgl/scene-helper.ts:804

Parameters:

Name Type Default
options PrepareImageOptions {}

Returns: Promise‹Base64Image


# prepareTopImage

prepareTopImage(options: PrepareTopImageOptions): Promise‹Base64Image

Defined in packages/configurator-core/src/webgl/scene-helper.ts:899

Parameters:

Name Type Default
options PrepareTopImageOptions {}

Returns: Promise‹Base64Image


# previewConstructionDone

previewConstructionDone(component: RoomleComponent, hasPreviews: boolean): void

Implementation of ConfiguratorViewModelCallbackI

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1611

Parameters:

Name Type
component RoomleComponent
hasPreviews boolean

Returns: void


# renderImage

renderImage(renderOptions: RenderOptions): Promise‹Base64Image

Defined in packages/configurator-core/src/webgl/scene-helper.ts:831

Parameters:

Name Type
renderOptions RenderOptions

Returns: Promise‹Base64Image


# requestDeleteSelectedComponent

requestDeleteSelectedComponent(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1552

Returns: void


# requestDockingsPreview

requestDockingsPreview(userInitiated: boolean, possibleChild?: UiPossibleChild, dragEvent?: DragEvent, dragIn?: boolean): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1498

Parameters:

Name Type
userInitiated boolean
possibleChild? UiPossibleChild
dragEvent? DragEvent
dragIn? boolean

Returns: void


# resetCamera

resetCamera(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:965

Returns: void


# resetCameraPositionToStart

resetCameraPositionToStart(animate: boolean): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:979

Parameters:

Name Type Default
animate boolean true

Returns: void


# resetCameraToState

resetCameraToState(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:973

Returns: void


# resetPreviews

resetPreviews(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:995

Returns: void


# resume

resume(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:572

Returns: void


# sceneCleared

sceneCleared(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:737

Returns: void


# selectComponent

selectComponent(runtimeId: number): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1749

Parameters:

Name Type
runtimeId number

Returns: void


# setBackgroundColor

setBackgroundColor(hex: string): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1438

Parameters:

Name Type
hex string

Returns: void


# setBackgroundImage

setBackgroundImage(url: string): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1442

Parameters:

Name Type
url string

Returns: void


# setBakedShadow

setBakedShadow(hex: string, url: string): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1446

Parameters:

Name Type
hex string
url string

Returns: void


# setCameraOffset

setCameraOffset(offset: CanvasOffset): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1040

Parameters:

Name Type
offset CanvasOffset

Returns: void


# setSelectionMode

setSelectionMode(mode: SELECTION_MODE): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1143

Parameters:

Name Type
mode SELECTION_MODE

Returns: void


# showDimensions

showDimensions(): Promise‹void›

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1385

Returns: Promise‹void›


# showGUI

showGUI(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1333

Returns: void


# showStats

showStats(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1380

Returns: void


# stopRenderLoop

stopRenderLoop(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:364

Returns: void


# updateScene

updateScene(): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1739

Returns: void


# updateSize

updateSize(changeCamera: boolean): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1018

Parameters:

Name Type Default
changeCamera boolean true

Returns: void


# zoomIn

zoomIn(value?: number): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1370

Parameters:

Name Type
value? number

Returns: void


# zoomOut

zoomOut(value?: number): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:1375

Parameters:

Name Type
value? number

Returns: void


# zoomToComponent

zoomToComponent(component: RoomleComponent): void

Defined in packages/configurator-core/src/webgl/scene-helper.ts:952

Parameters:

Name Type
component RoomleComponent

Returns: void