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

# RoomlePlanner.Internal.WallPlanObject

[planner-core/src/roomle-planner](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner.md).[internal](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/planner_core_src_roomle_planner._internal_.md).WallPlanObject

## Hierarchy

* [`PlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md)

  ↳ **`WallPlanObject`**

## Table of contents

### Properties

* [boxForMeasurement](#boxformeasurement)
* [customColor](#customcolor)
* [extRef](#extref)
* [fixedZ](#fixedz)
* [flipX](#flipx)
* [flipY](#flipy)
* [height](#height)
* [hidden](#hidden)
* [rotation](#rotation)
* [rotationToPreferredFront](#rotationtopreferredfront)
* [size](#size)
* [thickness](#thickness)

### Methods

* [clone](#clone)
* [delete](#delete)
* [getAttachedAttics](#getattachedattics)
* [getCatalogItemId](#getcatalogitemid)
* [getCenter](#getcenter)
* [getConfiguration](#getconfiguration)
* [getConfigurationHash](#getconfigurationhash)
* [getConfigurationRuntimeId](#getconfigurationruntimeid)
* [getCornerFromLeft](#getcornerfromleft)
* [getCornerFromRight](#getcornerfromright)
* [getCornerToLeft](#getcornertoleft)
* [getCornerToRight](#getcornertoright)
* [getFrom](#getfrom)
* [getId](#getid)
* [getLength](#getlength)
* [getMeshCenter](#getmeshcenter)
* [getMeshOffsetRelativeToObject](#getmeshoffsetrelativetoobject)
* [getObjectType](#getobjecttype)
* [getPreferredSide](#getpreferredside)
* [getRectangle](#getrectangle)
* [getTo](#getto)
* [getType](#gettype)
* [getWallDistances](#getwalldistances)
* [hasConfiguration](#hasconfiguration)
* [isExternalObject](#isexternalobject)

## Properties

### boxForMeasurement

• **boxForMeasurement**: [`KernelCube`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelcube.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[boxForMeasurement](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#boxformeasurement)

***

### customColor

• **customColor**: `number`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[customColor](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#customcolor)

***

### extRef

• **extRef**: [`EMSReference`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.emsreference.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[extRef](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#extref)

***

### fixedZ

• **fixedZ**: `boolean`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[fixedZ](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#fixedz)

***

### flipX

• **flipX**: `boolean`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[flipX](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#flipx)

***

### flipY

• **flipY**: `boolean`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[flipY](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#flipy)

***

### height

• `Readonly` **height**: `number`

***

### hidden

• `Readonly` **hidden**: `boolean`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[hidden](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#hidden)

***

### rotation

• **rotation**: `number`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[rotation](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#rotation)

***

### rotationToPreferredFront

• **rotationToPreferredFront**: `number`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[rotationToPreferredFront](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#rotationtopreferredfront)

***

### size

• **size**: [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[size](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#size)

***

### thickness

• `Readonly` **thickness**: `number`

## Methods

### clone

▸ **clone**(): [`KernelObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelobject.md)

#### Returns

[`KernelObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.kernelobject.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[clone](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#clone)

***

### delete

▸ **delete**(): `void`

#### Returns

`void`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[delete](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#delete)

***

### getAttachedAttics

▸ **getAttachedAttics**(): [`KernelAtticArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.kernelatticarray.md)

#### Returns

[`KernelAtticArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.kernelatticarray.md)

***

### getCatalogItemId

▸ **getCatalogItemId**(): `string`

#### Returns

`string`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getCatalogItemId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getcatalogitemid)

***

### getCenter

▸ **getCenter**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Overrides

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getCenter](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getcenter)

***

### getConfiguration

▸ **getConfiguration**(): `string`

#### Returns

`string`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getConfiguration](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getconfiguration)

***

### getConfigurationHash

▸ **getConfigurationHash**(): `string`

#### Returns

`string`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getConfigurationHash](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getconfigurationhash)

***

### getConfigurationRuntimeId

▸ **getConfigurationRuntimeId**(): `number`

#### Returns

`number`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getConfigurationRuntimeId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getconfigurationruntimeid)

***

### getCornerFromLeft

▸ **getCornerFromLeft**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

***

### getCornerFromRight

▸ **getCornerFromRight**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

***

### getCornerToLeft

▸ **getCornerToLeft**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

***

### getCornerToRight

▸ **getCornerToRight**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

***

### getFrom

▸ **getFrom**(): [`NodePlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.nodeplanobject.md)

#### Returns

[`NodePlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.nodeplanobject.md)

***

### getId

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

#### Returns

`number`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getId](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getid)

***

### getLength

▸ **getLength**(`preferredSide`): `number`

#### Parameters

| Name            | Type                                                                                                                                                     |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `preferredSide` | [`WallSide`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.wallside.md) |

#### Returns

`number`

***

### getMeshCenter

▸ **getMeshCenter**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getMeshCenter](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getmeshcenter)

***

### getMeshOffsetRelativeToObject

▸ **getMeshOffsetRelativeToObject**(): [`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Returns

[`KernelVector3`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelvector3.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getMeshOffsetRelativeToObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getmeshoffsetrelativetoobject)

***

### getObjectType

▸ **getObjectType**(): `string`

#### Returns

`string`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getObjectType](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getobjecttype)

***

### getPreferredSide

▸ **getPreferredSide**(): [`LeftOrRightWallSide`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.leftorrightwallside.md)

#### Returns

[`LeftOrRightWallSide`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.leftorrightwallside.md)

***

### getRectangle

▸ **getRectangle**(): [`Rectangle`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.rectangle.md)

#### Returns

[`Rectangle`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.rectangle.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getRectangle](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getrectangle)

***

### getTo

▸ **getTo**(): [`NodePlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.nodeplanobject.md)

#### Returns

[`NodePlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.nodeplanobject.md)

***

### getType

▸ **getType**(): `any`

#### Returns

`any`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getType](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#gettype)

***

### getWallDistances

▸ **getWallDistances**(): [`ObjectToWallLineArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.objecttowalllinearray.md)

#### Returns

[`ObjectToWallLineArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.objecttowalllinearray.md)

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[getWallDistances](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#getwalldistances)

***

### hasConfiguration

▸ **hasConfiguration**(): `boolean`

#### Returns

`boolean`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[hasConfiguration](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#hasconfiguration)

***

### isExternalObject

▸ **isExternalObject**(): `boolean`

#### Returns

`boolean`

#### Inherited from

[PlanObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md).[isExternalObject](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planobject.md#isexternalobject)


---

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

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

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

```
GET https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/planner_core_src_roomle_planner._internal_.wallplanobject.md?ask=<question>&goal=<user_goal>
```

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

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

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