Description | Example | Return Message | Group

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:
  • 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
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).

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):

2D Graphics Window

Scenarios

Version

6.1

STK Programming Interface 11.0.1