DoubleAnimationUsingPath Class
Animates the value of a Double property between two or more target values using a PathGeometry to specify those values. This animation can be used to move a visual object along a path.
System.Windows.Threading::DispatcherObject
System.Windows::DependencyObject
System.Windows::Freezable
System.Windows.Media.Animation::Animatable
System.Windows.Media.Animation::Timeline
System.Windows.Media.Animation::AnimationTimeline
System.Windows.Media.Animation::DoubleAnimationBase
System.Windows.Media.Animation::DoubleAnimationUsingPath
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
The DoubleAnimationUsingPath type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | DoubleAnimationUsingPath | Initializes a new instance of the DoubleAnimationUsingPath class. |
| Name | Description | |
|---|---|---|
![]() | AccelerationRatio | Gets or sets a value specifying the percentage of the timeline's Duration spent accelerating the passage of time from zero to its maximum rate. (Inherited from Timeline.) |
![]() | AutoReverse | Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline.) |
![]() | BeginTime | Gets or sets the time at which this Timeline should begin. (Inherited from Timeline.) |
![]() | CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) |
![]() | DecelerationRatio | Gets or sets a value specifying the percentage of the timeline's Duration spent decelerating the passage of time from its maximum rate to zero. (Inherited from Timeline.) |
![]() | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | Duration | Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline.) |
![]() | FillBehavior | Gets or sets a value that specifies how the Timeline behaves after it reaches the end of its active period. (Inherited from Timeline.) |
![]() | HasAnimatedProperties | Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.) |
![]() | IsAdditive | Gets or sets a value that indicates whether the target property's current value should be added to this animation's starting value. |
![]() | IsCumulative | Gets or sets a value that specifies whether the animation's value accumulates when it repeats. |
![]() | IsDestinationDefault | Gets a value that indicates whether this animation uses the defaultDestinationValue parameter of the GetCurrentValue method as its destination value. (Inherited from AnimationTimeline.) |
![]() | IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) |
![]() | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.) |
![]() | Name | Gets or sets the name of this Timeline. (Inherited from Timeline.) |
![]() | PathGeometry | Specifies the geometry used to generate this animation's output values. |
![]() | RepeatBehavior | Gets or sets the repeating behavior of this timeline. (Inherited from Timeline.) |
![]() | Source | Gets or sets the aspect of this animation's PathGeometry that determines its output value. |
![]() | SpeedRatio | Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline.) |
![]() | TargetPropertyType | Gets the type of value this animation generates. (Inherited from DoubleAnimationBase.) |
| Name | Description | |
|---|---|---|
![]() | AllocateClock | Creates a Clock for this AnimationTimeline. (Inherited from AnimationTimeline.) |
![]() | ApplyAnimationClock(DependencyProperty, AnimationClock) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.) |
![]() | ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty, AnimationTimeline) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
![]() | ClearValue(DependencyProperty) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) |
![]() | ClearValue(DependencyPropertyKey) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) |
![]() | Clone | Creates a modifiable clone of this DoubleAnimationUsingPath, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. |
![]() | CloneCore | Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.) |
![]() | CloneCurrentValue | Creates a modifiable clone of this Timeline object, making deep copies of this object's current values. (Inherited from Timeline.) |
![]() | CloneCurrentValueCore | Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable.) |
![]() | CoerceValue | Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.) |
![]() | CreateClock() | Creates a new AnimationClock from this AnimationTimeline. (Inherited from AnimationTimeline.) |
![]() | CreateClock(Boolean) | Creates a new Clock from this Timeline and specifies whether the new Clock is controllable. If this Timeline has children, a tree of clocks is created with this Timeline as the root. (Inherited from Timeline.) |
![]() | CreateInstance | Initializes a new instance of the Freezable class. (Inherited from Freezable.) |
![]() | CreateInstanceCore | Implementation of CreateInstanceCore. (Overrides Freezable::CreateInstanceCore().) |
![]() | Equals | Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | Freeze() | Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.) |
![]() | FreezeCore | Makes this Timeline unmodifiable or determines whether it can be made unmodifiable. (Inherited from Timeline.) |
![]() | GetAnimationBaseValue | Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.) |
![]() | GetAsFrozen | Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.) |
![]() | GetAsFrozenCore | Makes this instance a clone of the specified Timeline object. (Inherited from Timeline.) |
![]() | GetCurrentValue(Double, Double, AnimationClock) | Gets the current value of the animation. (Inherited from DoubleAnimationBase.) |
![]() | GetCurrentValue(Object, Object, AnimationClock) | Gets the current value of the animation. (Inherited from DoubleAnimationBase.) |
![]() | GetCurrentValueAsFrozen | Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.) |
![]() | GetCurrentValueAsFrozenCore | Makes this instance a frozen clone of the specified Timeline. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from Timeline.) |
![]() | GetCurrentValueCore | Calculates a value that represents the current value of the property being animated, as determined by the DoubleAnimationUsingPath. (Overrides DoubleAnimationBase::GetCurrentValueCore(Double, Double, AnimationClock).) |
![]() | GetHashCode | Gets a hash code for this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetLocalValueEnumerator | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetNaturalDuration | Returns the length of a single iteration of this Timeline. (Inherited from Timeline.) |
![]() | GetNaturalDurationCore | Returns the length of a single iteration of this AnimationTimeline. (Inherited from AnimationTimeline.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) |
![]() | InvalidateProperty | Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnChanged | Called when this DoubleAnimationUsingPath is modified. (Overrides Freezable::OnChanged().) |
![]() | OnFreezablePropertyChanged(DependencyObject, DependencyObject) | Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.) |
![]() | OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) | This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable.) |
![]() | OnPropertyChanged | Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable.) |
![]() | ReadLocalValue | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) |
![]() | ReadPreamble | Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable.) |
![]() | SetCurrentValue | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyProperty, Object) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyPropertyKey, Object) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) |
![]() | ShouldSerializeProperty | Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
![]() | WritePostscript | Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable.) |
![]() | WritePreamble | Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.) |
| Name | Description | |
|---|---|---|
![]() | Changed | Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.) |
![]() | Completed | Occurs when this timeline has completely finished playing: it will no longer enter its active period. (Inherited from Timeline.) |
![]() | CurrentGlobalSpeedInvalidated | Occurs when the rate at which time progresses for the timeline's clock changes. (Inherited from Timeline.) |
![]() | CurrentStateInvalidated | Occurs when the CurrentState property of the timeline's Clock is updated. (Inherited from Timeline.) |
![]() | CurrentTimeInvalidated | Occurs when the CurrentTime property of the timeline's Clock is updated. (Inherited from Timeline.) |
![]() | RemoveRequested | Occurs when the clock created for this timeline or one of its parent timelines is removed. (Inherited from Timeline.) |
| Name | Description | |
|---|---|---|
![]() ![]() | PathGeometryProperty | Identifies the PathGeometry dependency property. |
![]() ![]() | SourceProperty | Identifies the Source dependency property. |
DoubleAnimationUsingPath uses linear interpolation over a specified Duration.
DoubleAnimationUsingPath is similar to DoubleAnimation except that it uses a PathGeometry to interpolate over two or more values rather then between only two values like DoubleAnimation. Although DoubleAnimation is used for most simple animations involving a Double value, DoubleAnimationUsingPath is particularly well suited for animating the position of an object on the screen.
This example shows how to use the DoubleAnimationUsingPath class to move an object along a path defined by a PathGeometry.
The following example uses two DoubleAnimationUsingPath objects to move a rectangle along a geometric path:
The first DoubleAnimationUsingPath animates the X of the TranslateTransform applied to the rectangle. It makes the rectangle move horizontally along the path.
The second DoubleAnimationUsingPath animates the Y of the TranslateTransform applied to the rectangle. It makes the rectangle move vertically along the path.
<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:PresentationOptions="http://schemas.microsoft.com/winfx/2006/xaml/presentation/options" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="PresentationOptions"> <Page.Resources> <!-- This is the geometry creates the animation path. Because this example uses it multiple times, it's declared as a resource and frozen to improve performance. --> <PathGeometry x:Key="AnimationPath" Figures="M 10,100 C 35,0 135,0 160,100 180,190 285,200 310,100" PresentationOptions:Freeze="True" /> </Page.Resources> <Canvas Width="400" Height="400"> <!-- The object to animate. --> <Rectangle Width="30" Height="30" Fill="Blue"> <Rectangle.RenderTransform> <TranslateTransform x:Name="AnimatedTranslateTransform" /> </Rectangle.RenderTransform> <Rectangle.Triggers> <EventTrigger RoutedEvent="Path.Loaded"> <BeginStoryboard> <Storyboard RepeatBehavior="Forever"> <!-- Animates the rectangle horizotally along the path. --> <DoubleAnimationUsingPath Storyboard.TargetName="AnimatedTranslateTransform" Storyboard.TargetProperty="X" PathGeometry="{StaticResource AnimationPath}" Source="X" Duration="0:0:5" /> <!-- Animates the rectangle vertically along the path. --> <DoubleAnimationUsingPath Storyboard.TargetName="AnimatedTranslateTransform" Storyboard.TargetProperty="Y" PathGeometry="{StaticResource AnimationPath}" Source="Y" Duration="0:0:5" /> </Storyboard> </BeginStoryboard> </EventTrigger> </Rectangle.Triggers> </Rectangle> </Canvas> </Page>
For the complete sample, see Path Animation Sample.
Another way to move an object using a geometric path is to use a MatrixAnimationUsingPath object. For an example, see How to: Animate an Object Along a Path (Matrix Animation).
More Code
| How to: Rotate an Object by Using a Geometric Path | This example shows how to rotate (pivot) an object along a geometric path that is defined by a PathGeometry object. |
| How to: Animate an Object Along a Path (Point Animation) | This example shows how to use a PointAnimationUsingPath object to animate a Point along a curved path. |
| How to: Animate an Object Along a Path (Matrix Animation) | This example shows how to use the MatrixAnimationUsingPath class to animate an object along a path that is defined by a PathGeometry. |
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
