Description

IAgScAnimation Interface for Scenario-level properties that control the animation cycle, animation step definition and the intervals between refresh updates in the 2D and 3D windows.

Public Methods

GetTimeArrayComponent	Returns a time array component used to configure the time array or null if component has not been configured yet.
GetTimeArrayQualifiedPath	Returns the time array component's qualified path or null if no component has been configured yet.
ResetTimeArrayComponent	Removes and resets the display configuration by unsetting currently set time array component (if any).
SetTimeArrayComponent	Configure the time array using the specified time component. Allowed are only event arrays.
SetTimeArrayQualifiedPath	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\").

Public Properties

AnimCycleTime	Animation end time. Uses DateFormat Dimension.
AnimCycleType	Animation end time or loop-at time. A member of the AgEScEndLoopType enumeration.
AnimStepType	Time step, real time (with offset) or a multiple of real time. A member of the AgEScTimeStepType enumeration.
AnimStepValue	Animation time step. Dimension depends on context.
ContinueXRealtimeFromPause	Animation XRealtime Continue from Paused Time.
EnableAnimCycleTime	Enable a selection between end time and loop-at time.
RefreshDelta	Refresh Delta property, the 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.
RefreshDeltaType	Refresh Delta or high speed. A member of the AgEScRefreshDeltaType enumeration.
StartTime	Animation start time. Uses DateFormat Dimension.
TimeArrayIncrement	Animation Time Array Increment.
TimePeriod	Allows the user to configure the scenario's animation time period.

Example

Configure scenario animation

[C#]

IAgScAnimation animation = scenario.Animation;

animation.StartTime = "1 Jun 2004 12:00:00.00";
animation.EnableAnimCycleTime = true;
animation.AnimCycleType = AgEScEndLoopType.eEndTime;
animation.AnimCycleTime = "2 Jun 2004 12:00:00.00";
animation.AnimStepValue = 1000;
animation.RefreshDeltaType = AgEScRefreshDeltaType.eRefreshDelta;
animation.RefreshDelta = 0.02;

Configure scenario animation

[Visual Basic .NET]

Dim animation As IAgScAnimation = scenario.Animation

animation.StartTime = "1 Jun 2004 12:00:00.00"
animation.EnableAnimCycleTime = True
animation.AnimCycleType = AgEScEndLoopType.eEndTime
animation.AnimCycleTime = "2 Jun 2004 12:00:00.00"
animation.AnimStepValue = 1000
animation.RefreshDeltaType = AgEScRefreshDeltaType.eRefreshDelta
animation.RefreshDelta = 0.02

STK Objects	Send comments on this topic.
IAgScAnimation Interface