RoomlePlanner.default
planner-core/src/roomle-planner.default
Shared API between configurator and planner
Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new default(creator
)
Parameters
creator
string
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
Methods
_selectExternalObjectGroup
▸ _selectExternalObjectGroup(groupId
, switchToPlanner
): Promise
<void
>
Parameters
groupId
string
switchToPlanner
boolean
Returns
Promise
<void
>
_selectExternalObjectModule
▸ _selectExternalObjectModule(rootModuleId
, subModuleId
, selectPlanObject
, switchToConfigurator
, selectComponent
): Promise
<void
>
Parameters
rootModuleId
string
subModuleId
string
selectPlanObject
boolean
switchToConfigurator
boolean
selectComponent
boolean
Returns
Promise
<void
>
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
reason
'unknown'
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
configurationJson
The configuration JSON as string or object.
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
id
string
position?
rotation?
number
return the object runtime id
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
dragInObject
▸ dragInObject(idOrSerializedConfigString
, dragEvent
, type?
): Promise
<number
>
Parameters
idOrSerializedConfigString
string
undefined
dragEvent
DragEvent
undefined
type
'rml_id'
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