Plug-ins User Guide

Version 5.2 | Published March 20, 2024 ©

DataMultiParam

images/download/attachments/95401947/plugins_datamultiparam-icon.png
The DataMultiParam plug-in extends the DataParameter plug-in options. It enables DataPool to control multiple parameters. Incoming data contains all the values for the defined parameters.

Note: This plug-in is located in: Plugins -> Container plug-ins -> Data

Information: DataPool plug-ins only work properly on a single channel on the same machine.

DataMultiParam Properties

  • Format: Defines the container parameters to be controlled by incoming data. The format is specified in lines, each containing the following information:
    <Plug-in Type> <Plug-in Name> <Parameter Name>

    • <Plug-in Type> is either GEOMETRY or FUNCTION.

    • <Plug-in Name> is the name of the plug-in that is controlled.

    • <Parameter Name> is the name of the parameter in the specified plug-in to control.

      Note: Plug-in name and parameter name must be identical to the names used in Viz (names are case sensitive). To find out the correct names, open the Viz command console and change the parameter required. The correct spelling is displayed in the command console as part of the messages sent from Viz.

  • Separator: Defines a character in the incoming data that separates between the values of the defined parameters. Default separator is a pipe character (|).

Example

If the DataMultiParam plug-in is attached to a cylinder object, with an AutoRotate function plug-in, Field name is VALUE and the controlled parameters are:

  • GEOMETRY Cylinder angle

  • GEOMETRY Cylinder hole

  • FUNCTION AutoRotate rotspeed

Using the default separator, incoming data is VALUE=90 | 100 | 230. The result is:

  • Parameter angle of the Cylinder is set to the value 90.

  • Parameter hole of the Cylinder is set to the value 100.

  • Parameter rotspeed of the AutoRotate plug-in is set to the value 230.