Support site for Simplebim users
In This Topic
    Prototypes
    In This Topic

    We often get requests from customers for functionality that solves some specific problem. The Prototypes add-on is a place where we can quickly and easily implement and publish such functionality without cluttering Simplebim. Prototypes, like the name implies, do not go through the same testing process as functionality in the standard product. Often functionality matures in the Prototypes add-on and is then later included in some way in the standard product.

    The Prototypes add-on contains the following modules (version 8.0 / 12.7.2019)

    Tool: Group Delete

    Tool for deleting groups of a given type that have a name that matches a given pattern. This tool is useful for deleting groups that you don't need, which makes IFC file sizes smaller and speeds up operations inside Simplebim.

    Configuration Options

    Because this tool needs to be configured it can only be run from a template. This tool is not visible in the Tools drop-down menu of the ribbon.

    Key

    TARGET

    Defines the target of the operation, i.e. the groups that might be deleted by the tool. For example TARGET=ZONE specifies that only groups mapped to IfcZone may be deleted.

    Value
    ALL All groups

    GROUP

    Groups mapped to IfcGroup
    ASSET Groups mapped to IfcAsset
    INVENTORY Groups mapped to IfcInventory
    SYSTEM Groups mapped to IfcSystem
    BUILDINGSYSTEM Groups mapped to IfcBuildingSystem
    DISTRIBUTIONSYSTEM Groups mapped to IfcDistributionSystem
    DISTRIBUTIONCIRCUIT Groups mapped to IfcDistributionCircuit
    ZONE Groups mapped to IfcZone
    <Object Class> This option is used for deleting type objects. For example the value WALL sets the target to types of IfcWall.
    NOTE: It is possible to delete also type objects with this tool because internally type objects are handled as groups in Simplebim.
    Key

    PATTERN

    The pattern the name of the target group must match to be deleted

    Value

    The value may contain the wild cards * and ?.

    Examples

    • '*' deletes all target groups
    • 'ABC*' deletes all target groups where the name starts with 'ABC'
    • '*ABC' deletes all target groups where the name ends with 'ABC'
    • 'A*C' deletes all target groups where the name starts with A followed by any number of characters ending with B.
    • 'A???C' deletes all target groups where the name starts with A followed by any 3 characters and ends with B.

    Tool: Group Merge

    Tool for merging several groups with a similar name into a new group. Creates a new group with a given name, copies all objects from all groups where the name matches a given pattern and finally deletes the original groups from which the objects were copied.

    The new group is of the same type as the groups from which the objects were copied. For example when objects are copied from Zone -groups the new group will also be a Zone. If there is a mismatch in the group type, for example you try merge Zones and Systems the operation will fail and no new group is created and no existing groups are deleted.

    Because type objects, like wall types, are internally groups in Simplebim this tool can also be used for merging type objects.

    Configuration Options

    Because this tool needs to be configured it can only be run from a template. This tool is not visible in the Tools drop-down menu of the ribbon.

    Key

    NAME

    The name of the new group

    Value Any text
    Key

    PATTERN

    The pattern the name of the target group must match to be merged

    Value

    The value may contain the wild cards * and ?.

    Examples                   

    • 'ABC*' merges all groups where the name starts with 'ABC'
    • '*ABC' merges all groups where the name ends with 'ABC'
    • 'A*C' merges all groups where the name starts with A followed by any number of characters ending with B.
    • 'A???C' merges all groups where the name starts with A followed by any 3 characters and ends with B.

    Tool: Group Trim Name

    Tool for trimming the name of groups. This tool is useful when you want to trim for example an unwanted prefix from the name of type objects (which are groups in Simplebim)

    Configuration Options

    Because this tool needs to be configured it can only be run from a template. This tool is not visible in the Tools drop-down menu of the ribbon.

    Key

    TARGET

    Defines the target of the operation, i.e. the groups that might be deleted by the tool. For example TARGET=ZONE specifies that only groups mapped to IfcZone may be deleted.

    Value
    ALL All groups

    GROUP

    Groups mapped to IfcGroup
    ASSET Groups mapped to IfcAsset
    INVENTORY Groups mapped to IfcInventory
    SYSTEM Groups mapped to IfcSystem
    BUILDINGSYSTEM Groups mapped to IfcBuildingSystem
    DISTRIBUTIONSYSTEM Groups mapped to IfcDistributionSystem
    DISTRIBUTIONCIRCUIT Groups mapped to IfcDistributionCircuit
    ZONE Groups mapped to IfcZone
    <Object Class> This option is used for deleting type objects. For example the value WALL sets the target to types of IfcWall.
    NOTE: It is possible to delete also type objects with this tool because internally type objects are handled as groups in Simplebim.
    Key

    REGEX

    Value

    The regular expression that selects the part of the group name that you want to trim (remove).

    Examples

    • 'ABC' removes 'ABC' from anywhere within the name of the group
    • '^ABC' removes 'ABC' from the beginning of the name of the group
    • 'ABC$' removes 'ABC' from the end of the name of the group
    • '^(ABC)\d{1,3}$' removes 'ABC' from the beginning of the name of the group, but only if 'ABC' is followed by 1-3 digits after which there are no more characters in the name.

    Tool: Calculator

    Tool for calculating the value of a numeric property from up to 3 other numeric properties using a formula. 

    Configuration Options

    Because this tool needs to be configured it can only be run from a template. This tool is not visible in the Tools drop-down menu of the ribbon.

    Key

    OBJECTCLASS

    The name of the object class for which the property values are calculated

    Value Any valid object class name
    Key

    A

    The name or key of the first property used in the formula

    Value

    Name or key of a numeric property that exists for the specified object class

    Key

    B

    The name or key of the second property used in the formula. This key does not have to be given if the formula only uses one property.

    Value

    Name or key of a numeric property that exists for the specified object class.

    Key

    C

    The name or key of the third property used in the formula. This key does not have to be given if the formula only uses two properties.

    Value

    Name or key of a numeric property that exists for the specified object class

    Key

    FORMULA

    The formula used for calculating the value of the target property

    Value

    The formula supports all mathematical operator and parenthesis. The variables A, B and C may be used in the formula to represent the properties defined by the corresponding configuration keys.

    Examples

    • A+B
    • A+B)/C
    • (A+10)/(B*C)
    Key

    TARGETPROPERTY

    The name or key of the numeric property into which the result of the formula is written

    Value

    Name or key of a numeric property that exists for the specified object class

    Tool: Combiner

    Tool for combining text values from up to 5 properties using a formula. The functionality is similar to what can be done with the Property Value Combiner palette.

    Configuration Options

    Because this tool needs to be configured it can only be run from a template. This tool is not visible in the Tools drop-down menu of the ribbon.

     

    Key

    OBJECTCLASS

    The name of the object class for which the property values are calculated

    Value Any valid object class name
    Key

    A

    The name or key of the first property used in the formula

    Value

    Name or key of a text property that exists for the specified object class

    Key

    B

    The name or key of the second property used in the formula. This key does not have to be given if the formula only uses one property.

    Value

    Name or key of a text property that exists for the specified object class.

    Key

    C

    The name or key of the third property used in the formula. This key does not have to be given if the formula only uses two properties.

    Value

    Name or key of a text property that exists for the specified object class

    Key

    D

    The name or key of the fourth property used in the formula. This key does not have to be given if the formula only uses three properties.

    Value

    Name or key of a text property that exists for the specified object class

    Key

    E

    The name or key of the fifth property used in the formula. This key does not have to be given if the formula only uses four properties.

    Value

    Name or key of a text property that exists for the specified object class

    Key

    FORMULA

    The formula used for calculating the value of the target property

    Value

    The formula supports many of the text functions in Excel. The variables A, B and C may be used in the formula to represent the properties defined by the corresponding configuration keys. The variables must be enclosed in square brackets like in the example below. Please contact Datacubist support if you need more help on the formula.

    Examples

    • concatenate([A], ' (', [B], ')')
    Key

    TARGETPROPERTY

    The name or key of the text property into which the result of the formula is written

    Value

    Name or key of a numeric property that exists for the specified object class

    Example

    The example below combines the values of the Space Name and Space Number properties into t he Description property such that the space number follows the space name on brackets.

    Tool: Weight Watcher

    Tool for adding information about the geometric density of objects to the model. This helps you find objects that have complex geometries and thus bloat model and file sizes.

    The tool adds two new properties to each object that has geometry

    You must run the Basic Quantities tool before running this tool because the 'Triangle Count Per Cubic Metre' relies on the volume calculated by the Basic Quantities tool

    Instructions

    Using the Properties palette

    1. Import or open your model
    2. Run the 'Basic Quantities' tool
    3. Run the 'Weight Watcher' tool
    4. Select all objects in the 3D palette (Ctrl+A)
    5. Drag and drop all objects from the 3D Palette to the Properties palette
    6. Select the 'Triangle Count' property in the Properties palette
    7. The 'Triangle Count' is sorted by value and the objects with the largest triangle count are found at the and of the list.
    8. The 'Triangle Count Per Cubic Metre' property sometimes gives a better picture, especially when you have small objects with a complex geometry. This is however limited, because the Basic Quantities tool does not calculate a volume for all objects.

    Using the Appearance Editor workspace

    1. Import or open your model
    2. Run the 'Basic Quantities' tool
    3. Run the 'Weight Watcher' tool
    4. Open the Appearance Editor workspace
    5. In the 'Please Select Object Class or Group to Visualize" dropdown select the 'Weight Watcher' group.  It can be found pretty much at the end of the dropdown
    6. In the 'Please Select Property To Visualize' dropdown select either 'Triangle Count' or 'Triangle Count Per Cubic Metre'
    7. The objects are colored on a color scale from green to red, where the green objects have few triangles and the red objects have a lot. The objects with a lot of triangles can be found at the end of the list.
    8. Holding down Shift you can select multiple values at the end of the list, i.e. objects with a lot of triangles. This selects those objects in the 3D palette. Now isolate the selected objects in the 3D palette and you get a good idea of the objects with a lot of triangles.
      • To make this process easier you can set the 'Speak and Listen' mode in the ribbon of the 3D palette to 'Isolate' and the selected objects are automatically isolated.
      • One trick is to turn on Isolate for the 3D palette, then select only the last item in the Visualizer palette. This isolates the objects with the most triangles. Then hold down the Shift key and start pressing the Up Arrow key. This adds new rows to  the selection and the corresponding objects are isolated in the 3D palette.

    Tool: Save Selected GUIDs to File

    Alias: Save GUIDs to File

    Tool for writing the IFC GUIDs (Globally Unique IDs) of all selected objects into a text file. This allows you to move object selections, like included or excluded objects, between different versions of the same model.

    When this tool is run from a template or script it writes the IFC GUIDs of all included objects that have a geometry. In this scenario the file name must be given with the FILE_NAME parameter because the tool is run silently and no file save dialog is shown.

    Tool: Load Selected GUIDs from File

    Alias: Load GUIDs from File

    Tool for loading the GUIDs (Globally Unique IDs) of objects from a text file and selecting the corresponding objects. The file can be created with the Save Selected GUIDs to File -tool or it can be created by any other method as long as the file is a simple text file containing valid IFC GUIDs.

    When this tool is run from a template or script it can be configured to perform also other actions than selecting the objects with the GUIDs from the file. In this scenario the file name must be given with the FILE_NAME parameter because the tool is run silently and no file open dialog is shown. The action is given with the ACTION parameter.

    Key Value Description
    FILE_NAME The name of the file with path and extension Specifies the text file to load
    ACTION INCLUDE Includes objects with the GUIDs from the file
    EXCLUDE Excludes objects with the GUIDs from the file
    NDY Sets the status of objects with the GUIDs from the file to Not Decided Yet

    Tool: Anonymizer

    Tool for removing all author and software identification information from the model. All information in the header, person. organization, application, actor role, postal address and telecom address objects that could be used for determining the author of the model, is replaced with random strings. Random strings are used to make it visible in the resulting IFC dataset that this information has been removed on purpose. The random strings do not contain any encrypted data, but are truly random.

    The resulting dataset will still contain the information that it has been edited by Simplebim.

    If the model contains identification information in other places, such a custom properties such information must be removed separately using the generic property editing tools in Simplebim.

    This tool is useful when the model can't contain any information about the author, for example when models are submitted to a architectural competition.

    If needed the GUIDs of all objects can be re-created with the Edit GUIDs: Create New GUIDs - tool.

    Tool: Add Geometry Information

    Tool for querying information about the geometry of objects and adding this information to the objects as property data.

    The type geometric representation of objects can be an important factor when importing IFC into various applications. Not all applications support all ways of representing geometry in IFC and it is good to know in advance if the import can work. The geometric representation can also contain useful information, like profile definitions, for quantity take-off and other analysis.

    All properties added by this tool are post-fixed with '(geometry)'.

    Property Description
    Geometry Type

    The basic type of the 3D geometry.

    Value Description
    Extruded Profile A profile with linear extrusion
    Clipped Extruded Profile Extruded profile clipped with another geometry
    Brep Boundary representation, i.e. a solid defined by its boundary, which is represented by triangles or faces.
    Clipped Brep A Brep clipped with another geometry.
    Brep With Voids A Brep with empty volumes inside it.
    Identifier

    The Representation Identifier of the IfcRepresentation from which the information is collected. If the geometry is shared (mapped) the identifier is post-fixed with '(shared'). The typical value for the Identifier of 3D geometry is 'Body'

    Profile Name The name of the profile from the ProfileName property of the IFC profile definition. For example for steel profiles this is typically the local standard name of the steel profile.
    Profile Type

    The type of the profile based on the class of the IFC profile definition. The value is one of the following,

    Rounded Rectangle, Hollow Rectangle, Rectangle, Arbitrary With Voids, Closed Arbitrary, Center Line, Open Arbitrary, Composite, Mirrored, Derived, Asymmetric I-Shape, Hollow Circle, Circle, C-Shape, Ellipse, I-Shape, L-Shape, Trapezium, T-Shape, U-Shape, Z-Shape

    Different profile types can have additional properties specific to that profile type, for example a 'Rectangle' profile has the 'X Dim' and 'Y Dim' properties and a 'Circle' profile has a 'Radius'.

    Tool: Convert Objects

    Tool for converting objects from one object class to another.Please note that currently this tool converts all objects of a given object class. The intention is to allow a more precise selection of the objects to be converted.

    Configuration Options

    Because this tool needs to be configured it can only be run from a template. This tool is not visible in the Tools drop-down menu of the ribbon.

    Key SOURCE
    Value

    A name of a group or the key of the source object class, i.e. the object class from which you convert. Please note that for object classes this must currently be the key, not the name.

    If you want to convert only selected objects (not all objects of an object class), first create a group containing the objects you want to convert and use the name of the group as the source.
    Key

    TARGET

    Value

    The key of the target object class, i.e. the object class to which you convert. Please note that this must currently be the key, not the name.

    Key

    TARGET_PREDEFINED_TYPE

    Value

    The value of the Predefined Type property on the target object class. If you were for example converting a building element proxy to a furniture, you may want to specify that the Predefined Type of the resulting furniture is DESK.

    Key

    TARGET_USER_DEFINED_TYPE

    Value

    The value of the Object Type property on the target object class. If you were for example converting a building element proxy to a furniture, you may want to specify that the Object Type of the resulting furniture is DRESSER. In this case the Predefined Type is automatically set to USERDEFINED.

    Key

    MAP

    Value

    A comma delimited of property identity keys. The first value is the key of a property on the source object class and the second value the key of a property on the target object class. The values from the first property are copied to the values of the second property. The 3rd value is again the key of a property on the source object class, the fourth value the key of a property on the target object class and so on.

    NOTE: Providing the MAP is optional. By default all properties that exist both on the source and target tables are copied from source to target. The MAP provides a way to override this behavior for selected properties.

    Key

    INCLUDE_CONVERTED

    Value

    By default the converted objects are left in the Not Decided Yet state. By adding this key you can set all converted objects to the Included state.

    Tool: Delete Materials

    Tool for deleting all material information from the model.

    This tool only deletes the material information defined by the IFC material system. If the model has property set properties that contain information related to materials, you must exclude those properties to get rid of such material information.
    Deleting all material information can have unwanted side effects. For walls the position of the wall can be dependent on t he material layers and deleting the material layers can shift the geometry of the wall. In some cases material information is also mandatory according to the IFC schema (enforced through Where rules). Some applications may complain about this. Future developments of this tool (or similar other functionality) will take these issues into account.

    Tool: Add Appearance Information

    Tool for querying information about the appearance of objects and adding this information to the objects as property data.

    By adding the appearance information as property data it can be used for making selections and for automating operations in templates. The color could for example be used as a criterion in grouping objects for quantity take-off and transparency for determining the type of a facade element for energy analysis.

    Property Description
    Appearance Color

    The RGB value of the color. The format is: <red>;<green>;<blue>            

    Appearance Transparency The transparency as a whole number ranging from 0 to 100, where 100 means completely transparent

    Palette: HVAC Sub System Selector

    Palette for selecting a branch of a HVAC system. You select one object from the system in the 3D window and the selection is expanded within the system either upstream or downstream from the object you selected,