API ReferenceGlobalsRoomlePlanner

# Class: RoomlePlanner

# Hierarchy

  • RoomlePlanner

# Implements

# Index

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

+ new RoomlePlanner(creator: string): RoomlePlanner

Defined in packages/planner-core/src/roomle-planner.ts:141

Parameters:

Name Type
creator string

Returns: RoomlePlanner

# Properties

# creator

creator: string

Implementation of Context.creator

Defined in packages/planner-core/src/roomle-planner.ts:92

# Accessors

# PlannerCoreTypes

get PlannerCoreTypes(): PlannerKernelContainer

Defined in packages/planner-core/src/roomle-planner.ts:778

Returns: PlannerKernelContainer

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


# callbacks

get callbacks(): RoomlePlannerUiCallback

Defined in packages/planner-core/src/roomle-planner.ts:409

Returns: RoomlePlannerUiCallback

set callbacks(callback: RoomlePlannerUiCallback): void

Defined in packages/planner-core/src/roomle-planner.ts:413

Parameters:

Name Type
callback RoomlePlannerUiCallback

Returns: void

# Methods

# back

back(): void

Defined in packages/planner-core/src/roomle-planner.ts:428

Returns: void


# backTo

backTo(_cssClass: string): void

Defined in packages/planner-core/src/roomle-planner.ts:446

Parameters:

Name Type
_cssClass string

Returns: void


# backToPlanner

backToPlanner(): void

Defined in packages/planner-core/src/roomle-planner.ts:329

Returns: void


# cancelSelection

cancelSelection(): void

Defined in packages/planner-core/src/roomle-planner.ts:160

Returns: void


# deleteSelection

deleteSelection(): void

Defined in packages/planner-core/src/roomle-planner.ts:148

Returns: void


# disableRotation

disableRotation(): void

Defined in packages/planner-core/src/roomle-planner.ts:658

Disable rotation of selected elements

Returns: void


# disableSnapping

disableSnapping(): void

Defined in packages/planner-core/src/roomle-planner.ts:678

disable all types of snapping

Returns: void


# disableWallDrawing

disableWallDrawing(): void

Defined in packages/planner-core/src/roomle-planner.ts:764

Returns: void


# dragInObject

dragInObject(id: RapiId, dragEvent: DragEvent): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:662

Parameters:

Name Type
id RapiId
dragEvent DragEvent

Returns: Promise‹void›


# drawWalls

drawWalls(wallDefinitions: WallDefinition[], interactionOptions: InteractionOptions): KernelWall[]

Defined in packages/planner-core/src/roomle-planner.ts:714

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

Parameters:

Name Type Default
wallDefinitions WallDefinition[] -
interactionOptions InteractionOptions {}

Returns: KernelWall[]


# enableHD

enableHD(source?: DynamicLightSettingSource): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:273

Parameters:

Name Type
source? DynamicLightSettingSource

Returns: Promise‹void›


# enableRotation

enableRotation(): void

Defined in packages/planner-core/src/roomle-planner.ts:651

Enables rotation of selected elements

Returns: void


# enableSnapping

enableSnapping(): void

Defined in packages/planner-core/src/roomle-planner.ts:671

enable snapping of object to object and object to wall

Returns: void


# enableWallDrawing

enableWallDrawing(): void

Defined in packages/planner-core/src/roomle-planner.ts:760

Returns: void


# exportGLB

exportGLB(): void

Defined in packages/planner-core/src/roomle-planner.ts:236

Returns: void


# formatValueToUnitString

formatValueToUnitString(value: number, parameter: KernelParameter): string | number

Defined in packages/planner-core/src/roomle-planner.ts:706

Returns the formatted value based on the parameter.unitType

Parameters:

Name Type Description
value number -
parameter KernelParameter

Returns: string | number


# getCameraOffset

getCameraOffset(): CanvasOffset

Implementation of GlobalAPI

Defined in packages/planner-core/src/roomle-planner.ts:557

Returns: CanvasOffset


# getConfigurator

getConfigurator(): Configurator

