API Reference / Modules / configurator-core/src/roomle-configurator / <internal> / GlobalAPI
# Interface: GlobalAPI
configurator-core/src/roomle-configurator.
# Implemented by
# Table of contents
# Methods
- getCameraOffset
- getMain
- getScene
- getStorage
- getUnitFormatter
- setCameraOffset
- setEnvironmentMap
- updateScene
- updateSize
# Methods
# getCameraOffset
▸ getCameraOffset(): CanvasOffset
Gets the available screen space for our item default: 'left: 0, top: 1, right: 1, bottom: 0'
# Returns
# Defined in
packages/common-core/src/main.ts:64 (opens new window)
# getMain
▸ getMain(): default
# Returns
# Defined in
packages/common-core/src/main.ts:38 (opens new window)
# 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
# Defined in
packages/common-core/src/main.ts:44 (opens new window)
# getStorage
▸ getStorage(): default
# Returns
# Defined in
packages/common-core/src/main.ts:68 (opens new window)
# getUnitFormatter
▸ getUnitFormatter(): default
# Returns
# Defined in
packages/common-core/src/main.ts:66 (opens new window)
# 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
# Defined in
packages/common-core/src/main.ts:58 (opens new window)
# setEnvironmentMap
▸ setEnvironmentMap(params): void
# Parameters
| Name | Type |
|---|---|
params | EnvMapParams |
# Returns
void
# Defined in
packages/common-core/src/main.ts:70 (opens new window)
# updateScene
▸ updateScene(): void
Updates the scene (recalculating bounds) and restart rendering
# Returns
void
# Defined in
packages/common-core/src/main.ts:49 (opens new window)
# updateSize
▸ updateSize(): void
# Returns
void