IAnimation.GetCurrentValue(Object, Object, AnimationClock) Method

Definition

Namespace:

System.Windows.Media.Animation

Assembly:

PresentationCore.dll

Calculates the value this animation believes should be the current value for the property.

public:
 System::Object ^ GetCurrentValue(System::Object ^ defaultOriginValue, System::Object ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);

public object GetCurrentValue (object defaultOriginValue, object defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);

abstract member GetCurrentValue : obj * obj * System.Windows.Media.Animation.AnimationClock -> obj

Public Function GetCurrentValue (defaultOriginValue As Object, defaultDestinationValue As Object, animationClock As AnimationClock) As Object

Parameters

defaultOriginValue

Object

The suggested origin value to provide the animation, which is used if the animation does not have its own concept of a start value. If this animation is the first in a composition chain, it is the snapshot value, if one is available, or the base property value, if it is not; otherwise, it is the value returned by the previous animation in the chain with an animation clock that is not Stopped.

defaultDestinationValue

Object

The suggested destination value to provide the animation, which is used if the animation does not have its own concept of an end value. It is the base value if the animation is in the first composition layer of animations on a property; otherwise, it is the output value from the previous composition layer of animations for the property.

animationClock

AnimationClock

The animation clock that can generate the CurrentTime or CurrentProgress value to be used by the animation to generate its output value.

Returns

Object

The value this animation believes should be the current value for the property.