RoomleConfigurator.Internal.default-14

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

Hierarchy

• default

  ↳ default

  ↳ default

Implements

• Context

• LifeCycleCallbacks

• EventListenerObject

Table of contents

Properties

• _creator_

Methods

• addEventListener

• cameraBehaviourChanged

• changeEnvironmentMapIntensity

• cleanUp

• clearScene

• destroy

• enableHD

• exportCanvasScreenshot

• exportImageFromCamera

• getBounds

• getCameraOffset

• getGeometryBounds

• getOrthographicOffsetCamera

• getScene

• handleEvent

• loadDynamicLightSetting

• loadEnvMap

• loadSceneSettings

• lockCamera

• pause

• removeEventListener

• resume

• sceneChanged

• setBackgroundColor

• setBackgroundImage

• setCameraOffset

• setEnvironmentMap

• showGUI

• showStats

• unlockCamera

• updateCamera

• updateScene

Properties

_creator_

• _creator_: string

Implementation of

Context.creator

Methods

addEventListener

▸ addEventListener(_listener): void

Parameters

Name	Type
_listener	LifeCycleCallbacks

Returns

void

---

cameraBehaviourChanged

▸ cameraBehaviourChanged(): void

Returns

void

---

changeEnvironmentMapIntensity

▸ changeEnvironmentMapIntensity(intensity): void

Parameters

Name	Type
intensity	number

Returns

void

---

cleanUp

▸ cleanUp(): void

Returns

void

---

clearScene

▸ clearScene(): void

Returns

void

---

destroy

▸ destroy(): void

Returns

void

Implementation of

LifeCycleCallbacks.destroy

---

enableHD

▸ enableHD(source?): void

Parameters

Name	Type
source?	DynamicLightSettingSource

Returns

void

---

exportCanvasScreenshot

▸ exportCanvasScreenshot(quality?): Promise<string>

Parameters

Name	Type	Default value
quality	number	1

Returns

Promise<string>

---

exportImageFromCamera

▸ exportImageFromCamera(filename, shouldWaitForAssets?): Promise<void>

Parameters

Name	Type	Default value
filename	string	undefined
shouldWaitForAssets	boolean	false

Returns

Promise<void>

---

getBounds

▸ Abstract getBounds(): Box3

Returns

Box3

---

getCameraOffset

▸ getCameraOffset(): CanvasOffset

Returns

CanvasOffset

---

getGeometryBounds

▸ Abstract getGeometryBounds(): Box3

Returns

Box3

---

getOrthographicOffsetCamera

▸ getOrthographicOffsetCamera(): OrthographicOffsetCamera

Returns

OrthographicOffsetCamera

---

getScene

▸ getScene(): Scene

Returns

Scene

---

handleEvent

▸ handleEvent(evt): void

Parameters

Name	Type
evt	Event

Returns

void

Implementation of

EventListenerObject.handleEvent

---

loadDynamicLightSetting

▸ loadDynamicLightSetting(source): Promise<void>

Parameters

Name	Type
source	DynamicLightSettingSource

Returns

Promise<void>

---

loadEnvMap

▸ loadEnvMap(url): Promise<void>

Parameters

Name	Type
url	string

Returns

Promise<void>

---

loadSceneSettings

▸ loadSceneSettings(sceneSetting): Promise<void>

Parameters

Name	Type
sceneSetting	SceneSettings

Returns

Promise<void>

---

lockCamera

▸ lockCamera(): void

Returns

void

---

pause

▸ pause(): void

Returns

void

Implementation of

LifeCycleCallbacks.pause

---

removeEventListener

▸ removeEventListener(_listener): void

Parameters

Name	Type
_listener	LifeCycleCallbacks

Returns

void

---

resume

▸ resume(): void

Returns

void

Implementation of

LifeCycleCallbacks.resume

---

sceneChanged

▸ Abstract sceneChanged(): void

Returns

void

---

setBackgroundColor

▸ setBackgroundColor(hex): void

Parameters

Name	Type
hex	string

Returns

void

---

setBackgroundImage

▸ setBackgroundImage(url): void

Parameters

Name	Type
url	string

Returns

void

---

setCameraOffset

▸ setCameraOffset(offset): void

Parameters

Name	Type
offset	CanvasOffset

Returns

void

---

setEnvironmentMap

▸ setEnvironmentMap(url?, intensity?, rotation?, maxLightSources?): void

Parameters

Name	Type
url?	string
intensity?	number
rotation?	number
maxLightSources?	number

Returns

void

---

showGUI

▸ showGUI(): void

Returns

void

---

showStats

▸ showStats(): void

Returns

void

---

unlockCamera

▸ unlockCamera(): void

Returns

void

---

updateCamera

▸ updateCamera(_changeCamera?): void

Parameters

Name	Type	Default value
_changeCamera	boolean	true

Returns

void

---

updateScene

▸ updateScene(): void

Returns

void