Click or drag to resize

RealTimeSimulationAnimation Class

Allows the user to animate at any time: past, present, or future. The time between each animation frame is based on wall clock time. If the last frame rendered one second ago in wall clock time, the current frame will render at a time equal to the previous frame's time plus one second. A TimeMultiplier can be adjusted to make the simulation time progress faster or slower than real time.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Graphics
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public sealed class RealTimeSimulationAnimation : ForwardAndBackwardAnimation

The RealTimeSimulationAnimation type exposes the following members.

Constructors
  NameDescription
Public methodRealTimeSimulationAnimation
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyEndCycle
Gets or sets the end cycle.
(Inherited from ForwardAndBackwardAnimation.)
Public propertyEndTime
Gets or sets the end time of the animation.
(Inherited from ForwardAndBackwardAnimation.)
Public propertyIsAnimating
Gets whether or not animation is playing.
(Inherited from ForwardAnimation.)
Public propertyIsPaused
Gets whether or not animation is paused.
(Inherited from ForwardAnimation.)
Public propertyIsReset
Gets whether or not animation has been reset.
(Inherited from ForwardAnimation.)
Public propertyIsStopped
Gets whether or not animation is stopped.
(Inherited from ForwardAnimation.)
Public propertyMessageLoopType
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.)
Public propertyRefreshRate
Gets or sets the rate (fastest or fixed) at which the scene is refreshed during rendering.
(Inherited from ForwardAnimation.)
Public propertyStartCycle
Gets or sets the start cycle.
(Inherited from ForwardAndBackwardAnimation.)
Public propertyStartTime
Gets or sets the start time of the animation.
(Inherited from ForwardAndBackwardAnimation.)
Public propertyTargetedFramesPerSecond
Gets or sets the targeted frames per second if RefreshRate is set to use TargetedFramesPerSecond.
(Inherited from ForwardAnimation.)
Public propertyTime
Gets or sets the current animation time.
(Inherited from ForwardAnimation.)
Public propertyTimeMultiplier
Gets or sets the multiplier describing the rate of simulation time relative to real time. For example, if this value is 2.0, two seconds of simulation time will pass for each each second of real time.
Public propertyTimeStep
Gets or sets the quantity of real time, in seconds, that is stepped when StepForward or StepBackward is called. The simulation time will be stepped by this value times the TimeMultiplier. For example, if this value is 60.0, and TimeMultiplier is 3.0, Time will be stepped by 60.0 * 3.0 = 180.0 seconds when StepForward is called.
Top
Methods
  NameDescription
Public methodDispose (Inherited from MinimalForwardAnimation.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodNextFrame
Advances to the next frame. This method is called automatically during rendering, and should not be called directly.
(Inherited from ForwardAndBackwardAnimation.)
Public methodPause
Pauses animation.
(Inherited from ForwardAnimation.)
Public methodPlayBackward
Starts animation backward.
(Inherited from ForwardAndBackwardAnimation.)
Public methodPlayForward
Starts animation forward.
(Inherited from ForwardAnimation.)
Public methodReset
Resets animation to the start time.
(Inherited from ForwardAnimation.)
Public methodStepBackward
Steps animation backward.
(Inherited from ForwardAndBackwardAnimation.)
Public methodStepForward
Steps animation forward.
(Inherited from ForwardAnimation.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventHasReset
Occurs if animation has reset.
(Inherited from ForwardAnimation.)
Public eventPaused
Occurs if animation has paused.
(Inherited from ForwardAnimation.)
Public eventStarted
Occurs if animation has paused.
(Inherited from ForwardAnimation.)
Public eventStopped
Occurs if animation has stopped.
(Inherited from ForwardAnimation.)
Top
See Also