RoomlePlanner.Internal.ExternalObjectAPI
planner-core/src/roomle-planner.internal.ExternalObjectAPI
Implemented by
Table of contents
Methods
Methods
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>
loadExternalObjectGroup
▸ loadExternalObjectGroup(groupJson, findFreeSpaceInPlan): 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
groupJson
string | object
The group JSON as string or object.
findFreeSpaceInPlan
boolean
A free space is automatically searched for in the plane.
Returns
Promise<void>
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
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>
removeExternalObjectGroup
▸ removeExternalObjectGroup(groupId): Promise<void>
"removeExternalObjectGroup" removes a group and all its modules from the plan.
Parameters
groupId
string
The ID of the group of modules.
Returns
Promise<void>
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
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>
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>
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>
Last updated