# Class: default

planner-core/src/roomle-planner.default

Shared API between configurator and planner

# Implements

# Table of contents

# Constructors

constructor

# Properties

_creator_

# Accessors

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name	Type
`creator`	`string`

# Defined in

packages/planner-core/src/roomle-planner.ts:203 (opens new window)

# Properties

# _creator_

• _creator_: string

# Implementation of

Context.creator

# Defined in

packages/planner-core/src/roomle-planner.ts:149 (opens new window)

# Accessors

# PlannerCoreTypes

• get PlannerCoreTypes(): PlannerKernelContainer

# Returns

PlannerKernelContainer

an object which has all type constants from Roomle Core (C/C++)

# Defined in

packages/planner-core/src/roomle-planner.ts:956 (opens new window)

# callbacks

• get callbacks(): default

• set callbacks(callback): void

# Parameters

Name	Type
`callback`	`default`

# Returns

void

# Implementation of

ExternalEmbeddable.callbacks

# Defined in

packages/planner-core/src/roomle-planner.ts:531 (opens new window)

# Methods

# back

▸ back(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:545 (opens new window)

# backTo

▸ backTo(_cssClass): void

# Parameters

Name	Type
`_cssClass`	`string`

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:561 (opens new window)

# backToPlanner

▸ backToPlanner(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:424 (opens new window)

# calcPartsPriceSum

▸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>

# Parameters

Name	Type
`partList`	`KernelPartList`

# Returns

Promise<KernelPartListPrice>

# Defined in

packages/planner-core/src/roomle-planner.ts:1112 (opens new window)

# cancelSelection

▸ cancelSelection(reason?): void

# Parameters

Name	Type	Default value
`reason`	`CancelSelectionReasons`	`'unknown'`

# Returns

void

# Implementation of

RoomlePlannerCallback.cancelSelection

# Defined in

packages/planner-core/src/roomle-planner.ts:235 (opens new window)

# changeExteriorWallsMaterial

▸ changeExteriorWallsMaterial(material): void

# Parameters

Name	Type
`material`	`BatchPaintMaterial`

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1096 (opens new window)

# changeFloorsMaterial

▸ changeFloorsMaterial(material): void

# Parameters

Name	Type
`material`	`BatchPaintMaterial`

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1100 (opens new window)

# changeInteriorWallsMaterial

▸ changeInteriorWallsMaterial(material): void

# Parameters

Name	Type
`material`	`BatchPaintMaterial`

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1092 (opens new window)

# createNewSerializedConfiguration

▸ createNewSerializedConfiguration(configurationRuntimeId): Promise<string>

# Parameters

Name	Type
`configurationRuntimeId`	`number`

# Returns

Promise<string>

# Defined in

packages/planner-core/src/roomle-planner.ts:1082 (opens new window)

# deleteSelection

▸ deleteSelection(): void

# Returns

void

# Implementation of

RoomlePlannerCallback.deleteSelection

# Defined in

packages/planner-core/src/roomle-planner.ts:223 (opens new window)

# disableMeasurementLineDrawing

▸ disableMeasurementLineDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1208 (opens new window)

# disableMultiselect

▸ disableMultiselect(): void

Disable the selection of multiple elements.

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:776 (opens new window)

# disableRotation

▸ disableRotation(): void

Disable rotation of selected elements

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:757 (opens new window)

# disableSnapping

▸ disableSnapping(): void

disable all types of snapping

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:811 (opens new window)

# disableWallDrawing

▸ disableWallDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:928 (opens new window)

# dragInObject

▸ dragInObject(id, dragEvent): Promise<number>

# Parameters

Name	Type
`id`	`string`
`dragEvent`	`DragEvent`

# Returns

Promise<number>

# Defined in

packages/planner-core/src/roomle-planner.ts:787 (opens new window)

# drawWalls

▸ drawWalls(wallDefinitions, interactionOptions?): KernelWall[]

Draws walls according to the wall definitions this can be used to create a room on the fly

# Parameters

Name	Type
`wallDefinitions`	`WallDefinition`[]
`interactionOptions`	`InteractionOptions`

# Returns

KernelWall[]

# Defined in

packages/planner-core/src/roomle-planner.ts:854 (opens new window)

# duplicateItems

▸ duplicateItems(itemList): PlanObject[]

Duplicates all planObjects in the array and inserts them into the current plan

# Parameters

Name	Type	Description
`itemList`	`PlanObject`[]	Array of PlanObjects

# Returns

PlanObject[]

# Defined in

packages/planner-core/src/roomle-planner.ts:685 (opens new window)

# enableMeasurementLineDrawing

▸ enableMeasurementLineDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1204 (opens new window)

# enableMultiselect

▸ enableMultiselect(): void

Enable the selection of multiple elements. Common parameters shared between those elements can then be changed at once

# Returns

void

# Implementation of

RubensAPI.enableMultiselect

# Defined in

packages/planner-core/src/roomle-planner.ts:766 (opens new window)

# enableRotation

▸ enableRotation(): void

Enables rotation of selected elements

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:750 (opens new window)

# enableSnapping

▸ enableSnapping(): void

enable snapping of object to object and object to wall

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:804 (opens new window)

# enableWallDrawing

▸ enableWallDrawing(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:924 (opens new window)

# escapeDrawing

▸ escapeDrawing(cancelDrawing): void

# Parameters

Name	Type
`cancelDrawing`	`boolean`

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1248 (opens new window)

# exportGLB

▸ exportGLB(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:341 (opens new window)

# exportImageFromCamera

▸ exportImageFromCamera(filename?, shouldWaitForAssets?): Promise<void>

# Parameters

Name	Type	Default value
`filename`	`string`	`'image'`
`shouldWaitForAssets`	`boolean`	`false`

# Returns

Promise<void>

# Implementation of

RubensAPI.exportImageFromCamera

# Defined in

packages/planner-core/src/roomle-planner.ts:1137 (opens new window)

# formatValueToUnitString

▸ formatValueToUnitString(value, parameter): string | number

Returns the formatted value based on the parameter.unitType

# Parameters

Name	Type
`value`	`number`
`parameter`	`KernelParameter`

# Returns

string | number

# Defined in

packages/planner-core/src/roomle-planner.ts:846 (opens new window)

# generateTCExport

▸ generateTCExport(planObjectIds?): Promise<any>

# Parameters

Name	Type	Default value
`planObjectIds`	`string`[]	`[]`

# Returns

Promise<any>

# Defined in

packages/planner-core/src/roomle-planner.ts:1186 (opens new window)

# getCameraOffset

▸ getCameraOffset(): CanvasOffset

Gets the available screen space for our item default: 'left: 0, top: 1, right: 1, bottom: 0'

# Returns

CanvasOffset

# Implementation of

GlobalAPI.getCameraOffset

# Defined in

packages/planner-core/src/roomle-planner.ts:697 (opens new window)

# getConfigurator

▸ getConfigurator(): Configurator

# Returns

Configurator

# Defined in

packages/planner-core/src/roomle-planner.ts:565 (opens new window)

# getConfiguratorApi

▸ getConfiguratorApi(): default

# Returns

default

# Defined in

packages/planner-core/src/roomle-planner.ts:394 (opens new window)

# getConfiguratorContext

▸ getConfiguratorContext(): default

returns class containing configurator specific data properties

# Returns

default

# Defined in

packages/planner-core/src/roomle-planner.ts:949 (opens new window)

# getCurrentSkin

▸ getCurrentSkin(): Promise<RapiSkin>

# Returns

Promise<RapiSkin>

# Defined in

packages/planner-core/src/roomle-planner.ts:569 (opens new window)

# getObjects

▸ getObjects(): Promise<UiPlanObject[]>

returns all objects found in the current plan this includes info about size, rotation, id and parts

# Returns

Promise<UiPlanObject[]>

# Defined in

packages/planner-core/src/roomle-planner.ts:709 (opens new window)

# getPartlistOf

▸ getPartlistOf(id): Promise<KernelPartList>

get the Partlist of certain runtimeID can be used if partlist of a selected Item is needed

# Parameters

Name	Type	Description
`id`	`number`	runtimeID of a configurable item

# Returns

Promise<KernelPartList>

kernelPartlist with processed price, currency and RAL colors

# Defined in

packages/planner-core/src/roomle-planner.ts:821 (opens new window)

# getPlanInteractionHandler

▸ getPlanInteractionHandler(): Promise<PlanInteractionHandler>

# Returns

Promise<PlanInteractionHandler>

# Defined in

packages/planner-core/src/roomle-planner.ts:622 (opens new window)

# getPlanModelViewHelper

▸ getPlanModelViewHelper(): Promise<PlanModelViewHelper>

# Returns

Promise<PlanModelViewHelper>

# Defined in

packages/planner-core/src/roomle-planner.ts:626 (opens new window)

# getPlanOverview

▸ getPlanOverview(): Promise<PlanOverview>

get all info available for the current plan, including objects, rooms and walls

# Returns

Promise<PlanOverview>

# Defined in

packages/planner-core/src/roomle-planner.ts:724 (opens new window)

# getPlanXmlFrom

▸ getPlanXmlFrom(plan): any

# Parameters

Name	Type
`plan`	`RapiPlan` \| `RapiPlanSnapshotGetData`

# Returns

any

# Defined in

packages/planner-core/src/roomle-planner.ts:1071 (opens new window)

# getRuntimeComponentIdOfRootComponent

▸ getRuntimeComponentIdOfRootComponent(planObjectId): number

Returns the runtime component id of the plan object with the given id

# Parameters

Name	Type	Description
`planObjectId`	`number`	id of the plan object you want to get the runtime component id of the root component from

# Returns

number

number the number of the runtime id of the root component

# Implementation of

KernelUtilityForUi.getRuntimeComponentIdOfRootComponent

# Defined in

packages/planner-core/src/roomle-planner.ts:578 (opens new window)

# getScene

▸ getScene(): Scene

Returns the three.js scene (https://threejs.org/docs/#api/en/scenes/Scene) WARNING: This is the actual scene (reference) and not a copy!

# Returns

Scene

# Implementation of

GlobalAPI.getScene

# Defined in

packages/planner-core/src/roomle-planner.ts:689 (opens new window)

# getStorage

▸ getStorage(): default

returns manager class to interface with indexedDB storage

# Returns

default

# Implementation of

RubensAPI.getStorage

# Defined in

packages/planner-core/src/roomle-planner.ts:942 (opens new window)

# getUnitFormatter

▸ getUnitFormatter(): default

returns unit formatter for formatting input und output values in scene

# Returns

default

# Implementation of

GlobalAPI.getUnitFormatter

# Defined in

packages/planner-core/src/roomle-planner.ts:935 (opens new window)

# getWallAngleDegrees

▸ getWallAngleDegrees(wall): number

Returns the wall angle in degrees relative to the camera

# Parameters

Name	Type	Description
`wall`	`default`	a WallPlanElementViewModel instance

# Returns

number

# Defined in

packages/planner-core/src/roomle-planner.ts:1108 (opens new window)

# hasWalls

▸ hasWalls(): boolean

# Returns

boolean

# Defined in

packages/planner-core/src/roomle-planner.ts:912 (opens new window)

# importGLB

▸ importGLB(url): void

# Parameters

Name	Type
`url`	`string`

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:345 (opens new window)

# init

▸ init(element, preloadPlanId?, options?): Promise<void>

# Parameters

Name	Type
`element`	`HTMLElement`
`preloadPlanId?`	`string`
`options?`	`InitDataDefinition` & `GlobalInitDataDefinition`

# Returns

Promise<void>

# Defined in

packages/planner-core/src/roomle-planner.ts:239 (opens new window)

# insertItemList

▸ insertItemList(ids): Promise<number[]>

# Parameters

Name	Type
`ids`	`string`[]

# Returns

Promise<number[]>

# Defined in

packages/planner-core/src/roomle-planner.ts:661 (opens new window)

# insertItems

▸ insertItems(itemList): Promise<number[]>

Inserts all of the items in the array into current plan

# Parameters

Name	Type	Description
`itemList`	`RapiItem`[]	Array of items received from the Roomle API

# Returns

Promise<number[]>

# Defined in

packages/planner-core/src/roomle-planner.ts:677 (opens new window)

# insertObject

▸ insertObject(id, position?, rotation?): Promise<number>

Inserts the object into the scene (at a given position and rotation)

# Parameters

Name	Type	Description
`id`	`string`
`position?`	`Position3`	x (left/right),y (up, down) and z(front, back) in meters
`rotation?`	`number`	in radians

# Returns

Promise<number>

# Defined in

packages/planner-core/src/roomle-planner.ts:636 (opens new window)

# isCurrentlyDrawing

▸ isCurrentlyDrawing(): boolean

# Returns

boolean

# Defined in

packages/planner-core/src/roomle-planner.ts:1253 (opens new window)

# isReady

▸ isReady(): void

# Returns

void

# Implementation of

KernelAccessCallbackI.isReady

# Defined in

packages/planner-core/src/roomle-planner.ts:382 (opens new window)

# loadError

▸ loadError(error?): void

# Parameters

Name	Type
`error?`	`any`

# Returns

void

# Implementation of

KernelAccessCallbackI.loadError

# Defined in

packages/planner-core/src/roomle-planner.ts:618 (opens new window)

# loadPlan

▸ loadPlan(id, options?): Promise<RapiPlan | RapiPlanSnapshotGetData>

# Parameters

Name	Type
`id`	`string`
`options?`	`InitDataDefinition` & `GlobalInitDataDefinition`

# Returns

Promise<RapiPlan | RapiPlanSnapshotGetData>

# Defined in

packages/planner-core/src/roomle-planner.ts:280 (opens new window)

# loadPlanXml

▸ loadPlanXml(xml, options?): Promise<void>

# Parameters

Name	Type
`xml`	`string`
`options?`	`InitDataDefinition` & `GlobalInitDataDefinition`

# Returns

Promise<void>

# Defined in

packages/planner-core/src/roomle-planner.ts:256 (opens new window)

# moveCamera

▸ moveCamera(cameraParameter): Promise<void>

# Parameters

Name	Type
`cameraParameter`	`CameraParameter`

# Returns

Promise<void>

# Defined in

packages/planner-core/src/roomle-planner.ts:1078 (opens new window)

# moveElementPosition

▸ moveElementPosition(selectedElement, position): void

Move the current selected element in the 3D space

# Parameters

Name	Type	Description
`selectedElement`	`default`	this is the current selected plan object
`position`	`KernelVector3`	new KernelVector3 position of the current selected element returns runtime ID of the new object

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1153 (opens new window)

# moveElementsPosition

▸ moveElementsPosition(selectedElements, position): void

Moves the current multi-selected elements in the 3D space

# Parameters

Name	Type	Description
`selectedElements`	`default`[]	this is the current selected plan object
`position`	`KernelVector3`	new KernelVector3 position of the current selected element returns runtime ID of the new object

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:1166 (opens new window)

# onCloseHSC

▸ onCloseHSC(): void

# Returns

void

# Defined in

packages/planner-core/src/roomle-planner.ts:539 (opens new window)

# preparePerspectiveImage

▸ preparePerspectiveImage(options?): Promise<Base64Image>

Generates a perspective image (slightly from the side) and returns it as base64

# Parameters

Name	Type
`options`	`PrepareImageOptions`

# Returns

Promise<Base64Image>

# Defined in

packages/planner-core/src/roomle-planner.ts:743 (opens new window)

# preparePerspectiveImageOf

▸ preparePerspectiveImageOf(runtimeId, options?): Promise<Base64Image>

Generates a perspective image (slightly from the side) of a plan element by a given runtime-id and returns it as base64

# Parameters

Name	Type	Description
`runtimeId`	`number`	runtime-id of the plan element, e.g.: a selected element
`options`	`PrepareImageOptions`	PrepareImageOptions

# Returns

Promise<Base64Image>

# Defined in

packages/planner-core/src/roomle-planner.ts:1179 (opens new window)

# prepareTopImage

▸ prepareTopImage(options?): Promise<Base64Image>

Generates a top image (birds eye view) and returns it as base64

# Parameters

Name	Type
`options`	`PrepareImageOptions`

# Returns

Promise<Base64Image>

# Defined in

packages/planner-core/src/roomle-planner.ts:735 (opens new window)

# removeElements

▸ removeElements(kernelPlanElements, interactionOptions?): Promise<void>

# Parameters

Name	Type
`kernelPlanElements`	`KernelObject`[]
`interactionOptions`	`InteractionOptions`

# Returns

Promise<void>

# Defined in

packages/planner-core/src/roomle-planner.ts:884 (opens new window)

# resetCameraPosition

▸ resetCameraPosition(): void

# Returns

void

# Implementation of

RubensAPI.resetCameraPosition

# Defined in

packages/planner-core/src/roomle-planner.ts:337 (opens new window)

# rotateSelection

▸ rotateSelection(rotateBy): void

rotates the selected item(s)

# Parameters

Name	Type	Description
`rotateBy`	`number`	angle in rad

# Returns

void

# Implementation of

RoomlePlannerCallback.rotateSelection

# Defined in

packages/planner-core/src/roomle-planner.ts:231 (opens new window)

# saveCurrentPlanSnapshot

▸ saveCurrentPlanSnapshot(parentPlanId?): Promise<RapiPlanSnapshotGetData>

# Parameters

Name	Type
`parentPlanId?`	`string`

# Returns

Promise<RapiPlanSnapshotGetData>

# Defined in

packages/planner-core/src/roomle-planner.ts:968 (opens new window)

# selectPlanObjectById

▸ selectPlanObjectById(runtimeId): Promise<void>

select an object in the scene based on its runtime id

# Parameters

Name	Type
`runtimeId`	`number`

# Returns

Promise<void>

# Defined in

packages/planner-core/src/roomle-planner.ts:420 (opens new window)

# setCameraOffset

▸ setCameraOffset(offset): void

Sets the available screen space for our item Example 1: right 0.9 means 10% padding on the right side Example 2: bottom 0.2 means 20% padding on the bottom side default: 'left: 0, top: 1, right: 1, bottom: 0'