Class GorgonTextSpriteAnimationController

A controller used to handle animations for a GorgonTextSprite.

Inheritance
object
GorgonAnimationController<GorgonTextSprite>
GorgonTextSpriteAnimationController
Inherited Members
Namespace: Gorgon.Animation
Assembly: Gorgon.Animation.Gorgon2D.dll
Syntax
public class GorgonTextSpriteAnimationController : GorgonAnimationController<GorgonTextSprite>
Remarks

This controller is an implementation of the GorgonAnimationController<T> type and is used apply animations to a GorgonTextSprite.

A controller will update the GorgonTextSprite properties over a certain time frame (or continuously if looped) using a IGorgonAnimation.

This controller will advance the time for an animation, and coordinate the changes from interpolation (if supported) between IGorgonKeyFrame items on a IGorgonAnimationTrack<T>. The values from the animation will then by applied to the object properties.

This controller type contains registrations for the tracks corresponding the many of the properties on a GorgonTextSprite. These registrations are available to the developer as static values on the class, and these should be used to identify the track name (e.g. Builder.EditVector2(GorgonTextSpriteAnimationController.PositionTrack.TrackName);.

Constructors

| Edit this page View Source

GorgonTextSpriteAnimationController()

Initializes a new instance of the GorgonTextSpriteAnimationController class.

Declaration
public GorgonTextSpriteAnimationController()
See Also

Fields

| Edit this page View Source

AnchorTrack

The track registration for the anchor point, in relative coordinates, of the sprite.

Declaration
public static readonly GorgonTrackRegistration AnchorTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

AngleTrack

The track registration for the angle of rotation for the sprite.

Declaration
public static readonly GorgonTrackRegistration AngleTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

ColorTrack

The track registration for the color on a sprite.

Declaration
public static readonly GorgonTrackRegistration ColorTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

DepthTrack

The track registration for the depth value of the sprite.

Declaration
public static readonly GorgonTrackRegistration DepthTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

OpacityTrack

The track registration for the opacity of the sprite.

Declaration
public static readonly GorgonTrackRegistration OpacityTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

OpacityTrackName

The name of the opacity track.

Declaration
public const string OpacityTrackName = "Opacity"
Field Value
Type Description
string
See Also
| Edit this page View Source

Position3DTrack

The track registration for the position, and depth of the sprite.

Declaration
public static readonly GorgonTrackRegistration Position3DTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

PositionTrack

The track registration for the position of the sprite.

Declaration
public static readonly GorgonTrackRegistration PositionTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

ScaleTrack

The track registration for the scale, using relative values, of the sprite.

Declaration
public static readonly GorgonTrackRegistration ScaleTrack
Field Value
Type Description
GorgonTrackRegistration
See Also
| Edit this page View Source

ScaledSizeTrack

The track registration for the scale, using absolute values, of the sprite.

Declaration
public static readonly GorgonTrackRegistration ScaledSizeTrack
Field Value
Type Description
GorgonTrackRegistration
See Also

Methods

| Edit this page View Source

OnColorUpdate(GorgonTrackRegistration, GorgonTextSprite, GorgonColor)

Function called when a GorgonColor value needs to be updated on the animated object.

Declaration
protected override void OnColorUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, GorgonColor value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
GorgonColor value

The value to apply.
Overrides
See Also
| Edit this page View Source

OnQuaternionValueUpdate(GorgonTrackRegistration, GorgonTextSprite, Quaternion)

Function called when a Quaternion value needs to be updated on the animated object.

Declaration
protected override void OnQuaternionValueUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, Quaternion value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
Quaternion value

The value to apply.
Overrides
See Also
| Edit this page View Source

OnRectangleUpdate(GorgonTrackRegistration, GorgonTextSprite, RectangleF)

Function called when a SharpDX RectangleF value needs to be updated on the animated object.

Declaration
protected override void OnRectangleUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, RectangleF value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
RectangleF value

The value to apply.
Overrides
See Also
| Edit this page View Source

OnSingleValueUpdate(GorgonTrackRegistration, GorgonTextSprite, float)

Function called when a single floating point value needs to be updated on the animated object.

Declaration
protected override void OnSingleValueUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, float value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
float value

The value to apply.
Overrides
See Also
| Edit this page View Source

OnTexture2DUpdate(GorgonTrackRegistration, GorgonTextSprite, GorgonTexture2DView, RectangleF, int)

Function called when a texture needs to be updated on the object.

Declaration
protected override void OnTexture2DUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, GorgonTexture2DView texture, RectangleF textureCoordinates, int textureArrayIndex)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
GorgonTexture2DView texture

The texture to switch to.
RectangleF textureCoordinates

The new texture coordinates to apply.
int textureArrayIndex

The texture array index.
Overrides
See Also
| Edit this page View Source

OnVector2ValueUpdate(GorgonTrackRegistration, GorgonTextSprite, Vector2)

Function called when a 2D vector value needs to be updated on the animated object.

Declaration
protected override void OnVector2ValueUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, Vector2 value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
Vector2 value

The value to apply.
Overrides
See Also
| Edit this page View Source

OnVector3ValueUpdate(GorgonTrackRegistration, GorgonTextSprite, Vector3)

Function called when a 3D vector value needs to be updated on the animated object.

Declaration
protected override void OnVector3ValueUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, Vector3 value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
Vector3 value

The value to apply.
Overrides
See Also
| Edit this page View Source

OnVector4ValueUpdate(GorgonTrackRegistration, GorgonTextSprite, Vector4)

Function called when a 4D vector value needs to be updated on the animated object.

Declaration
protected override void OnVector4ValueUpdate(GorgonTrackRegistration track, GorgonTextSprite animObject, Vector4 value)
Parameters
Type Name Description
GorgonTrackRegistration track

The track currently being processed.
GorgonTextSprite animObject

The object to update.
Vector4 value

The value to apply.
Overrides
See Also

Extension Methods

See Also