Description | Example | Return message | Group

Animate

Direct animation of a scenario

Syntax

Animate <ScenarioPath> {AnimateOption} <Parameters>

Related commands

Description

For a detailed discussion of the Animation tool bar and the animation process, refer to STK Help Topics.

The Animate command controls the scenario's graphic animation in all 2D and 3D Graphics windows. Each of the Animate actions performs exactly as if you had clicked the corresponding button in the Animation tool bar.

To set details of Animation control see the SetAnimation command.

{AnimateOption} can be:

{AnimateOption}<Parameters>Description
PauseN/APause the animation sequence at the current time.
ResetN/AStop the animation and reset to the animation start time.
RefreshN/AStop the animation and refresh at the current time.
FasterN/AIncrease the animation time step.
SlowerN/ADecrease the animation time step.
Start[{Forward | Reverse | RealTime | XRealTime | Normal}] [{End | Loop | Continuous}]Begin animation using the specified parameters. The first set of parameters defines the direction or speed of animation. The default is Forward. The second set of parameters defines what to do when the animation end time is reached. The default is End.
Step{Forward | Reverse}Move the scenario forward or backward one time step.
XRealTimeContinueFromPausedTime{On | Off}Turn XRealTimeContinueFromPausedTime on to pause the internal realtime clock while the animation is paused and continue playing from the current animation time when animation is resumed. By default XRealtime mode continues running the internal realtime clock while an animation is paused. When the animation is resumed the animation time jumps ahead by however long the animation was paused.

Examples

To animate the scenario forward, and stop when the end time is reached:

Animate * Start End

To pause the animation:

Animate * Pause

Return message

If activated, Connect returns an acknowledgment message for each Animate command sent.

Group membership

This command belongs to the following group(s):

2D Graphics Window

VO

VO Objects

Version

10.1