SplineDoubleKeyFrame SplineDoubleKeyFrame SplineDoubleKeyFrame Class

Definition

Animates from the Double value of the previous key frame to its own Value using splined interpolation.

public : sealed class SplineDoubleKeyFrame : DoubleKeyFrame, ISplineDoubleKeyFrame
public sealed class SplineDoubleKeyFrame : DoubleKeyFrame, ISplineDoubleKeyFrame
Public NotInheritable Class SplineDoubleKeyFrame Inherits DoubleKeyFrame Implements ISplineDoubleKeyFrame
<SplineDoubleKeyFrame .../>
Inheritance
SplineDoubleKeyFrameSplineDoubleKeyFrameSplineDoubleKeyFrame
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

This XAML example moves a rectangle across a screen. The example uses the DoubleAnimationUsingKeyFrames class to animate the X property of a TranslateTransform applied to a Rectangle. This animation uses three key frames in the following manner:

  1. During the first three seconds, it uses an instance of the LinearDoubleKeyFrame class to move the rectangle along a path at a steady rate from its starting position to the 500 position. Linear key frames like LinearDoubleKeyFrame create a smooth linear transition between values.
  2. At the end of the fourth second, it uses an instance of the DiscreteDoubleKeyFrame class to suddenly move the rectangle to the next position. Discrete key frames like DiscreteDoubleKeyFrame create sudden jumps between values. In this example, the rectangle is at the starting position and then suddenly appears at the 500 position.
  3. In the final two seconds, it uses an instance of the SplineDoubleKeyFrame class to move the rectangle back to its starting position. Spline key frames such as SplineDoubleKeyFrame create a variable transition between values according to the value of the KeySpline property. In this example, the rectangle begins by moving slowly and then speeds up exponentially toward the end of the time segment.
<StackPanel>
    <StackPanel.Resources>
        <Storyboard x:Name="myStoryboard">

            <!-- Animate the TranslateTransform's X property
             from 0 to 350, then 50,
             then 200 over 10 seconds. -->
            <DoubleAnimationUsingKeyFrames
          Storyboard.TargetName="MyAnimatedTranslateTransform"
          Storyboard.TargetProperty="X"
          Duration="0:0:10" EnableDependentAnimation="True">

                <!-- Using a LinearDoubleKeyFrame, the rectangle moves 
                 steadily from its starting position to 500 over 
                 the first 3 seconds.  -->
                <LinearDoubleKeyFrame Value="500" KeyTime="0:0:3" />

                <!-- Using a DiscreteDoubleKeyFrame, the rectangle suddenly 
                 appears at 400 after the fourth second of the animation. -->
                <DiscreteDoubleKeyFrame Value="400" KeyTime="0:0:4" />

                <!-- Using a SplineDoubleKeyFrame, the rectangle moves 
                 back to its starting point. The
                 animation starts out slowly at first and then speeds up. 
                 This KeyFrame ends after the 6th
                 second. -->
                <SplineDoubleKeyFrame KeySpline="0.6,0.0 0.9,0.00" Value="0" KeyTime="0:0:6" />

            </DoubleAnimationUsingKeyFrames>
        </Storyboard>
    </StackPanel.Resources>
    <Rectangle Fill="Blue" Width="50" Height="50" Loaded="Start_Animation">
        <Rectangle.RenderTransform>
            <TranslateTransform x:Name="MyAnimatedTranslateTransform" 
             X="0" Y="0" />
        </Rectangle.RenderTransform>
    </Rectangle>
</StackPanel>
' Start the animation when the object loads
Private Sub Start_Animation(ByVal sender As Object, ByVal e As EventArgs)
    myStoryboard.Begin()
End Sub
// Start the animation when the object loads
private void Start_Animation(object sender, RoutedEventArgs e)
{
    myStoryboard.Begin();
}

Remarks

Key-frame animations permit more than one target value that is reached at a point along the animation timeline. In other words each key frame can specify a different intermediate value, and the last key frame reached is the final animation value. By specifying multiple values to animate, you can make more complex animations. You can mix discrete, linear, and spline keyframes in the same keyframe collection.

For more info on how to use key-frame animations, see Key-frame animations and easing function animations.

Constructors

SplineDoubleKeyFrame() SplineDoubleKeyFrame() SplineDoubleKeyFrame()

Initializes a new instance of the SplineDoubleKeyFrame class.

public : SplineDoubleKeyFrame()
public SplineDoubleKeyFrame()
Public Sub New()

Properties

Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

KeySpline KeySpline KeySpline

Gets or sets the two control points that define animation progress for this key frame.

public : KeySpline KeySpline { get; set; }
public KeySpline KeySpline { get; set; }
Public ReadWrite Property KeySpline As KeySpline
<SplineDoubleKeyFrame KeySpline="keySplineValue"/>
Value
KeySpline KeySpline KeySpline

The two control points that specify the cubic Bezier curve that defines the progress of the key frame.

KeySplineProperty KeySplineProperty KeySplineProperty

Identifies the KeySpline dependency property.

public : static DependencyProperty KeySplineProperty { get; }
public static DependencyProperty KeySplineProperty { get; }
Public Static ReadOnly Property KeySplineProperty As DependencyProperty
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the KeySpline dependency property.

KeyTime KeyTime KeyTime

Inherited from DoubleKeyFrame

KeyTimeProperty KeyTimeProperty KeyTimeProperty

Inherited from DoubleKeyFrame

Value Value Value

Inherited from DoubleKeyFrame

ValueProperty ValueProperty ValueProperty

Inherited from DoubleKeyFrame

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

See Also