Common Parameters for all DataPool Plugins

Field Name: This is the name of the DataField from which the plugin receives the data.

Data Min and Data Max: Specifies value mapping between incoming data and a Viz value. These parameters are always used in conjunction with two parameters representing Viz values (usually named Value Min and Value Max). The Data Min value is converted to a minimum Viz value and the Max Data is converted to a maximum Viz value. All incoming values are converted respectively to Viz values. When the Clamp parameter is set On, Values out of this range (smaller than Data Min or larger than Data Max) will be cropped to the Min/Max values. When Clamp is off, incoming values will be divided by the range between Data Min and Data Max and the remainder value will be used as the incoming value and interpolated to Viz values.

  • Example: 

    Data Min is 0 
Data Max is 100 
Viz Min is 0
Viz Max is 100
Sent value is 125

    If Clamp is on the Viz value will be set to 100 (i.e. all values above Data Max (100) will be cropped to the Data Max Value and interpolated to Viz Values)

    If Clamp is off, Viz value will be set to 25. Incoming value is 125, divided by 100 (the range between Data Min and Data Max), the remainder is 25 and it will be interpolated to Viz value.

Prefix: Specifies a prefix string that will be added in front of the incoming data string.

Suffix: Specifies a suffix string that will be added at the end of the incoming data string.

Clamp: All DataPool plugins that use the Data Min and Data Max parameters have a clamp button.

Setting the Clamp parameter On, will clamp the incoming data values to the data min/max range. Values out of this range (smaller than Data Min or larger than Data Max) will be cropped to the Min/Max values when the Clamp parameter is set On.

Notify only when value change: When a DataField value is changed, all the DataPool plugins registered to that DataField are triggered.

This happens also if the DataField was set to the same values.

Turning the "Notify only when value change" mode ON: will notify the data plugins only if the field value was actually changed.

The default behavior is OFF (as it was in previous DP releases, before adding this feature).

Use Other Container: ON/OFF

DataPool container plugins affect the containers they are attached to, and cannot affect other containers directly. In cases where a plugin should affect another container or when the same plugin should be used on the same container, the "Use Other Container" parameter is used.

A common example of using this parameter is changing multiple keyframes in an animation. Since only one plugin can be attached to the container, dummy containers with DataKeyFrame plugin, using the "Use Other Container" parameter, can be used to affect the remaining keyframes (This parameter makes the DataKeyFrame2 plugin unnecessary. The plugin is installed for backwards compatibility only).

When setting the Use Other Container ON, additional options will be enabled:

  • PARENT: the DataPool plugin will affect the parent container, i.e. the container residing above the current container in the scene hierarchy.

  • GrParent: the DataPool plugin will affect the grandparent container, i.e. the container residing two levels above the current container in the scene hierarchy.

  • GrGrParent: the DataPool plugin will affect the great grandparent container, i.e. the container residing three levels above the current container in the scene hierarchy.

  • REMOTE: when remote is selected another parameter, Rempte Container, will be enabled. Drag the container to be effected to the container place holder.

    Note: When using the Parent, GrParent or GrGrParent options, the link to the other container is relative. When using the Remote option the link to the other container is absolute. Using the relative options is recommended when using object designs that will be duplicated in the scene and controlling containers within the object hierarchy (like in Viz Curious Maps Client labels or Viz Weather objects).

    Note: The REMOTE option maintains compatibility with previous versions of DataPool using the Use Remote Container option.

Incremental Change: Specifies if the incoming data will be added to the current value of the data field (ON) or replace the current value of the data field (Off).

Use Conversion Table: When set ON, a Conversion Table Name parameter will be enabled. Enter the table name as it appears in the DP_ConvTable.csv file, without the proceedings leading and proceeding underscore characters.

Copyright © 2015 Vizrt