Description | Example | Return message | Group

GetAnimationData

Return information about the animation settings.

Syntax

GetAnimationData <ScenarioPath> {Option}

Related commands

Description

{Option}Description
TimePeriodReturns the Start and End animation times in Connect date units.
ModeReturns the animation mode, will return one of the following:
  • Using Time Step
  • Using Time Step, Loop at End Time
  • Using Time Step, Stop at End Time
  • Realtime
  • XRealTime
  • XRealTime, Loop at End Time
  • XRealTime, Stop at End Time
RefreshModeReturns the animation refresh mode, returned value will be High Speed or Using Refresh Delta.
CurrentTimeReturns the current animation time in Connect date units.
TimeStepReturns the time step being used for animation, in Connect time units (default is seconds).
RefreshDeltaReturns the refresh delta, in Connect time units (default is seconds).
RealTimeXReturns the real time multiplier, in Connect time units (default is seconds).
RealTimeOffsetReturns the real time offset, in Connect time units (default is seconds).
FrameRateReturns the current frame rate for animation.
StateReturns the animation state, returned value will be Active, Inactive, or Paused.
DirectionReturns the animation direction, returned value will be Forward or Reverse.

Examples

GetAnimationData * TimePeriod

Return message

ACK GETANIMATIONDATA 50 "1 Jun 2004 00:00:00.00", "2 Jun 2004 00:00:00.00"

Examples

GetAnimationData * RefreshMode

Return message

ACK GETANIMATIONDATA 19 Using Refresh Delta

Group membership

This command belongs to the following group(s):

2D Graphics Window

Scenarios

Version

11.5