Vector4FFromToByAnimation Class

Animates a Vector4F value from/to/by a certain value.

Inheritance Hierarchy

SystemObject
  DigitalRune.AnimationAnimationVector4F
    DigitalRune.AnimationFromToByAnimationVector4F
      DigitalRune.AnimationVector4FFromToByAnimation

Namespace: DigitalRune.Animation
Assembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)

Syntax

C++

Copy

public class Vector4FFromToByAnimation : FromToByAnimation<Vector4F>

Public Class Vector4FFromToByAnimation
	Inherits FromToByAnimation(Of Vector4F)

public ref class Vector4FFromToByAnimation : public FromToByAnimation<Vector4F>

type Vector4FFromToByAnimation =  
    class
        inherit FromToByAnimation<Vector4F>
    end

The Vector4FFromToByAnimation type exposes the following members.

Constructors

	Name	Description
	Vector4FFromToByAnimation	Initializes a new instance of the Vector4FFromToByAnimation class

Top

Methods

	Name	Description
	CreateBlendAnimation	Creates a new BlendAnimationT. (For internal use only.) (Inherited from AnimationT.)
	CreateInstance	Creates an animation instance that can be used to play back the animation. (For internal use only.) (Inherited from AnimationT.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationTime	Gets the animation time for the specified time on the timeline. (Inherited from AnimationT.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetState	Gets the state of the animation for the specified time on the timeline. (Inherited from AnimationT.)
	GetTotalDuration	Gets the total length of the timeline. (Inherited from FromToByAnimationT.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Gets the value of the animation at the specified time. (Inherited from AnimationT.)
	GetValueCore	Evaluates the animation function at the specified animation time. (Inherited from FromToByAnimationT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	By	Gets or sets the final value of the animation relative to the start value. (Inherited from FromToByAnimationT.)
	Duration	Gets or sets the duration of the interpolation. (Inherited from FromToByAnimationT.)
	EasingFunction	Gets or sets the easing function that controls the pace of the interpolation. (Inherited from FromToByAnimationT.)
	FillBehavior	Gets or sets a value that specifies how the animation behaves when it reaches the end of its duration. (Inherited from AnimationT.)
	From	Gets or sets the start value of the animation. (Inherited from FromToByAnimationT.)
	IsAdditive	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.)
	TargetObject	Gets or sets the object to which the animation is applied by default. (Inherited from AnimationT.)
	TargetProperty	Gets or sets the property to which the animation is applied by default. (Inherited from AnimationT.)
	To	Gets or sets the final value of the animation. (Inherited from FromToByAnimationT.)
	Traits	Gets the traits of the animation values. (Overrides AnimationTTraits.)

Top

Remarks

This type of animation changes a value from, to, or by a certain value depending on the properties set:

Properties Specified	Resulting Behavior
From and To	The animation interpolates between the value specified by From and the value specified by To.
From and By	The animation interpolates between the value specified by From and the sum of the values specified by From and By.
From	The animation interpolates between the value specified by From and the default source value (see parameters of GetValue(TimeSpan, T, T, T)). When an IAnimatableProperty is animated this means that the From value is animated towards the output of the previous animation. If there is no previous animation, then the From value is animated towards the base value of the property.
To	The animation interpolates from the default source value (see parameters of GetValue(TimeSpan, T, T, T)) to the value specified by To. When an IAnimatableProperty is animated this means that the output of the previous animation is animated towards the To value. If there is no previous animation, then the base value of the property is animated towards the To value.
By	The animation interpolates from the default source value (see parameters of GetValue(TimeSpan, T, T, T)) to the sum of this value plus the value specified by By. When an IAnimatableProperty is animated this means that the output of the previous animation is animated towards the sum of the this value plus the By value. If there is no previous animation, then the base value of the property is animated towards the sum of the base value plus the By value.
No properties set	The animation interpolates between the default source value to the default target value (see parameters of GetValue(TimeSpan, T, T, T)). When an IAnimatableProperty is animated this means that the previous animation's output value is animated towards the base value of the property.

If both To and By are specified, the By value will be ignored.

The property Duration specifies the period of time over which the interpolation takes place.

By default, the animation interpolates linearly between the specified values. An easing function (see property EasingFunction) can be applied to control the pace of the transition.

The property IsAdditive can be set to add the output of the animation to the property that is being animated. Note that the animation needs to be fully defined to be additive. A from/to/by animation is fully defined if either From and To or From and By are set. The result is undefined if the animation is only partially defined (either the start or the final value is missing)!

Reference

DigitalRune.Animation Namespace