planner-core/src/roomle-planner.default
Shared API between configurator and planner
Type parameters
Table of contents
• new default<P>(creator, activePlugins?)
Type parameters
extends readonly "external-objects"[] = readonly []
• _creator_: string
Implementation of
Context.creator
PlannerCoreTypes
• get PlannerCoreTypes(): PlannerKernelContainer
PlannerKernelContainer
an object which has all type constants from Roomle Core (C/C++)
• get callbacks(): default
default
Implementation of
ExternalEmbeddable.callbacks
• set callbacks(callback): void
void
Implementation of
ExternalEmbeddable.callbacks
• get hasSingleRoom(): boolean
Check if the 3D scene contains only one room
boolean
True if there is only one room, false otherwise
_selectExternalObjectGroup
▸ _selectExternalObjectGroup(groupId, switchToPlanner): Promise<void>
Promise<void>
_selectExternalObjectModule
▸ _selectExternalObjectModule(rootModuleId, subModuleId, selectPlanObject, switchToConfigurator, selectComponent, highlightSelection): Promise<void>
Promise<void>
▸ addAtticToWall(wall, kneeHeight, width, preferredSide?): KernelAttic
Creates a sloping roof attic on a given wall.
The wall to add an attic to.
Height of the attic knee wall.
Width of the sloping roof.
The side where the attic should be added.
KernelAttic
The newly created attic.
▸ back(): void
void
▸ backTo(_cssClass): void
void
▸ backToPlanner(): void
void
calcPartsPriceSum
▸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>
Promise<KernelPartListPrice>
cancelSelection
▸ cancelSelection(reason?): void
void
Implementation of
RoomlePlannerCallback.cancelSelection
changeExteriorWallsMaterial
▸ changeExteriorWallsMaterial(material): void
void
changeFloorsMaterial
▸ changeFloorsMaterial(material): void
void
changeInteriorWallsMaterial
▸ changeInteriorWallsMaterial(material): void
void
▸ 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.
The configuration JSON as string or object.
Promise<void>
Implementation of
ExternalObjectAPI.configureExternalObjectApi
createNewSerializedConfiguration
▸ createNewSerializedConfiguration(configurationRuntimeId): Promise<string>
Promise<string>
createPlanFromObject
▸ createPlanFromObject(id, position?, rotation?): Promise<number>
creates and loads a plan from a given object
return the object runtime id
Promise<number>
deleteSelection
▸ deleteSelection(): void
void
Implementation of
RoomlePlannerCallback.deleteSelection
disableAdvancedDocking
▸ disableAdvancedDocking(): void
disable docking of objects that fit together when objects are snapped in the plan
void
▸ disableEvents(): void
void
disableMeasurementLineDrawing
▸ disableMeasurementLineDrawing(): void
void
disableMultiselect
▸ disableMultiselect(): void
Disable the selection of multiple elements.
void
disableRotation
▸ disableRotation(): void
Disable rotation of selected elements
void
disableShowChildrenOfPlanObject
▸ disableShowChildrenOfPlanObject(planElementViewModel): void
disable interaction with child components of configurable objects in the plan
void
disableSnapping
▸ disableSnapping(): void
disable all types of snapping
void
disableWallDrawing
▸ disableWallDrawing(): void
void
downloadHomagIxExportPoC
▸ downloadHomagIxExportPoC(): Promise<any>
Promise<any>
▸ dragInObject(idOrSerializedConfigString, dragEvent, type?): Promise<number>
idOrSerializedConfigString
Promise<number>
▸ drawWalls(wallDefinitions, interactionOptions?): KernelWall[]
Draws walls according to the wall definitions
this can be used to create a room on the fly
KernelWall[]
▸ duplicateItems(itemList): PlanObject[]
Duplicates all planObjects in the array and inserts them into the current plan
PlanObject[]
enableAdvancedDocking
▸ enableAdvancedDocking(): void
enable docking of objects that fit together when objects are snapped in the plan
void
▸ enableEvents(): void
void
enableMeasurementLineDrawing
▸ enableMeasurementLineDrawing(): void
void
enableMultiselect
▸ enableMultiselect(): void
Enable the selection of multiple elements.
Common parameters shared between those elements can then be changed at once
void
Implementation of
RubensAPI.enableMultiselect
▸ enableRotation(): void
Enables rotation of selected elements
void
enableShowChildrenOfPlanObject
▸ enableShowChildrenOfPlanObject(planElementViewModel): void
enable interaction with child components of configurable objects in the plan
void
▸ enableSnapping(): void
enable snapping of object to object and object to wall
void
enableWallDrawing
▸ enableWallDrawing(): void
void
▸ escapeDrawing(cancelDrawing): void
void
exportCanvasScreenshot
▸ exportCanvasScreenshot(quality?): Promise<string>
Promise<string>
Implementation of
RubensAPI.exportCanvasScreenshot
▸ exportGLB(): void
void
exportImageFromCamera
▸ exportImageFromCamera(filename?, shouldWaitForAssets?): Promise<void>
Promise<void>
Implementation of
RubensAPI.exportImageFromCamera
▸ formatValueToUnitString(value, parameter): string | number
Returns the formatted value based on the parameter.unitType
string | number
generateTCExport
▸ generateTCExport(planObjectIds?): Promise<any>
Promise<any>
getAttachedAttic
▸ getAttachedAttic(wall): KernelAttic
Gets the attached attic from a wall.
The wall to retrieve the attic from.
KernelAttic
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'
CanvasOffset
Implementation of
GlobalAPI.getCameraOffset
getConfigurator
▸ getConfigurator(): Configurator
Configurator
getConfiguratorApi
▸ getConfiguratorApi(): default<P>
default<P>
getConfiguratorContext
▸ getConfiguratorContext(): default
returns class containing configurator specific data properties
default
▸ getCurrentSkin(): Promise<RapiSkin>
Promise<RapiSkin>
getExternalObjectGroups
▸ getExternalObjectGroups(): Promise<object[]>
"getExternalObjectGroups" returns all groups of external objects modules (PosData) that are currently loaded in the plan.
Promise<object[]>
Implementation of
ExternalObjectAPI.getExternalObjectGroups
▸ getObjects(): Promise<UiPlanObject[]>
returns all objects found in the current plan
this includes info about size, rotation, id and parts
Promise<UiPlanObject[]>
▸ getPartlistOf(id): Promise<KernelPartList>
get the Partlist of certain runtimeID
can be used if partlist of a selected Item is needed
runtimeID of a configurable item
Promise<KernelPartList>
kernelPartlist with processed price, currency and RAL colors
getPlanInteractionHandler
▸ getPlanInteractionHandler(): Promise<PlanInteractionHandler>
Promise<PlanInteractionHandler>
getPlanModelViewHelper
▸ getPlanModelViewHelper(): Promise<PlanModelViewHelper>
Promise<PlanModelViewHelper>
getPlanOverview
▸ getPlanOverview(): Promise<PlanOverview>
get all info available for the current plan, including objects, rooms and walls
Promise<PlanOverview>
▸ getPlanXmlFrom(plan): any
any
getRuntimeComponentIdOfRootComponent
▸ getRuntimeComponentIdOfRootComponent(planObjectId): number
Returns the runtime component id of the plan object with the given id
id of the plan object you want to get the runtime component id of the root component from
number
number the number of the runtime id of the root component
Implementation of
KernelUtilityForUi.getRuntimeComponentIdOfRootComponent
▸ 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!
Scene
Implementation of
GlobalAPI.getScene
▸ getStorage(): default
returns manager class to interface with indexedDB storage
default
Implementation of
RubensAPI.getStorage
▸ getUnitFormatter(): default
returns unit formatter for formatting input und output values in scene
default
Implementation of
GlobalAPI.getUnitFormatter
getWallAngleDegrees
▸ getWallAngleDegrees(wall): number
Returns the wall angle in degrees relative to the camera
a WallPlanElementViewModel instance
number
▸ hasWalls(): boolean
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.
A single runtime ID, an array of runtime IDs, or null.
void
▸ importGLB(url): void
void
▸ init(element, preloadPlanId?, options?): Promise<void>
Promise<void>
▸ insertItemList(ids): Promise<number[]>
Promise<number[]>
▸ insertItems(itemList): Promise<number[]>
Inserts all of the items in the array into current plan
Array of items received from the Roomle API
Promise<number[]>
▸ insertObject(id, position?, rotation?): Promise<number>
Inserts the object into the scene (at a given position and rotation)
x (left/right),y (up, down) and z(front, back) in meters
Promise<number>
isCurrentlyDrawing
▸ isCurrentlyDrawing(): boolean
boolean
▸ isReady(): void
void
Implementation of
KernelAccessCallbackI.isReady
▸ loadError(error?): void
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.
Name
Type
Default value
Description
The group JSON as string or object.
A free space is automatically searched for in the plane.
Verify whether the root modules of the group need to be rearranged as they have changed in size.
Groups that were merged into another group and have to be delete (this is required to generate correct undo/redo steps).
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.
The library JSON as string or object.
void
Implementation of
ExternalObjectAPI.loadExternalObjectLibrary
▸ loadPlan(id, options?): Promise<RapiPlan | RapiPlanSnapshotGetData>
Promise<RapiPlan | RapiPlanSnapshotGetData>
▸ loadPlanXml(xml, options?): Promise<void>
Promise<void>
▸ moveCamera(cameraParameter): Promise<void>
Promise<void>
moveElementPosition
▸ moveElementPosition(selectedElement, position): void
Move the current selected element in the 3D space
this is the current selected plan object
new KernelVector3 position of the current selected element returns runtime ID of the new object
void
moveElementsPosition
▸ moveElementsPosition(selectedElements, position): void
Moves the current multi-selected elements in the 3D space
this is the current selected plan object
new KernelVector3 position of the current selected element returns runtime ID of the new object
void
▸ onCloseHSC(): void
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.
The ID of the group of modules or the ID of the root module.
The ID of the sub module.
If true, the modules are opened, if false, they are closed, if the geometry is already in the desired state, nothing happens.
If true the opening or closing is animated else the geometry is switched instantly.
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
Name
Type
Default value
Description
defaults to false. Determines whether to generate a perspective image for the current configuration.
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
runtime-id of the plan element, e.g.: a selected element
Promise<Base64Image>
prepareTopImage
▸ prepareTopImage(options?): Promise<Base64Image>
Generates a top image (birds eye view) and returns it as base64
Promise<Base64Image>
▸ removeAttic(attic): void
Removes an attic from a wall.
void
▸ removeElements(kernelPlanElements, interactionOptions?): Promise<void>
Promise<void>
removeExternalObjectGroup
▸ removeExternalObjectGroup(groupId, wasMerged?): Promise<void>
"removeExternalObjectGroup" removes a group and all its modules from the plan.
Name
Type
Default value
Description
The ID of the group of modules.
Should be set to true if the group has been merged with another group (this is required to generate correct undo/redo steps).
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.
void
Implementation of
ExternalObjectAPI.removeExternalObjectRootModule
renderImagesOfExternalObjectGroup
▸ renderImagesOfExternalObjectGroup(groups): Promise<{ [key: string]: string; }>
"renderImagesOfExternalObjectGroups" renders images of groups of modules.
Promise<{ [key: string]: string; }>
Implementation of
ExternalObjectAPI.renderImagesOfExternalObjectGroup
resetCameraPosition
▸ resetCameraPosition(): void
void
Implementation of
RubensAPI.resetCameraPosition
resolveShortUrl
▸ resolveShortUrl(shortUrl): Promise<string>
Resolves a shortened URL.
The shortened URL to resolve.
Promise<string>
A promise that resolves to the URL.
rotateSelection
▸ rotateSelection(rotateBy): void
rotates the selected item(s)
void
Implementation of
RoomlePlannerCallback.rotateSelection
saveCurrentPlanSnapshot
▸ saveCurrentPlanSnapshot(parentPlanId?, configurationHashOrGroupId?): Promise<RapiPlanSnapshotGetData>
configurationHashOrGroupId?
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
id of the current plan, optional
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.
The ID of the group of modules.
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.
The ID of the root module.
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.
The ID of the root module.
The ID of the sub module.
Promise<void>
Implementation of
ExternalObjectAPI.selectExternalObjectSubModule
selectPlanObjectById
▸ selectPlanObjectById(runtimeId): Promise<void>
select an object in the scene based on its runtime id
Promise<void>
▸ setAtticSide(attic, side): void
Set the attic direction from a wall.
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'
void
Implementation of
GlobalAPI.setCameraOffset
setEnvironmentMap
▸ setEnvironmentMap(params): void
void
Implementation of
GlobalAPI.setEnvironmentMap
setMeasurementLineLength
▸ setMeasurementLineLength(measurementId, length, wallDirection): void
void
setObjectToWallMeasurementLength
▸ setObjectToWallMeasurementLength(planElementId, measurementId, length): void
void
▸ setOverrides(initData): void
Set general configuration parameter
void
▸ setSceneEvents(sceneEvents): void
set which events are enabled in the scene, for example disable selection of walls and wall nodes
void
setWallMeasurementLength
▸ setWallMeasurementLength(measurementId, length, wallDirection): void
void
▸ showBenchmarks(): void
void
▸ showGUI(): void
void
▸ showStats(): void
void
showsChildrenOfPlanObject
▸ showsChildrenOfPlanObject(planElementViewModel): boolean
returns true if interaction with the child components of a configuration object is enabled, and flashes otherwise
boolean
startConfiguring
▸ startConfiguring(): void
void
▸ startViewing(): void
void
▸ swapObject(old, idOfNew): Promise<number>
Swap two plan objects in the scene in the same position for example swap two object variants
this is the current selected plan object
the RAPI id of the new plan object returns runtime ID of the new object
Promise<number>
▸ switch2D(): void
void
▸ switch3D(): void
void
switchToConfigurator
▸ switchToConfigurator(): Promise<Configurator>
Promise<Configurator>
Implementation of
RoomlePlannerCallback.switchToConfigurator
switchToFirstPerson
▸ switchToFirstPerson(): void
void
switchToPlanner
▸ switchToPlanner(id?): void
void
▸ switchToViewer(): Promise<GlbViewer>
Promise<GlbViewer>
Implementation of
RoomlePlannerCallback.switchToViewer
▸ syncCatalog(catalogId): Promise<void>
Promise<void>
▸ toggleConfigureInRoom(): void
void
▸ update(): void
void
updateAtticKneeHeight
▸ updateAtticKneeHeight(attic, kneeHeight): void
Updates the knee height of an attic.
The new knee height value.
void
updateAtticWidth
▸ updateAtticWidth(attic, width): void
Updates the width of an attic.
void
▸ updateScene(): void
Updates the scene (recalculating bounds) and restart rendering
void
Implementation of
GlobalAPI.updateScene
▸ updateSize(): void
void
Implementation of
GlobalAPI.updateSize