Defined in packages/planner-core/src/roomle-planner.ts:450

Returns: Configurator


# getConfiguratorApi

getConfiguratorApi(): RoomleConfigurator

Defined in packages/planner-core/src/roomle-planner.ts:299

Returns: RoomleConfigurator


# getCurrentSkin

getCurrentSkin(): Promise‹RapiSkin

Defined in packages/planner-core/src/roomle-planner.ts:454

Returns: Promise‹RapiSkin


# getObjects

getObjects(): Promise‹UiPlanObject[]›

Defined in packages/planner-core/src/roomle-planner.ts:569

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

Returns: Promise‹UiPlanObject[]›


# getPartlistOf

getPartlistOf(id: number): Promise‹KernelPartList | null›

Defined in packages/planner-core/src/roomle-planner.ts:688

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 | null›

kernelPartlist with processed price, currency and RAL colors


# getPlanInteractionHandler

getPlanInteractionHandler(): Promise‹PlanInteractionHandler

Defined in packages/planner-core/src/roomle-planner.ts:503

Returns: Promise‹PlanInteractionHandler


# getPlanModelViewHelper

getPlanModelViewHelper(): Promise‹PlanModelViewHelper›

Defined in packages/planner-core/src/roomle-planner.ts:507

Returns: Promise‹PlanModelViewHelper›


# getPlanOverview

getPlanOverview(): Promise‹PlanOverview

Defined in packages/planner-core/src/roomle-planner.ts:627

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

Returns: Promise‹PlanOverview


# getRuntimeComponentIdOfRootComponent

getRuntimeComponentIdOfRootComponent(planObjectId: number): number

Implementation of KernelUtilityForUi

Defined in packages/planner-core/src/roomle-planner.ts:463

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


# getScene

getScene(): Scene

Implementation of GlobalAPI

Defined in packages/planner-core/src/roomle-planner.ts:549

Returns: Scene


# getUnitFormatter

getUnitFormatter(): UnitFormatter

Implementation of GlobalAPI

Defined in packages/planner-core/src/roomle-planner.ts:771

returns unit formatter for formatting input und output values in scene

Returns: UnitFormatter


# hasWalls

hasWalls(): boolean

Defined in packages/planner-core/src/roomle-planner.ts:748

Returns: boolean


# importGLB

importGLB(url: string): void

Defined in packages/planner-core/src/roomle-planner.ts:240

Parameters:

Name Type
url string

Returns: void


# init

init(element: HTMLElement, preloadPlanId?: string, options?: InitData): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:164

Parameters:

Name Type
element HTMLElement
preloadPlanId? string
options? InitData

Returns: Promise‹void›


# insertItemList

insertItemList(ids: RapiId[]): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:531

Parameters:

Name Type
ids RapiId[]

Returns: Promise‹void›


# insertItems

insertItems(itemList: RapiItem[]): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:545

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‹void›


# insertObject

insertObject(id: RapiId, position?: Position3, rotation?: number): Promise‹void | KernelObject

Defined in packages/planner-core/src/roomle-planner.ts:517

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

Parameters:

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

Returns: Promise‹void | KernelObject


# isReady

isReady(): void

Implementation of KernelAccessCallbackI

Defined in packages/planner-core/src/roomle-planner.ts:288

Returns: void


# loadError

loadError(error?: any): void

Implementation of KernelAccessCallbackI

Defined in packages/planner-core/src/roomle-planner.ts:499

Parameters:

Name Type
error? any

Returns: void


# loadPlan

loadPlan(id: string, options?: InitData): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:195

Parameters:

Name Type
id string
options? InitData

Returns: Promise‹void›


# loadPlanXml

loadPlanXml(xml: string, options?: InitData): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:177

Parameters:

Name Type
xml string
options? InitData

Returns: Promise‹void›


# onCloseHSC

onCloseHSC(): void

Defined in packages/planner-core/src/roomle-planner.ts:421

Returns: void


# preparePerspectiveImage

preparePerspectiveImage(options: PrepareImageOptions): Promise‹Base64Image

Defined in packages/planner-core/src/roomle-planner.ts:644

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

