# RoomlePlanner.Internal.default-1

[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-52.md)

  ↳ **`default`**

## Table of contents

### Constructors

* [constructor](#constructor)

### Accessors

* [isSelected](#isselected)

### Methods

* [addMesh](#addmesh)
* [clear](#clear)
* [clearReference](#clearreference)
* [deselect](#deselect)
* [getBoundingBox](#getboundingbox)
* [getBounds](#getbounds)
* [getContainer](#getcontainer)
* [getId](#getid)
* [getKernelObject](#getkernelobject)
* [getMesh](#getmesh)
* [getName](#getname)
* [getObject](#getobject)
* [getObjectAsync](#getobjectasync)
* [getPlanElement](#getplanelement)
* [getPosition](#getposition)
* [getRotation](#getrotation)
* [getSize](#getsize)
* [getWallDimension](#getwalldimension)
* [hide](#hide)
* [hidePreviewBox](#hidepreviewbox)
* [hoverOff](#hoveroff)
* [hoverOn](#hoveron)
* [remove](#remove)
* [select](#select)
* [setContainerVisibility](#setcontainervisibility)
* [setObject](#setobject)
* [setTopView](#settopview)
* [show](#show)
* [toJSON](#tojson)
* [update](#update)

## Constructors

### constructor

• **new default**(`planObject`)

#### Parameters

| Name         | Type                                                                                                                                  |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| `planObject` | [`PlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md) |

#### Overrides

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

## Accessors

### isSelected

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

#### Returns

`boolean`

## Methods

### addMesh

▸ **addMesh**(`mesh`): `void`

#### Parameters

| Name   | Type                                                                                                |
| ------ | --------------------------------------------------------------------------------------------------- |
| `mesh` | `Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` \| `Material`\[], `Object3DEventMap`> |

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[addMesh](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#addmesh)

***

### clear

▸ **clear**(): `void`

#### Returns

`void`

#### Inherited from

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

***

### clearReference

▸ **clearReference**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[clearReference](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#clearreference)

***

### deselect

▸ **deselect**(): `void`

#### Returns

`void`

#### Overrides

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

***

### getBoundingBox

▸ **getBoundingBox**(): [`RoomleEventedMesh`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#roomleeventedmesh)

#### Returns

[`RoomleEventedMesh`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#roomleeventedmesh)

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getBoundingBox](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getboundingbox)

***

### getBounds

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

#### Returns

`Box3`

#### Inherited from

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

***

### getContainer

▸ **getContainer**(): `Object3D`<`Object3DEventMap`>

#### Returns

`Object3D`<`Object3DEventMap`>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getContainer](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getcontainer)

***

### getId

▸ **getId**(): `number`

#### Returns

`number`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getId](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getid)

***

### getKernelObject

▸ **getKernelObject**(): [`KernelWall`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelwall.md)

#### Returns

[`KernelWall`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelwall.md)

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getKernelObject](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#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](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getMesh](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getmesh)

***

### getName

▸ **getName**(): `string`

#### Returns

`string`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getName](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getname)

***

### getObject

▸ **getObject**(): [`RoomleEventedObject3D`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#roomleeventedobject3d)

#### Returns

[`RoomleEventedObject3D`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#roomleeventedobject3d)

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getObject](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getobject)

***

### getObjectAsync

▸ **getObjectAsync**(): `Promise`<`Object3D`<`Object3DEventMap`>>

#### Returns

`Promise`<`Object3D`<`Object3DEventMap`>>

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getObjectAsync](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getobjectasync)

***

### getPlanElement

▸ **getPlanElement**(): [`PlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md)

#### Returns

[`PlanObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md)

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getPlanElement](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getplanelement)

***

### getPosition

▸ **getPosition**(): `Vector3`

#### Returns

`Vector3`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getPosition](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getposition)

***

### getRotation

▸ **getRotation**(): `number`

#### Returns

`number`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getRotation](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getrotation)

***

### getSize

▸ **getSize**(): `Vector3`

#### Returns

`Vector3`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[getSize](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#getsize)

***

### getWallDimension

▸ **getWallDimension**(`zoomFactor`, `clientWidth`, `clientHeight`): [`WallDimension`](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md#walldimension)

#### Parameters

| Name           | Type     |
| -------------- | -------- |
| `zoomFactor`   | `number` |
| `clientWidth`  | `number` |
| `clientHeight` | `number` |

#### Returns

[`WallDimension`](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md#walldimension)

***

### hide

▸ **hide**(): `void`

#### Returns

`void`

***

### hidePreviewBox

▸ **hidePreviewBox**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[hidePreviewBox](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#hidepreviewbox)

***

### hoverOff

▸ **hoverOff**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[hoverOff](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#hoveroff)

***

### hoverOn

▸ **hoverOn**(): `void`

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[hoverOn](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#hoveron)

***

### remove

▸ **remove**(): `void`

#### Returns

`void`

#### Inherited from

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

***

### select

▸ **select**(): `void`

#### Returns

`void`

#### Overrides

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

***

### setContainerVisibility

▸ **setContainerVisibility**(`isVisible`): `void`

#### Parameters

| Name        | Type      |
| ----------- | --------- |
| `isVisible` | `boolean` |

#### Returns

`void`

***

### setObject

▸ **setObject**(`object`): `void`

#### Parameters

| Name     | Type                                                                                                                                                     |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [`RoomleEventedObject3D`](/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_.md#roomleeventedobject3d) |

#### Returns

`void`

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[setObject](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#setobject)

***

### setTopView

▸ **setTopView**(`enabled`): `void`

#### Parameters

| Name      | Type      |
| --------- | --------- |
| `enabled` | `boolean` |

#### Returns

`void`

#### Overrides

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[setTopView](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#settopview)

***

### show

▸ **show**(): `void`

#### Returns

`void`

***

### toJSON

▸ **toJSON**(): `Object`

#### Returns

`Object`

| Name            | Type     |
| --------------- | -------- |
| `rootElementId` | `number` |

#### Inherited from

[default](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md).[toJSON](/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.default-52.md#tojson)

***

### update

▸ **update**(): `void`

#### Returns

`void`

#### Overrides

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


---

# 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-1.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.