> For the complete documentation index, see [llms.txt](https://docs.roomle.com/rubens/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/glb_viewer_core_src_roomle_glb_viewer.default.md).

# RoomleGlbViewer.default

[glb-viewer-core/src/roomle-glb-viewer](/rubens/rubens-sdk/rubens-sdk-reference/modules/glb_viewer_core_src_roomle_glb_viewer.md).default

## Implements

* [`GlobalAPI`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md)
* [`Context`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.context.md)
* [`ExternalEmbeddable`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.externalembeddable.md)<[`GlbViewerUiCallbacks`](/rubens/rubens-sdk/rubens-sdk-reference/classes/glb_viewer_core_src_roomle_glb_viewer.glbvieweruicallbacks.md)>

## 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](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.context.md).[*creator*](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.context.md#_creator_)

## Accessors

### callbacks

• `get` **callbacks**(): `Object`

#### Returns

`Object`

#### Implementation of

[ExternalEmbeddable](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.externalembeddable.md).[callbacks](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.externalembeddable.md#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`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset.md)

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

#### Returns

[`CanvasOffset`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset.md)

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[getCameraOffset](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#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 (<https://threejs.org/docs/#api/en/scenes/Scene)\\>
WARNING: This is the actual scene (reference) and not a copy!

#### Returns

`Scene`

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[getScene](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#getscene)

***

### getStorage

▸ **getStorage**(): [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-1.md)

returns manager class to interface with indexedDB storage

#### Returns

[`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-1.md)

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[getStorage](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#getstorage)

***

### getUnitFormatter

▸ **getUnitFormatter**(): [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default.md)

returns unit formatter for formatting input und output values in scene

#### Returns

[`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default.md)

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[getUnitFormatter](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#getunitformatter)

***

### init

▸ **init**(`element`, `initData?`): `Promise`<`void`>

#### Parameters

| Name        | Type                                                                                                                         |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `element`   | `HTMLElement`                                                                                                                |
| `initData?` | [`InitDataDefinition`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.initdatadefinition.md) |

#### 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](/rubens/rubens-sdk/rubens-sdk-reference/modules/glb_viewer_core_src_roomle_glb_viewer.md)) and an environment definition (see [@roomle/web-sdk/configurator-core/src/environment/dynamic-environment-setting-loaderEnvironmentSetting](/rubens/rubens-sdk/rubens-sdk-reference/modules/glb_viewer_core_src_roomle_glb_viewer.md)).

#### Parameters

| Name            | Type                                                                                                                         |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `sceneSettings` | [`SceneSettings`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_scene_settings_loader.scenesettings.md) |

#### 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`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.cameraparameter.md) |

#### Returns

`Promise`<`void`>

***

### pauseTest

▸ **pauseTest**(): `void`

#### Returns

`void`

***

### preparePerspectiveImage

▸ **preparePerspectiveImage**(): `Promise`<[`Base64Image`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image.md)>

#### Returns

`Promise`<[`Base64Image`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image.md)>

***

### 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`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset.md) |

#### Returns

`void`

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[setCameraOffset](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#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](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[setEnvironmentMap](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#setenvironmentmap)

***

### setOverrides

▸ **setOverrides**(`initData`): `void`

#### Parameters

| Name       | Type                                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `initData` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_configurator._internal_.default-9.md) \| `Partial`<[`InitDataDefinition`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.initdatadefinition.md) & [`GlobalInitDataDefinition`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_utils_shims.globalinitdatadefinition.md)> |

#### Returns

`void`

***

### showGUI

▸ **showGUI**(): `void`

#### Returns

`void`

***

### updateScene

▸ **updateScene**(): `void`

Updates the scene (recalculating bounds) and restart rendering

#### Returns

`void`

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[updateScene](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#updatescene)

***

### updateSize

▸ **updateSize**(): `void`

#### Returns

`void`

#### Implementation of

[GlobalAPI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md).[updateSize](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.globalapi.md#updatesize)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/glb_viewer_core_src_roomle_glb_viewer.default.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.