Parameters:

Name Type Default Description
options PrepareImageOptions {}

Returns: Promise‹Base64Image


# prepareTopImage

prepareTopImage(options: PrepareImageOptions): Promise‹Base64Image

Defined in packages/planner-core/src/roomle-planner.ts:636

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

Parameters:

Name Type Default Description
options PrepareImageOptions {}

Returns: Promise‹Base64Image


# removeElements

removeElements(kernelPlanElements: KernelObject[], interactionOptions: InteractionOptions): void

Defined in packages/planner-core/src/roomle-planner.ts:737

Parameters:

Name Type Default
kernelPlanElements KernelObject[] -
interactionOptions InteractionOptions {}

Returns: void


# rotateSelection

rotateSelection(rotateBy: number): void

Defined in packages/planner-core/src/roomle-planner.ts:156

rotates the selected item(s)

Parameters:

Name Type Description
rotateBy number angle in rad

Returns: void


# selectPlanObjectById

selectPlanObjectById(runtimeId: number): void

Defined in packages/planner-core/src/roomle-planner.ts:325

select an object in the scene based on its runtime id

Parameters:

Name Type Description
runtimeId number

Returns: void


# setCameraOffset

setCameraOffset(offset: CanvasOffset): void

Implementation of GlobalAPI

Defined in packages/planner-core/src/roomle-planner.ts:561

Parameters:

Name Type
offset CanvasOffset

Returns: void


# setOverrides

setOverrides(initData: InitDataDefinition & GlobalInitDataDefinition): void

Defined in packages/planner-core/src/roomle-planner.ts:215

Set general configuration parameter

Parameters:

Name Type Description
initData InitDataDefinition & GlobalInitDataDefinition

Returns: void


# setSceneEvents

setSceneEvents(sceneEvents: SceneEvents): void

Defined in packages/planner-core/src/roomle-planner.ts:786

set which events are enabled in the scene, for example disable selection of walls and wall nodes

Parameters:

Name Type Description
sceneEvents SceneEvents

Returns: void


# showBenchmarks

showBenchmarks(): void

Defined in packages/planner-core/src/roomle-planner.ts:295

Returns: void


# showStats

showStats(): void

Defined in packages/planner-core/src/roomle-planner.ts:417

Returns: void


# startConfiguring

startConfiguring(): void

Defined in packages/planner-core/src/roomle-planner.ts:312

Returns: void


# startViewing

startViewing(): void

Defined in packages/planner-core/src/roomle-planner.ts:308

Returns: void


# switch2D

switch2D(): void

Defined in packages/planner-core/src/roomle-planner.ts:224

Returns: void


# switch3D

switch3D(): void

Defined in packages/planner-core/src/roomle-planner.ts:228

Returns: void


# switchToConfigurator

switchToConfigurator(): Promise‹Configurator

Defined in packages/planner-core/src/roomle-planner.ts:333

Returns: Promise‹Configurator


# switchToFirstPerson

switchToFirstPerson(): void

Defined in packages/planner-core/src/roomle-planner.ts:232

Returns: void


# switchToPlanner

switchToPlanner(id?: string): void

Defined in packages/planner-core/src/roomle-planner.ts:378

Parameters:

Name Type
id? string

Returns: void


# switchToViewer

switchToViewer(): Promise‹GlbViewer

Defined in packages/planner-core/src/roomle-planner.ts:358

Returns: Promise‹GlbViewer


# syncCatalog

syncCatalog(catalogId: string): Promise‹void›

Defined in packages/planner-core/src/roomle-planner.ts:495

Parameters:

Name Type
catalogId string

Returns: Promise‹void›


# update

update(): void

Defined in packages/planner-core/src/roomle-planner.ts:399

Returns: void


# updateScene

updateScene(): void

Implementation of GlobalAPI

Defined in packages/planner-core/src/roomle-planner.ts:553

Returns: void


# updateSize

updateSize(): void

Implementation of GlobalAPI

Defined in packages/planner-core/src/roomle-planner.ts:385

Returns: void