IAnimation

class ansys.stk.core.stkobjects.IAnimation

Provide methods to control scenario animation.

Overview

Methods

play_forward	Animate forward.
play_backward	Animate backward.
pause	Pause the animation.
rewind	Stop and reset the animation.
step_forward	Advance the animation one step forward.
step_backward	Reverse the animation one step backward.
faster	Increase the speed of the animation.
slower	Decrease the speed of the animation.

Properties

mode	Animation mode.
current_time	Current animation time. In Epoch seconds.
step	Get animation time step.
animation_options	Animation options.
high_speed	Control the animation speed.

Examples

Reset the scenario time

# STKObjectRoot root: STK Object Model Root
root.rewind()

Change animation mode

# STKObjectRoot root: STK Object Model Root
scenario = root.current_scenario
root.animation_options = AnimationOptionType.STOP
root.mode = AnimationEndTimeMode.X_REAL_TIME
scenario.animation_settings.animation_step_value = 1  # second
scenario.animation_settings.refresh_delta = 0.03  # second

Import detail

from ansys.stk.core.stkobjects import IAnimation

Property detail

property IAnimation.mode: AnimationEndTimeMode

Animation mode.

property IAnimation.current_time: float

Current animation time. In Epoch seconds.

property IAnimation.step: str

Get animation time step.

property IAnimation.animation_options: AnimationOptionType

Animation options.

property IAnimation.high_speed: bool

Control the animation speed.

Method detail

IAnimation.play_forward(self) → None

Animate forward.

Returns:

None

IAnimation.play_backward(self) → None

Animate backward.

Returns:

None

IAnimation.pause(self) → None

Pause the animation.

Returns:

None

IAnimation.rewind(self) → None

Stop and reset the animation.

Returns:

None

IAnimation.step_forward(self) → None

Advance the animation one step forward.

Returns:

None

IAnimation.step_backward(self) → None

Reverse the animation one step backward.

Returns:

None

IAnimation.faster(self) → None

Increase the speed of the animation.

Returns:

None

IAnimation.slower(self) → None

Decrease the speed of the animation.

Returns:

None