SimulationAnimation Class

Allows the user to animate at any time: past, present, or future. The time between each animation frame is defined by TimeStep.

Inheritance Hierarchy

Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

public sealed class SimulationAnimation : ForwardAndBackwardAnimation

Public NotInheritable Class SimulationAnimation
	Inherits ForwardAndBackwardAnimation

public ref class SimulationAnimation sealed : public ForwardAndBackwardAnimation

[<SealedAttribute>]
type SimulationAnimation =  
    class
        inherit ForwardAndBackwardAnimation
    end

The SimulationAnimation type exposes the following members.

Constructors

	Name	Description
	SimulationAnimation	Initializes a new instance.

Properties

	Name	Description
	EndCycle	Gets or sets the end cycle. (Inherited from ForwardAndBackwardAnimation.)
	EndTime	Gets or sets the end time of the animation. (Inherited from ForwardAndBackwardAnimation.)
	IsAnimating	Gets whether or not animation is playing. (Inherited from ForwardAnimation.)
	IsPaused	Gets whether animation is paused. (Inherited from ForwardAnimation.)
	IsReset	Gets whether animation has been reset. (Inherited from ForwardAnimation.)
	IsStopped	Gets whether animation is stopped. (Inherited from ForwardAnimation.)
	MessageLoopType	Gets or sets the type of message loop, Windows Forms or Windows Presentation Foundation, employed by the application. By default, this is set to MessageLoopType.AutoDetect. (Inherited from ForwardAnimation.)
	RefreshRate	Gets or sets the rate (fastest or fixed) at which the scene is refreshed during rendering. (Inherited from ForwardAnimation.)
	StartCycle	Gets or sets the start cycle. (Inherited from ForwardAndBackwardAnimation.)
	StartTime	Gets or sets the start time of the animation. (Inherited from ForwardAndBackwardAnimation.)
	TargetedFramesPerSecond	Gets or sets the targeted frames per second if RefreshRate is set to use TargetedFramesPerSecond. (Inherited from ForwardAnimation.)
	Time	Gets or sets the current animation time. (Inherited from ForwardAnimation.)
	TimeStep	Gets or sets the size of an animation step in seconds.

Methods

	Name	Description
	Dispose	(Inherited from MinimalForwardAnimation.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	NextFrame	Advances to the next frame. This method is called automatically during rendering, and should not be called directly. (Inherited from ForwardAndBackwardAnimation.)
	Pause	Pauses animation. (Inherited from ForwardAnimation.)
	PlayBackward	Starts animation backward. (Inherited from ForwardAndBackwardAnimation.)
	PlayForward	Starts animation forward. (Inherited from ForwardAnimation.)
	Reset	Resets animation to the start time. (Inherited from ForwardAnimation.)
	StepBackward	Steps animation backward. (Inherited from ForwardAndBackwardAnimation.)
	StepForward	Steps animation forward. (Inherited from ForwardAnimation.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Events

	Name	Description
	HasReset	Occurs if animation has reset. (Inherited from ForwardAnimation.)
	Paused	Occurs if animation has paused. (Inherited from ForwardAnimation.)
	Started	Occurs if animation has paused. (Inherited from ForwardAnimation.)
	Stopped	Occurs if animation has stopped. (Inherited from ForwardAnimation.)