Set values to control animation.
SetAnimation <ScenarioPath> {AnimateOption} <Parameters>
The SetAnimation command is used to control animation in the 2D and 3D windows.
Valid values for {AnimateOption} can be:
| {AnimateOption} | <Parameters> | Description |
|---|---|---|
| CurrentTime | {TimeInstant} | Set the current animation time. |
| StartTimeOnly | {TimeInstant} | Set the start time for animation. |
| StartAndCurrentTime | {TimeInstant} | Set the start time for animation and also set the current animation time. |
| EndTime | {TimeInstant} | Set the end time for animation. |
| EndMode | {End | Loop | Continuous} | Defines what to do when the animation end time is reached. The default is Continuous, unless the user enters an EndTime in which case the EndMode default is End. |
| AnimationMode | {Normal | RealTime | XRealTime} | Set the animation mode to RealTime to animate in real time in accordance with your computer's internal clock. Set the animation mode to XRealTime to animate x number of times faster than real-time. |
| TimeStep | {Increase | Decrease | <StepValue>} | Increase or decrease the time step incrementally or set the time step to a specific value. <StepValue> is entered in Connect time units. |
| RealTimeOffset | {Increase | Decrease | <OffsetValue>} | Increase or decrease the offset value incrementally or set the offset value to a specific value. This value is used when the animation mode is RealTime. <OffsetValue> is entered in Connect time units. |
| XRealTimeMultiplier | {Increase | Decrease | <MultValue>} | Increase or decrease the multiplier incrementally or set the multiplier to a specific value. This value is used when the animation mode is XRealTime. <MultValue> is entered in Connect time units. |
| RefreshMode | {HighSpeed | RefreshDelta} | Specify the amount of time between screen refresh updates. High Speed refreshes the screen as fast as the system is able. Refresh Delta uses the amount of time set using the RefreshDelta option as the time between refresh updates. For instance, if you enter 1.0, STK attempts to refresh the screen once every second. The actual refresh delta is limited by the minimum time necessary to draw the scenario. The refresh time varies with processor performance, graphics hardware and scenario complexity. |
| RefreshDelta | <RefreshDelta> | Set the refresh delta value for
animation. This value is entered in Connect time units.
Note: This value is used only if the RefreshMode is set to RefreshDelta. |
Hint: For valid {TimeInstant} values see Time Options.
If a time component is entered, then the current time of the component will be used, not the time component. If UseAnalysisStartTime is entered for Start time then the animation start time will track any analysis start time changes. If UseAnalysisStopTime is entered for End time then the animation end time will track any analysis end time changes.
Note: The StartTime {"<DateTime>" | UseAnalysisStartTime} option is deprecated in STK 9.2. Use the StartTimeOnly or StartAndCurrentTime options instead.
To set animation times so that animation starts at 12 a.m. on November 2, 2011, the step time is every 10 seconds, the refresh delta is 0.5 seconds and refresh mode is set to use the refresh delta:
SetAnimation * StartTimeOnly "2 Nov 2011 00:00:00.0" TimeStep 10 RefreshDelta 0.5 RefreshMode RefreshDelta
Set the animation to loop at the specified end time:
SetAnimation * EndMode Loop Endtime "2 Nov 2011 14:00:00.00"
Set the animation mode to realtime, and the set realtime offset to be incremented from it's current value:
SetAnimation * AnimationMode RealTime RealTimeOffset Increase
Set the animation start time and current animation time to be the same as the analysis start time:
SetAnimation * StartAndCurrentTime UseAnalysisStartTime
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
10
STK Programming Interface 11.0.1