ScenarioAnimation

class ansys.stk.core.stkobjects.ScenarioAnimation

Class defining the animation properties of a Scenario.

Overview

Methods

get_time_array_component	Return a time array component used to configure the time array or null if component has not been configured yet.
get_time_array_qualified_path	Return the time array component’s qualified path or null if no component has been configured yet.
reset_time_array_component	Remove and resets the display configuration by unsetting currently set time array component (if any).
set_time_array_component	Configure the time array using the specified time component. Allowed are only event arrays.
set_time_array_qualified_path	Configure the time array using the specified time component. Allowed are only event arrays. QualifiedPath format adheres to the format used throughout VGT API (i.e. Scenario/Scenario1 OneMinuteSampleTimes EventArray).

Properties

animation_cycle_time	Animation end time. Uses DateFormat Dimension.
animation_end_loop_type	Animation end time or loop-at time. A member of the ScenarioEndLoopType enumeration.
animation_step_type	Time step, real time (with offset) or a multiple of real time. A member of the ScenarioTimeStepType enumeration.
animation_step_value	Animation time step. Dimension depends on context.
continue_x_real_time_from_pause	Animation XRealtime Continue from Paused Time.
enable_anim_cycle_time	Enable a selection between end time and loop-at time.
refresh_delta	Amount of time between refresh updates. 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. Uses Time Dimension.
refresh_delta_type	Refresh Delta or high speed. A member of the ScenarioRefreshDeltaType enumeration.
start_time	Animation start time. Uses DateFormat Dimension.
time_array_increment	Animation Time Array Increment.
time_period	Allow the user to configure the scenario’s animation time period.

Import detail

from ansys.stk.core.stkobjects import ScenarioAnimation

Property detail

property ScenarioAnimation.animation_cycle_time: Any

Animation end time. Uses DateFormat Dimension.

property ScenarioAnimation.animation_end_loop_type: ScenarioEndLoopType

Animation end time or loop-at time. A member of the ScenarioEndLoopType enumeration.

property ScenarioAnimation.animation_step_type: ScenarioTimeStepType

Time step, real time (with offset) or a multiple of real time. A member of the ScenarioTimeStepType enumeration.

property ScenarioAnimation.animation_step_value: float

Animation time step. Dimension depends on context.

property ScenarioAnimation.continue_x_real_time_from_pause: bool

Animation XRealtime Continue from Paused Time.

property ScenarioAnimation.enable_anim_cycle_time: bool

Enable a selection between end time and loop-at time.

property ScenarioAnimation.refresh_delta: float

Amount of time between refresh updates. 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. Uses Time Dimension.

property ScenarioAnimation.refresh_delta_type: ScenarioRefreshDeltaType

Refresh Delta or high speed. A member of the ScenarioRefreshDeltaType enumeration.

property ScenarioAnimation.start_time: Any

Animation start time. Uses DateFormat Dimension.

property ScenarioAnimation.time_array_increment: int

Animation Time Array Increment.

property ScenarioAnimation.time_period: ScenarioAnimationTimePeriod

Allow the user to configure the scenario’s animation time period.

Method detail

ScenarioAnimation.get_time_array_component(self) → IAnalysisWorkbenchComponent

Return a time array component used to configure the time array or null if component has not been configured yet.

Returns:

IAnalysisWorkbenchComponent

ScenarioAnimation.get_time_array_qualified_path(self) → str

Return the time array component’s qualified path or null if no component has been configured yet.

Returns:

str

ScenarioAnimation.reset_time_array_component(self) → None

Remove and resets the display configuration by unsetting currently set time array component (if any).

Returns:

None

ScenarioAnimation.set_time_array_component(self, component: IAnalysisWorkbenchComponent) → None

Configure the time array using the specified time component. Allowed are only event arrays.

Parameters:

component : IAnalysisWorkbenchComponent

Returns:

None

ScenarioAnimation.set_time_array_qualified_path(self, qualified_path: str) → None

Configure the time array using the specified time component. Allowed are only event arrays. QualifiedPath format adheres to the format used throughout VGT API (i.e. Scenario/Scenario1 OneMinuteSampleTimes EventArray).

Parameters:

qualified_path : str

Returns:

None