RoomleConfigurator.Internal.GlobalAPI

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

Implemented by

• default
• default
• default

Table of contents

Accessors

• globalCallbacks

Methods

• getCameraOffset
• getMain
• getScene
• getStorage
• getUnitFormatter
• setCameraOffset
• setEnvironmentMap
• updateScene
• updateSize

Accessors

globalCallbacks

• get globalCallbacks(): GlobalCallback

Returns

GlobalCallback

Methods

getCameraOffset

▸ getCameraOffset(): CanvasOffset

Gets the available screen space for our item default: 'left: 0, top: 1, right: 1, bottom: 0'

Returns

CanvasOffset

---

getMain

▸ getMain(): default

Returns

default

---

getScene

▸ getScene(): Scene

Returns the three.js scene (https://threejs.org/docs/#api/en/scenes/Scene) WARNING: This is the actual scene (reference) and not a copy!

Returns

Scene

---

getStorage

▸ getStorage(): default

Returns

default

---

getUnitFormatter

▸ getUnitFormatter(): default

Returns

default

---

setCameraOffset

▸ setCameraOffset(offset): void

Sets the available screen space for our item Example 1: right 0.9 means 10% padding on the right side Example 2: bottom 0.2 means 20% padding on the bottom side default: 'left: 0, top: 1, right: 1, bottom: 0'

Parameters

Name	Type
offset	CanvasOffset

Returns

void

---

setEnvironmentMap

▸ setEnvironmentMap(params): void

Parameters

Name	Type
params	EnvMapParams

Returns

void

---

updateScene

▸ updateScene(): void

Updates the scene (recalculating bounds) and restart rendering

Returns

void

---

updateSize

▸ updateSize(): void

Returns

void