PointAnimation Class

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Definition

Namespace:

Windows.UI.Xaml.Media.Animation

Animates the value of a Point property between two target values using linear interpolation over a specified Duration.

Equivalent WinUI class: Microsoft.UI.Xaml.Media.Animation.PointAnimation.

public ref class PointAnimation sealed : Timeline

/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class PointAnimation final : Timeline

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class PointAnimation final : Timeline

[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class PointAnimation : Timeline

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class PointAnimation : Timeline

Public NotInheritable Class PointAnimation
Inherits Timeline

<PointAnimation .../>

Inheritance

Object IInspectable DependencyObject Timeline PointAnimation

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

The following example shows how to use the PointAnimation to animate the Center property of an EllipseGeometry.

// Start the animation when the object loads
void SampleApp::Page::Start_Animation(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
    myStoryboard->Begin();
}

<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();
}

' Start the animation when the object loads
Private Sub Start_Animation(ByVal sender As Object, ByVal e As EventArgs)
    myStoryboard.Begin()
End Sub

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.

Constructors

PointAnimation()

Initializes a new instance of the PointAnimation class.

Properties

AutoReverse	Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.Timeline.AutoReverse. (Inherited from Timeline)
BeginTime	Gets or sets the time at which this Timeline should begin. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.Timeline.BeginTime. (Inherited from Timeline)
By	Gets or sets the total amount by which the animation changes its starting value. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.By.
ByProperty	Identifies the By dependency property. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.ByProperty.
Dispatcher	Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher. (Inherited from DependencyObject)
Duration	Gets or sets the length of time for which this timeline plays, not counting repetitions. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.Timeline.Duration. (Inherited from Timeline)
EasingFunction	Gets or sets the easing function you are applying to the animation. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.EasingFunction.
EasingFunctionProperty	Identifies the EasingFunction dependency property. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.EasingFunctionProperty.
EnableDependentAnimation	Gets or sets a value that declares whether animated properties that are considered dependent animations should be permitted to use this animation declaration. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.EnableDependentAnimation.
EnableDependentAnimationProperty	Identifies the EnableDependentAnimation dependency property. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.EnableDependentAnimationProperty.
FillBehavior	Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.Timeline.FillBehavior. (Inherited from Timeline)
From	Gets or sets the animation's starting value. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.From.
FromProperty	Identifies the From dependency property. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.FromProperty.
RepeatBehavior	Gets or sets the repeating behavior of this timeline. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.Timeline.RepeatBehavior. (Inherited from Timeline)
SpeedRatio	Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.Timeline.SpeedRatio. (Inherited from Timeline)
To	Gets or sets the animation's ending value. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.To.
ToProperty	Identifies the To dependency property. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Animation.PointAnimation.ToProperty.

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue. (Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

Completed

Occurs when the Storyboard object has completed playing. Equivalent WinUI event: Microsoft.UI.Xaml.Media.Animation.Timeline.Completed. (Inherited from Timeline)

See also

• Timeline
• Point
• PointAnimationUsingKeyFrames
• Storyboarded animations
• XAML animation sample