Configurationformat
Kernelversion 2.24.0
Definitions
Catalogs
A catalog consists of items, components, tags and materials. It can be private (visible only to selected users and the owner) or public (available for all Roomle users).
Tag
Tags are the way items are organized in catalogs. Each catalog must have at least one root-tag. Tags can be structured hierarchically and one tag can be a child of multiple other tags. Each Tag is linked to one catalog and must have a (globally) unique identifier.
Item
An item is an object that can be added to a plan or loaded into a configurator. This can be a normal 3D object or a pre-defined configuration of components. Each item belongs to exactly one catalog but can be linked to multiple tags. Items which are not linked to any tag are not visible to the user. Every item must have a unique SKU (within the catalog). The terms item and product refer to the same thing and can be used interchangeably.
Component
A component is the basic element used for configurable objects. Each component contains a definition on how this component can be configured and used within configurations. Similar to items, components can be linked to multiple tags. Every component must have a unique identifier (within the catalog).
Mesh
Within each catalog you can define meshes to be used in the geometry-script of a component. Each mesh can have data for different formats and quality levels. At the moment only CRT (Corto compressed meshes) with Realtime quality (level 50) is used. Within the script the mesh can be inserted with the AddExternalMesh command. The MeshId is the combined id <catalogId>:<meshId>.
Defined meshes (external meshes in the script) improve loading performance since only those meshes are loaded that are currently needed. In contrast to scripted meshes where the whole mesh is part of the script and needs to be interpreted even if not shown. Furthermore defined meshes provide the client with the ability to reuse the mesh (since defined meshes have an id and are const by definition) within the scene which also improves performance and memory usage.
Material
Within each catalog you can define materials that can be used in the geometry script of a component. Each material can have no or multiple textures assigned to it for use. Each material must have a unique identifier (within the catalog).
Configurations
When talking about configurable items you must distinguish between what we call "configuring variants" (which is basically just changing colors, product dimensions, etc.) and "combining components to one object" (creation of new objects and products - real configuration). Components can be seen as templates for the basic elements of configurable objects. A component itself can not be used within a plan. To use a component within a plan it must be embedded into a configurated item, which is an item with a given configuration. The configuration (see section configuration format) defines the actual variant of the involved components used in the configuration.
Configuring variants
An example for configuring variants is a table where you can change the dimensions and the material of the surface. In Roomle this can be modeled as one component with parameters for the dimensions and the material. This table within a plan is defined through a configuration containing only one component.
Combining components
Roomle Configuration Format
The Roomle Configuration Format is serialized as JSON file.
Coordinate system
The coordinate system within the Roomle ConfigurationScript is a left-handed cartesian coordinate system with +Z as the up vector and +Y as the forward direction of the model. In the 3d file 1 Model Unit has to correspond to 1mm real world size of the object.
Component definition
The component definition defines how a component should be displayed, which parameters are possible and the interaction with other components. It includes all information needed within the configurator. This includes:
A condition when the component is considered valid. This can be used for Components who must have specific parameters/dockings set to be valid.
A list of possible parameters including the possible values and a default value per parameter
A list of possible animations including the possible actions.
A list of possible ParentDockings and ChildDockings. These are the connectors to combine different components.
A list of possible SiblingPoints. These are connectors throu which components can transfer data (e.g. parameter values) regardless of the parent-child connection.
A list of possible AddOnSpots. These are visual aids for the User.
A list of possible Subcomponents which can be used within the geometry script and will be displayed in the partlist
The article number script written in RoomleScript
The geometry script written in RoomleScript
The geometryHD script written in RoomleScript. This version is used in special clients for higher resolution and quality. Besides thatit follows the same logic and definitions as the geometry script. Everything that can be done in the geometry script can be done in geometryHD too.
The previewGeometry script written in RoomleScript. When provided, this geometry is used to preview objects during adding of new children. If not provided, the geometry script is used. All geometry-script functions work the same in the previewGeometry. If provided the previewGeometry script should be less complex than the real geometry script to improve performance during the insertion.
The boundingGeometry is intended to define the simplified boundaries of the components geometry that can be used for collision detection and cutting holes of construction objects in walls.
The boundingGeometry script written in RoomleScript.
The packageSize contains a Array<int>, these are all the numbers of packages which are allowed for this component
The packaging contains a list of sizes with conditions for adding certain sizes if needed
The
numberInPartListandsortInPartListproperties which define how many and at which position the component should be shown in the partlist.The price calculation written in RoomleScript
an onUpdate RoomleScript which is executed everytime something changes within the component. Within this script even parameters of the component may be changed.
Parameters
A component is completely defined by the values of its parameters. Parameters have multiple ways to control where and how it is shown and behaves.
If all connected parameters behind a global parameter have the same value, the global parameter is automatically set to this value.
visible: shown to the user as part of the component. Default value
true.enabled: user can modify the value. Default value
true.global: all global parameters with the same key within a configuration are combined together and shown globally. The global value for a parameter-key may differ from the actual value on the component (if the component-parameter is changed after the global value is set). New components get the global value assigned automatically on dock. If all connected parameters behind a global parameter have the same value, the global parameter is automatically set to this value. Default value
false.volatile: If this property is set, the parameter is not stored in the configuration. Default value
false.visibleAsGlobal: the global parameter is shown if any of the connected component parameters is set as "visibleAsGlobal", otherwise its invisible globally. visible and visibleAsGlobal can be completely independent. Default value
true.visibleInPartlist: if this parameter should be shown in the partlist. parameters not visible in the partlist are also ignored in the aggregation of components in the partlist. Default value
true.userTriggeredChange: is set to true, if onValueChange is triggered from user. Then for corresponding key respective values fetched from json will be set. if onValueChange is internal trigger, values are ignored.
an onValueChange RoomleScript which can be provided for every Parameter and is executed on startup (change from no value to the first/default value) and every time this parameter changes.
visibleInPlanner: If the parameter is "global" and "visibleInPlanner", the object parameter is delivered with the PlanObject when a plan overview or an individual plan object is requested. If the "visibleInPlanner" property of the parameter is set but not the "global" property, then a warning is generated when the component is read and the parameter is treated as if "visibleInPlanner" would be "false".
Parameter and possible children level
The visibility of parameters and possible children are restricted and are only visible if the user level exceeds the restriction. Therefore the property level needs to be added to parameters or possible children. The value of the property can only be an integral constant. The default restriction level is 0, so these parameters are visible to all users. The user level is set via an environment variable and is 0 by default. The core only populates the parameters and possible children that the user can access. Thus, a user with a higher level can access more parameters and more restricted parameters can be accessed by fewer users. As the default level of each parameter is 0, this new feature has no impact on the live content, as any user can access parameters with level 0 (unrestricted).
Parameter levelCondition
For parameters, you can define a levelCondition in addition to the level. This is a script that is evaluated in addition to the level. Both of these conditions must evaluate true that a parameter is visible for a specific user. If no levelCondition is provided it defaults to true. It is possible to access the current user level within the levelCondition script using the keyword level. Keep in mind that it is not possible to access a component parameter with the same name. It is not possible to write parameters within this script and therefore it is not possible to change the user level.
Example:
This would result for a user of level 0 only seeing the parameter ["one"]. But a user of level 30 would see the parameters ["one", "three"]. The user of level 30 does not see parameters two, four and five even if their level would be sufficient, but the levelCondition scripts evaluate to false.
Animations
An animation looks similar to a parameter, but is actually something completely different. The actual state of the animation is not saved in the configuration and must not change the configuration hash. The animation does not change the product or the partial list of the product itself. It is merely a visual effect.
key: The key of the animation. This key is used to combine animations with the same key within a configuration. The key is also used to define the animation action in the geometry script.
label, labels: The label of the animation which is shown in the UI.
group: The key of the parameterGroup the animation belongs to.
visible: shown to the user as part of the component. Default value
true.enabled: user can trigger an action of the animation. Default value
true.global: all global animations with the same key within a configuration are combined together and shown globally. If the animations have different actions, all the actions are combined together.
visibleAsGlobal: the global animations is shown if any of the connected component animations is set as "visibleAsGlobal", otherwise its invisible globally. visible and visibleAsGlobal can be completely independent. Default value
true.visibleInPlanner: If the animations is "global" and "visibleInPlanner", the object animations is delivered with the PlanObject when a plan overview or an individual plan object is requested.
actions: A list of possible actions for the animation. Each action has a key a label and a type. The possible types are
originandmatrix:origin: The action animates all parts of the geometry back to its original position.matrix: The action animates all parts of the geometry to the orientation and position defined in the geometry script with the animation matrix corresponding to the key of the action.
Subcomponents
Every component can contain multiple subcomponents. A subcomponent references a component with all of its scripts and computations. The main component may set parameters of the subcomponents via assignments. It's also possible for the main component to define one or more subcomponents as active. If defined, the main component can take parameters of the active subcomponents to supersede its own.
Supersedings
For active subcomponents the main component may define supersedings. If a superseding parameter is defined, it completly replaces the parameter of the main component with the same key if one exists. This means that from outside it behave as if the parameter were the parameter of the main component itself although the validValues and all calculations are done in the subcomponent.
This is specially useful for cases where the main component acts as a metacomponent which only decides which subcomponent is used. In this case all calculations can stay subcomponent specific without the need to copy them to the main component while still having all logic available.
The values of the superseded parameters are also available in the main component (and may override existing values in the main component) and can be used in geometry, docking etc. Be aware that the values of the superseding parameters may not be available on the initial executions of "onUpdate" since the component needs to initialize itself before knowing what parameters will be superseded. Consider using ifnull in such a case.
Optionally, the key used to access the substituted parameters in the component can be specified by adding an override object with a key attribute. This is useful for avoiding parameter shadowing in the main component and for superseding parameters with the same name from different subcomponents. In the script, the substituted parameter can be used just as if there were a parameter with the used override key.
By default, the substituted parameter maps to the same group specified in the subcomponent. This default behavior can be changed by setting an override group. Membership in a group can even be removed by assigning an empty string to the override group.
Data
Getting data
Static JSON data that can be queried in RoomleScript with the functions getData, getDataOrNull or getDataWithDefault. While getData generates an error if the data is not found, getDataOrNull and getDataWithDefault never generate an error and always return a valid value. getDataOrNull returns null if the data is not found, while getDataWithDefault has an additional default argument that is returned if the data is not found. The default argument is only evaluated if the data is not found.
The getData* can return not only values, but also objects and arrays. The elements of the objects can be accessed with the . (member access) operator. Multidimensional arrays or lists of arrays are not supported because the RoomleScript does not support multidimensional arrays at all, not even for basic data types.
Example
getData* returns a copy of the data. The elements of objects can also be assigned. Note that this only changes the data in the variable, but of course not the data in the component.
In the Roomle script, the names of the variables can also be self, other, child, parent, sibling, connection, other_connection, parameter and object. Despite the fact that this is a bad style, it does not contradict the corresponding context names. However, if such a variable is an object, the context must be explicitly specified when accessing the object's members.
Elements of arrays of objects can be accessed with the get function:
Elements of arrays of objects can be overwritten with the set function:
As for any other array, the length of an array of objects can be get with the length function:
Evaluating data
In addition to the gerData* functions, there are evaluateData, evaluateDataOrNull or evaluateDataWithDefault. These functions work exactly like the corresponding getData* functions, however, if the data is a string, the string is treated as an expression and evaluated. The expressions in the data are not parsed when the component is loaded, but only at runtime when the particular element in "data" is evaluated for the first time. Note that to prevent recursion, it is not allowed to call a getData* or evaluateData* function again within a data expression.
Example
With the functions getSubComponentData, getSubComponentDataOrNull, getSubComponentDataWithDefault, evaluateSubComponentData, evaluateSubComponentDataOrNull and evaluateSubComponentDataWithDefault data from subcomponents can be accessed. The functions work exactly like the corresponding getData* and evaluateData* functions, but have an additional argument at the beginning, which is the internal ID of the subcomponent.
Example
Finding data
In addition to getting or evaluating data, the data can also be filtered using the findData, findSubComponentData, findAndEvaluateData, and findAndEvaluateSubComponentData functions. findData" returns the filtered objects and values as they are. findAndEvaluateData treats expressions as strings and evaluates them before filtering. With the functions findSubComponentData, and findAndEvaluateSubComponentData data from subcomponents can be accessed.
The last arguments of this functions is the filter functions, which can be a script function ot a component function. The function must have exactly 2 arguments, the key and the value of the data object and The function must return a boolean value. If an array is searched, the key is a 'Decimal' number with the index of the element. If an object is searched for, the key is a "String" value with the key of the data object. All functions return an array with the matches. If no value matches the filter, an empty array is returned. If an object is searched for, the returned array contains objects with 2 properties. The name of the first property is "key" and contains the key of the matching object. The name of the second property is "value" and contains the value of the matching object.
If the functions are used with a component function, the first argument of the component function must be the key and the second argument of the function must be the value. The values are passed to the function in the order of the arguments, not in the order of the keys. So if the name of the first argument is "value" and the name of the second argument is "key", this is just bad naming, but it does not change the order of the arguments. Default values of the arguments are of no use:
If the functions are used to look up array data, all the values that match the filter are returned in an array. If no value matches the filter, an empty array is returned. Regardless of whether you search in objects or arrays, arrays with key value pairs are always returned. If you search in arrays, the "key" is the index of the element found. The indices of course start with 0. When searching in objects, the "key" is the name of the property found. "value" is the element found.
The content of valueA is an array with 2 object:.
The content of valueB is an array with 2 objects:
The content of valueC is an empty array with 2 objects with the properties "key" and "value":
If no value matches the filter, an empty array is returned.
The content of valueD is an empty array [].
The data is evaluated prior to filtering:
The content of valueE is an array with 3 objects:
With findDataKey and findSubComponentDataKey it is also possible to search only for indices and keys of objects and values. The functions work exactly like the corresponding findData and findSubComponentData functions, but return only the keys or indices of the matching objects and values instead of key-value pairs.
The content of valueA is an array with 2 indices: [2, 3].
The content of valueB is an array with 2 indices: [2, 3].
The content of valueC is an empty array with 2 keys ['key3', 'key4'].
If no value matches the filter, an empty array is returned.
The content of valueD is an empty array [].
Plugin Data
imos
To transfer structural data from rml-configurations to imos, the components need additional information:
the zones for the imos topology
dividers to split up the zones
elements to be used in the zones with well known CP_PART_NAME (those need to exist in imos already)
for the main component (the root element) we also need the dimensions (width/depth/height) of the furniture, the rootzone and possible other attributes to be added to the main article.
The definition of a rootzone within the plugin-data of a component defines the start of a new article. All child- and subcomponents of this component will be added to this article. That is the zones, divisions and elements of those components. Until a new root-zone is found which triggers the next article.
Every element in the imos plugindata is interpreted as an expression and executed within the context of the component before put into the pxm export.
Every part within the imos plugindata (zone,division,element) can contain an "active" node which is interpreted as boolean expression. If this expression is present and evaluates to false, the part is not added to the pxm-export. an articleDescription with no active zone, is completly ignored for the export.
sample json part:
Sample file
id
string
the global unique id of the component. It is combined from the unique id of the catalog and an unique id of the component within the catalog
onUpdate
Script
a Script being executed on every changes. Setting of parametervalues within this script persist.
valid
Script
a condition to evaluate if the component is considered valid.
label
Script
A script being executed when the label is requested. Once preset, the label map ("labels") is ignored.
labels
map
a map containing key-value pairs for the label of this component. The keys are the isocodes of the language. The values are the labels to be used.
parameters
array
list of the possible parameters of this component
parameterGroups
array
list of the possible parameterGroups of this component.
possibleChildren
array
list of the possibleChild objects defining possible children for this component. Each child must have either itemId or componentId. Items must be configurable. Can have a script defining if it is the default. If multiple possible children evaluate default to true, its undefined which one is taken as the default child.
parentDockings
map
contains the definitions for all possible dockings where other components can be docked to this component as children. There can be points, lines, ranges (of points) and lineRanges.
childDockings
map
contains the definitions of all possible dockingPoints where this component can be docked to another component as a child. This contains only points.
addOnSpots
array
contains the definitions of all possible addOnSpots.
subComponents
array
list of possible subcomponents of this component. They can be referenced from the geometryScript and the previewGeometry by the internalId. If the component itself should appear in the partlist additionally to the subcomponents, a backreference is possible but deprecated, numberInPartList and sortInPartList in the component definition itself should be used instead
articleNr
string
the script to calculate the articleNr that should be displayed in the partlist. If the script contains only a string, this string is used as the articleNr. Otherwise the content of the variable "articleNr" is used.
packageSizes
array
list of numbers of packages which are allowed for this component
packaging
array
list of sizes with conditions for adding certain sizes if needed
dimensionings
array
list of all dimensionings that might be used.
siblings
array
contains the definitions of all possible siblingPoints.
geometry
string
the geometry script for this component. For details see the RoomleScript chapter.
geometryHD
string
the geometry script for higher quality of this component. For details see the RoomleScript chapter.
previewGeometry
string
the geometry script for this component in previewmode. For details see the RoomleScript chapter.
environmentGeometry
string
the geometry script for the environment of this component
boundingGeometry
string
the geometry script for the bounds of this component
planInteraction
object
definition about how the object interacts with the plan
data
object
contains the subobject with plugin-specific data
plugin-data
object
data that can be queried with the function getData, getDataOrNull or getDataWithDefault
Measuring of Components
By default the Configurator takes the real bounding box of the geometry as the measurements. If necessary the scripter can provide a custom definition for the shown measurements with the setBoxForMeasurement command in the onUpdate script. When the command is called, the display of the measurements behaves as if the component would consist only of a simple Cube with the size and offset as given in the command.
Combining Components
Components can be docked to each other via dockpoints. Each Component can have at most one parent which leads to a parent-child treehierachy. It is possible to transfer data from one component to another. Either directly via the Dockingconnection or via Siblingconnections which can be created between any two components. Data is transfered via assignments.
Labels
Components, Parameters, Parameter Groups, Value objects and Dimensioning objects can have a label. A Label is a user friendly name used to represent the object in the user interface. Labels can be defined with either a language map or a script. A label map is a collection of language and label pairs. If the label for a requested language does not exist in a label map, the English label is used. If the English label is requested but does not exist, the key or value of the object is used instead of the label. In a label script, a label will be generated completely dynamically. Once a label script is preset, the label map is ignored. However, the label from the labels map is the input label of the label script.
Label map exsample:
Label script examples:
Value object label scripts can be combined with the automatically unit formatted values. In the example below, the values label of the "size" parameter is "ø 100 cm" if isRound and "100 cm" otherwise.
Docking
Each component can define dockingPoints and dockingLines where other components can be docked to (called ParentDockings) and dockingPoints (called ChildDockings) through which this component can be docked to the ParentDockings of other components. Components which are docked to another component A are called the children of A. Through the docking connection the parent can set parameters of the child, e.g. the width of a shelf can be set by the parent frame. The child can also set parameters of the parent. There are three types of assignments: onDock, onUpdate and onUndock.
When a new component is docked the assignments are always first executed on the parent side. Meaning
assignmentOnDock in parentDocking
assignmentOnDock in childDocking
assignmentOnUpdate in parentDocking
assignmentOnUpdate in childDocking
Assignments in the onDock Block doesn't trigger recursive onUpdate actions themself.
On configuration changes, only the update assignments from the changed component are executed.
On Undock the order is reversed:
assignmentOnUnDock in childDocking
assignmentOnUnDock in parentDocking
One ParentDockPoint can only be used by one ChildDockPoint, on the other hand one ParentDockLine can be used by multiple ChildDockPoints at once. The maximum possible Children on a DockLine can be set via the maxChildren property.
Dynamically change docking
If an existing dock-connection and the parent-child relationship becomes invalid (due to a changed condition or changed masks), the child is undocked from their parent. In principle and dogmatically, an undocked child (a child without a parent) and all of its children (the entire child tree) are deleted immediately. However, in order to prevent unnecessary deletion, an alternative docking between the child and the parent is sought and, if found, established (docked) before the children are deleted. This feature enables completely dynamic changes of docking points. When the docking is changed, the child's position is recalculated and automatically changed depending on the new position and rotation, whereby the distance from the new to the old position is not restricted. If there is more than 1 possible new docking position, the position that causes the smallest translation of the child component is selected.
Delete PlanComponent and try to keep the children
If a PlanComponent is deleted and the children of the deleted PlanCmponent should be kept, it must be attempted to dock the children to the parent. A child can only be kept if it can be docked to the parent. Therefore, a matching docking point with a mask that matches the parent's mask must be found. Which child has priority when docking to the parent depends on the "persistent" and "priority" properties of the "parentDockings" to which the children are currently docked. This means that the PlanComponet to be deleted decides via the "persistent" and "priority" properties of the "parentDockings" which children are retained. If "persistent" is set to "false", a child element cannot be docked at all to the parent of its parent. The default value for "persistent" is "true". All chides that may be docked to the parent of their parent are sorted by the attribute "priority" and are attempted to dock in this order. If the attribute "Priority" is not set, this means the lowest priority.
In the following example, component "A" has a child "B". "B" itself has three children "C1", "C2" and "C3". For the parent docking of "B" to "C1", the attribute "persistent" is set to "false". The parent docking of "B" to "C2" has set the attribute "persistent" to "true" and "priority" 1. The parent docking of "B" to "C3" has set the attribute "persistent" to "true" and "priority" 1.
PlanComponent "B" is deleted. The root PlanComponent can only take over one of the 3 children because it has only one docking point. The PlanComponent "C1" is not "persistent", so it is not docked to the root PlanComponent. "C1" is automatically deleted. "C2" has the higher priority than "C3", so that "C2" is docked to the root PlanComponent and "C3" is automatically deleted.
Collision detection of docked components
Sometimes a newly added component would collide with an existing one. In some cases this is the expected behavior but in other scenarios the collision should not be allowed. It is possible to define a collisionCondition script for DockingPoints, DockingLines, DockingPointRanges and DockingLineRanges. The collisionCondition script defines if a collision with another component is allowed for the corresponding docking. If the collisionCondition script evaluates to false all docking previews of colliding components get discarded, so it is not possible to add a component there. A list (array) of all colliding components can be retrieved inside of the collisionCondition script via collidingComponentIDs. It is an array which contains the IDs of all colliding components, ordered by their overlapping volume from largest to smallest. There are also some additional functions available inside the collisionCondition script:
getComponentProperty(key:string, *componentId:int)getBoxOrigin(*componentId:int)getBoxSize(*componentId:int)getBoxForMeasurementOrigin(*componentId:int)getBoxForMeasurementSize(*componentId:int)
These functions have been extended and optionally accept an additional parameter to retrieve the corresponding data from a specific component via its ID. The IDs inside the collidingComponentIDs variable can be used in this case.
The calculation of the collision detection is based on axis aligned bounding box calculations. So for determination if something is colliding or not the BoundingBox or BoxForMeasurement (if available) get used. This is a very fast and performant calculation but has the drawback that sometimes components can get detected as colliding, even if they aren't, just because their bounding boxes are colliding but not the 3D objects themselves. This is especially the case if 3D objects get rotated.
If the object has a BoundingGeometry defined this geometry gets used and a more complex mesh intersection calculation is taking place which checks if the 3D objects are intersecting each other. This is an exact calculation that checks exactly the 3D meshes against each other, and so is a bit slower but far more precise. If only one of the objects has a BoundingGeometry defined the BoundingBox of the other object gets used for calculation. Be aware that if the component to be docked has a BoundingGeometry defined, the more complex mesh intersection calculation will always take place at docking preview generation.
In the case of DockingLines and DockingLineRanges, the generated lines are clipped based on the projection of the bounding box of the colliding geometry onto the line. This means that the line is segmented and shortened depending on the collisions detected. If none of the remaining line segments is large enough to dock the component in its full size, the line is completely discarded.
Locking of parent dockings
With the property childDeletionLocked it is possible to prevent deletion of child components on a specific parent docking. If this property is set to true it will not be possible to delete the child component docked at this docking. But if the parent component itself gets deleted, the docked child will also get deleted, even if the childDeletionLocked property is set to true. childDeletionLocked supports simple expression/condition scripts.
Siblings
Additionaly to assignments throu parent/child connections, components can transfer Data via Siblingpoints. Siblingpoints connect to any other siblingpoint with the same mask and same position somewhere within the object. Therefor its possible to transfer data (parametervalues) directly between two childcomponents on completly seperated branches in the parent-child-hierachy. Like Dokcings, Siblingpoints have onDock, onUpdate and onUndock assignments. Regarding the executionorder during the docking process the logic follows the same rules as with Dockingpoints: first the assignments from the currently existing Component, then the assignment from the newly docked one. First both onDock, then onUpdate. On undock the order is reversed, same as with the DockingPoints.
Docking assigments are always executed prior to sibling assignments.
Self Assignments
Normal assignments (either on docking or siblings) sets the value of a parameter on the other side of the connection. With self assignments one can set values on parameters of the component of the docking/sibling.
Self assignments are always executed after the "normal" assignment and never trigger recursive actions.
onUpdate of Connections
Each connection definition (dockingpoint, dockingline, siblingpoint) may have their own onUpdate. Those are executed after the onUpdate of the component and the calculation of the position but before any other script of the connection is evaluated (condition, assignments). This onUpdate may write values to the connections-context which is then available in the other scripts on this connection. This is usefull when the connection may decide what data from the whole component to use within this context.
Silent Assignments
Normal "On Update"-Assignments lead to a disabling of the parameter which is set from the assignment. This is done because normally a User shouldnt be able to change a Parameter whose value will be override with the next refresh. In some case (e.g. if the change of the value triggers an update of the connected Component which leads to changes in the parameters so that the changed value stays the same after the next refresh) this automatic disabling should be silenced. In this case one can use assignmentsOnUpdateSilent. Those assignments are handled exactly like onUpdate Assignments, but without disabling the parameter. Silent assignments are always applied before the normal assignments (if both exist).
AssignmentScripts
For more complex solutions its possible to define assignmentScripts. Again seperated into onDock, onUnDock and onUpdate, those scripts are executed after the "normal" assignments are done. Within the assignmentScript one has access to the values of both sides of the connection (parent and child in docking, both siblings for siblingpoints). Those are accessilbe via context definition. F.e. the paramter "width" of the other side of the connection is accessible via "other.width" while "self.width" is the own parameter width. In parentDockings the "other." context is also accessible via "child.", in childDockings its "parent." and for Siblings its "sibling."
Dock Ranges
Dockranges provide the ability to create a range of dockPoints without specifing each of them individually. A range is defined by a startingPoint, the stepSize and the endPoint. The step might be one 3D step which is used as a direct increment until the endPoint is reached, or as stepX, stepY and stepZ which creates a raster of points. The condition and assignments are defined for the range, but executed for each generated point seperatly. Within those scripts you can access the position of the point and index within the range via "connection.position" and "connection.index".
AddOn Spots
For a visual hint to the user, its possible to define addOnSpots. An AddOnSpot is a position in the 3D space relative to the current Component where a Plus-Sign is shown. If the User clicks on the sign, the AddOn-View opens.
AddOnSpots have a position and a condition. The mask is defined for future use and has nothing to do with docking masks.
Packaging Size
This feature allows defining a package size for its component. This size will be the amount of all appearances of this component. Description by example:
The possible "packageSizes" are set to [5,3], this means for example if the component is docked 11 times the number of packages with size 5 will be 2 and the number of packages with size 3 will be 1. The number of components will always be first divided into the biggest possible package size and then the next smaller one and next smaller one until the smallest one is reached.
The parameter packaging adds also the size 1 to the "packageSize" if the condition of "someOtherParameter == 1" is true.
The parameter "articleNr" and "pricing" are containing the variable "packageSize". Therefore it is possible to get the current "packageSize".
Dimensioning
The configurator automatically shows the dimensions of the bounding box, or of the boxForMeasurement if defined. Additional dimensioning levels can be defined as objects in the dimensionings array. Every dimensioning has a type, from, to, level and visibility field. If a dimensioning has a label ("label" or "labels") the the calculated value and the unit of the dimensioning is replaced by the label. If the "visbility" script evaluates to false, the dimensioning is not shown.
Dimensioning objects can be applied not only to a single component, but also across components. The “context” attribute must be set for this. The value of the context attribute can be “component”, “object” or “both” (“component” and “object”) and the default value is "component". “object” dimensions that are of the same "type" and the same "level" and that are connected to each other or overlap are combined across components.
Dimensioning definition:
type
"z"
defines where this dimensioning applies (x, y or z)
from
defines the begining of the dimensioning
to
defines the end of the dimensioning
level
0
the layer of the dimensioning. 0 is the outermost layer
context
"component"
can be "component", "object" or "both"
label
a script to calculate the label of the dimensioning
labels
a map containing key-value pairs for the label of this dimensioning.
visible
true
can be any condition defining if this dimensioning should be shown
Example:
Instead of using a static dimensioning definition object with a “visibility” property, a dimensioning can also be created using the AddAbsoluteDimensioning function in the “onUpdate” script. This function creates a dimenisoning object exactly as if it were explicitly specified in the component definition JSON.
Example:
Plan interaction
In order for configurations to interact with objects in the plan such as walls, it must be possible to define the part of the geometries that can be influenced. This information must be taken into account when placing a configuration in a plan.
Intersect with wallssee
Snap levels
Snap vectors
Wall thickness
Configuration format
The Configuration describes an actual component in a plan with the set parameters and the docked children.
componentId
string
the id of outermost component.
parameters
map
the values to be set for the parameters of this component. Its a Map of key-value pairs where the key is the key of the parameter and the value is the value to be set.
children
array
contains recursivly the definition for all components which are docked to this component.
children/dockChild
string
defines the dockingPoint (one of the points defined in ChildDockings) used to dock this component to its parent. It is defined throu the position of the dockingPoint.
children/dockParent
string
defines the docking of the parent (from the possible dockings defined in ParentDockings of the parent) used to dock this component to. For a DockingPoint the Array contains one point (position of the point), for a DockingLine it contains two points (the start and end point of the line). The positions are within the coordinate system of the parent.
children/dockPosition
string
defines the actual position of the dockingPoint within the coordinate system of the parent. This is used to define the actual position on a dockingLine.
A note to the docking logic: The positions should be stated with 2 digits floating point precision. When matching the points with given docking points from the component definition, they are rounded to 1 digit.
Requirements
There are a few requirements to consider when defining the configuration definition for Components. Since Roomle provides realtime visualization on different plattforms, the models must not become to complex. In general the same rules apply as for static items. When talking about 3D visualization the final number of triangles is the main factor. The less triangles the better the performance. On the other hand less triangles may mean less quality. Therefore one should thrive for the perfect tradeoff between quality and performance.
We define recommendations for preferred average values and upper boundaries that must not be exceeded.
Items
Since Components can be combined to items (via docking logic) of a big variety in size and complexity are possible. Nevertheless the average trianglecount should be between 2000 and 3000. Any Item must not exceed 10000 triangles.
For these values only the rendered triangles are counted, meaning the geometry parts send to the 3D engine for a given parameter combination. Meshes and Primitives which are in the geometryscript but not send to the Engine because of conditions in the script are not counted. Because of the nature of primitives, they should always be preferred to meshes wherever possible.
AddCube
43
12
AddSphere
Depending on the maximum size per dimension: < 10 mm: up to 80 < 100 mm: up to 290 < 1000 mm: up to 1100 < 3000 mm: up to 2100
same
AddCylinder
8*CircleSegments - 4
4*CircleSegments - 4
AddPrism
8*NumberOfVertices - 4
4*NumberOfVertices - 4
AddRectangle
2
2
AddMesh
as defined in the call if no indices provided: nrVertices/3
as defined in the call if no indices provided: nrVertices/3
Configuration Definition
Beside the restrictions on triangles for realtime rendering performance, restriction on filesize for the configuration format apply. This is needed to ensure parsing and execution speed during interaction. Configuration definition should have less than 10k characters on average and must not exceed 500k characters. For these values all characters in the json-file are counted. To fullfill those boundaries one should try to use primitives wherever possible.
Textures
Since imagefiles are always heavy on the memory usage, please keep the usage of textures as little as possible.
Regarding imagefiles for the textures, the same rules as for textures of static items applies:
Imagefiles must be JPEG or PNG with a maximum size of 2048x2048 pixels. The recommended size is below 512x512 pixels. For better performance consider keeping the imagesize a power of two (e.g. 32,64,128...), not necessarily square and use the mm dimensions for scaling.
JSON Objects
This chapter defines all possible JSON Objects used within a Component definition or Configuration. A "?" denotes an optional field.
Script-types
For some properties it is possible to pass a Script, Expression or Condition instead of a simple constant value. The different script types are:
Script: Complex scriptse.g.:
"value1 = 1; value2 = 2; if (value1 < value2) {return true;}"
Expression: Simple expression that evaluates to a specific valuee.g.:
"value1 - value2"
Condition: Similar to expression but always evaluates totrueorfalsee.g.:
"value1 >= value2"
Configuration
Loading Configurations
By default, the order in which the components of a configuration are loaded and docked is undefined and arbitrary This may lead to undesirable behavior in relation to the code in the component definition scripts. To avoid this, the sortOnLoad property can be used to define the order in which the components are loaded. The sortOnLoad property is a constant integer value that defines the order in which the components are docked. Once the components of the configuration have the sortOnLoad property defined the components are sorted by this property before they are docked. Components without the sortOnLoad property are docked after the components with the sortOnLoad property. If the none of the components have the sortOnLoad property defined, the order in which the components are docked is arbitrary.
RoomleScript
RoomleScript is a simple scripting untyped language used within the component definition and configurations. There exists the possiblity of Comments either single line or multiline. Comments are ignored by the Configurator.
Grammar
Operator precedence
1
-a, +a
Unary plus and minus
2
!a
Logical NOT
3
a++
Suffix/postfix increment
4
a*b, a/b, a%b
Multiplication, division and modulo
5
a+b, a-b, a|b
Addition, subtraction and concatenation
6
a>=b, a<=b, a>b, a<b
Relational operators < and ≤ and > and ≥ respectively
7
a==b, a!=b
Equality operators = and ≠ respectively
8
a&&b
Logical AND
9
a||b
Logical OR
10
a?b:c
Ternary conditional
The Roomle script supports the % (modulo) operator and also has the fmod(float):float function.
break statement:
The break statement terminates a for-loop. If a "break" statement is inside nested loops, the innermost loop containing the statement is terminated. A break statement that is not inside a loop is ignored and has no effect.
continue statement:
The continue statement skips the remaining statements in a for-loop, but the loop itself is not terminated. The loop continues its execution with the next iteration. When a continue statement is inside nested loops, only the innermost loop containing the statement is affected A continue statement that is not inside a loop is ignored and has no effect.
return statement:
The return statement terminates the script immediately. This statement can be invoked anywhere within a script. All subsequent commands are skipped and the script ends. It is possible to return a value for scripts that assign a value to its dependent property via "=", such as
articleNrlabelvalidconditionpriceretailPrice
Parameters, internal Variables and Context
Parameters and Variables
Within a component every script has access to a list of variables. All scripts can read the values but only onUpdate, onValueChange and the assignmentScripts are allowed to change them. The list of variables contain all Parameters with the parameter-key as the variable name. New variables are created on first use (e.g. when a value is assigned to it). In Scripts with write access to the internal variables those variables are also stored and from now on accessible from all the other scripts.
Variables context
_.*-> Local context: Available only inside the scope of the current script*andself.-> Self context: Available in all scripts of the component. Can be read everywhere, but only written in specific scriptsconnection.*-> Connection context: Available in connection elements (dockpoint, dockline, sibling)other.*,other_connection.*-> Other context: Available in connection elements (dockpoint, dockline, sibling)object.*-> Object context: This is the global context and these variables are available in all scripts of all connected components and parts
Connection, other and other_connection context
In some scripts you have access to more than one list of variables at once (for example in assignmentScripts). For that you can access variables via "<context>.<variableName>" . In any connection element (dockpoint, dockline, sibling) you can for example access the position of the current dockPoint via "connection.position" and the index within the dockRange via "connection.index". also the context of the other side of the connection (if one is connected) is available in other_connection.*
Global variable context (object scope)
Basic data types
All basic data types (baseType) are support and follow the usual order:
boolintfloatstring
So string is more powerful than float which is more powerful than int and that again is more powerful than bool. This comes to use when working with arrays. That means that you can for example insert a float value into an array of string but not the other way round. More on that topic in the descriptions of the individual array operations.
Integer data type for values
Support for integer data type in roomle script was introduced later in its lifetime and so requires a special suffix i to explicitly define an integer value to not break existing content. So an integer value of 500 looks like 500i, if only 500 gets supplied then this value gets interpreted as a float value. So this means if you have an integer array of arr = [1i,2i,3i] it is necessary to also use the suffix for all array (value) operations, so for example if you look for a value inside of the array inArray(2,arr) would deliver false but inArray(2i,arr) true as a result. Values inside of the array, and also the output, is without the suffix, so it looks like this [1,2,3] and also if you get a value from it get(arr,2) it delivers 3 as result. So the suffix is just needed to explicitly define the data type of the value. IMPORTANT: As mentioned before this is only needed for values! It is not needed for things like indices or such stuff, but is also supported, so it is possible to write an index with or without the suffix.
Available Functions
This section includes all functions available in the Roomle Script
General Functions
activeGroupInView
-
To request active group in the view.
getPosition
*componentId:int
Returns the current position of the component in the coordinate system of the parent. ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
getAbsolutePosition
*componentId:int
Returns the current position of the component in the coordinate system of the root component (absolute position). ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
getDockPosition
-
Returns the current position of the childDockPoint of this component in the coordinate system of the parent.
getDockPositionRelativeToParentDock
-
Returns the current position of the childDockPoint of this component relative to the parentDock in the coordinate system of the parent. The reference is the point for dockpoints and the starting point for docklines.
getUniqueRuntimeId
-
Returns a unique runtimeId for the component. This id is unique in the session and wont change for this component (during this session).
getPointlistFromSvg
svgData:String, *index:int, *curvePointDensity:int
isnull
-
Checks whether the provided variable is null. if variable is null it returns true , otherwise false.
setnull
-
Sets the given variable to null.
getMaterialProperty
parameterKey:string, propertyKey:string, defaultValue:string
Returns material property value for a material.
getEnvironmentProperty
propertyKey:string
Returns the requested environment property. Retrievable properties are country, currency, language, unit, unitString and level
xFromVector
vector:Vector3f{x,y,z}
Returns the x component of the given vector.
yFromVector
vector:Vector3f{x,y,z}
Returns the y component of the given vector.
zFromVector
vector:Vector3f{x,y,z}
Returns the z component of the given vector.
set
array:Array<baseType> index:int value:baseType
Sets the value at the given index in the array. It is possible to set values of a lower type in an array of a more powerful type, e.g. set a bool value in an array of type float. Keep in mind that the value gets converted to the type of the array.
get
array:Array<baseType> index:int
Returns the value at the given index in the array.
pushBack
array:Array<baseType> value:baseType array:Array<baseType> value:Array<baseType>
Adds the value, or multiple values, at the end of the array. It is also possible to add another array via variable or literal. Also mixed parameters are support (eg: pushback(arr, 1, 2, otherArr, [3, 4, 5]). It is possible to push back single values of a lower type to an array of a more powerful type. The value then gets converted to the type of the array. Push back an array, or multiple values at once, into an array of a different type is not possible. pushBack is also implemented for Vecto2f and Vector3f. So it is possible to push Vecto2f and Vector3f arrays and values to arrays of the corresponding type.
insert
array:Array<baseType> index:int value:baseType array:Array<baseType> index:int value:Array<baseType>
Insert the value, or multiple values, at the given index and pushes back all other elements in the existing array. Inserting multiple values at once is also supported. It is also possible to insert single values of a lower type to an array of a more powerful type. The value then gets converted to the type of the array. Inserting an array, or multiple values at once, into an array of a different type is not possible.
removeAt
array:Array<baseType> index:int array:Array<baseType> indexBegin:int indexEnd:int
Removes one, or multiple, elements from an array and returns the next valid element in the array. If a range of elements gets removed indexBegin defines the first element to be removed and all elements up to indexEnd get removed, without the element at indexEnd. So the element before indexEnd is the last element that gets removed and the element at indexEnd stays and will be returned as the next valid element in the array.
popBack
array:Array<baseType>
Removes and returns the last element of the array.
indexOf
value:baseType array:Array<baseType>
Returns the first index of the value in the array, or -1 if not found.
length
array:Array<baseType>
Returns the current length of the array.
getBoxOrigin
*componentId:int
Returns the (local) origin position of the bounding box of this component relative to its own root (not global!). ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
getBoxSize
*componentId:int
Returns the size of the bounding box of this component. ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
getBoxForMeasurementOrigin
*componentId:int
Returns the (local) origin position of the measurement box of this component relative to its own root (not global!). ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
getBoxForMeasurementSize
*componentId:int
Returns the size of the measurement box of this component. ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
setBoxForMeasurement
Box:Vector3f{w,d,h},Offset:Vector3f{x,y,z}
Defines the box to be used for calculating the measurements of this component. (only allowed in "onUpdate")
isEnabled
parameterKey:string
Returns true if the parameter is enabled.
setEnabled
parameterKey:string, value:bool
Sets the enabled-property of the parameter to the given value. (only allowed in "onUpdate")
isVisible
parameterKey:string
Returns true if the parameter is visible.
setVisible
parameterKey:string, value:bool
Sets the visible-property of the parameter to the given value. (only allowed in "onUpdate")
like
value: string, pattern: string
Returns true if the value of the string matches the pattern, '_' is a wildcard for any character and '%' is a wildcard for any string.
in
anyVariable, listOfValues...
Returns true if the first Parameter is equal to any of the remaining parameters.
inArray
anyVariable, array:Array<baseType>
Returns true if the first Parameter is equal to any of the elements in the array.
intersection
array:Array<baseType>, array:Array<baseType>
Returns an array containing the numbers that exist in both arrays. Intersecting arrays of different types also returns an empty array.
string
value:any [, precision:int]
Converts the parameter to string, the precision argument is optional and specifies the decimal places of a floating-point number.
stringToArray
argument:string
Converts a string to an array of floating-point numbers (array:Array). The numbers in the string have to be constants. e.g.: stringToArray('[1,2,3]') returns the array [1.0, 2.0, 3.0].
stringToVector2f
argument:string
Converts a string to a value of type Vector2f. The numbers in the string have to be constants. e.g.: stringToVector2f('{1,2}') and stringToVector2f('Vector2f{1,2}') returns the vecotor Vector2f{1.0, 2.0}.
stringToVector3f
argument:string
Converts a string to a value of type Vector3f. The numbers in the string have to be constants. e.g.: stringToVector3f('{1,2,3}') and stringToVector3f('Vector3f{1,2,3}') returns the vecotor Vector3f{1.0, 2.0, 3.0}.
float
any
Converts the parameter to float.
size
param:string
Calculates the size of the given string.
substring
string:string, startIndex:int, length:int
Returns the substring of the given string, starting at startIndex with given length.
stringPart
string:string, delimiter:string, index:int, *fallback:string
Splits a string at the delimiter and returns the substring at the corresponding index, or the (optional) fallback-value (or empty string if not provided) if not found or invalid.
stringSplit
string:string, delimiter:string
Splits a string at the delimiter and returns an array:Array<string> with all substrings.
tanh
angle:float
Returns the tanges hyperbolicus.
sinh
angle:float
returns the sinus hyperbolicus.
cosh
angle:float
Returns the cosinus hyperbolicus.
tan
angle:float
Returns the tanges.
sin
angle:float
Returns the sinus.
cos
angle:float
Returns the cosinus.
atan
value:float
Returns the arcus tanges.
atan2
y:float, x:float
Returns the principal value of the arc tangent of y/x.
asin
value:float
Returns the arcus sinus.
acos
value:float
Returns the arcus cosinus.
log
value:float
Returns the natural logarithm.
log10
value:float
Returns the logarithm with base 10.
exp
value:float
Returns the exponential function.
fabs
value:float
Returns the absolute value.
sqrt
value:float
returns the square root.
fmod
a:float, b:float
Returns the floating point remainder of a/b.
pow
a:float, b:float
Calculates a to the power of b.
floor
number:float, digits:int
Returns the next lower number with the given digits.
ceil
number:float,digits:int
Returns the next bigger number with the given digits.
round
number:float, digits:int
Rounds to the nearest number with the given digits.
isnull
anyVariable
Returns true if the variable/parameter is not set.
ifnull
anyVariable, defaultValue:any
Returns the first parameter if it is not null, otherwise the second.
getData
... key: (string or int)
Returns an element of the "data" object addressed by a list of keys and/or indices.
getDataOrNull
... key: (string or int)
Returns an element of the "data" object addressed by a list of keys and/or indices.
getDataWithDefault
... key: (string or int), defaultValue: (boolean, int, float or string)
Returns an element of the "data" object addressed by a list of keys and/or indices.
getSubComponentData
internalId: string, ... key: (string or int)
Returns an element of the "data" object addressed by a list of keys and/or indices from a subcomponent.
getSubComponentDataOrNull
internalId: string, ... key: (string or int)
Returns an element of the "data" object addressed by a list of keys and/or indices from a subcomponent.
getSubComponentDataWithDefault
internalId: string, ... key: (string or int), defaultValue: (boolean, int, float or string)
Returns an element of the "data" object addressed by a list of keys and/or indices from a subcomponent.
evalauteData
... key: (string or int)
Evalautes an element of the "data" object addressed by a list of keys and/or indices.
evalauteDataOrNull
... key: (string or int)
Evalautes an element of the "data" object addressed by a list of keys and/or indices.
evaluateDataWithDefault
... key: (string or int), defaultValue: (boolean, int, float or string)
Evalautes an element of the "data" object addressed by a list of keys and/or indices.
evaluateSubComponentData
internalId: string, ... key: (string or int)
Evalautes an element of the "data" object addressed by a list of keys and/or indices from a subcomponent.
evaluateSubComponentDataOrNull
internalId: string, ... key: (string or int)
Evalautes an element of the "data" object addressed by a list of keys and/or indices from a subcomponent.
evaluateSubComponentDataWithDefault
internalId: string, ... key: (string or int), defaultValue: (boolean, int, float or string)
Evaluates an element of the "data" object addressed by a list of keys and/or indices from a subcomponent.
findData
... key: (string or int), filterFunction: String
Search for objects in a data using a filter function. The return value is an array with all matches.
findSubComponentDataData
internalId: string,... key: (string or int), filterFunction: String
Search for objects in a data using a filter function from a subcomponent. The return value is an array with all matches.
findAndEvaluateData
... key: (string or int), filterFunction: String
Evalautes and search for objects in a data using a filter function. The return value is an array with all matches.
findAndEvaluateSubComponentData
internalId: string,... key: (string or int), filterFunction: String
Evalautes and search for objects in a data using a filter function from a subcomponent. The return value is an array with all matches.
getComponentProperty
key:string, *componentId:int
Returns the value for the given property-key. Available keys are runtimeId, catalogId and externalId. getComponentProperty('runtimeId') delivers the same result as getUniqueRuntimeId() and returns an integer value with the runtimeId, whereas getComponentProperty('catalogId') and getComponentProperty('externalId') return a string value with the corresponding id-values (or empty string if no catalogId was defined). ONLY Inside of the collisionCondition script it is possible to optionally pass a componentId to the function to retrieve the data from the corresponding component.
getObjectProperty
key: string, *defaultValue: (boolean, int, float or string)
Returns the value for the given property-key from the plan object.
wallthickness: Returns the thickness of the wall to which the plan object is attached if the object is used as a construction object. Otherwise, the default value or, if not present, 0 is returned.configurationLoaded: Returns if the initial loading process of the configuration is completed.
AddAbsoluteDimensioning
type: string, from: float, to: float, level: int, *context: string, *label: string
Adds a dimensionig object. (only allowed in "onUpdate")
Custom Script Functions
It is possible to define a custom function inside of scripts. These functions are available in the whole script after its definition, also if it was defined in the scope of an if/else/for body or even inside another function. The function is only available inside the script it was defined, so it is not possible to use a function that was defined in the onUpdate script inside the geometryScript (for example). To define a function it is only needed to provide the function keyword, followed by a name and parameters inside of brackets, followed by the function body inside curly brackets. Functions also support return values. So a function can look like this:
Afterwards you can call the function simply by writing
which result is 20 with the given example.
Functions have the same access rights as the scripts in which they get defined and used. So for example a function defined inside the geometry script has the same access rights as the geometry script itself.
If a parameter shadows an existing variable by using the same name, the parameters value gets used inside the function and a warning message gets raised. If a function shadows an existing, internal function by using the same name, the custom defined function overrules the existing, internal one and a warning message gets raised. Local variables (e.g.: _.a) are only available inside the function and get deleted when out of scope.
It is possible to pass functions as parameters or use them as values, for example something like this:
Custom Component Functions
Similar to the Custom Script Functions it is possible to define Custom Component Functions. The biggest difference is that these functions are accessible in all scripts of the component. Another difference is that these functions support default values for arguments and also keyword arguments. Be aware that the first argument can not be passed via keyword argument! These functions are defined in the functions section of the component and look like this:
In this example the identifier/name (key) of the function is foo and so is callable from all scripts by simply writing its name: foo(). Defining a key is mandatory, without it a function would not be callable. The next section is the arguments section which defines an array of function arguments. Setting the key is mandatory because this is the name of the paramter it gets referenced inside the function script. The defaultValue property of an argument is optional and gets used inside the function script if no parameter was provided during function call. The last section is the function script itself, or function-body, and is the main part of the function and where the magic happens. Everything you can do inside a script is also possible to do inside the function script, including defining Custom Script Functions inside the body of a component function script. Be aware of script access rights, so if you create a component function that writes to a parameter or accesses members from other or connection or something, it is not possible to call this component function inside a script that does not have the corresponding access rights. So for example if your component function writes to a parameter it is not possible to call this functions inside of a geometry script. The highest access of a component function gets determined during compile time and throws an error if access rights got violated. It is also not possible to call functions recursive, this alse gets determined during compile time and throws an error, such functions are callable but always return 0. Function name overrides are possible but throw a warning and the hierarchy is Custom Script Function -> Custom Component Function -> Internal Function, that means you can overwrite a internal function with a component function and then overwrite a component function with a script function. Variable shadowing gets detemined during runtime and also throws a warning, similar to how script functions behave. If a function gets called with too few arguments and no default values are given you also get an error. It is possible to call a component funciton inside another component function.
So a complete component definition could look something like this example:
This would result in the parameter called result having the value 10. The value for argument myArg1 gets set during function call (5) and the value for argument arg2 gets taken from its defined default value.
It is also possible to call functions from sub-components. This can simply be achieved by putting the name of the sub-component with a dot in front of the function call, so something like comp.func(). This could look like the following example:
This would result in the parameter called result having the value 911. The result gets assigned via the onUpdate script in the main-component which calls the function foo(...) of the sub-component called library with the value 910 as function argument. Every function is always executed in the context of its caller, so keep this in mind regarding script access rights and variable shadowing.
Component function parameter direction
It is possible to also define the direction of a parameter. This means if it is only an input parameter (default) or an input/output parameter that can also be written to. For this simply add the direction property "direction": "inout" to a parameter and you can write to it inside the function. Keep in mind that only variables can be passed as function argument for such parameters, so no const values or expressions (e.g: func(5) or func(var + 1) is not possible and throws an error). It is possible to do this for multiple parameters.
Available values for direction are:
in(default) - Read only, can not be changedinout- Changeable inside the function
So a complete component definition could look like this example:
This would result in the parameter called result having the value this is a test.
Component function scope
The function call is always in the scope of its caller. So if, for example, there is a variable x in the script and afterwards a component function gets called it has access to x. However, the function has only access to functions defined in the same component! So if you have a function A() in ComponentA and a function B() in ComponentB, this function B() can not access function A() because it is defined in a different component that is not included as a sub component. But it is possible to pass function A() as a parameter to function B() of the sub component.
Component function types
Some scripts in roomle script have special functions available, like AddCube in geometry. These special functions are not available in default component functions, but it is possible to define the type of a component function to make these functions available. The available function types are:
defaultonUpdatechangeablecollisionConditiongeometryexport
A function without a specified type is considered as default. These types can be defined by setting it via the key type inside the function definition:
Functions of the type default can be called from everywhere, all others can only be called inside the corresponding scripts. It is also possible to call functions inside functions of a different type, but validity is depended of the context of the calling script. So for example it is possible to call a default function that calls a geometry function (and vice versa) inside a geometry script, but not inside an onUpdate script. The special functions inside the scripts and corresponding typed functions are:
collisionConditiongetBoxOrigingetBoxSizegetBoxForMeasurementOrigingetBoxForMeasurementSize
changeablesetBoxForMeasurementsetVisiblesetEnabled
onUpdaterequestDockItemsetBoxForMeasurementsetVisiblesetEnabled
geometryBeginObjGroupCubeCylinderSpherePrismMeshRectangleMoveMatrixByRotateMatrixByScaleMatrixBySetObjDimensionPointCopyEndObjGroupSetObjSurfaceSetObjSurfaceAttributeSetUvTransformScaleUvMatrixByRotateUvMatrixByMoveUvMatrixBySubComponentAddCubeAddPlainCubeAddCylinderAddSphereAddPrismAddMeshAddExternalMeshAddRectangleAndOperatorOrOperatorMinusOperatorIntersectWithWallsReverseFaces
exportgetBoxOrigingetBoxSizegetBoxForMeasurementOrigingetBoxForMeasurementSizegetPositiongetAbsolutePosition
So a complete component definition could look something like this:
Geometry Object Functions
There exist a set of functions for generating geometry objects for this component. Each function has optional Parameters to modify the generation of the uv-Coordinates for the object. This is relevant for the placement of textures.
A uvScale of 2 means that the uv-Coordinates are scaled by 2 which results in the texture being shown with half the size. Same goes for the uv-Offset and Rotation: They modifiy the position and orientation of the uv-Coordinates, which in return affects the placement of the texture in the "other" direction.
For the AddMesh function one can provide explicit uvCoord and normals. The number of uvCoords must match the number of indices provided. The number of normals must match the number of vertices provided.
Vertices, uvCoords and uvOffset ist always in mm.
SubComponent injects the corrensponding geometry of the given Subcomponent. For geometry, geometryHD, previewGeoemtry, environmentGeometry or boundingGeometry scripts the corresponding geometry, geometryHD, previewGeoemtry, environmentGeometry or boundingGeometry of the sub component is injected.
Keyword arguments
It is possible to pass parameters for geometry functions via keyword arguments. So it is not needed to input all parameters with default values just to set the last one, instead it is possible to pass the parameter name and value to set it. So for example if one wants to just set the bevel value, instead of writing AddCube(Vector3f{1000, 1000, 1000}, Vector2f{0, 0}, 0, Vector2f{0, 0}, 100); it is possible to just write AddCube(Vector3f{1000, 1000, 1000}, bevelWidth=100); instead. The paramter names can be looked up in the list below.
This is currently only possible for geometry functions of simple geometries, not meshes or external meshes. So it is currently supported by:
AddCube
AddPlainCube
AddCylinder
AddSphere
AddPrism
AddRectangle
Geometry faces indices
Basic geometry funtions support passing of multiple individual properties via arrays for some parameters (like materials or uvTransforms). The index of the property inside the array specifies the face of the geometry the property gets applied to. These indices are as follows:
BASE
0
BEVEL
1
TOP
2
BOTTOM
3
FRONT
4
BACK
5
LEFT
6
RIGHT
7
Material parameter
The corresponding keyword arguments are:
BASE
0
material
BEVEL
1
materialBevel
TOP
2
materialTop
BOTTOM
3
materialBottom
FRONT
4
materialFront
BACK
5
materialBack
LEFT
6
materialLeft
RIGHT
7
materialRight
Or materials to pass whole array as keyword argument.
So if a for example a cube gets created with the following code:
The result is a cube with a green bevel, a blue top, black bottom, cyan front, magenta back, yellow left side and white right side. The first member in the array is always the base material, so if not all sides are explicitly set to a material these sides get the base material assigned.
So if for example if a cube gets created with the following code:
The result will be a red cube with a green bevel and a blue top.
It is also possible to set the materials via keyword arguments, so the code could look like this:
Or pass an array as keyword argument:
These would result in a black cube with a red bevel.
If a material for a side gets provided via keyword arguments but no base material ("material") was given an error message will be logged and the base material gets set to the default value (empty string which results in plain white in the renderer). Some geometries, like prism or cylinder, have no left, right, front and back, but only a side/mantle that goes all around. In this case the material for the side has to be set via the 'materialFront' property or corresponding index in the array, all other provided side materials will be ignored.
If setObjSurface(...) function gets called after component creation, all previously defined materials get overridden.
UvTransform parameters
If SetUvTransform(...) function gets called after component creation, the transform gets added to the existing one.
Material attributes
It is possible to override a representation property of the material for a specific geometry. This avoids the need to create multiple materials in the database when only one property (e.g. colour) is different. For example, a basic "plastic" material can be added to the DB, but the actual colour of the object is set in Roomle Script. This can be done with the SetObjSurfaceAttribute function, where a key/value pair is specified that overrides a property of the current object material. The colour of the material can be specified with a hexadecimal colour representation ('#ff8000', 'rgb(255,128,0)', 'rgb(50%,0%,100%)', 'hsl(0,100%,50%)'). e.g.:
Parameters marked with * are optional.
Table of Geometry Functions
AddCube
Size:Vector3f{width,depth,height}, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float , *uvOffset:Vector2f{offU, offV}, *bevelWidth, *materials:Array<String>
AddPlainCube
Size:Vector3f{width,depth,height}, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float , *uvOffset:Vector2f{offU, offV}, *materials:Array<String>
AddSphere
Size:Vector3f{width,depth,height}, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float ,*uvOffset:Vector2f{offU, offV}, *materials:Array<String>
Creates a Sphere. Passing multiple materials or uvTransforms via array is possible but has no effect because Sphere has only one face. Only the first value will be taken.
AddCylinder
RadiusBottom:float, RadiusTop:float,Height:float, CircleSegments:float, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float , *uvOffset:Vector2f{offU, offV}, *bevelWidth, *materials:Array<String>
AddPrism
Height:float, Vertices:Array<Vector2f>, *uvScale:Vector2f{scaleU, scaleV} ,*uvRotation:float , *uvOffset:Vector2f{offU, offV}, *bevelWidth, *materials:Array<String>
AddRectangle
Size:Vector2f{width,height}, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float , *uvOffset:Vector2f{offU, offV}, *materials:Array<String>
Creates a flat rectangle. Passing multiple materials or uvTransforms via array is possible but has no effect because Rectangle has only one face. Only the first value will be taken.
Copy
Creates a copy of the last drawn object or group
AddMesh
Vertices:Array<Vector3f>, *Indices:Array<int> , *uvScale:Vector2f{scaleU, scaleV } , *uvRotation:float , *uvOffset:Vector2f{offU, offV }
Creates a mesh from the given vertices. If no indices are provided, the number of points must be a multiple of 3. Every group of 3 vertices form a triangle. With indices there must not be an index bigger than the number of Points -1. The number of Indices must be a multiple of
AddMesh
Vertices:Array<Vector3f>, *Indices:Array<int> , *uvCoordinates:Array<Vector2f> , *normals:Array<Vector3f>
Creates a mesh from the given vertices with uvCoordinates and normals
AddExternalMesh
meshId:String, Bounds:Vector3f{w,d,h}, *BoundsOffset:Vector3f{x,y,z}, *uvScale:Vector2f{scaleU, scaleV } , *uvRotation:float , *uvOffset:Vector2f{offU, offV }
Adds an external Mesh with the given Id. Bounds and boundsOffset tells the configurator the size and position of the loading box until the mesh is loaded. Optional parameters for scaling, rotating and offsetting uvCoordinates are supported.
BeginObjGroup
GroupName:String
Begins a new objectgroup
EndObjGroup
GroupName:String
Defines the end of the Objectgroup
MoveMatrixBy
translation: Vector3f{x,y,z}
Moves the previously drawn object or group by the given vector
RotateMatrixBy
axis: Vector3f{x,y,z}, pivot: Vector3f{x,y,z}, angle:float
Rotates the last drawn object or group according to the parameter. The unit of the angle is Degree.
ScaleMatrixBy
scaling: Vector3f{x,y,z}, *pivot: Vector3f{x,y,z}
Scales the last drawn object or group by the given vector around a given pivot. Pivot is optional and defaults to {0,0,0} if no values provided
SetUvTransform
uvScale:Vector2f{scaleU, scaleV }, uvRotation:float, uvOffset: Vector2f{offU, offV }
Sets UV transform for the last drawn object. Overrides previous SetUvTransform calls, but gets multiplied on uvTransforms added via geometry generation functions.
ScaleUvMatrixBy
uvScale: Vector2f{scaleU, scaleV }
Applies scaling to UVs of the last drawn object
RotateUvMatrixBy
uvRotation: float
Applies rotation to UVs of the last drawn object. The unit of the angle is Degree.
MoveUvMatrixBy
uvOffset: Vector2f{offU, offV}
Applies offset to UVs of the last drawn object
AnimationMatrixMoveBy
key: String, translation: Vector3f{x,y,z}
Set the animation movement of the previously drawn object or group by the given vector. The key is the combination of the animation and the action associated with a double dot animationKey:actionKey.
AnimationMatrixRotateBy
key: String, axis: Vector3f{x,y,z}, pivot: Vector3f{x,y,z}, angle: float
Sets the animation rotation of the last drawn object or group according to the parameter. The unit of the angle is Degree. The key is the combination of the animation and the action associated with a double dot animationKey:actionKey.
AnimationMatrixScaleBy
key: String, scaling: Vector3f{x,y,z}, *pivot: Vector3f{x,y,z}
Sets the animation scaling of the last drawn object or group by the given vector around a given pivot. Pivot is optional and defaults to {0,0,0} if no values provided. The key is the combination of the animation and the action associated with a double dot animationKey:actionKey.
SetObjSurface
MaterialId:String
Assigns the given Material to the last drawn object or group
SetObjSurfaceAttribute
AttributeId: String or Variable, AttributeValue: Any
Overries an attribute of the Material of the last drawn object or group
SubComponent
internalId:String
Injects the geometry of the given Subcomponent
AndOperator
Intersect the two previously constructed geometries, the result is the volume that both geometries have in common (A AND B)
OrOperator
Merge the two previously constructed geometries, the result is the outer cover of both geometries (A OR B)
MinusOperator
Subtracts the two previously constructed geometries from each other (A - B)
ClipOperator
position: Vector3f, direction: Vector3f, *material: String, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float, *uvOffset:Vector2f{offU, offV},
Clips the previously constructed geometry with a plane and optionally creates a cap. The cap geometry is only generated if a material is specified.
StretchOperator
position: Vector3f, direction: distance: float,Vector3f, *material: String, *uvScale:Vector2f{scaleU, scaleV} , *uvRotation:float, *uvOffset:Vector2f{offU, offV},
Stretchs the previously constructed geometry with at a plane. The object is divided into 2 parts in the plane and an extrudate is inserted between the two parts.
ReverseFaces
Reverses the faces of the last drawn object or group
IntersectWithWalls
Indicates that the previously constructed geometry must be intersected with walls (*1)
*1) Intersection with walls cannot be applied prior to 3D Boolean operations. Therefore, using a geometry that needs to be intersected by walls in a Boolean operation will result in an error.
RotateMatrix
The RotateMatrixBy function can be used to rotate an object.
The object is always rotated around the origin of the world (0, 0, 0). That means if the centre of the mesh is not (0, 0, 0) or the object is moved prior to rotation, the origin of the world is the pivot point of the rotation.
To get better control over the rotation, the pivot point can be specified explicitly.
ScaleMatrixBy
The ScaleMatrixBy function can be used to scale an object.
The object is always scaled relative the origin of the world (0, 0, 0). This means that if the centre of the mesh is not (0, 0, 0) or the object is moved prior to scaling, the origin of the world is the pivot point for scaling.
To get better control over the scaling, the pivot point can be specified explicitly.
Animations Matrix (AnimationMatrixMoveBy, AnimationMatrixRotateBy, AnimationMatrixScaleBy)
Component definitions are asset that are used to create configurations and display them in the 3D scene, but the component definition does not trigger any actions. Component definitions only define which actions can be triggered and what happens when they are triggered. The actions are triggered by the user in the 3D scene, e.g. by clicking on a button, or are automatically triggered by the system (WebSdk) when the user interacts with the model. Thus, the geometry script defines what the final state of an animation is when it is triggered. The final state of the animation is defined by an animation matrix, which is combined with the object's matrix when the animation is triggered.
e.g.:
It is important that the functions generate exactly one animation matrix per "key" and geometry when they are chained together. If you apply animation matrices to a group, it is not the group that is animated, but the animation matrix of each individual object in the group is manipulated. The final animation matrix is the combination of the original matrix of the geometry and the additional animation matrix. With this approach it is currently not yet possible to create complex animations, but only very simple animations such as changing the position or rotating around an axis. It is also not possible to animate parts of a Boolean operation, but only the entire object that results from a Boolean operation.
e.g.:
You can do something like this:
But not something like this:
At first glance this looks pretty similar, but there is one important difference in the last two lines of the geometry script. The first example applies the CSG operator (MINUS) first and then the AnimationMatrix second. This means that Object is constructed first and then the animation gets applied to the whole object. The second example adds the AnimationMatrix first and then the CSG operation, so the AnimationMatrix would be part of the CSG operation and this is not allowed and throws an error. The same is true for clip- and stretch-operations.
CSG (Constructive Solid Geometry) Operators (AndOperator, MinusOperator, OrOperator)
The CSG operators can unite, intersect or subtract individual geometries or even groups of geometries. e.g.:
OrOperator
AndOperator
MinusOperator
combines two geometries, respectively determines the united volume
intersects two geometries, respectively determines the volume that two geometries have in common
subtracts the second geometry from the first one
The operators also work with geometries made of different materials. The final shape consists of the materials of the two objects from which it was created. So, for example, if a cube with material A is subtracted from a cube with material B, the resulting shape will have materials A and B. This also applies to multiple material geometries, groups, nested groups and combinations of all these where the objects in groups are ORed as long as no other operation is explicitly specified.
SetObjSurface('roomle_script_test:texture_4x4');
AddPlainCube(Vector3f{1000, 1000, 1000});
MoveMatrixBy(Vector3f{250, 250, 250});
SetObjSurface('roomle_script_test:red');
MinusOperator();
AddCube(Vector3f{1000, 1000, 1000}, bevelWidth = 50, materials = m1);
m2 = ['roomle_script_test:magenta', 'roomle_script_test:yellow'];
AddCube(Vector3f{1000, 1000, 1000}, bevelWidth = 50, materials = m2);
MoveMatrixBy(Vector3f{250, 250, 250});
MinusOperator();
AddPlainCube(Vector3f{1000, 1000, 800});
SetObjSurface('roomle_script_test:blue');
AddPlainCube(Vector3f{800, 800, 1000});
SetObjSurface('roomle_script_test:cyan');
MoveMatrixBy(Vector3f{200, 200, 800});
EndObjGroup();
BeginObjGroup();
AddCylinder(500, 500, 1400, 32);
SetObjSurface('roomle_script_test:yellow');
MoveMatrixBy(Vector3f{1000, 1000, 200});
AddSphere(Vector3f{1000, 1000, 1000});
SetObjSurface('roomle_script_test:red');
MoveMatrixBy(Vector3f{700, 700, 500});
EndObjGroup();
MinusOperator();
If a material is set after the CSG operation with SetObjSurface, the material of the whole resulting geometry will be overwritten and the resulting geometry will have only this material. If the material specification for a part of the geometry is missing, the first material involved in the operation is automatically used.
The operators work on the basis of the winding order of the triangles of the meshes. It may therefore be necessary to reverse the order of the triangles of the mesh. This can be done with the ReverseFaces function.
ClipOperator
The clip operator has 2 mandatory parameters and 4 optional parameters
With the clip operator geometry can be clipped with a plane. The plane is defined by a position and a direction. The operator clips exactly one geometry or group. It clips the geometry or group which was drawn prior to the clip operation. The clip operator can also create a cap geometry. The cap geometry is only generated if a material is specified.
The clip operator works with the logic that you get what you see. Let's assume you are looking from a position in the scene in a certain direction, then everything you see is kept and everything you don't see is clipped.
The ClipOperator is optimized for clipping a geometry with one plane and is therefore much more performant than the MinusOperator, which is a general boolean operation. For example, if you want to clip a geometry by a cube (A AND B, where B is the cube), then the cube consists of 6 faces, where each face has 2 triangles, resulting in a total of 12 triangles that must be considered for the clipping. The same can be achieved with 6 clipping planes, with each plane requiring only one operation, with the advantage that each clipped side cap can be given its own material. Of course, a clipping plane cannot be used to cut holes, for this purpose the MinusOperator is the best choice.
StretchOperator
The stretch operator has 3 mandatory parameters and 4 optional parameters.
The stretch operator is an extension of the clip operator. Unlike the clip operator, however, it does not cut off a piece of the geometry, but divides the geometry in a plane, moves the parts apart and fills the gap with an extrude. The plane is defined by a position and a direction. The material and the UV transformation of the extruder can be specified separately as an option.
GetPointlistFromSvg function
Description
In RoomleScript we habe the possibility to get a list of 2D points from an input SVG. This can be further used to pass to the addPrism function to create an three dimensional object from an 2D SVG input.
getPointlistFromSvg
svgData:String, *index:int, *curvePointDensity:int
Returns a vector:Vector2f with the contents of an SVG as 2D pointlist.
This function supports all the basic functionality of SVGs but is limited to the geometry related stuff. That means it can create a pointlist (contour) from an SVG, but does not read any color values (color, gradient, ...) or any advanced functiality (animations, ...). But it can read any shapes, polygons, lines, curves and all that stuff.
It is also possible to read multiple shapes defined in a single SVG file. It is necessary to pass the index of the desired shape. If not it will always return the first shape per default.
It is also possible to define the pointlist resolution for curves, called "curve point density". If a shape consist of a straight line only the start- and end-point get added to the list. If the shape is a curve it adds as many points on that curve depending on the curve-point-density parameter. If none is provided it defaults to 8.
The following table shows the outcomes when using different values for the curve point density parameter. The value to be used always depends on how large your object, or line segments are. Keep in mind that this setting affects the poly count of the final 3D geometry, the higher the curve point density, the higher the polycount. As already mentioned the default value is set to 8, which is a pretty useful value in general, but it can be necessary to change this value depending on your situation. Keep in mind that this value defnies how many points should be drawn from start to end point of a curve, including start and end point, so the value can not be lower than 2.
The provided SVG data has to be a string and can not be loaded directly from a file, so it is necessary to open the desired SVG file in an editor and copy the contents into a string in RoomleScript.
Also the code is optimized to convert an SVG only once, so if you call getPointlistFromSvg multiple times for the same SVG (with the same curve point density) you will get a cached pointlist returned, so calling it multiple times (e.g.: with different indices) does not have an impact on performance.
Example
Here is a small example of how such a RoomleScript definition could look like:
The outcome of this example would look like this:
Notice how the offset definition in the SVG content also affects the position of the geometry in the 3D scene.
Docking request functions
A docking request can only be used in the "onUpdate" script of a component.
requestDockItem
item: String, parentPostion: Vector3f{x,y,z}, *childPostion: Vector3f{x,y,z}
Requests the docking of an item at the specified position to this component.
The docking request is only valid if a docking point or a docking line is defined at the parent position in the component. The subordinate position is optional and is only used to select a subordinate position if multiple child points are defined.
Construction elements special features
For construction elements in the Planner (Roomle Room Planner), like doors and windows, there are some special features available. These features only affect component definitions that are used as construction elements. On "generic" components these features have no effect.
Door arches
Constants
There are various constants available in roomle script, accessible via a specific keyword.
Math Constants
e
M_E
2.71828182845904523536028747135266250
log2(e)
M_LOG2E
1.44269504088896340735992468100189214
log10(e)
M_LOG10E
0.434294481903251827651128918916605082
loge(2)
M_LN2
0.693147180559945309417232121458176568
loge(10)
M_LN10
2.30258509299404568401799145468436421
pi
M_PI
3.14159265358979323846264338327950288
pi/2
M_PI_2
1.57079632679489661923132169163975144
pi/4
M_PI_4
0.785398163397448309615660845819875721
1/pi
M_1_PI
0.318309886183790671537767526745028724
2/pi
M_2_PI
0.636619772367581343075535053490057448
2/sqrt(pi)
M_2_SQRTPI
1.12837916709551257389615890312154517
sqrt(2)
M_SQRT2
1.41421356237309504880168872420969808
1/sqrt(2)
M_SQRT1_2
0.707106781186547524400844362104849039
Other Constants
null
NULL_VALUE
null
Examples
Component Definition of a table
This geometry script defines a table where the material of the plate and the legs can be set (via Parameter of the component). The width of the table is also a parameter.
Last updated
