Animation

Description

sealed class Tinman.Engine.Scenes.Entities.Animation

Derived from

SceneEntityBase abstract
ITimestampRangeProperty
ITimestampConsumer

A scene entity that runs an animation.

Public / Constructors

Animation

public constructor Animation → (1)

order opt : int32 = -1

See ISceneObject.Order.

Creates a new instance of Animation.

Public / Methods

Add

public method Add → (2)

consumer in : ITimestampConsumer

[not-null]
The animatable object to add.

timestampDelta opt : float64 = 0

Optional timestamp delta to apply.

Adds an animatable object.

If the given consumer in object has already been added, this method only updates the timestamp delta, which in turn may update the value of the ITimestampConsumer.Timestamp property.

See also

Animation.Remove

Remove

public method Remove → (1)

consumer in : ITimestampConsumer

[not-null]
The animatable object to remove.

Removes an animatable object.

The Add and Remove methods are not balanced, so the given consumer in object is removed instantly.

See also

Animation.Add

Reset

public method Reset → (1)

play opt : bool = false

Play animation after resetting it?

Resets this animation.

The following properties are set by this method:

Public / Attributes

Looped

public attribute Looped → (get,set)

value : bool

true if the animation is looped, false if not.

Loop playback of animation?

Defaults to false.

Paused

public attribute Paused → (get,set)

value : bool

true if the animation is paused, false if not.

Pauses the animation.

Defaults to true.

Time­Lapse

public attribute TimeLapse → (get,set)

value : float64

The time lapse factor. If negative, the animation will run backwards.

Time lapse factor for the animation.

Defaults to 1.

Timestamp

public attribute Timestamp → (get,set)

value : float64

The timestamp (see GeoPathSample.Timestamp).

The timestamp value to consume.