# RoomlePlanner.Internal.default

[planner-core/src/roomle-planner](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner.md).[internal](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md).default

## Hierarchy

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

  ↳ **`default`**

## Implements

* [`PlannerKernelCallbackI`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md)

## Table of contents

### Constructors

* [constructor](#constructor)

### Properties

* [\_creator\_](#_creator_)
* [currentSelection](#currentselection)

### Accessors

* [configuratorContext](#configuratorcontext)
* [hasSingleRoom](#hassingleroom)

### Methods

* [\_preparePerspectiveImage](#_prepareperspectiveimage)
* [addComponentHandlers](#addcomponenthandlers)
* [addEventListener](#addeventlistener)
* [addMesh](#addmesh)
* [addPlanMesh](#addplanmesh)
* [addPlanObjectToScene](#addplanobjecttoscene)
* [addPreviewHandlers](#addpreviewhandlers)
* [addPreviewLineHandlers](#addpreviewlinehandlers)
* [animateElement](#animateelement)
* [backToPlanner](#backtoplanner)
* [beginPlanConstruction](#beginplanconstruction)
* [cameraBehaviourChanged](#camerabehaviourchanged)
* [cancelComponentSelection](#cancelcomponentselection)
* [cancelDockings](#canceldockings)
* [cancelPlanElementSelection](#cancelplanelementselection)
* [cancelPreviousDockings](#cancelpreviousdockings)
* [changeEnvironmentMapIntensity](#changeenvironmentmapintensity)
* [changeExteriorWallsMaterial](#changeexteriorwallsmaterial)
* [changeFloorMaterial](#changefloormaterial)
* [changeFloorsMaterial](#changefloorsmaterial)
* [changeInteriorWallsMaterial](#changeinteriorwallsmaterial)
* [changeOffset](#changeoffset)
* [cleanUp](#cleanup)
* [clearScene](#clearscene)
* [componentDeleted](#componentdeleted)
* [componentUpdated](#componentupdated)
* [configurationLoaded](#configurationloaded)
* [debugScene](#debugscene)
* [debugSceneGraph](#debugscenegraph)
* [deletePlanElementByIds](#deleteplanelementbyids)
* [deletePlanElementSelection](#deleteplanelementselection)
* [destroy](#destroy)
* [disableAdvancedDocking](#disableadvanceddocking)
* [disableConfiguratorEvents](#disableconfiguratorevents)
* [disableEvents](#disableevents)
* [disableMeasurementLineDrawing](#disablemeasurementlinedrawing)
* [disablePlannerEvents](#disableplannerevents)
* [disableRotation](#disablerotation)
* [disableShowChildrenOfPlanObject](#disableshowchildrenofplanobject)
* [disableSnapping](#disablesnapping)
* [disableWallDrawing](#disablewalldrawing)
* [display](#display)
* [dragIn](#dragin)
* [enableAdvancedDocking](#enableadvanceddocking)
* [enableConfiguratorEvents](#enableconfiguratorevents)
* [enableDragIn](#enabledragin)
* [enableEvents](#enableevents)
* [enableHD](#enablehd)
* [enableMeasurementLineDrawing](#enablemeasurementlinedrawing)
* [enablePlannerEvents](#enableplannerevents)
* [enableRotation](#enablerotation)
* [enableShowChildrenOfPlanObject](#enableshowchildrenofplanobject)
* [enableSnapping](#enablesnapping)
* [enableWallDrawing](#enablewalldrawing)
* [endPlanConstruction](#endplanconstruction)
* [escapeDrawing](#escapedrawing)
* [exportCanvasScreenshot](#exportcanvasscreenshot)
* [exportGLB](#exportglb)
* [exportImageFromCamera](#exportimagefromcamera)
* [getBounds](#getbounds)
* [getCameraOffset](#getcameraoffset)
* [getCameraParameters3d](#getcameraparameters3d)
* [getComponent](#getcomponent)
* [getGeometryBounds](#getgeometrybounds)
* [getObjectComponent](#getobjectcomponent)
* [getOrthographicOffsetCamera](#getorthographicoffsetcamera)
* [getPlanObject](#getplanobject)
* [getPlannerSceneEventHandler](#getplannersceneeventhandler)
* [getRootPlanObjectId](#getrootplanobjectid)
* [getScene](#getscene)
* [getScreenXY](#getscreenxy)
* [getSelectedRuntimeComponentIds](#getselectedruntimecomponentids)
* [getWallAngleDegrees](#getwallangledegrees)
* [handleEvent](#handleevent)
* [handlerSwitchedPlans](#handlerswitchedplans)
* [hideDimensions](#hidedimensions)
* [highlightExternalObject](#highlightexternalobject)
* [highlightParts](#highlightparts)
* [highlightPlanElementById](#highlightplanelementbyid)
* [highlightPlanElementsById](#highlightplanelementsbyid)
* [importGLB](#importglb)
* [loadDynamicLightSetting](#loaddynamiclightsetting)
* [loadEnvMap](#loadenvmap)
* [loadSceneSettings](#loadscenesettings)
* [loadStaticPlanObjects](#loadstaticplanobjects)
* [lockCamera](#lockcamera)
* [moveCamera](#movecamera)
* [moveElementPosition](#moveelementposition)
* [moveElementsPosition](#moveelementsposition)
* [pause](#pause)
* [planBoundsChanged](#planboundschanged)
* [planCleared](#plancleared)
* [planCompletelyLoaded](#plancompletelyloaded)
* [planElementChanged](#planelementchanged)
* [planElementRemoved](#planelementremoved)
* [planHistoryStateChanged](#planhistorystatechanged)
* [planObjectConfigurationChanged](#planobjectconfigurationchanged)
* [planObjectConfigurationLoaded](#planobjectconfigurationloaded)
* [planObjectConstructionDone](#planobjectconstructiondone)
* [planObjectUpdated](#planobjectupdated)
* [planXMLLoaded](#planxmlloaded)
* [preload](#preload)
* [preparePartImage](#preparepartimage)
* [preparePerspectiveImage](#prepareperspectiveimage)
* [preparePerspectiveImageOf](#prepareperspectiveimageof)
* [prepareTopImage](#preparetopimage)
* [previewConstructionDone](#previewconstructiondone)
* [removeEventListener](#removeeventlistener)
* [removePlanObjectFromScene](#removeplanobjectfromscene)
* [renderImage](#renderimage)
* [requestCatalogItem](#requestcatalogitem)
* [requestDeleteSelectedComponent](#requestdeleteselectedcomponent)
* [requestDockingsPreview](#requestdockingspreview)
* [resetCameraPositionToStart](#resetcamerapositiontostart)
* [resetConfiguratorContext](#resetconfiguratorcontext)
* [resetPreviews](#resetpreviews)
* [resume](#resume)
* [rotatePlanElementSelection](#rotateplanelementselection)
* [saveConfigToIdb](#saveconfigtoidb)
* [sceneChanged](#scenechanged)
* [sceneCleared](#scenecleared)
* [selectComponent](#selectcomponent)
* [selectPlanObject](#selectplanobject)
* [setBackgroundColor](#setbackgroundcolor)
* [setBackgroundImage](#setbackgroundimage)
* [setCameraOffset](#setcameraoffset)
* [setCompletelyLoaded](#setcompletelyloaded)
* [setEnvironmentMap](#setenvironmentmap)
* [setMeasurementLineLength](#setmeasurementlinelength)
* [setMode](#setmode)
* [setObjectToWallMeasurementLength](#setobjecttowallmeasurementlength)
* [setSceneEvents](#setsceneevents)
* [setSelectionMode](#setselectionmode)
* [setWallMeasurementLength](#setwallmeasurementlength)
* [showDimensions](#showdimensions)
* [showGUI](#showgui)
* [showStats](#showstats)
* [showsChildrenOfPlanObject](#showschildrenofplanobject)
* [startConfiguring](#startconfiguring)
* [startViewing](#startviewing)
* [startedDrawing](#starteddrawing)
* [stoppedDrawing](#stoppeddrawing)
* [switchTo2D](#switchto2d)
* [switchTo3D](#switchto3d)
* [switchToFirstPerson](#switchtofirstperson)
* [toggleConfigureInRoom](#toggleconfigureinroom)
* [unlockCamera](#unlockcamera)
* [updateCamera](#updatecamera)
* [updateCameraOnDrawWalls](#updatecameraondrawwalls)
* [updateScene](#updatescene)
* [waitForMaterialQueue](#waitformaterialqueue)
* [zoomIn](#zoomin)
* [zoomOut](#zoomout)

## Constructors

### constructor

• **new default**(`creator`, `offset`, `plannerCallback`, `mode`)

#### Parameters

| Name              | Type                                                                                                                                                                                                          |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `creator`         | `string`                                                                                                                                                                                                      |
| `offset`          | [`CanvasOffset`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.canvasoffset.md)                                                                                        |
| `plannerCallback` | [`RoomlePlannerCallback`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner.roomleplannercallback.md)                                                                        |
| `mode`            | [`Enumify`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_configurator._internal_.md#enumify)<{ `CAMERA_2D`: `"2D"` = '2D'; `CAMERA_3D`: `"3D"` = '3D'; `CAMERA_FP`: `"FP"` = 'FP' }> |

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[constructor](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#constructor)

## Properties

### \_creator\_

• **\_creator\_**: `string`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[*creator*](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#_creator_)

***

### currentSelection

• **currentSelection**: [`SelectionPayload`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner_ui_callback.selectionpayload.md) = `null`

## Accessors

### configuratorContext

• `get` **configuratorContext**(): [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-7.md)

#### Returns

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

***

### hasSingleRoom

• `get` **hasSingleRoom**(): `boolean`

#### Returns

`boolean`

## Methods

### \_preparePerspectiveImage

▸ **\_preparePerspectiveImage**(`options?`, `isolationMode?`): `Promise`<[`Base64Image`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image.md)>

#### Parameters

| Name             | Type                                                                                                                                                        |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options`        | [`PrepareImageOptionsPlanner`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.prepareimageoptionsplanner.md) |
| `isolationMode?` | `boolean`                                                                                                                                                   |

#### Returns

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

***

### addComponentHandlers

▸ **addComponentHandlers**(`component`): `void`

#### Parameters

| Name        | Type                                                                                                                                            |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `component` | [`RoomleComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[addComponentHandlers](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#addcomponenthandlers)

***

### addEventListener

▸ **addEventListener**(`_listener`): `void`

#### Parameters

| Name        | Type                                                                                                                                           |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `_listener` | [`LifeCycleCallbacks`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.lifecyclecallbacks.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[addEventListener](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#addeventlistener)

***

### addMesh

▸ **addMesh**(`_planElement`, `_material`, `_vertices`, `_indices`, `_uvCoords`, `_normals`): `void`

#### Parameters

| Name           | Type                                                                                                                                    |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `_planElement` | [`PlanElement`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planelement.md) |
| `_material`    | `any`                                                                                                                                   |
| `_vertices`    | `Float32Array`                                                                                                                          |
| `_indices`     | `Int32Array`                                                                                                                            |
| `_uvCoords`    | `Float32Array`                                                                                                                          |
| `_normals`     | `Float32Array`                                                                                                                          |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[addMesh](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#addmesh)

***

### addPlanMesh

▸ **addPlanMesh**(`_plan`, `_material`, `_vertices`, `_indices`, `_uvCoords`, `_normals`, `_type`): `void`

#### Parameters

| Name        | Type                                                                                                                      |
| ----------- | ------------------------------------------------------------------------------------------------------------------------- |
| `_plan`     | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |
| `_material` | `any`                                                                                                                     |
| `_vertices` | `Float32Array`                                                                                                            |
| `_indices`  | `Int32Array`                                                                                                              |
| `_uvCoords` | `Float32Array`                                                                                                            |
| `_normals`  | `Float32Array`                                                                                                            |
| `_type`     | [`KernelEnum`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelenum.md)                           |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[addPlanMesh](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#addplanmesh)

***

### addPlanObjectToScene

▸ **addPlanObjectToScene**(`planViewModel`): `Promise`<`void`>

#### Parameters

| Name            | Type                                                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `planViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-51.md) |

#### Returns

`Promise`<`void`>

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[addPlanObjectToScene](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#addplanobjecttoscene)

***

### addPreviewHandlers

▸ **addPreviewHandlers**(`previewComponent`): `void`

#### Parameters

| Name               | Type                                                                                                                                              |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `previewComponent` | [`PreviewComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.previewcomponent.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[addPreviewHandlers](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#addpreviewhandlers)

***

### addPreviewLineHandlers

▸ **addPreviewLineHandlers**(`previewLineComponent`): `void`

#### Parameters

| Name                   | Type                                                                                                                                                      |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `previewLineComponent` | [`PreviewLineComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.previewlinecomponent.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[addPreviewLineHandlers](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#addpreviewlinehandlers)

***

### animateElement

▸ **animateElement**(`elementId`, `parameterName`, `value`, `applyToChildren`, `animate`): `void`

#### Parameters

| Name              | Type      |
| ----------------- | --------- |
| `elementId`       | `number`  |
| `parameterName`   | `string`  |
| `value`           | `string`  |
| `applyToChildren` | `boolean` |
| `animate`         | `boolean` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[animateElement](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#animateelement)

***

### backToPlanner

▸ **backToPlanner**(): `void`

#### Returns

`void`

***

### beginPlanConstruction

▸ **beginPlanConstruction**(`_plan`): `void`

#### Parameters

| Name    | Type                                                                                                                      |
| ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `_plan` | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[beginPlanConstruction](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#beginplanconstruction)

***

### cameraBehaviourChanged

▸ **cameraBehaviourChanged**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[cameraBehaviourChanged](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#camerabehaviourchanged)

***

### cancelComponentSelection

▸ **cancelComponentSelection**(`resetCamera?`, `reason?`): `void`

#### Parameters

| Name           | Type                                                                                                                                                       |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `resetCamera?` | `boolean`                                                                                                                                                  |
| `reason?`      | [`CancelSelectionReasons`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#cancelselectionreasons) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[cancelComponentSelection](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#cancelcomponentselection)

***

### cancelDockings

▸ **cancelDockings**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[cancelDockings](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#canceldockings)

***

### cancelPlanElementSelection

▸ **cancelPlanElementSelection**(`reason`): `void`

#### Parameters

| Name     | Type                                                                                                                                                       |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `reason` | [`CancelSelectionReasons`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#cancelselectionreasons) |

#### Returns

`void`

***

### cancelPreviousDockings

▸ **cancelPreviousDockings**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[cancelPreviousDockings](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#cancelpreviousdockings)

***

### changeEnvironmentMapIntensity

▸ **changeEnvironmentMapIntensity**(`intensity`): `void`

#### Parameters

| Name        | Type     |
| ----------- | -------- |
| `intensity` | `number` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[changeEnvironmentMapIntensity](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#changeenvironmentmapintensity)

***

### changeExteriorWallsMaterial

▸ **changeExteriorWallsMaterial**(`material`): `void`

#### Parameters

| Name       | Type                                                                                                                             |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `material` | [`BatchPaintMaterial`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner.batchpaintmaterial.md) |

#### Returns

`void`

***

### changeFloorMaterial

▸ **changeFloorMaterial**(`material`): `Promise`<`void`>

#### Parameters

| Name       | Type                                                                                                    |
| ---------- | ------------------------------------------------------------------------------------------------------- |
| `material` | [`RapiMaterial`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_rapi_types.rapimaterial.md) |

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[changeFloorMaterial](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#changefloormaterial)

***

### changeFloorsMaterial

▸ **changeFloorsMaterial**(`material`): `void`

#### Parameters

| Name       | Type                                                                                                                             |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `material` | [`BatchPaintMaterial`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner.batchpaintmaterial.md) |

#### Returns

`void`

***

### changeInteriorWallsMaterial

▸ **changeInteriorWallsMaterial**(`material`): `void`

#### Parameters

| Name       | Type                                                                                                                             |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `material` | [`BatchPaintMaterial`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner.batchpaintmaterial.md) |

#### Returns

`void`

***

### changeOffset

▸ **changeOffset**(`offset`): `void`

#### Parameters

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

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[changeOffset](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#changeoffset)

***

### cleanUp

▸ **cleanUp**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[cleanUp](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#cleanup)

***

### clearScene

▸ **clearScene**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[clearScene](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#clearscene)

***

### componentDeleted

▸ **componentDeleted**(`component`): `void`

#### Parameters

| Name        | Type                                                                                                                                            |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `component` | [`RoomleComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[componentDeleted](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#componentdeleted)

***

### componentUpdated

▸ **componentUpdated**(`component`, `_kernelComponent`): `void`

#### Parameters

| Name               | Type                                                                                                                                            |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `component`        | [`RoomleComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent.md) |
| `_kernelComponent` | [`KernelComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelcomponent.md)                                       |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[componentUpdated](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#componentupdated)

***

### configurationLoaded

▸ **configurationLoaded**(`component`, `isFreeFlying`): `void`

#### Parameters

| Name           | Type                                                                                                                                            |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `component`    | [`RoomleComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent.md) |
| `isFreeFlying` | `boolean`                                                                                                                                       |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[configurationLoaded](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#configurationloaded)

***

### debugScene

▸ **debugScene**(): `Scene`

#### Returns

`Scene`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[debugScene](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#debugscene)

***

### debugSceneGraph

▸ **debugSceneGraph**(`id?`): `void`

#### Parameters

| Name  | Type     |
| ----- | -------- |
| `id?` | `number` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[debugSceneGraph](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#debugscenegraph)

***

### deletePlanElementByIds

▸ **deletePlanElementByIds**(`runtimeIds`): `Promise`<`void`>

#### Parameters

| Name         | Type        |
| ------------ | ----------- |
| `runtimeIds` | `number`\[] |

#### Returns

`Promise`<`void`>

***

### deletePlanElementSelection

▸ **deletePlanElementSelection**(): `Promise`<`void`>

#### Returns

`Promise`<`void`>

***

### destroy

▸ **destroy**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[destroy](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#destroy)

***

### disableAdvancedDocking

▸ **disableAdvancedDocking**(): `void`

#### Returns

`void`

***

### disableConfiguratorEvents

▸ **disableConfiguratorEvents**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[disableConfiguratorEvents](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#disableconfiguratorevents)

***

### disableEvents

▸ **disableEvents**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[disableEvents](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#disableevents)

***

### disableMeasurementLineDrawing

▸ **disableMeasurementLineDrawing**(): `void`

#### Returns

`void`

***

### disablePlannerEvents

▸ **disablePlannerEvents**(): `void`

#### Returns

`void`

***

### disableRotation

▸ **disableRotation**(): `void`

#### Returns

`void`

***

### disableShowChildrenOfPlanObject

▸ **disableShowChildrenOfPlanObject**(`planElementViewModel`): `void`

#### Parameters

| Name                   | Type                                                                                                                            |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `planElementViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |

#### Returns

`void`

***

### disableSnapping

▸ **disableSnapping**(): `void`

#### Returns

`void`

***

### disableWallDrawing

▸ **disableWallDrawing**(): `void`

#### Returns

`void`

***

### display

▸ **display**(`component`): `void`

#### Parameters

| Name        | Type                                                                                                                                            |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `component` | [`RoomleComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[display](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#display)

***

### dragIn

▸ **dragIn**(`dragEvent`): `void`

#### Parameters

| Name        | Type        |
| ----------- | ----------- |
| `dragEvent` | `DragEvent` |

#### Returns

`void`

***

### enableAdvancedDocking

▸ **enableAdvancedDocking**(): `void`

#### Returns

`void`

***

### enableConfiguratorEvents

▸ **enableConfiguratorEvents**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[enableConfiguratorEvents](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#enableconfiguratorevents)

***

### enableDragIn

▸ **enableDragIn**(`dragEvent`): `void`

#### Parameters

| Name        | Type        |
| ----------- | ----------- |
| `dragEvent` | `DragEvent` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[enableDragIn](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#enabledragin)

***

### enableEvents

▸ **enableEvents**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[enableEvents](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#enableevents)

***

### enableHD

▸ **enableHD**(`source?`): `void`

#### Parameters

| Name      | Type                                                                                                                                                                     |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `source?` | [`DynamicLightSettingSource`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_lightsetting_dynamic_light_setting_loader.dynamiclightsettingsource.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[enableHD](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#enablehd)

***

### enableMeasurementLineDrawing

▸ **enableMeasurementLineDrawing**(): `void`

#### Returns

`void`

***

### enablePlannerEvents

▸ **enablePlannerEvents**(): `void`

#### Returns

`void`

***

### enableRotation

▸ **enableRotation**(): `void`

#### Returns

`void`

***

### enableShowChildrenOfPlanObject

▸ **enableShowChildrenOfPlanObject**(`planElementViewModel`): `void`

#### Parameters

| Name                   | Type                                                                                                                            |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `planElementViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |

#### Returns

`void`

***

### enableSnapping

▸ **enableSnapping**(): `void`

#### Returns

`void`

***

### enableWallDrawing

▸ **enableWallDrawing**(): `void`

#### Returns

`void`

***

### endPlanConstruction

▸ **endPlanConstruction**(`_plan`): `void`

#### Parameters

| Name    | Type                                                                                                                      |
| ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `_plan` | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[endPlanConstruction](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#endplanconstruction)

***

### escapeDrawing

▸ **escapeDrawing**(`cancelDrawing`): `void`

#### Parameters

| Name            | Type      |
| --------------- | --------- |
| `cancelDrawing` | `boolean` |

#### Returns

`void`

***

### exportCanvasScreenshot

▸ **exportCanvasScreenshot**(`quality?`): `Promise`<`string`>

#### Parameters

| Name      | Type     | Default value |
| --------- | -------- | ------------- |
| `quality` | `number` | `1`           |

#### Returns

`Promise`<`string`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[exportCanvasScreenshot](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#exportcanvasscreenshot)

***

### exportGLB

▸ **exportGLB**(`_exportObjects?`, `_id?`): `void`

#### Parameters

| Name              | Type                              |
| ----------------- | --------------------------------- |
| `_exportObjects?` | `Object3D`<`Object3DEventMap`>\[] |
| `_id?`            | `string`                          |

#### Returns

`void`

***

### exportImageFromCamera

▸ **exportImageFromCamera**(`filename`, `shouldWaitForAssets?`): `Promise`<`void`>

#### Parameters

| Name                  | Type      | Default value |
| --------------------- | --------- | ------------- |
| `filename`            | `string`  | `undefined`   |
| `shouldWaitForAssets` | `boolean` | `false`       |

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[exportImageFromCamera](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#exportimagefromcamera)

***

### getBounds

▸ **getBounds**(): `Box3`

#### Returns

`Box3`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getBounds](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getbounds)

***

### getCameraOffset

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

#### Returns

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

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getCameraOffset](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getcameraoffset)

***

### getCameraParameters3d

▸ **getCameraParameters3d**(): [`CameraParameter`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.cameraparameter.md)

#### Returns

[`CameraParameter`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.cameraparameter.md)

***

### getComponent

▸ **getComponent**(`componentRuntimeId`): [`KernelComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelcomponent.md)

#### Parameters

| Name                 | Type     |
| -------------------- | -------- |
| `componentRuntimeId` | `number` |

#### Returns

[`KernelComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelcomponent.md)

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getComponent](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getcomponent)

***

### getGeometryBounds

▸ **getGeometryBounds**(): `Box3`

#### Returns

`Box3`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getGeometryBounds](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getgeometrybounds)

***

### getObjectComponent

▸ **getObjectComponent**(`id`): [`KernelPlanObjectComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent.md)

#### Parameters

| Name | Type     |
| ---- | -------- |
| `id` | `number` |

#### Returns

[`KernelPlanObjectComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent.md)

***

### getOrthographicOffsetCamera

▸ **getOrthographicOffsetCamera**(): [`OrthographicOffsetCamera`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.orthographicoffsetcamera.md)

#### Returns

[`OrthographicOffsetCamera`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.orthographicoffsetcamera.md)

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getOrthographicOffsetCamera](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getorthographicoffsetcamera)

***

### getPlanObject

▸ **getPlanObject**(`id`): [`KernelPlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobject.md)

#### Parameters

| Name | Type     |
| ---- | -------- |
| `id` | `number` |

#### Returns

[`KernelPlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobject.md)

***

### getPlannerSceneEventHandler

▸ **getPlannerSceneEventHandler**(): [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-4.md)

#### Returns

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

***

### getRootPlanObjectId

▸ **getRootPlanObjectId**(`id`): `number`

This is needed to get the root plan object id in case a plan element is selected\
which has been docked using `advanced docking`

#### Parameters

| Name | Type     |
| ---- | -------- |
| `id` | `number` |

#### Returns

`number`

***

### getScene

▸ **getScene**(): `Scene`

#### Returns

`Scene`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getScene](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getscene)

***

### getScreenXY

▸ **getScreenXY**(`position`): `Vector3`

#### Parameters

| Name       | Type      |
| ---------- | --------- |
| `position` | `Vector3` |

#### Returns

`Vector3`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getScreenXY](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getscreenxy)

***

### getSelectedRuntimeComponentIds

▸ **getSelectedRuntimeComponentIds**(): `number`\[]

#### Returns

`number`\[]

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[getSelectedRuntimeComponentIds](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#getselectedruntimecomponentids)

***

### getWallAngleDegrees

▸ **getWallAngleDegrees**(`wall`): `number`

#### Parameters

| Name   | Type                                                                                                                 |
| ------ | -------------------------------------------------------------------------------------------------------------------- |
| `wall` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-1.md) |

#### Returns

`number`

***

### handleEvent

▸ **handleEvent**(`evt`): `void`

#### Parameters

| Name  | Type    |
| ----- | ------- |
| `evt` | `Event` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[handleEvent](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#handleevent)

***

### handlerSwitchedPlans

▸ **handlerSwitchedPlans**(`fromPlan`, `toPlan`): `void`

#### Parameters

| Name       | Type                                                                                                                      |
| ---------- | ------------------------------------------------------------------------------------------------------------------------- |
| `fromPlan` | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |
| `toPlan`   | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[handlerSwitchedPlans](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#handlerswitchedplans)

***

### hideDimensions

▸ **hideDimensions**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[hideDimensions](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#hidedimensions)

***

### highlightExternalObject

▸ **highlightExternalObject**(`planObjectComponent`): `void`

#### Parameters

| Name                  | Type                                                                                                                          |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `planObjectComponent` | [`KernelPlanObjectComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent.md) |

#### Returns

`void`

***

### highlightParts

▸ **highlightParts**(`ids`): `void`

#### Parameters

| Name  | Type        |
| ----- | ----------- |
| `ids` | `number`\[] |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[highlightParts](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#highlightparts)

***

### highlightPlanElementById

▸ **highlightPlanElementById**(`runtimeId`): `void`

#### Parameters

| Name        | Type     |
| ----------- | -------- |
| `runtimeId` | `number` |

#### Returns

`void`

***

### highlightPlanElementsById

▸ **highlightPlanElementsById**(`runtimeIds`): `void`

#### Parameters

| Name         | Type        |
| ------------ | ----------- |
| `runtimeIds` | `number`\[] |

#### Returns

`void`

***

### importGLB

▸ **importGLB**(`url`): `void`

#### Parameters

| Name  | Type     |
| ----- | -------- |
| `url` | `string` |

#### Returns

`void`

***

### loadDynamicLightSetting

▸ **loadDynamicLightSetting**(`source`): `Promise`<`void`>

#### Parameters

| Name     | Type                                                                                                                                                                     |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `source` | [`DynamicLightSettingSource`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_lightsetting_dynamic_light_setting_loader.dynamiclightsettingsource.md) |

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[loadDynamicLightSetting](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#loaddynamiclightsetting)

***

### loadEnvMap

▸ **loadEnvMap**(`url`): `Promise`<`void`>

#### Parameters

| Name  | Type     |
| ----- | -------- |
| `url` | `string` |

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[loadEnvMap](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#loadenvmap)

***

### loadSceneSettings

▸ **loadSceneSettings**(`sceneSetting`): `Promise`<`void`>

#### Parameters

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

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[loadSceneSettings](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#loadscenesettings)

***

### loadStaticPlanObjects

▸ **loadStaticPlanObjects**(): `void`

#### Returns

`void`

***

### lockCamera

▸ **lockCamera**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[lockCamera](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#lockcamera)

***

### 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`>

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[moveCamera](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#movecamera)

***

### moveElementPosition

▸ **moveElementPosition**(`selectedElement`, `position`): `void`

#### Parameters

| Name              | Type                                                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `selectedElement` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |
| `position`        | [`KernelVector3`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)                           |

#### Returns

`void`

***

### moveElementsPosition

▸ **moveElementsPosition**(`selectedElements`, `position`): `void`

#### Parameters

| Name               | Type                                                                                                                               |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `selectedElements` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md)\[] |
| `position`         | [`KernelVector3`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)                              |

#### Returns

`void`

***

### pause

▸ **pause**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[pause](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#pause)

***

### planBoundsChanged

▸ **planBoundsChanged**(): `void`

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planBoundsChanged](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#planboundschanged)

***

### planCleared

▸ **planCleared**(): `void`

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planCleared](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#plancleared)

***

### planCompletelyLoaded

▸ **planCompletelyLoaded**(`_plan`): `void`

#### Parameters

| Name    | Type                                                                                                                      |
| ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `_plan` | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planCompletelyLoaded](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#plancompletelyloaded)

***

### planElementChanged

▸ **planElementChanged**(`_plan`, `planElementViewModel`): `void`

#### Parameters

| Name                   | Type                                                                                                                            |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `_plan`                | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md)       |
| `planElementViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planElementChanged](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#planelementchanged)

***

### planElementRemoved

▸ **planElementRemoved**(`element`): `void`

#### Parameters

| Name      | Type                                                                                                                                    |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `element` | [`PlanElement`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planelement.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planElementRemoved](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#planelementremoved)

***

### planHistoryStateChanged

▸ **planHistoryStateChanged**(): `void`

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planHistoryStateChanged](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#planhistorystatechanged)

***

### planObjectConfigurationChanged

▸ **planObjectConfigurationChanged**(`plan`, `element`): `Promise`<`void`>

#### Parameters

| Name      | Type                                                                                                                            |
| --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `plan`    | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md)       |
| `element` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |

#### Returns

`Promise`<`void`>

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planObjectConfigurationChanged](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#planobjectconfigurationchanged)

***

### planObjectConfigurationLoaded

▸ **planObjectConfigurationLoaded**(`plan`, `element`, `success`): `void`

#### Parameters

| Name      | Type                                                                                                                                    |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`    | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md)               |
| `element` | [`PlanElement`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planelement.md) |
| `success` | `boolean`                                                                                                                               |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[planObjectConfigurationLoaded](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#planobjectconfigurationloaded)

***

### planObjectConstructionDone

▸ **planObjectConstructionDone**(`_planObject`): `void`

#### Parameters

| Name          | Type                                                                                            |
| ------------- | ----------------------------------------------------------------------------------------------- |
| `_planObject` | [`PlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.planobject.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[planObjectConstructionDone](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#planobjectconstructiondone)

***

### planObjectUpdated

▸ **planObjectUpdated**(`planObject`, `geometryChanged`, `pendingDocking`): `void`

#### Parameters

| Name              | Type                                                                                            |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| `planObject`      | [`PlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.planobject.md) |
| `geometryChanged` | `boolean`                                                                                       |
| `pendingDocking`  | `boolean`                                                                                       |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[planObjectUpdated](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#planobjectupdated)

***

### planXMLLoaded

▸ **planXMLLoaded**(`plan`): `void`

#### Parameters

| Name   | Type                                                                                                                      |
| ------ | ------------------------------------------------------------------------------------------------------------------------- |
| `plan` | [`Plan`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan.md) |

#### Returns

`void`

***

### preload

▸ **preload**(`id`): `void`

#### Parameters

| Name | Type     |
| ---- | -------- |
| `id` | `string` |

#### Returns

`void`

***

### preparePartImage

▸ **preparePartImage**(`partId`, `options`): `Promise`<`any`>

#### Parameters

| Name      | Type                                                                                                                                                    |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `partId`  | `number`                                                                                                                                                |
| `options` | [`PrepareImageOptions`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.prepareimageoptions.md) |

#### Returns

`Promise`<`any`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[preparePartImage](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#preparepartimage)

***

### preparePerspectiveImage

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

#### Parameters

| Name             | Type                                                                                                                                                    |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options`        | [`PrepareImageOptions`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.prepareimageoptions.md) |
| `isolationMode?` | `boolean`                                                                                                                                               |

#### Returns

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

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[preparePerspectiveImage](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#prepareperspectiveimage)

***

### preparePerspectiveImageOf

▸ **preparePerspectiveImageOf**(`runtimeId`, `options?`): `Promise`<[`Base64Image`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image.md)>

#### Parameters

| Name        | Type                                                                                                                                                    |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `runtimeId` | `number`                                                                                                                                                |
| `options`   | [`PrepareImageOptions`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.prepareimageoptions.md) |

#### Returns

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

***

### prepareTopImage

▸ **prepareTopImage**(`options?`, `isolationMode?`): `Promise`<[`Base64Image`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/common_core_src_common_interfaces.base64image.md)>

#### Parameters

| Name             | Type                                                                                                                                                    |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options`        | [`PrepareImageOptions`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.prepareimageoptions.md) |
| `isolationMode?` | `boolean`                                                                                                                                               |

#### Returns

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

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[prepareTopImage](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#preparetopimage)

***

### previewConstructionDone

▸ **previewConstructionDone**(`_component`, `hasPreviews`): `void`

#### Parameters

| Name          | Type                                                                                                                                            |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `_component`  | [`RoomleComponent`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent.md) |
| `hasPreviews` | `boolean`                                                                                                                                       |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[previewConstructionDone](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#previewconstructiondone)

***

### removeEventListener

▸ **removeEventListener**(`_listener`): `void`

#### Parameters

| Name        | Type                                                                                                                                           |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `_listener` | [`LifeCycleCallbacks`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_configurator._internal_.lifecyclecallbacks.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[removeEventListener](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#removeeventlistener)

***

### removePlanObjectFromScene

▸ **removePlanObjectFromScene**(`planViewModel`): `void`

#### Parameters

| Name            | Type                                                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `planViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[removePlanObjectFromScene](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#removeplanobjectfromscene)

***

### renderImage

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

#### Parameters

| Name            | Type                                                      |
| --------------- | --------------------------------------------------------- |
| `renderOptions` | `Partial`<{ `useCurrentPerspective`: `boolean` = false }> |

#### Returns

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

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[renderImage](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#renderimage)

***

### requestCatalogItem

▸ **requestCatalogItem**(`catalogItemId`): `void`

#### Parameters

| Name            | Type     |
| --------------- | -------- |
| `catalogItemId` | `string` |

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[requestCatalogItem](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#requestcatalogitem)

***

### requestDeleteSelectedComponent

▸ **requestDeleteSelectedComponent**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[requestDeleteSelectedComponent](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#requestdeleteselectedcomponent)

***

### requestDockingsPreview

▸ **requestDockingsPreview**(`userInitiated`, `possibleChild?`, `dragEvent?`, `dragIn?`): `void`

#### Parameters

| Name             | Type                                                                                                      |
| ---------------- | --------------------------------------------------------------------------------------------------------- |
| `userInitiated`  | `boolean`                                                                                                 |
| `possibleChild?` | [`UiPossibleChild`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.uipossiblechild.md) |
| `dragEvent?`     | `DragEvent`                                                                                               |
| `dragIn?`        | `boolean`                                                                                                 |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[requestDockingsPreview](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#requestdockingspreview)

***

### resetCameraPositionToStart

▸ **resetCameraPositionToStart**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[resetCameraPositionToStart](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#resetcamerapositiontostart)

***

### resetConfiguratorContext

▸ **resetConfiguratorContext**(`reason`): `void`

#### Parameters

| Name     | Type                                                                                                                                                       |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `reason` | [`CancelSelectionReasons`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#cancelselectionreasons) |

#### Returns

`void`

***

### resetPreviews

▸ **resetPreviews**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[resetPreviews](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#resetpreviews)

***

### resume

▸ **resume**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[resume](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#resume)

***

### rotatePlanElementSelection

▸ **rotatePlanElementSelection**(`rotateBy`): `void`

#### Parameters

| Name       | Type     |
| ---------- | -------- |
| `rotateBy` | `number` |

#### Returns

`void`

***

### saveConfigToIdb

▸ **saveConfigToIdb**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[saveConfigToIdb](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#saveconfigtoidb)

***

### sceneChanged

▸ **sceneChanged**(): `void`

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[sceneChanged](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#scenechanged)

***

### sceneCleared

▸ **sceneCleared**(`shouldHardReset`): `void`

#### Parameters

| Name              | Type      |
| ----------------- | --------- |
| `shouldHardReset` | `boolean` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[sceneCleared](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#scenecleared)

***

### selectComponent

▸ **selectComponent**(`runtimeId`, `triggerClickCallback?`): `void`

#### Parameters

| Name                   | Type      | Default value |
| ---------------------- | --------- | ------------- |
| `runtimeId`            | `number`  | `undefined`   |
| `triggerClickCallback` | `boolean` | `true`        |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[selectComponent](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#selectcomponent)

***

### selectPlanObject

▸ **selectPlanObject**(`runtimeId`): `Promise`<`void`>

#### Parameters

| Name        | Type     |
| ----------- | -------- |
| `runtimeId` | `number` |

#### Returns

`Promise`<`void`>

***

### setBackgroundColor

▸ **setBackgroundColor**(`hex`): `void`

#### Parameters

| Name  | Type     |
| ----- | -------- |
| `hex` | `string` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[setBackgroundColor](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#setbackgroundcolor)

***

### setBackgroundImage

▸ **setBackgroundImage**(`url`): `void`

#### Parameters

| Name  | Type     |
| ----- | -------- |
| `url` | `string` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[setBackgroundImage](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#setbackgroundimage)

***

### setCameraOffset

▸ **setCameraOffset**(`offset`): `void`

#### Parameters

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

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[setCameraOffset](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#setcameraoffset)

***

### setCompletelyLoaded

▸ **setCompletelyLoaded**(`completelyLoaded`): `void`

#### Parameters

| Name               | Type      |
| ------------------ | --------- |
| `completelyLoaded` | `boolean` |

#### Returns

`void`

***

### setEnvironmentMap

▸ **setEnvironmentMap**(`url?`, `intensity?`, `rotation?`, `maxLightSources?`): `void`

#### Parameters

| Name               | Type     |
| ------------------ | -------- |
| `url?`             | `string` |
| `intensity?`       | `number` |
| `rotation?`        | `number` |
| `maxLightSources?` | `number` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[setEnvironmentMap](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#setenvironmentmap)

***

### setMeasurementLineLength

▸ **setMeasurementLineLength**(`measurementId`, `length`, `wallDirection`): `void`

#### Parameters

| Name            | Type     |
| --------------- | -------- |
| `measurementId` | `number` |
| `length`        | `number` |
| `wallDirection` | `string` |

#### Returns

`void`

***

### setMode

▸ **setMode**(`mode`): `void`

#### Parameters

| Name   | Type                                                                                                                                                                                                          |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mode` | [`Enumify`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_configurator._internal_.md#enumify)<{ `CAMERA_2D`: `"2D"` = '2D'; `CAMERA_3D`: `"3D"` = '3D'; `CAMERA_FP`: `"FP"` = 'FP' }> |

#### Returns

`void`

***

### setObjectToWallMeasurementLength

▸ **setObjectToWallMeasurementLength**(`planElementId`, `measurementId`, `length`): `void`

#### Parameters

| Name            | Type     |
| --------------- | -------- |
| `planElementId` | `number` |
| `measurementId` | `number` |
| `length`        | `number` |

#### Returns

`void`

***

### setSceneEvents

▸ **setSceneEvents**(`sceneEvents`): `void`

#### Parameters

| Name          | Type                                                                                                               |
| ------------- | ------------------------------------------------------------------------------------------------------------------ |
| `sceneEvents` | [`SceneEvents`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner.sceneevents.md) |

#### Returns

`void`

***

### setSelectionMode

▸ **setSelectionMode**(`mode`): `void`

#### Parameters

| Name   | Type                                                                                                                                     |
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `mode` | [`SELECTION_MODE`](/rubens/rubens-sdk/rubens-sdk-reference/enums/configurator_core_src_roomle_configurator._internal_.selection_mode.md) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[setSelectionMode](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#setselectionmode)

***

### setWallMeasurementLength

▸ **setWallMeasurementLength**(`measurementId`, `length`, `wallDirection`): `void`

#### Parameters

| Name            | Type                                                                                                                                 |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `measurementId` | `number`                                                                                                                             |
| `length`        | `number`                                                                                                                             |
| `wallDirection` | [`EMSConstant`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.emsconstant.md) |

#### Returns

`void`

***

### showDimensions

▸ **showDimensions**(): `Promise`<`void`>

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[showDimensions](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#showdimensions)

***

### showGUI

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

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[showGUI](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#showgui)

***

### showStats

▸ **showStats**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[showStats](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#showstats)

***

### showsChildrenOfPlanObject

▸ **showsChildrenOfPlanObject**(`planElementViewModel`): `boolean`

#### Parameters

| Name                   | Type                                                                                                                            |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `planElementViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md) |

#### Returns

`boolean`

***

### startConfiguring

▸ **startConfiguring**(): `void`

#### Returns

`void`

***

### startViewing

▸ **startViewing**(): `void`

#### Returns

`void`

***

### startedDrawing

▸ **startedDrawing**(): `void`

called by kernel

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[startedDrawing](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#starteddrawing)

***

### stoppedDrawing

▸ **stoppedDrawing**(): `void`

called by kernel

#### Returns

`void`

#### Implementation of

[PlannerKernelCallbackI](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md).[stoppedDrawing](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plannerkernelcallbacki.md#stoppeddrawing)

***

### switchTo2D

▸ **switchTo2D**(): `void`

#### Returns

`void`

***

### switchTo3D

▸ **switchTo3D**(): `void`

#### Returns

`void`

***

### switchToFirstPerson

▸ **switchToFirstPerson**(): `void`

#### Returns

`void`

***

### toggleConfigureInRoom

▸ **toggleConfigureInRoom**(): `void`

#### Returns

`void`

***

### unlockCamera

▸ **unlockCamera**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[unlockCamera](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#unlockcamera)

***

### updateCamera

▸ **updateCamera**(`_changeCamera?`): `void`

#### Parameters

| Name            | Type      | Default value |
| --------------- | --------- | ------------- |
| `_changeCamera` | `boolean` | `true`        |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[updateCamera](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#updatecamera)

***

### updateCameraOnDrawWalls

▸ **updateCameraOnDrawWalls**(): `void`

#### Returns

`void`

***

### updateScene

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

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[updateScene](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#updatescene)

***

### waitForMaterialQueue

▸ **waitForMaterialQueue**(): `Promise`<`void`>

#### Returns

`Promise`<`void`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[waitForMaterialQueue](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#waitformaterialqueue)

***

### zoomIn

▸ **zoomIn**(`value?`): `void`

#### Parameters

| Name     | Type     |
| -------- | -------- |
| `value?` | `number` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[zoomIn](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#zoomin)

***

### zoomOut

▸ **zoomOut**(`value?`): `void`

#### Parameters

| Name     | Type     |
| -------- | -------- |
| `value?` | `number` |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md).[zoomOut](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-10.md#zoomout)


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
