Animates the value of a Point property between two target values using linear interpolation over a specified Duration.
Inheritance
- Object
- DependencyObject
- Timeline
- PointAnimation
Syntax
<PointAnimation .../>
Attributes
- ActivatableAttribute(NTDDI_WIN8)
- MarshalingBehaviorAttribute(Agile)
- StaticAttribute(Windows.UI.Xaml.Media.Animation.IPointAnimationStatics, NTDDI_WIN8)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The PointAnimation class has these types of members:
Constructors
The PointAnimation class has these constructors.
| Constructor | Description |
|---|---|
| PointAnimation | Initializes a new instance of the PointAnimation class. |
Events
The PointAnimation class has these events.
| Event | Description |
|---|---|
| Completed | Occurs when the Storyboard object has completed playing. (Inherited from Timeline) |
Methods
The PointAnimation class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
Properties
The PointAnimation class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write | Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline) | |
| Read/write | Gets or sets the time at which this Timeline should begin. (Inherited from Timeline) | |
| Read/write | Gets or sets the total amount by which the animation changes its starting value. | |
| Read-only | Identifies the By dependency property. | |
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read/write | Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline) | |
| Read/write | Gets or sets the easing function you are applying to the animation. | |
| Read-only | Identifies the EasingFunction dependency property. | |
| Read/write | Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration. | |
| Read-only | Identifies the EnableDependentAnimation dependency property. | |
| Read/write | Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period. (Inherited from Timeline) | |
| Read/write | Gets or sets the animation's starting value. | |
| Read-only | Identifies the From dependency property. | |
| Read/write | Gets or sets the repeating behavior of this timeline. (Inherited from Timeline) | |
| Read/write | Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline) | |
| Read/write | Gets or sets the animation's ending value. | |
| Read-only | Identifies the To dependency property. |
Remarks
Use PointAnimation to animate the property value of any dependency property that is of type Point.
Linear interpolation for a Point means that X and Y values are treated as a number and the interpolation is simply a mathematical operation.
Sometimes you'll need to use indirect property targeting in order to target a sub-property of another object that's the value of a property on the target. For example, in order to animate parts of a PathGeometry, you need to reference some of the intermediate object-property values, until the last step in the indirect property path is truly a Point value. For more info on indirect property targeting and other storyboarded animation concepts, see Storyboarded animations or Property path syntax.
A PointAnimation typically has at least one of the From, By or To properties set, but never all three.
- From only: The animation progresses from the value specified by the From property to the base value of the property being animated.
- From and To: The animation progresses from the value specified by the From property to the value specified by the To property.
- From and By: The animation progresses from the value specified by the From property to the value specified by the sum of the From and By properties.
- To only: The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the To property.
- By only: The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the By property.
The From, By or To properties of a PointAnimation aren't a Point value. Instead these are a Nullable for Point. The default value for these is null, not an uninitialized structure. That null value is how the animation system distinguishes that you haven't specifically set a value. Visual C++ component extensions (C++/CX) doesn't have a Nullable type, so it uses IReference instead.
Examples
The following example shows how to use the PointAnimation to animate the Center property of an EllipseGeometry.
<Canvas Width="450" Height="350"> <Canvas.Resources> <Storyboard x:Name="myStoryboard"> <!-- Animate the center point of the ellipse from 100 X, 300 Y to 400 X, 100 Y over 5 seconds. --> <PointAnimation Storyboard.TargetProperty="Center" Storyboard.TargetName="MyAnimatedEllipseGeometry" Duration="0:0:5" From="100,300" To="400,100" RepeatBehavior="Forever" EnableDependentAnimation="True"/> </Storyboard> </Canvas.Resources> <Path Fill="Blue" Loaded="Start_Animation"> <Path.Data> <!-- Describes an ellipse. --> <EllipseGeometry x:Name="MyAnimatedEllipseGeometry" Center="200,100" RadiusX="15" RadiusY="15" /> </Path.Data> </Path> </Canvas>
// Start the animation when the object loads private void Start_Animation(object sender, RoutedEventArgs e) { myStoryboard.Begin(); }
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
Build date: 12/4/2012