Click or drag to resize
DigitalRuneSkeletonKeyFrameAnimationGetValue Method
Gets the value of the animation at the specified time.

Namespace: DigitalRune.Animation.Character
Assembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax
public void GetValue(
	TimeSpan time,
	ref SkeletonPose defaultSource,
	ref SkeletonPose defaultTarget,
	ref SkeletonPose result
)

Parameters

time
Type: SystemTimeSpan
The time value on the timeline.
defaultSource
Type: DigitalRune.Animation.CharacterSkeletonPose
In: The source value that should be used by the animation if the animation does not have its own source value.
defaultTarget
Type: DigitalRune.Animation.CharacterSkeletonPose
In: The target value that should be used by the animation if the animation does not have its own target value.
result
Type: DigitalRune.Animation.CharacterSkeletonPose
Out: The value of the animation at the given time. (The animation returns defaultSource if the animation is Delayed or Stopped at time.)

Implements

IAnimationTGetValue(TimeSpan, T, T, T)
Exceptions
ExceptionCondition
AnimationException This animation is not frozen. Freeze must be called before the animation can be used.
ArgumentNullExceptiondefaultSource, defaultTarget or result is .
Remarks

Note that the parameters need to be passed by reference. defaultSource and defaultTarget are input parameters. The resulting animation value is stored in result.

The values of the defaultSource and the defaultTarget parameters depend on where the animation is used. If the animation is used to animate an IAnimatablePropertyT, then the values depend on the position of the animation in the composition chain:

  • If the animation has replaced another animation using SnapshotAndReplace: defaultSource is the last output value of the animation which was replaced and defaultTarget is the base value of the animated property.
  • If the animation is the first in an animation composition chain: defaultSource and defaultTarget are the base value of the animated property.
  • If the animation is not the first in an animation composition chain: defaultSource is the output of the previous stage in the composition chain and defaultTarget is the base value of the animated property.

If the animation is not used to animate an IAnimatablePropertyT, the values need to be set by the user depending on the context where the animation is used. (In most cases it is safe to ignore the parameters and just pass default values.)

See Also