GetAnimationData
Return information about the animation settings.
Syntax
GetAnimationData <ScenarioPath> {Option}
Related Commands
Description
| {Option} | Description |
|---|---|
| TimePeriod | Returns the Start and End animation times in Connect date units. |
| Mode | Returns the animation mode, will return one of the following:
|
| RefreshMode | Returns the animation refresh mode, returned value will be High Speed or Using Refresh Delta. |
| CurrentTime | Returns the current animation time in Connect date units. |
| TimeStep | Returns the time step being used for animation, in Connect time units (default is seconds). |
| RefreshDelta | Returns the refresh delta, in Connect time units (default is seconds). |
| RealTimeX | Returns the real time multiplier, in Connect time units (default is seconds). |
| RealTimeOffset | Returns the real time offset, in Connect time units (default is seconds). |
| FrameRate | Returns the current frame rate for animation. |
| State | Returns the animation state, returned value will be Active, Inactive, or Paused. |
| Direction | Returns the animation direction, returned value will be Forward or Reverse. |
Example
GetAnimationData * TimePeriod
ReturnMessage
ACK
GETANIMATIONDATA 50
"1 Jun 2004 00:00:00.00", "2 Jun 2004 00:00:00.00"
Example
GetAnimationData * RefreshMode
ReturnMessage
ACK
GETANIMATIONDATA 19
Using Refresh Delta
Group Membership
This command belongs to the following group(s):
Version
11.5