# RoomlePlanner.Internal.default-15 [planner-core/src/roomle-planner](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner).[internal](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_).default ## Hierarchy * [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14) ↳ **`default`** ## Table of contents ### Constructors * [constructor](#constructor) ### Methods * [addChildEntityComponent](#addchildentitycomponent) * [addMesh](#addmesh) * [addRootComponent](#addrootcomponent) * [clear](#clear) * [clearReference](#clearreference) * [deselect](#deselect) * [failConstruction](#failconstruction) * [finishConstruction](#finishconstruction) * [getBoundingBox](#getboundingbox) * [getBounds](#getbounds) * [getConfigurationRuntimeId](#getconfigurationruntimeid) * [getConstructionElementMeasurements](#getconstructionelementmeasurements) * [getContainer](#getcontainer) * [getId](#getid) * [getKernelObject](#getkernelobject) * [getMesh](#getmesh) * [getName](#getname) * [getObject](#getobject) * [getObjectAsync](#getobjectasync) * [getObjectMeasurements](#getobjectmeasurements) * [getPlanElement](#getplanelement) * [getPlanObject](#getplanobject) * [getPosition](#getposition) * [getRootComponentId](#getrootcomponentid) * [getRootComponentRuntimeId](#getrootcomponentruntimeid) * [getRotation](#getrotation) * [getSize](#getsize) * [getTopViewContainer](#gettopviewcontainer) * [hidePreviewBox](#hidepreviewbox) * [hoverOff](#hoveroff) * [hoverOn](#hoveron) * [isInitDone](#isinitdone) * [remove](#remove) * [select](#select) * [setObject](#setobject) * [setRapiItem](#setrapiitem) * [setTopView](#settopview) * [toJSON](#tojson) * [update](#update) ## Constructors ### constructor • **new default**(`planObject`) #### Parameters | Name | Type | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `planObject` | [`PlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject) | #### Overrides [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[constructor](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#constructor) ## Methods ### addChildEntityComponent ▸ **addChildEntityComponent**(`component`): `void` #### Parameters | Name | Type | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `component` | [`RoomleComponent`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent) | #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[addChildEntityComponent](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#addchildentitycomponent) *** ### addMesh ▸ **addMesh**(`mesh`): `void` #### Parameters | Name | Type | | ------ | ------------------------------ | | `mesh` | `Object3D`<`Object3DEventMap`> | #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[addMesh](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#addmesh) *** ### addRootComponent ▸ **addRootComponent**(`component`): `void` #### Parameters | Name | Type | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `component` | [`RoomleComponent`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.roomlecomponent) | #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[addRootComponent](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#addrootcomponent) *** ### clear ▸ **clear**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[clear](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#clear) *** ### clearReference ▸ **clearReference**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[clearReference](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#clearreference) *** ### deselect ▸ **deselect**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[deselect](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#deselect) *** ### failConstruction ▸ **failConstruction**(): `Promise`<`void`> #### Returns `Promise`<`void`> #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[failConstruction](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#failconstruction) *** ### finishConstruction ▸ **finishConstruction**(): `Promise`<`void`> #### Returns `Promise`<`void`> #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[finishConstruction](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#finishconstruction) *** ### getBoundingBox ▸ **getBoundingBox**(): [`RoomleEventedMesh`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_roomle_configurator._internal_#roomleeventedmesh) #### Returns [`RoomleEventedMesh`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_roomle_configurator._internal_#roomleeventedmesh) #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getBoundingBox](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getboundingbox) *** ### getBounds ▸ **getBounds**(): `Box3` #### Returns `Box3` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getBounds](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getbounds) *** ### getConfigurationRuntimeId ▸ **getConfigurationRuntimeId**(): `number` #### Returns `number` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getConfigurationRuntimeId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getconfigurationruntimeid) *** ### getConstructionElementMeasurements ▸ **getConstructionElementMeasurements**(`zoomFactor`, `clientWidth`, `clientHeight`): [`ConstructionMeasurements`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.constructionmeasurements) #### Parameters | Name | Type | | -------------- | -------- | | `zoomFactor` | `number` | | `clientWidth` | `number` | | `clientHeight` | `number` | #### Returns [`ConstructionMeasurements`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.constructionmeasurements) *** ### getContainer ▸ **getContainer**(): `Object3D`<`Object3DEventMap`> #### Returns `Object3D`<`Object3DEventMap`> #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getContainer](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getcontainer) *** ### getId ▸ **getId**(): `number` #### Returns `number` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getid) *** ### getKernelObject ▸ **getKernelObject**(): [`KernelObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelobject) #### Returns [`KernelObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelobject) #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getKernelObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getkernelobject) *** ### getMesh ▸ **getMesh**(`material`): `Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` | `Material`\[], `Object3DEventMap`> #### Parameters | Name | Type | | ---------- | ----- | | `material` | `any` | #### Returns `Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` | `Material`\[], `Object3DEventMap`> #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getMesh](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getmesh) *** ### getName ▸ **getName**(): `string` #### Returns `string` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getName](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getname) *** ### getObject ▸ **getObject**(): [`RoomleEventedObject3D`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_roomle_configurator._internal_#roomleeventedobject3d) #### Returns [`RoomleEventedObject3D`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_roomle_configurator._internal_#roomleeventedobject3d) #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getobject) *** ### getObjectAsync ▸ **getObjectAsync**(): `Promise`<`Object3D`<`Object3DEventMap`>> #### Returns `Promise`<`Object3D`<`Object3DEventMap`>> #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getObjectAsync](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getobjectasync) *** ### getObjectMeasurements ▸ **getObjectMeasurements**(`zoomFactor`, `clientWidth`, `clientHeight`): [`ObjectMeasurements`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.objectmeasurements) #### Parameters | Name | Type | | -------------- | -------- | | `zoomFactor` | `number` | | `clientWidth` | `number` | | `clientHeight` | `number` | #### Returns [`ObjectMeasurements`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.objectmeasurements) #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getObjectMeasurements](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getobjectmeasurements) *** ### getPlanElement ▸ **getPlanElement**(): [`ConstructionPlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.constructionplanobject) #### Returns [`ConstructionPlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.constructionplanobject) #### Overrides [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getPlanElement](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getplanelement) *** ### getPlanObject ▸ **getPlanObject**(): [`PlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject) #### Returns [`PlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject) #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getPlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getplanobject) *** ### getPosition ▸ **getPosition**(): `Vector3` #### Returns `Vector3` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getPosition](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getposition) *** ### getRootComponentId ▸ **getRootComponentId**(): `number` #### Returns `number` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getRootComponentId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getrootcomponentid) *** ### getRootComponentRuntimeId ▸ **getRootComponentRuntimeId**(): `number` #### Returns `number` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getRootComponentRuntimeId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getrootcomponentruntimeid) *** ### getRotation ▸ **getRotation**(): `number` #### Returns `number` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getRotation](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getrotation) *** ### getSize ▸ **getSize**(): `Vector3` #### Returns `Vector3` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[getSize](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#getsize) *** ### getTopViewContainer ▸ **getTopViewContainer**(): [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-23) #### Returns [`default`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-23) *** ### hidePreviewBox ▸ **hidePreviewBox**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[hidePreviewBox](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#hidepreviewbox) *** ### hoverOff ▸ **hoverOff**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[hoverOff](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#hoveroff) *** ### hoverOn ▸ **hoverOn**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[hoverOn](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#hoveron) *** ### isInitDone ▸ **isInitDone**(): `Promise`<`void`> #### Returns `Promise`<`void`> #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[isInitDone](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#isinitdone) *** ### remove ▸ **remove**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[remove](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#remove) *** ### select ▸ **select**(): `void` #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[select](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#select) *** ### setObject ▸ **setObject**(`object`): `void` #### Parameters | Name | Type | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `object` | [`RoomleEventedObject3D`](https://docs.roomle.com/rubens/rubens-sdk/modules/configurator_core_src_roomle_configurator._internal_#roomleeventedobject3d) | #### Returns `void` #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[setObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#setobject) *** ### setRapiItem ▸ **setRapiItem**(`rapiItem`): `void` #### Parameters | Name | Type | | ---------- | ------------------------------------------------------------------------------------------------------------------- | | `rapiItem` | [`RapiItem`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_rapi_types.rapiitem) | #### Returns `void` *** ### setTopView ▸ **setTopView**(`enabled`): `Promise`<`void`> #### Parameters | Name | Type | | --------- | --------- | | `enabled` | `boolean` | #### Returns `Promise`<`void`> #### Overrides [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[setTopView](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#settopview) *** ### toJSON ▸ **toJSON**(): `Object` #### Returns `Object` | Name | Type | | ------------------------ | -------- | | `rootComponentRuntimeId` | `number` | | `rootElementId` | `number` | #### Inherited from [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[toJSON](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#tojson) *** ### update ▸ **update**(): `void` #### Returns `void` #### Overrides [default](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-14).[update](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/planner_core_src_roomle_planner._internal_.default-14#update)