# RoomleConfigurator.Internal.PlanModelViewHelper

[configurator-core/src/roomle-configurator](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator).[internal](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/modules/configurator_core_src_roomle_configurator._internal_).PlanModelViewHelper

## Table of contents

### Methods

* [calculateLightSourceDistribution](#calculatelightsourcedistribution)
* [getExternalComponentModuleIdsForSelection](#getexternalcomponentmoduleidsforselection)
* [getExternalObjectComponent](#getexternalobjectcomponent)
* [getExternalObjectGroups](#getexternalobjectgroups)
* [getObjectComponent](#getobjectcomponent)
* [getPlanObject](#getplanobject)
* [getPlanOverview](#getplanoverview)
* [getRootPlanObjectId](#getrootplanobjectid)
* [requestMesh3d](#requestmesh3d)

## Methods

### calculateLightSourceDistribution

▸ **calculateLightSourceDistribution**(`plan`, `lightSourceConfiguration`): [`RoomLightSourceDistributionArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.roomlightsourcedistributionarray)

#### Parameters

| Name                       | Type                                                                                                                                                                                  |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`                     | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan)                                         |
| `lightSourceConfiguration` | [`LightSourceConfiguration`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.lightsourceconfiguration) |

#### Returns

[`RoomLightSourceDistributionArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.roomlightsourcedistributionarray)

***

### getExternalComponentModuleIdsForSelection

▸ **getExternalComponentModuleIdsForSelection**(`plan`, `groupOrRootModuleId`, `subModuleId`): [`ExternalModuleInformation`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.externalmoduleinformation)

#### Parameters

| Name                  | Type                                                                                                                                          |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`                | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan) |
| `groupOrRootModuleId` | `string`                                                                                                                                      |
| `subModuleId`         | `string`                                                                                                                                      |

#### Returns

[`ExternalModuleInformation`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.externalmoduleinformation)

***

### getExternalObjectComponent

▸ **getExternalObjectComponent**(`plan`, `groupId`, `moduleId`): [`KernelPlanObjectComponent`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent)

#### Parameters

| Name       | Type                                                                                                                                          |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`     | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan) |
| `groupId`  | `string`                                                                                                                                      |
| `moduleId` | `string`                                                                                                                                      |

#### Returns

[`KernelPlanObjectComponent`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent)

***

### getExternalObjectGroups

▸ **getExternalObjectGroups**(`plan`): [`KernelObjectConfigurationArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.kernelobjectconfigurationarray)

#### Parameters

| Name   | Type                                                                                                                                          |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan` | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan) |

#### Returns

[`KernelObjectConfigurationArray`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/classes/configurator_core_src_roomle_configurator._internal_.kernelobjectconfigurationarray)

***

### getObjectComponent

▸ **getObjectComponent**(`plan`, `aComponentOrConfigurationId`): [`KernelPlanObjectComponent`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent)

#### Parameters

| Name                          | Type                                                                                                                                          |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`                        | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan) |
| `aComponentOrConfigurationId` | `number`                                                                                                                                      |

#### Returns

[`KernelPlanObjectComponent`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobjectcomponent)

***

### getPlanObject

▸ **getPlanObject**(`plan`, `aRuntimeId`): [`KernelPlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobject)

#### Parameters

| Name         | Type                                                                                                                                          |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`       | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan) |
| `aRuntimeId` | `number`                                                                                                                                      |

#### Returns

[`KernelPlanObject`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/typings_kernel.kernelplanobject)

***

### getPlanOverview

▸ **getPlanOverview**(`planObject`): [`PlanOverview`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planoverview)

#### Parameters

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

#### Returns

[`PlanOverview`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planoverview)

***

### getRootPlanObjectId

▸ **getRootPlanObjectId**(`plan`, `aRuntimeId`): `number`

#### Parameters

| Name         | Type                                                                                                                                          |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `plan`       | [`Plan`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.plan) |
| `aRuntimeId` | `number`                                                                                                                                      |

#### Returns

`number`

***

### requestMesh3d

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

#### Parameters

| Name      | Type                                                                                                                                                        |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `element` | [`PlanElement`](https://docs.roomle.com/rubens/rubens-sdk/rubens-sdk-reference/interfaces/configurator_core_src_roomle_configurator._internal_.planelement) |

#### Returns

`void`