Click or drag to resize
DigitalRunePathAnimationTPoint, TPathKey, TPath Class
Animates a point that follows a predefined path. (Base implementation.)
Inheritance Hierarchy
SystemObject
  DigitalRune.AnimationAnimationTPoint
    DigitalRune.AnimationPathAnimationTPoint, TPathKey, TPath
      DigitalRune.AnimationPath2FAnimation
      DigitalRune.AnimationPath3FAnimation

Namespace: DigitalRune.Animation
Assembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax
public abstract class PathAnimation<TPoint, TPathKey, TPath> : Animation<TPoint>
where TPoint : Object, IEquatable<TPoint>
where TPathKey : CurveKey<float, TPoint>
where TPath : PiecewiseCurve<float, TPoint, TPathKey>

Type Parameters

TPoint
The type of the path points, such as Vector2F, Vector3F, etc.
TPathKey
The type of the path key. (A type derived from CurveKeyTParam, TPoint.)
TPath
The type of the path. (A type derived from PiecewiseCurveTParam, TPoint, TCurveKey.)

The PathAnimationTPoint, TPathKey, TPath type exposes the following members.

Constructors
  NameDescription
Protected methodPathAnimationTPoint, TPathKey, TPath
Initializes a new instance of the PathAnimationTPoint, TPathKey, TPath class.
Top
Methods
  NameDescription
Public methodCreateBlendAnimation (Inherited from AnimationT.)
Public methodCreateInstance
Creates an animation instance that can be used to play back the animation. (For internal use only.)
(Inherited from AnimationT.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAnimationTime
Gets the animation time for the specified time on the timeline.
(Inherited from AnimationT.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetState
Gets the state of the animation for the specified time on the timeline.
(Inherited from AnimationT.)
Public methodGetTotalDuration
Gets the total length of the timeline.
(Overrides AnimationTGetTotalDuration.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Gets the value of the animation at the specified time.
(Inherited from AnimationT.)
Protected methodGetValueCore
Evaluates the animation function at the specified animation time.
(Overrides AnimationTGetValueCore(TimeSpan, T, T, T).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyEndParameter
Gets or sets the end parameter.
Public propertyFillBehavior
Gets or sets a value that specifies how the animation behaves when it reaches the end of its duration.
(Inherited from AnimationT.)
Public propertyIsAdditive
Gets or sets a value indicating whether the output of the animation is added to the current value of the property that is being animated.
(Inherited from AnimationT.)
Public propertyPath
Gets or sets the animation path.
Public propertyReturnsTangent
Gets or sets a value indicating whether the animation returns the tangent or the point on the path.
Public propertyStartParameter
Gets or sets the start parameter.
Public propertyTargetObject
Gets or sets the object to which the animation is applied by default.
(Inherited from AnimationT.)
Public propertyTargetProperty
Gets or sets the property to which the animation is applied by default.
(Inherited from AnimationT.)
Public propertyTraits
Gets the traits of the animation values.
(Inherited from AnimationT.)
Top
Remarks

A path animation moves a point in space along a predefined path (see property Path). The animation path is a spline-based curve consisting of several path keys (also known as 'key frames'). A path key defines a point in space. The parameter of a path key is the animation time - the time at which the point on the path is reached. A path key also defines the type of interpolation that is used for the segment between the current and the next path key. All relevant types of spline-based interpolations can be used for the path segments.

Duration: A path animation, by default, runs from the start (parameter = 0) until the last path key is reached. The parameter of the last path key determines the natural duration of the animation. The optional properties StartParameter and EndParameter can be used to explicitly define which part of the path should be played.

Loop Behavior: When the StartParameter is less than the parameter of the first path key or EndParameter is greater than the parameter of the last path key then the path is automatically repeated using a certain loop behavior. The loop behavior can be defined using the properties PreLoop and PostLoop of the Path.

Important: The path animation requires that the path keys are sorted ascending by their parameter (time value). The method Sort can be called to sort all path keys.

See Also