DataCondition

graphics/plugins_datacondition-icon.png

DataCondition evaluates the value of the DataField it is registered to using a defined comparison function and executes an action accordingly

graphics/plugins_datacondition.png
Unique Parameters

  • Format: Defines the way incoming data will be handled. Data can be used as a number, string, a set of X Y values or a set of X Y Z values.

    • Number: The plugin performs a simple numeric evaluation.

    • Text: the plugin performs an alphanumeric evaluation.

    • X Y: the plugin calculates the summery of the absolute value of the difference between the first and second values of the arguments and compares it to the Precision value multiplied by 2.

  • Condition: Specifies the evaluation function to be applied.

    Evaluation is done left to right: i.e. incoming data is placed at the left side of the comparison operator.

    "True" will always run the action and "False" will always run the "else" action (if enabled).

    The "If" option evaluates the DataField value: i.e. all values other than zero will run the Action, zero will run the Else Action

  • Arguments: Defines the expression that is compared to the incoming data. An argument can be a constant (i.e. a fixed number/text) or a data field value. To specify a data field value as an argument, use the following syntax: $(DataFieldName).

  • Compare Vectors: If this parameter is "ON" then the incoming data must be defined as a vector (an array of DataFields with definition of the number of items) and the argument expression is taken to be a vector of data. The comparison is then done item by item and the action is executed accordingly on each of the children. If this parameter is "OFF" then each item in the incoming data is compared against one single argument.

  • Precision: This parameter effects only the evaluation of X Y and X Y Z formats. It defines the margin in which the evaluation will result as true (see X Y or X Y Z) Format explanation).

  • Do Once On Change: When set ON, only if the condition result was changed, i.e. if it was changed from true to false or vice versa, the action (or Else Action) will be triggered. When set OFF, every time the condition id checked the action (or Else Action) will be triggered accordingly.

  • Action: Specifies the action to be invoked. If the action string begins with "0 .." then the command is handled as a Viz command, otherwise it’s considered to be a DataPool command. The action can contain more than one command to be called. The commands must be separated by semicolons (";"). Expressions can be used in the action: utilizing the special DataPool variables.

  • Else: When set "ON", the Else Action will be enabled. When an else action is defined it will be executed if the evaluation result is false. When set OFF, the Else Action field will be disabled and no action will be executed when the evaluation result is false.

  • Else Action: Defines the action to execute if the evaluation result is false.

Copyright © 2015 Vizrt