Creating a New VHL Interface

The VHL Interface Editor allows you to expose properties in the VHL.

You can also use it to rename properties and add meaningful descriptions for each property.

  1. If you are not already in the Mechanism editor, either open an existing mechanism or create a new one.
  2. Select Simulation in the Toolbox.
  3. Double-click VHL Interface. The VHL Interface Editor appears.
    vhl_editor_create.png
  4. In the Explorer tree, click any object that contains properties (parts, constraints, controllers, wheel components, and collision geometries). Their properties appear in the Property panel on the right.
  5. From the Property panel, drag and drop the property you want to expose onto either the Input, Output, or Parameters section of the Interface Editor.
    Warning
    Read-only input and parameter properties cannot be exposed in the VHL Interface Editor.
    vhl_editor_addprop.png
  6. Now you can perform any of these tasks to customize your exposed parameter:
    • By default, the exposed parameter uses the name of the internal property. To use a different name, double-click on the Name cell and type the new name.
    • To add a description for the parameter, double-click on the Description cell and type the description. You can press the Enter or Tab key to finish editing.
    • You can add minimum and maximum values for the parameter in the appropriate column. A exposed parameter can only be set the range value of the minimum and maximum value.
    • To break the link between the VHL Interface and the source of the property, hover over the arrow in the Data column of the property you want to disconnect. When you see the trash can icon, click on it. The parameter still appears in the VHL Interface Editor, but the link to the reference of the data has been disconnected.
      vhl_editor_breaklink.png
    • To connect a property to an existing parameter (for example, if its link was broken), drag and drop the property onto the Data column of the target property's row.
    • To delete the entire parameter entry from the Interface, select the row you want to delete and press the Delete key.
  7. Additionally, you can add Outputs to the Interface Editor by clicking the + button next to Outputs heading.
    • In the resulting drop-down list, select the type of data for this new output (e.g., Integer, Boolean, String). An output of that data type is added to the table, where you can edit its details.