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:100

Parameters:

Name Type
creator string

Returns: RoomlePlanner

# Properties

# creator

creator: string

Implementation of Context.creator

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

# Accessors

# callbacks

get callbacks(): RoomlePlannerUiCallback

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

Returns: RoomlePlannerUiCallback

set callbacks(callback: RoomlePlannerUiCallback): void

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

Parameters:

Name Type
callback RoomlePlannerUiCallback

Returns: void

# Methods

# back

back(): void

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

Returns: void


# backTo

backTo(cssClass: string): void

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

Parameters:

Name Type
cssClass string

Returns: void


# cancelSelection

cancelSelection(): void

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

Returns: void


# deleteSelection

deleteSelection(): void

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

Returns: void


# disableRotation

disableRotation(): void

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

Disable rotation of selected elements

Returns: void


# dragInObject

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

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

Parameters:

Name Type
id RapiId
dragEvent DragEvent

Returns: Promise‹void›


# enableHD

enableHD(): Promise‹void›

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

Returns: Promise‹void›


# enableRotation

enableRotation(): void

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

Enables rotation of selected elements

Returns: void


# exportGLB

exportGLB(): void

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

Returns: void


# getCameraOffset

getCameraOffset(): CanvasOffset

Implementation of GlobalAPI

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

Returns: CanvasOffset


# getConfigurator

getConfigurator(): Configurator

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

Returns: Configurator


# getCurrentSkin

getCurrentSkin(): Promise‹RapiSkin

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

Returns: Promise‹RapiSkin


# getObjects

getObjects(): Promise‹KernelPlanObject[]›

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

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

Returns: Promise‹KernelPlanObject[]›


# getPlanInteractionHandler

getPlanInteractionHandler(): Promise‹PlanInteractionHandler

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

Returns: Promise‹PlanInteractionHandler


# getPlanModelViewHelper

getPlanModelViewHelper(): Promise‹PlanModelViewHelper›

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

Returns: Promise‹PlanModelViewHelper›


# getPlanOverview

getPlanOverview(): Promise‹PlanOverview

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

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:388

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:465

Returns: Scene


# importGLB

importGLB(url: string): void

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

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:124

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:447

Parameters:

Name Type
ids RapiId[]

Returns: Promise‹void›


# insertItems

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

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

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:436

Parameters:

Name Type
id RapiId
position? Position3
rotation? number

Returns: Promise‹void | KernelObject


# isReady

isReady(): void

Implementation of KernelAccessCallbackI

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

Returns: void


# loadError

loadError(error?: any): void

Implementation of KernelAccessCallbackI

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

Parameters:

Name Type
error? any

Returns: void


# loadPlan

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

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

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:137

Parameters:

Name Type
xml string
options? InitData

Returns: Promise‹void›


# onBackStackChanged

onBackStackChanged(currentStack: string[]): void

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

Parameters:

Name Type
currentStack string[]

Returns: void


# onCloseHSC

onCloseHSC(): void

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

Returns: void


# preparePerspectiveImage

preparePerspectiveImage(options: PrepareImageOptions): Promise‹Base64Image

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

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:508

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

Parameters:

Name Type Default Description
options PrepareImageOptions {}

Returns: Promise‹Base64Image


# rotateSelection

rotateSelection(rotateBy: number): void

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

rotates the selected item(s)

Parameters:

Name Type Description
rotateBy number angle in rad

Returns: void


# setCameraOffset

setCameraOffset(offset: CanvasOffset): void

Implementation of GlobalAPI

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

Parameters:

Name Type
offset CanvasOffset

Returns: void


# setOverrides

setOverrides(initData: InitDataDefinition & GlobalInitDataDefinition): void

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

Set general configuration parameter

Parameters:

Name Type Description
initData InitDataDefinition & GlobalInitDataDefinition

Returns: void


# showBenchmarks

showBenchmarks(): void

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

Returns: void


# showStats

showStats(): void

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

Returns: void


# switch2D

switch2D(): void

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

Returns: void


# switch3D

switch3D(): void

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

Returns: void


# switchToConfigurator

switchToConfigurator(): Promise‹Configurator

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

Returns: Promise‹Configurator


# switchToFirstPerson

switchToFirstPerson(): void

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

Returns: void


# switchToPlanner

switchToPlanner(id?: string): void

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

Parameters:

Name Type
id? string

Returns: void


# switchToViewer

switchToViewer(): Promise‹GlbViewer

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

Returns: Promise‹GlbViewer


# syncCatalog

syncCatalog(catalogId: string): Promise‹void›

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

Parameters:

Name Type
catalogId string

Returns: Promise‹void›


# update

update(): void

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

Returns: void


# updateScene

updateScene(): void

Implementation of GlobalAPI

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

Returns: void


# updateSize

updateSize(): void

Implementation of GlobalAPI

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

Returns: void