Documentation Center

Viz Plug-ins User Guide

Version 5.1 | Published December 12, 2023 ©

DataKeyFrame

images/download/attachments/95401962/plugins_datakeyframe-icon.png
The DataKeyFrame plug-in affects a named keyframe of an animation defined on the container the plug-in is attached to. Keyframe name must be unique. When the FieldName changes, the plug-in looks for the keyframe and assigns new values to it.

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.

DataKeyFrame Properties

  • KeyFrame Name: Defines the name of the keyframe the plug-in works on. The keyframe name must be unique.

  • Reset KeyFrame: Defines the name of a keyframe containing initial parameters to be used when a RESET string is received. If a RESET data is accepted, the keyframe values are set to the values of the Reset KeyFrame. The keyframe name must be unique.

  • Value Format: Defines the format of the received data.

    Note: If data format is not as defined in the Value Format parameter, unpredictable behavior occurs.

Known Issues

When using DataKeyFrame inside a Transition Logic scene, be sure to use unique keyframe names, as searching for a keyframe inside a merged geometry only returns the first one.