# RoomlePlanner.Internal.default-18

[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)

### Properties

* [currentPoint](#currentpoint)

### Methods

* [addMesh](#addmesh)
* [clear](#clear)
* [clearReference](#clearreference)
* [deselect](#deselect)
* [deselectAllDraggablePoints](#deselectalldraggablepoints)
* [deselectPoint1Draggable](#deselectpoint1draggable)
* [deselectPoint2Draggable](#deselectpoint2draggable)
* [getBoundingBox](#getboundingbox)
* [getBounds](#getbounds)
* [getContainer](#getcontainer)
* [getId](#getid)
* [getKernelObject](#getkernelobject)
* [getMeasurementLineDimension](#getmeasurementlinedimension)
* [getMesh](#getmesh)
* [getName](#getname)
* [getObject](#getobject)
* [getObjectAsync](#getobjectasync)
* [getPlanElement](#getplanelement)
* [getPoint1Draggable](#getpoint1draggable)
* [getPoint1DraggableBoundingBox](#getpoint1draggableboundingbox)
* [getPoint2Draggable](#getpoint2draggable)
* [getPoint2DraggableBoundingBox](#getpoint2draggableboundingbox)
* [getPosition](#getposition)
* [getRotation](#getrotation)
* [getSize](#getsize)
* [handleDraggablePointsSelection](#handledraggablepointsselection)
* [hide](#hide)
* [hideAllSubLines](#hideallsublines)
* [hideDraggableNodes](#hidedraggablenodes)
* [hideDraggablePointsOnDragStart](#hidedraggablepointsondragstart)
* [hidePoint1DraggableNode](#hidepoint1draggablenode)
* [hidePoint2DraggableNode](#hidepoint2draggablenode)
* [hidePreviewBox](#hidepreviewbox)
* [hoverOff](#hoveroff)
* [hoverOffDragPoint1](#hoveroffdragpoint1)
* [hoverOffDragPoint2](#hoveroffdragpoint2)
* [hoverOn](#hoveron)
* [hoverOnDragPoint1](#hoverondragpoint1)
* [hoverOnDragPoint2](#hoverondragpoint2)
* [remove](#remove)
* [select](#select)
* [selectAllDraggablePoints](#selectalldraggablepoints)
* [selectPoint1Draggable](#selectpoint1draggable)
* [selectPoint2Draggable](#selectpoint2draggable)
* [selectPointOnDragStart](#selectpointondragstart)
* [setObject](#setobject)
* [setTopView](#settopview)
* [show](#show)
* [showAllSubLines](#showallsublines)
* [showDraggableNodes](#showdraggablenodes)
* [showDraggablePointsOnDragEnd](#showdraggablepointsondragend)
* [showDraggablePointsOnHoverOff](#showdraggablepointsonhoveroff)
* [showDraggablePointsOnHoverOn](#showdraggablepointsonhoveron)
* [showPoint1DraggableNode](#showpoint1draggablenode)
* [showPoint2DraggableNode](#showpoint2draggablenode)
* [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)

## Properties

### currentPoint

• **currentPoint**: `string`

## Methods

### addMesh

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

#### Parameters

| Name   | Type                           |
| ------ | ------------------------------ |
| `mesh` | `Object3D`<`Object3DEventMap`> |

#### Returns

`void`

#### Inherited from

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

#### Inherited from

[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)

***

### deselectAllDraggablePoints

▸ **deselectAllDraggablePoints**(): `void`

#### Returns

`void`

***

### deselectPoint1Draggable

▸ **deselectPoint1Draggable**(): `void`

#### Returns

`void`

***

### deselectPoint2Draggable

▸ **deselectPoint2Draggable**(): `void`

#### Returns

`void`

***

### 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**(): [`KernelObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelobject.md)

#### Returns

[`KernelObject`](/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelobject.md)

#### Inherited from

[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)

***

### getMeasurementLineDimension

▸ **getMeasurementLineDimension**(): [`MeasurementLineDimension`](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md#measurementlinedimension)

#### Returns

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

***

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

***

### getPoint1Draggable

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

#### Returns

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

***

### getPoint1DraggableBoundingBox

▸ **getPoint1DraggableBoundingBox**(): `Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` | `Material`\[], `Object3DEventMap`>

#### Returns

`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` | `Material`\[], `Object3DEventMap`>

***

### getPoint2Draggable

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

#### Returns

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

***

### getPoint2DraggableBoundingBox

▸ **getPoint2DraggableBoundingBox**(): `Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` | `Material`\[], `Object3DEventMap`>

#### Returns

`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` | `Material`\[], `Object3DEventMap`>

***

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

***

### handleDraggablePointsSelection

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

#### Parameters

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

#### Returns

`void`

***

### hide

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

#### Returns

`void`

***

### hideAllSubLines

▸ **hideAllSubLines**(): `void`

#### Returns

`void`

***

### hideDraggableNodes

▸ **hideDraggableNodes**(): `void`

#### Returns

`void`

***

### hideDraggablePointsOnDragStart

▸ **hideDraggablePointsOnDragStart**(`planElementViewModel`, `point`): `void`

#### Parameters

| Name                   | Type                                                                                                                                                             |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `planElementViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-18.md)                                            |
| `point`                | [`MeasurementLineDraggablePoints`](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md#measurementlinedraggablepoints) |

#### Returns

`void`

***

### hidePoint1DraggableNode

▸ **hidePoint1DraggableNode**(): `void`

#### Returns

`void`

***

### hidePoint2DraggableNode

▸ **hidePoint2DraggableNode**(): `void`

#### Returns

`void`

***

### hidePreviewBox

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

#### Returns

`void`

#### Overrides

[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)

***

### hoverOffDragPoint1

▸ **hoverOffDragPoint1**(): `void`

#### Returns

`void`

***

### hoverOffDragPoint2

▸ **hoverOffDragPoint2**(): `void`

#### Returns

`void`

***

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

***

### hoverOnDragPoint1

▸ **hoverOnDragPoint1**(): `void`

#### Returns

`void`

***

### hoverOnDragPoint2

▸ **hoverOnDragPoint2**(): `void`

#### Returns

`void`

***

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

#### Inherited from

[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)

***

### selectAllDraggablePoints

▸ **selectAllDraggablePoints**(): `void`

#### Returns

`void`

***

### selectPoint1Draggable

▸ **selectPoint1Draggable**(): `void`

#### Returns

`void`

***

### selectPoint2Draggable

▸ **selectPoint2Draggable**(): `void`

#### Returns

`void`

***

### selectPointOnDragStart

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

#### Parameters

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

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

***

### showAllSubLines

▸ **showAllSubLines**(): `void`

#### Returns

`void`

***

### showDraggableNodes

▸ **showDraggableNodes**(): `void`

#### Returns

`void`

***

### showDraggablePointsOnDragEnd

▸ **showDraggablePointsOnDragEnd**(`planElementViewModel`, `point`): `void`

#### Parameters

| Name                   | Type                                                                                                                                                             |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `planElementViewModel` | [`default`](/rubens/rubens-sdk/rubens-sdk-reference/classes/planner_core_src_roomle_planner._internal_.default-18.md)                                            |
| `point`                | [`MeasurementLineDraggablePoints`](/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md#measurementlinedraggablepoints) |

#### Returns

`void`

***

### showDraggablePointsOnHoverOff

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

#### Parameters

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

#### Returns

`void`

***

### showDraggablePointsOnHoverOn

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

#### Parameters

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

#### Returns

`void`

***

### showPoint1DraggableNode

▸ **showPoint1DraggableNode**(): `void`

#### Returns

`void`

***

### showPoint2DraggableNode

▸ **showPoint2DraggableNode**(): `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-18.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.