By default, all objects with collision geometry are set to interact with one another. However, you have the option to establish specific collision detection rules that can prevent interactions between selected pairs.

Collision rules can be applied to groups of one or more collidable objects. These rules can be configured at the mechanism, assembly, part, or individual collision geometry level, and combinations of these levels are supported.

The Collision Label Rules feature consists of two key components: the Collision Label and the Collision Label Rule. Users start by utilizing the Collision Label to label collidable objects.

Subsequently, the Collision Label Rule is created to specify the collision behavior for these labeled groups.

Detailed instructions are available in this chapter for adding, deleting and modifying collision rules.

1 Labeling Collidable Objects
2 Adding Collision Rules to the List
- 2.1 Loading Collision Rules JSON File
- 2.2 Manually Adding Collision Rules
3 Removing Collision Rules from the List
4 Modifying Collision Rules
5 Collision Rules JSON File

Labeling Collidable Objects

To add a label to one or more collidable objects, navigate to the Toolbox and locate the Dynamics category, or simply search for "collision label." Double-click on Collision Label to insert the extension into its parent scene, mechanism, or assembly. An empty list of collidable objects will appear in the property panel. You can add multiple Collision Labels if needed.

Adding Collision Rules to the List

You can add new rules by loading them from an external JSON file or by manually creating them. To add the Collision Label Rules extension, navigate to the Basic category in the ToolBox and double-click on it. This will add the extension to its parent scene, mechanism, or assembly, and an empty list of rules will appear in the property panel. You can then create additional Collision Label Rules as needed.

Loading Collision Rules JSON File

On Collision file field in the property browser

Click the Browse button […] on the right of the field.
To select the JSON file, navigate to the Open File window.
If the file is valid, the collision rule pairs will be added to the Collision rules list.

The Collision Rules table is displayed as read-only, as the collision rules are loaded directly from a JSON file

To clear the Collision File field, just click the dropdown button [V] and choose the Clear Field option from the menu.

When the JSON file path is removed and the field is left blank, the list of collision rules remains intact, and the Collision Rules table becomes editable.

Manually Adding Collision Rules

To manually add collision rules, ensure that the Collision File field is left empty. Click the [+] button located in the top right corner of the Collision Rules table. This action will create an empty row at the bottom of the list, allowing you to enter the collision labels manually.

Removing Collision Rules from the List

To remove collision rules, just click the [-] button, and the last entry in the table will be removed.

Note that the [-] button will only be enabled if the Collision File field is left blank.

Modifying Collision Rules

To manage the collision status, toggle the Collision option within the rule settings.
To modify the collision label, click on the Edit text widget to focus on it, allowing you to change or enter a new label.

Note that the Edit text widget will only be enabled if the Collision File field is left blank.

To reorder collision rule, click the Drag button [=] to reorder the collision pair in the table.

To edit Collision Rules JSON file, click the dropdown button [V] and choose the Open External… option from the menu. Then choose the text editor to edit the JSON file

Collision Rules JSON File

{
    "title": "JSON Schema for Vortex Collision Label Rule",
    "version": 1,
    "Collision Rules": [
        {
            "Label 1": "FMHead",
            "Label 2": "FMHead",
            "Collision": "false"
        },
        {
            "Label 1": "Fingers",
            "Label 2": "Tool",
            "Collision": "true"
        },
        {
            "Label 1": "RamTool",
            "Label 2": "RamTool",
            "Collision": "true"
        },
        {
            "Label 1": "SpringsTool",
            "Label 2": "SpringsTool",
            "Collision": "true"
        },
        {
            "Label 1": "Pins",
            "Label 2": "Tool",
            "Collision": "true"
        },
        {
            "Label 1": "MagCenter",
            "Label 2": "Tool",
            "Collision": "true"
        },
        {
            "Label 1": "RamPlunger",
            "Label 2": "RamPlunger",
            "Collision": "true"
        }
    ]
}