# Class: default
glb-viewer-core/src/roomle-glb-viewer.default
# Implements
# Table of contents
# Constructors
# Properties
# Accessors
# Methods
- clearScene
- getCameraOffset
- getCurrentId
- getScene
- getStorage
- getUnitFormatter
- init
- loadGLB
- loadSceneSetting
- loadStaticItem
- pauseTest
- preparePerspectiveImage
- processRenderList
- resumeTest
- setCameraOffset
- setEnvironmentMap
- setOverrides
- showGUI
- updateScene
- updateSize
# Constructors
# constructor
• new default(creator)
# Parameters
| Name | Type |
|---|---|
creator | string |
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:79 (opens new window)
# Properties
# _creator_
• _creator_: string
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:49 (opens new window)
# Accessors
# callbacks
• get callbacks(): Object
# Returns
Object
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:240 (opens new window)
# Methods
# clearScene
▸ clearScene(): void
Remove the current glb from the scene if it exists
# Returns
void
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:126 (opens new window)
# getCameraOffset
▸ getCameraOffset(): CanvasOffset
Gets the available screen space for our item default: 'left: 0, top: 1, right: 1, bottom: 0'
# Returns
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:87 (opens new window)
# getCurrentId
▸ getCurrentId(): string
Returns the current item id or url of the loaded object
# Returns
string
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:168 (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
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:244 (opens new window)
# getStorage
▸ getStorage(): default
returns manager class to interface with indexedDB storage
# Returns
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:262 (opens new window)
# getUnitFormatter
▸ getUnitFormatter(): default
returns unit formatter for formatting input und output values in scene
# Returns
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:255 (opens new window)
# init
▸ init(element, initData?): Promise<void>
# Parameters
| Name | Type |
|---|---|
element | HTMLElement |
initData? | InitDataDefinition |
# Returns
Promise<void>
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:91 (opens new window)
# loadGLB
▸ loadGLB(url, scaling?, callback?): Promise<void>
Loads the GLB from the given URL Param
# Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
url | string | undefined | |
scaling | number | 1 | defaults to 1 |
callback? | (percent: number) => void | undefined | loading percent between 0 and 1 |
# Returns
Promise<void>
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:136 (opens new window)
# loadSceneSetting
▸ loadSceneSetting(sceneSettings): Promise<void>
Loads a SceneSettings object, currently it can can contain a light setting definition (see @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.loadDynamicLightSetting) and an environment definition (see @roomle/web-sdk/common-core/src/environment/dynamic-environment-setting-loader#EnvironmentSetting).
# Parameters
| Name | Type |
|---|---|
sceneSettings | SceneSettings |
# Returns
Promise<void>
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:177 (opens new window)
# loadStaticItem
▸ loadStaticItem(staticItemId, callback?): Promise<void>
Loads the glb asset from the static item
# Parameters
| Name | Type | Description |
|---|---|---|
staticItemId | string | |
callback? | (percent: number) => void | loading percent between 0 and 1 |
# Returns
Promise<void>
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:156 (opens new window)
# pauseTest
▸ pauseTest(): void
# Returns
void
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:232 (opens new window)
# preparePerspectiveImage
▸ preparePerspectiveImage(): Promise<Base64Image>
# Returns
Promise<Base64Image>
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:181 (opens new window)
# processRenderList
▸ processRenderList(jsonString, width?, height?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
jsonString | string | undefined |
width | number | 320 |
height | number | 320 |
# Returns
void
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:185 (opens new window)
# resumeTest
▸ resumeTest(element): void
# Parameters
| Name | Type |
|---|---|
element | HTMLElement |
# Returns
void
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:227 (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
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:83 (opens new window)
# setEnvironmentMap
▸ setEnvironmentMap(params): void
# Parameters
| Name | Type |
|---|---|
params | Object |
params.intensity? | number |
params.maxLightSources? | number |
params.rotation? | number |
params.url? | string |
# Returns
void
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:266 (opens new window)
# setOverrides
▸ setOverrides(initData): void
# Parameters
| Name | Type |
|---|---|
initData | default | Partial<InitDataDefinition & GlobalInitDataDefinition> |
# Returns
void
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:203 (opens new window)
# showGUI
▸ showGUI(): void
# Returns
void
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:236 (opens new window)
# updateScene
▸ updateScene(): void
Updates the scene (recalculating bounds) and restart rendering
# Returns
void
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:248 (opens new window)
# updateSize
▸ updateSize(): void
# Returns
void
# Implementation of
# Defined in
packages/glb-viewer-core/src/roomle-glb-viewer.ts:213 (opens new window)