RoomlePlanner.default
planner-core/src/roomle-planner.default
Shared API between configurator and planner
Type parameters
P
extends readonly PluginName[] = readonly []
Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new default<P>(creator, activePlugins?)
Type parameters
P
extends readonly "external-objects"[] = readonly []
Parameters
creator
string
activePlugins?
P
Properties
_creator_
• _creator_: string
Implementation of
Accessors
PlannerCoreTypes
• get PlannerCoreTypes(): PlannerKernelContainer
Returns
an object which has all type constants from Roomle Core (C/C++)
callbacks
• get callbacks(): default
Returns
Implementation of
• set callbacks(callback): void
Parameters
callback
Returns
void
Implementation of
hasSingleRoom
• get hasSingleRoom(): boolean
Check if the 3D scene contains only one room
Returns
boolean
True if there is only one room, false otherwise
Methods
_selectExternalObjectGroup
â–¸ _selectExternalObjectGroup(groupId, switchToPlanner): Promise<void>
Parameters
groupId
string
switchToPlanner
boolean
Returns
Promise<void>
_selectExternalObjectModule
â–¸ _selectExternalObjectModule(rootModuleId, subModuleId, selectPlanObject, switchToConfigurator, selectComponent, highlightSelection): Promise<void>
Parameters
rootModuleId
string
subModuleId
string
selectPlanObject
boolean
switchToConfigurator
boolean
selectComponent
boolean
highlightSelection
boolean
Returns
Promise<void>
addAtticToWall
â–¸ addAtticToWall(wall, kneeHeight, width, preferredSide?): KernelAttic
Creates a sloping roof attic on a given wall.
Parameters
kneeHeight
number
Height of the attic knee wall.
width
number
Width of the sloping roof.
Returns
The newly created attic.
back
â–¸ back(): void
Returns
void
backTo
â–¸ backTo(_cssClass): void
Parameters
_cssClass
string
Returns
void
backToPlanner
â–¸ backToPlanner(): void
Returns
void
calcPartsPriceSum
â–¸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>
Parameters
partList
Returns
Promise<KernelPartListPrice>
cancelSelection
â–¸ cancelSelection(reason?): void
Parameters
Returns
void
Implementation of
RoomlePlannerCallback.cancelSelection
changeExteriorWallsMaterial
â–¸ changeExteriorWallsMaterial(material): void
Parameters
material
Returns
void
changeFloorsMaterial
â–¸ changeFloorsMaterial(material): void
Parameters
material
Returns
void
changeInteriorWallsMaterial
â–¸ changeInteriorWallsMaterial(material): void
Parameters
material
Returns
void
configureExternalObjectApi
â–¸ configureExternalObjectApi(configurationJson): Promise<void>
With "configureExternalObjectApi" the default representation of the objects and UI and the default behavior when interacting with external objects can be completely or partially overwritten. This configuration should be set prior to loading plans or objects.
Parameters
Returns
Promise<void>
Implementation of
ExternalObjectAPI.configureExternalObjectApi
createNewSerializedConfiguration
â–¸ createNewSerializedConfiguration(configurationRuntimeId): Promise<string>
Parameters
configurationRuntimeId
number
Returns
Promise<string>
createPlanFromObject
â–¸ createPlanFromObject(id, position?, rotation?): Promise<number>
creates and loads a plan from a given object
Parameters
Returns
Promise<number>
deleteSelection
â–¸ deleteSelection(): void
Returns
void
Implementation of
RoomlePlannerCallback.deleteSelection
disableAdvancedDocking
â–¸ disableAdvancedDocking(): void
disable docking of objects that fit together when objects are snapped in the plan
Returns
void
disableEvents
â–¸ disableEvents(): void
Returns
void
disableMeasurementLineDrawing
â–¸ disableMeasurementLineDrawing(): void
Returns
void
disableMultiselect
â–¸ disableMultiselect(): void
Disable the selection of multiple elements.
Returns
void
disableRotation
â–¸ disableRotation(): void
Disable rotation of selected elements
Returns
void
disableShowChildrenOfPlanObject
â–¸ disableShowChildrenOfPlanObject(planElementViewModel): void
disable interaction with child components of configurable objects in the plan
Parameters
planElementViewModel
Returns
void
disableSnapping
â–¸ disableSnapping(): void
disable all types of snapping
Returns
void
disableWallDrawing
â–¸ disableWallDrawing(): void
Returns
void
downloadHomagIxExportPoC
â–¸ downloadHomagIxExportPoC(): Promise<any>
Returns
Promise<any>
dragInObject
â–¸ dragInObject(idOrSerializedConfigString, dragEvent, type?): Promise<number>
Parameters
Returns
Promise<number>
drawWalls
â–¸ drawWalls(wallDefinitions, interactionOptions?): KernelWall[]
Draws walls according to the wall definitions this can be used to create a room on the fly
Parameters
wallDefinitions
interactionOptions
Returns
duplicateItems
â–¸ duplicateItems(itemList): PlanObject[]
Duplicates all planObjects in the array and inserts them into the current plan
Parameters
Returns
enableAdvancedDocking
â–¸ enableAdvancedDocking(): void
enable docking of objects that fit together when objects are snapped in the plan
Returns
void
enableEvents
â–¸ enableEvents(): void
Returns
void
enableMeasurementLineDrawing
â–¸ enableMeasurementLineDrawing(): void
Returns
void
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
enableRotation
â–¸ enableRotation(): void
Enables rotation of selected elements
Returns
void
enableShowChildrenOfPlanObject
â–¸ enableShowChildrenOfPlanObject(planElementViewModel): void
enable interaction with child components of configurable objects in the plan
Parameters
planElementViewModel
Returns
void
enableSnapping
â–¸ enableSnapping(): void
enable snapping of object to object and object to wall
Returns
void
enableWallDrawing
â–¸ enableWallDrawing(): void
Returns
void
escapeDrawing
â–¸ escapeDrawing(cancelDrawing): void
Parameters
cancelDrawing
boolean
Returns
void
exportCanvasScreenshot
â–¸ exportCanvasScreenshot(quality?): Promise<string>
Parameters
quality?
number
Returns
Promise<string>
Implementation of
RubensAPI.exportCanvasScreenshot
exportGLB
â–¸ exportGLB(): void
Returns
void
exportImageFromCamera
â–¸ exportImageFromCamera(filename?, shouldWaitForAssets?): Promise<void>
Parameters
filename
string
'image'
shouldWaitForAssets
boolean
false
Returns
Promise<void>
Implementation of
RubensAPI.exportImageFromCamera
formatValueToUnitString
â–¸ formatValueToUnitString(value, parameter): string | number
Returns the formatted value based on the parameter.unitType
Parameters
value
number
parameter
Returns
string | number
generateTCExport
â–¸ generateTCExport(planObjectIds?): Promise<any>
Parameters
planObjectIds
string[]
[]
Returns
Promise<any>
getAttachedAttic
â–¸ getAttachedAttic(wall): KernelAttic
Gets the attached attic from a wall.
Parameters
Returns
The first attached attic or null.
getCameraOffset
â–¸ getCameraOffset(): CanvasOffset
Gets the available screen space for our item default: 'left: 0, top: 1, right: 1, bottom: 0'
Returns
Implementation of
getConfigurator
â–¸ getConfigurator(): Configurator
Returns
getConfiguratorApi
â–¸ getConfiguratorApi(): default<P>
Returns
default<P>
getConfiguratorContext
â–¸ getConfiguratorContext(): default
returns class containing configurator specific data properties
Returns
getCurrentSkin
â–¸ getCurrentSkin(): Promise<RapiSkin>
Returns
Promise<RapiSkin>
getExternalObjectGroups
â–¸ getExternalObjectGroups(): Promise<object[]>
"getExternalObjectGroups" returns all groups of external objects modules (PosData) that are currently loaded in the plan.
Returns
Promise<object[]>
Implementation of
ExternalObjectAPI.getExternalObjectGroups
getObjects
â–¸ getObjects(): Promise<UiPlanObject[]>
returns all objects found in the current plan this includes info about size, rotation, id and parts
Returns
Promise<UiPlanObject[]>
getPartlistOf
â–¸ getPartlistOf(id): Promise<KernelPartList>
get the Partlist of certain runtimeID can be used if partlist of a selected Item is needed
Parameters
id
number
runtimeID of a configurable item
Returns
Promise<KernelPartList>
kernelPartlist with processed price, currency and RAL colors
getPlanInteractionHandler
â–¸ getPlanInteractionHandler(): Promise<PlanInteractionHandler>
Returns
Promise<PlanInteractionHandler>
getPlanModelViewHelper
â–¸ getPlanModelViewHelper(): Promise<PlanModelViewHelper>
Returns
Promise<PlanModelViewHelper>
getPlanOverview
â–¸ getPlanOverview(): Promise<PlanOverview>
get all info available for the current plan, including objects, rooms and walls
Returns
Promise<PlanOverview>
getPlanXmlFrom
â–¸ getPlanXmlFrom(plan): any
Parameters
Returns
any
getRuntimeComponentIdOfRootComponent
â–¸ getRuntimeComponentIdOfRootComponent(planObjectId): number
Returns the runtime component id of the plan object with the given id
Parameters
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
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
getStorage
â–¸ getStorage(): default
returns manager class to interface with indexedDB storage
Returns
Implementation of
getUnitFormatter
â–¸ getUnitFormatter(): default
returns unit formatter for formatting input und output values in scene
Returns
Implementation of
getWallAngleDegrees
â–¸ getWallAngleDegrees(wall): number
Returns the wall angle in degrees relative to the camera
Parameters
Returns
number
hasWalls
â–¸ hasWalls(): boolean
Returns
boolean
highlightPlanElements
â–¸ highlightPlanElements(runtimeIds): void
Highlights one or more objects in the scene based on their runtime IDs.
If runtimeIds is null, all highlighted objects will be unhighlighted.
Parameters
runtimeIds
number | number[]
A single runtime ID, an array of runtime IDs, or null.
Returns
void
importGLB
â–¸ importGLB(url): void
Parameters
url
string
Returns
void
init
â–¸ init(element, preloadPlanId?, options?): Promise<void>
Parameters
Returns
Promise<void>
insertItemList
â–¸ insertItemList(ids): Promise<number[]>
Parameters
ids
string[]
Returns
Promise<number[]>
insertItems
â–¸ insertItems(itemList): Promise<number[]>
Inserts all of the items in the array into current plan
Parameters
itemList
(RapiItem | RapiConfiguration | `__ext__obj__#${string}` | ExternalObject)[]
Array of items received from the Roomle API
Returns
Promise<number[]>
insertObject
â–¸ insertObject(id, position?, rotation?): Promise<number>
Inserts the object into the scene (at a given position and rotation)
Parameters
id
string
rotation?
number
in radians
Returns
Promise<number>
isCurrentlyDrawing
â–¸ isCurrentlyDrawing(): boolean
Returns
boolean
isReady
â–¸ isReady(): void
Returns
void
Implementation of
loadError
â–¸ loadError(error?): void
Parameters
error?
any
Returns
void
Implementation of
KernelAccessCallbackI.loadError
loadExternalObjectGroup
â–¸ loadExternalObjectGroup(groupData, findFreeSpaceInPlan, verifyArrangement?, mergedGroups?): Promise<void>
"loadExternalObjectGroup" loads a group of modules and places them in the plan. If the group has already been loaded, it is completely replaced by the new group. This function therefore has 2 use cases:
Load a new group of modules
Update or modify an existing group of modules The initial location of the group and the IDs of the modules are defined in the group JSON.
Parameters
findFreeSpaceInPlan
boolean
undefined
A free space is automatically searched for in the plane.
verifyArrangement
boolean
false
Verify whether the root modules of the group need to be rearranged as they have changed in size.
mergedGroups
string[]
[]
Groups that were merged into another group and have to be delete (this is required to generate correct undo/redo steps).
Returns
Promise<void>
Implementation of
ExternalObjectAPI.loadExternalObjectGroup
loadExternalObjectLibrary
â–¸ loadExternalObjectLibrary(libraryJson): void
"loadExternalObjectLibrary" loads the master data of a library. If master data has already been loaded for the library, it is completely replaced by the new master data.
Parameters
libraryJson
string | object
The library JSON as string or object.
Returns
void
Implementation of
ExternalObjectAPI.loadExternalObjectLibrary
loadPlan
â–¸ loadPlan(id, options?): Promise<RapiPlan | RapiPlanSnapshotGetData>
Parameters
id
string
options?
Returns
Promise<RapiPlan | RapiPlanSnapshotGetData>
loadPlanXml
â–¸ loadPlanXml(xml, options?): Promise<void>
Parameters
xml
string
options?
Returns
Promise<void>
moveCamera
â–¸ moveCamera(cameraParameter): Promise<void>
Parameters
cameraParameter
Returns
Promise<void>
moveElementPosition
â–¸ moveElementPosition(selectedElement, position): void
Move the current selected element in the 3D space
Parameters
position
new KernelVector3 position of the current selected element returns runtime ID of the new object
Returns
void
moveElementsPosition
â–¸ moveElementsPosition(selectedElements, position): void
Moves the current multi-selected elements in the 3D space
Parameters
position
new KernelVector3 position of the current selected element returns runtime ID of the new object
Returns
void
onCloseHSC
â–¸ onCloseHSC(): void
Returns
void
openOrCloseGeometryOfExternalObject
â–¸ openOrCloseGeometryOfExternalObject(groupIdOrRootModuleId, subModuleId, open, animate): Promise<void>
"openOrCloseGeometryOfExternalObject" switches the geometry of the modules between closed and open representation. The function can switch the geometry of the group or the singe root module with the ID "groupIdOrRootModuleId". If "groupIdOrRootModuleId" is the ID of a root module and the "subModuleId" is also specified, only this one sub-module is opened or closed.
Parameters
groupIdOrRootModuleId
string
The ID of the group of modules or the ID of the root module.
subModuleId
string
The ID of the sub module.
open
boolean
If true, the modules are opened, if false, they are closed, if the geometry is already in the desired state, nothing happens.
animate
boolean
If true the opening or closing is animated else the geometry is switched instantly.
Returns
Promise<void>
Implementation of
ExternalObjectAPI.openOrCloseGeometryOfExternalObject
preparePerspectiveImage
â–¸ preparePerspectiveImage(options?, isolationMode?): Promise<Base64Image>
Generates a perspective image (slightly from the side) and returns it as base64
Parameters
isolationMode
boolean
false
defaults to false. Determines whether to generate a perspective image for the current configuration.
Returns
Promise<Base64Image>
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
runtimeId
number
runtime-id of the plan element, e.g.: a selected element
Returns
Promise<Base64Image>
prepareTopImage
â–¸ prepareTopImage(options?): Promise<Base64Image>
Generates a top image (birds eye view) and returns it as base64
Parameters
options
Returns
Promise<Base64Image>
removeAttic
â–¸ removeAttic(attic): void
Removes an attic from a wall.
Parameters
Returns
void
removeElements
â–¸ removeElements(kernelPlanElements, interactionOptions?): Promise<void>
Parameters
kernelPlanElements
interactionOptions
Returns
Promise<void>
removeExternalObjectGroup
â–¸ removeExternalObjectGroup(groupId, wasMerged?): Promise<void>
"removeExternalObjectGroup" removes a group and all its modules from the plan.
Parameters
groupId
string
undefined
The ID of the group of modules.
wasMerged
boolean
false
Should be set to true if the group has been merged with another group (this is required to generate correct undo/redo steps).
Returns
Promise<void>
Implementation of
ExternalObjectAPI.removeExternalObjectGroup
removeExternalObjectRootModule
â–¸ removeExternalObjectRootModule(rootModuleId): void
"removeExternalObjectRootModule" removes a root module from a group and splits the remaining group if the removed root module is located between other root modules. If the group consists of only one root module, the group is removed.
Parameters
rootModuleId
string
Returns
void
Implementation of
ExternalObjectAPI.removeExternalObjectRootModule
renderImagesOfExternalObjectGroup
â–¸ renderImagesOfExternalObjectGroup(groups): Promise<{ [key: string]: string; }>
"renderImagesOfExternalObjectGroups" renders images of groups of modules.
Parameters
groups
object
Returns
Promise<{ [key: string]: string; }>
Implementation of
ExternalObjectAPI.renderImagesOfExternalObjectGroup
resetCameraPosition
â–¸ resetCameraPosition(): void
Returns
void
Implementation of
resolveShortUrl
â–¸ resolveShortUrl(shortUrl): Promise<string>
Resolves a shortened URL.
Parameters
shortUrl
string
The shortened URL to resolve.
Returns
Promise<string>
A promise that resolves to the URL.
rotateSelection
â–¸ rotateSelection(rotateBy): void
rotates the selected item(s)
Parameters
rotateBy
number
angle in rad
Returns
void
Implementation of
RoomlePlannerCallback.rotateSelection
saveCurrentPlanSnapshot
â–¸ saveCurrentPlanSnapshot(parentPlanId?, configurationHashOrGroupId?): Promise<RapiPlanSnapshotGetData>
Parameters
parentPlanId?
string
configurationHashOrGroupId?
string | string[]
Returns
Promise<RapiPlanSnapshotGetData>
saveExternalObjectSnapshot
â–¸ saveExternalObjectSnapshot(parentPlanId?): Promise<RapiPlanSnapshotGetDataWith3dUrls>
Saves a snapshot of the external objects in the plan without walls and other objects Also contains the urls to the glb and usdz files
Parameters
parentPlanId?
string
id of the current plan, optional
Returns
Promise<RapiPlanSnapshotGetDataWith3dUrls>
the snapshot of the external objects if there are no external objects it returns null
selectExternalObjectGroup
â–¸ selectExternalObjectGroup(groupId): Promise<void>
"selectExternalObjectGroup" changes the selected object in the scene. The function selects a complete group of root modules and always switches to planning mode. If the group consists of only one root module, this is equivalent to selecting a single root module.
Parameters
groupId
string
The ID of the group of modules.
Returns
Promise<void>
Implementation of
ExternalObjectAPI.selectExternalObjectGroup
selectExternalObjectRootModule
â–¸ selectExternalObjectRootModule(rootModuleId): Promise<void>
"selectExternalObjectRootModule" changes the selected object in the scene. The function selects a root module within a group and always switches to planning mode.
Parameters
rootModuleId
string
The ID of the root module.
Returns
Promise<void>
Implementation of
ExternalObjectAPI.selectExternalObjectRootModule
selectExternalObjectSubModule
â–¸ selectExternalObjectSubModule(rootModuleId, subModuleId): Promise<void>
"selectExternalObjectSubModule" changes the selected object in the scene. The function selects a sub module a root module and always switches to configuration mode.
Parameters
rootModuleId
string
The ID of the root module.
subModuleId
string
The ID of the sub module.
Returns
Promise<void>
Implementation of
ExternalObjectAPI.selectExternalObjectSubModule
selectPlanObjectById
â–¸ selectPlanObjectById(runtimeId): Promise<void>
select an object in the scene based on its runtime id
Parameters
runtimeId
number
Returns
Promise<void>
setAtticSide
â–¸ setAtticSide(attic, side): void
Set the attic direction from a wall.
Parameters
Returns
void
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'
Parameters
offset
Returns
void
Implementation of
setEnvironmentMap
â–¸ setEnvironmentMap(params): void
Parameters
params
Object
params.intensity?
number
params.maxLightSources?
number
params.rotation?
number
params.url?
string
Returns
void
Implementation of
setMeasurementLineLength
â–¸ setMeasurementLineLength(measurementId, length, wallDirection): void
Parameters
measurementId
number
length
number
wallDirection
string
Returns
void
setObjectToWallMeasurementLength
â–¸ setObjectToWallMeasurementLength(planElementId, measurementId, length): void
Parameters
planElementId
number
measurementId
number
length
number
Returns
void
setOverrides
â–¸ setOverrides(initData): void
Set general configuration parameter
Parameters
initData
Returns
void
setSceneEvents
â–¸ setSceneEvents(sceneEvents): void
set which events are enabled in the scene, for example disable selection of walls and wall nodes
Parameters
sceneEvents
Returns
void
setWallMeasurementLength
â–¸ setWallMeasurementLength(measurementId, length, wallDirection): void
Parameters
Returns
void
showBenchmarks
â–¸ showBenchmarks(): void
Returns
void
showGUI
â–¸ showGUI(): void
Returns
void
showStats
â–¸ showStats(): void
Returns
void
showsChildrenOfPlanObject
â–¸ showsChildrenOfPlanObject(planElementViewModel): boolean
returns true if interaction with the child components of a configuration object is enabled, and flashes otherwise
Parameters
planElementViewModel
Returns
boolean
startConfiguring
â–¸ startConfiguring(): void
Returns
void
startViewing
â–¸ startViewing(): void
Returns
void
swapObject
â–¸ swapObject(old, idOfNew): Promise<number>
Swap two plan objects in the scene in the same position for example swap two object variants
Parameters
idOfNew
string
the RAPI id of the new plan object returns runtime ID of the new object
Returns
Promise<number>
switch2D
â–¸ switch2D(): void
Returns
void
switch3D
â–¸ switch3D(): void
Returns
void
switchToConfigurator
â–¸ switchToConfigurator(): Promise<Configurator>
Returns
Promise<Configurator>
Implementation of
RoomlePlannerCallback.switchToConfigurator
switchToFirstPerson
â–¸ switchToFirstPerson(): void
Returns
void
switchToPlanner
â–¸ switchToPlanner(id?): void
Parameters
id?
string
Returns
void
switchToViewer
â–¸ switchToViewer(): Promise<GlbViewer>
Returns
Promise<GlbViewer>
Implementation of
RoomlePlannerCallback.switchToViewer
syncCatalog
â–¸ syncCatalog(catalogId): Promise<void>
Parameters
catalogId
string
Returns
Promise<void>
toggleConfigureInRoom
â–¸ toggleConfigureInRoom(): void
Returns
void
update
â–¸ update(): void
Returns
void
updateAtticKneeHeight
â–¸ updateAtticKneeHeight(attic, kneeHeight): void
Updates the knee height of an attic.
Parameters
kneeHeight
number
The new knee height value.
Returns
void
updateAtticWidth
â–¸ updateAtticWidth(attic, width): void
Updates the width of an attic.
Parameters
width
number
The new width value.
Returns
void
updateScene
â–¸ updateScene(): void
Updates the scene (recalculating bounds) and restart rendering
Returns
void
Implementation of
updateSize
â–¸ updateSize(): void
Returns
void
Implementation of
Last updated