# RoomleGlbViewer.default [glb-viewer-core/src/roomle-glb-viewer](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/glb_viewer_core_src_roomle_glb_viewer).default ## Implements * [`GlobalAPI`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi) * [`Context`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.context) * [`ExternalEmbeddable`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.externalembeddable)<[`GlbViewerUiCallbacks`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/glb_viewer_core_src_roomle_glb_viewer.glbvieweruicallbacks)> ## Table of contents ### Constructors * [constructor](#constructor) ### Properties * [\_creator\_](#_creator_) ### Accessors * [callbacks](#callbacks) ### Methods * [clearScene](#clearscene) * [exportCanvasScreenshot](#exportcanvasscreenshot) * [getCameraOffset](#getcameraoffset) * [getCurrentId](#getcurrentid) * [getScene](#getscene) * [getStorage](#getstorage) * [getUnitFormatter](#getunitformatter) * [init](#init) * [loadGLB](#loadglb) * [loadSceneSetting](#loadscenesetting) * [loadStaticItem](#loadstaticitem) * [moveCamera](#movecamera) * [pauseTest](#pausetest) * [preparePerspectiveImage](#prepareperspectiveimage) * [processRenderList](#processrenderlist) * [resumeTest](#resumetest) * [setCameraOffset](#setcameraoffset) * [setEnvironmentMap](#setenvironmentmap) * [setOverrides](#setoverrides) * [showGUI](#showgui) * [updateScene](#updatescene) * [updateSize](#updatesize) ## Constructors ### constructor • **new default**(`creator`) #### Parameters | Name | Type | | --------- | -------- | | `creator` | `string` | ## Properties ### \_creator\_ • **\_creator\_**: `string` #### Implementation of [Context](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.context).[*creator*](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_configurator._internal_.context#_creator_) ## Accessors ### callbacks • `get` **callbacks**(): `Object` #### Returns `Object` #### Implementation of [ExternalEmbeddable](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.externalembeddable).[callbacks](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_configurator._internal_.externalembeddable#callbacks) ## Methods ### clearScene ▸ **clearScene**(): `void` Remove the current glb from the scene if it exists #### Returns `void` *** ### exportCanvasScreenshot ▸ **exportCanvasScreenshot**(`quality?`): `Promise`<`string`> #### Parameters | Name | Type | | ---------- | -------- | | `quality?` | `number` | #### Returns `Promise`<`string`> *** ### getCameraOffset ▸ **getCameraOffset**(): [`CanvasOffset`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset) Gets the available screen space for our item\ default: 'left: 0, top: 1, right: 1, bottom: 0' #### Returns [`CanvasOffset`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset) #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[getCameraOffset](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#getcameraoffset) *** ### getCurrentId ▸ **getCurrentId**(): `string` Returns the current item id or url of the loaded object #### Returns `string` *** ### getScene ▸ **getScene**(): `Scene` Returns the three.js scene ( WARNING: This is the actual scene (reference) and not a copy! #### Returns `Scene` #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[getScene](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#getscene) *** ### getStorage ▸ **getStorage**(): [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-1) returns manager class to interface with indexedDB storage #### Returns [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-1) #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[getStorage](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#getstorage) *** ### getUnitFormatter ▸ **getUnitFormatter**(): [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default) returns unit formatter for formatting input und output values in scene #### Returns [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default) #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[getUnitFormatter](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#getunitformatter) *** ### init ▸ **init**(`element`, `initData?`): `Promise`<`void`> #### Parameters | Name | Type | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `element` | `HTMLElement` | | `initData?` | [`InitDataDefinition`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.initdatadefinition) | #### Returns `Promise`<`void`> *** ### 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`> *** ### 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](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/glb_viewer_core_src_roomle_glb_viewer)) and an environment definition (see [@roomle/web-sdk/configurator-core/src/environment/dynamic-environment-setting-loaderEnvironmentSetting](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/glb_viewer_core_src_roomle_glb_viewer)). #### Parameters | Name | Type | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `sceneSettings` | [`SceneSettings`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_scene_settings_loader.scenesettings) | #### Returns `Promise`<`void`> *** ### 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`> *** ### moveCamera ▸ **moveCamera**(`cameraParameter`): `Promise`<`void`> #### Parameters | Name | Type | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cameraParameter` | [`CameraParameter`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.cameraparameter) | #### Returns `Promise`<`void`> *** ### pauseTest ▸ **pauseTest**(): `void` #### Returns `void` *** ### preparePerspectiveImage ▸ **preparePerspectiveImage**(): `Promise`<[`Base64Image`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image)> #### Returns `Promise`<[`Base64Image`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image)> *** ### processRenderList ▸ **processRenderList**(`jsonString`, `width?`, `height?`): `void` #### Parameters | Name | Type | Default value | | ------------ | -------- | ------------- | | `jsonString` | `string` | `undefined` | | `width` | `number` | `320` | | `height` | `number` | `320` | #### Returns `void` *** ### resumeTest ▸ **resumeTest**(`element`): `void` #### Parameters | Name | Type | | --------- | ------------- | | `element` | `HTMLElement` | #### Returns `void` *** ### 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`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset) | #### Returns `void` #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[setCameraOffset](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#setcameraoffset) *** ### 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 [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[setEnvironmentMap](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#setenvironmentmap) *** ### setOverrides ▸ **setOverrides**(`initData`): `void` #### Parameters | Name | Type | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `initData` | [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_configurator._internal_.default-9) \| `Partial`<[`InitDataDefinition`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.initdatadefinition) & [`GlobalInitDataDefinition`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.globalinitdatadefinition)> | #### Returns `void` *** ### showGUI ▸ **showGUI**(): `void` #### Returns `void` *** ### updateScene ▸ **updateScene**(): `void` Updates the scene (recalculating bounds) and restart rendering #### Returns `void` #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[updateScene](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#updatescene) *** ### updateSize ▸ **updateSize**(): `void` #### Returns `void` #### Implementation of [GlobalAPI](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi).[updateSize](https://docs.roomle.com/rubens/rubens-sdk/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi#updatesize)