Click or drag to resize
DigitalRuneAnimationInstanceWeight Property
Gets or sets the animation weight.

Namespace: DigitalRune.Animation
Assembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax
public float Weight { get; set; }

Property Value

Type: Single
The animation weight. The value lies in the range [0, 1]. The default value is 1.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionvalue is negative or greater than 1.
Remarks

The animation weight defines the intensity of the animation. It is a factor that is applied to the animation output. The animation weight is in particular relevant when multiple animations should be combined. Each animation combines its output with the output of the previous stage in the animation composition chain. (If the animation is the first animation of a composition chain it combines its value with the base value of the property that is being animated.)

The default value is 1 which means that 100% of the animation is returned, overriding any previous stage in a animation composition chain. A value of 0.75 means that result is weighted combination of the previous stage (25%) and the output of the current animation (75%). A value of 0 basically disables the output of the current animation.

Changing the animation weight of an instance affects the entire subtree: the current animation instance and all children. The effective animation weight is the product of all weights from the root node to the current animation instance.

See Also