Vector3KeyFrameAnimation Vector3KeyFrameAnimation Vector3KeyFrameAnimation Class

Definition

A time-based animation that targets any Vector3-based property with one or more keyframes.

public : sealed class Vector3KeyFrameAnimation : KeyFrameAnimation, IVector3KeyFrameAnimation
public sealed class Vector3KeyFrameAnimation : KeyFrameAnimation, IVector3KeyFrameAnimation
Public NotInheritable Class Vector3KeyFrameAnimation Inherits KeyFrameAnimation Implements IVector3KeyFrameAnimation
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples


void AnimatingVisualOffset(Visual targetVisual) 
{ 
    var animation = _compositor.CreateVector3KeyFrameAnimation(); 

    // 
    // Define specific easing functions. 
    // 


    var linear = _compositor.CreateLinearEasingFunction(); 

    var easeIn = _compositor.CreateCubicBezierEasingFunction( 
            new Vector2(0.5f, 0.0f), new Vector2(1.0f, 1.0f)); 

    var easeOut = _compositor.CreateCubicBezierEasingFunction( 
            new Vector2(0.0f, 0.0f), new Vector2(0.5f, 1.0f)); 

    // 
    // Add a set of key frames to describe how the Offset should change over time.   
    // 

    animation.InsertKeyFrame(0.00f, new Vector3(100.0f, 100.0f, 0.0f)); 
    animation.InsertKeyFrame(0.25f, new Vector3(300.0f, 100.0f, 0.0f), easeIn); 
    animation.InsertKeyFrame(0.50f, new Vector3(300.0f, 300.0f, 0.0f), linear); 
    animation.InsertKeyFrame(0.75f, new Vector3(100.0f, 300.0f, 0.0f), linear); 
    animation.InsertKeyFrame(1.00f, new Vector3(100.0f, 100.0f, 0.0f), easeOut); 

    // 
    // The animation curve defined by the key frames will scale to match the duration. 
    // 

    animation.Duration = TimeSpan.FromMilliseconds(4000); 

    targetVisual.StartAnimation("Offset", animation); 
}

Remarks

Use the CompostionObject.StartAnimation and CompostionObject.StopAnimation methods to start and stop the animation.

An animation is associated with an object's property by calling CompositionObject::StartAnimation and specifying the property name and the animation. See the remarks section of CompositionObject::StartAnimation for a list of animatable properties.

Methods

ClearAllParameters ClearAllParameters ClearAllParameters

Clears all of the parameters of the animation.

(Inherited from CompositionAnimation)

ClearParameter(String) ClearParameter(String) ClearParameter(String)

Clears a parameter from the animation.

(Inherited from CompositionAnimation)

Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)

InsertExpressionKeyFrame(Single,String) InsertExpressionKeyFrame(Single,String) InsertExpressionKeyFrame(Single,String)

Inserts an expression key frame.

(Inherited from KeyFrameAnimation)

InsertExpressionKeyFrame(Single,String,CompositionEasingFunction) InsertExpressionKeyFrame(Single,String,CompositionEasingFunction) InsertExpressionKeyFrame(Single,String,CompositionEasingFunction)

Inserts an expression keyframe.

(Inherited from KeyFrameAnimation)

InsertKeyFrame(Single, Vector3) InsertKeyFrame(Single, Vector3) InsertKeyFrame(Single, Vector3)

Inserts a key frame.

public : void InsertKeyFrame(float normalizedProgressKey, Vector3 value)
public void InsertKeyFrame(Single normalizedProgressKey, Vector3 value)
Public Function InsertKeyFrame(normalizedProgressKey As Single, value As Vector3) As void
Parameters
normalizedProgressKey
float Single Single

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0.

value
Vector3 Vector3 Vector3

The value of the key frame.

See Also

InsertKeyFrame(Single, Vector3, CompositionEasingFunction) InsertKeyFrame(Single, Vector3, CompositionEasingFunction) InsertKeyFrame(Single, Vector3, CompositionEasingFunction)

Inserts a key frame with the specified easing function.

public : void InsertKeyFrame(float normalizedProgressKey, Vector3 value, CompositionEasingFunction easingFunction)
public void InsertKeyFrame(Single normalizedProgressKey, Vector3 value, CompositionEasingFunction easingFunction)
Public Function InsertKeyFrame(normalizedProgressKey As Single, value As Vector3, easingFunction As CompositionEasingFunction) As void
Parameters
normalizedProgressKey
float Single Single

The time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0.

value
Vector3 Vector3 Vector3

The value of the key frame.

easingFunction
CompositionEasingFunction CompositionEasingFunction CompositionEasingFunction

The easing function to use when interpolating between frames.

See Also

SetBooleanParameter(String,Boolean) SetBooleanParameter(String,Boolean) SetBooleanParameter(String,Boolean)

Sets a boolean value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

SetColorParameter(String,Color) SetColorParameter(String,Color) SetColorParameter(String,Color)

Sets a Color value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

SetMatrix3x2Parameter(String,Matrix3x2) SetMatrix3x2Parameter(String,Matrix3x2) SetMatrix3x2Parameter(String,Matrix3x2)

Sets a Matrix3x2 value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

SetMatrix4x4Parameter(String,Matrix4x4) SetMatrix4x4Parameter(String,Matrix4x4) SetMatrix4x4Parameter(String,Matrix4x4)

Sets a Matrix4x4 value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

SetQuaternionParameter(String,Quaternion) SetQuaternionParameter(String,Quaternion) SetQuaternionParameter(String,Quaternion)

Sets a Quaternion value for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

SetReferenceParameter(String,CompositionObject) SetReferenceParameter(String,CompositionObject) SetReferenceParameter(String,CompositionObject)

Sets a reference to a Composition object for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

SetScalarParameter(String,Single) SetScalarParameter(String,Single) SetScalarParameter(String,Single)

Sets a Scalar value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

SetVector2Parameter(String,Vector2) SetVector2Parameter(String,Vector2) SetVector2Parameter(String,Vector2)

Sets a Vector2 value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

SetVector3Parameter(String,Vector3) SetVector3Parameter(String,Vector3) SetVector3Parameter(String,Vector3)

Sets a Vector3 value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

SetVector4Parameter(String,Vector4) SetVector4Parameter(String,Vector4) SetVector4Parameter(String,Vector4)

Sets a Vector4 value parameter for use with an ExpressionAnimation or an expression keyframe.

(Inherited from CompositionAnimation)

StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Starts an animation group.

The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

StopAnimation(String) StopAnimation(String) StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Properties

Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)

DelayBehavior DelayBehavior DelayBehavior

The delay behavior of the key frame animation.

(Inherited from KeyFrameAnimation)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

DelayTime DelayTime DelayTime

Delay before the animation starts after CompositionObject::StartAnimation is called.

(Inherited from KeyFrameAnimation)

Direction Direction Direction

The direction the animation is playing.

The Direction property allows you to drive your animation from start to end or end to start or alternate between start and end or end to start if animation has an IterationCount greater than one. This gives an easy way for customizing animation definitions.

(Inherited from KeyFrameAnimation)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)

DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Duration Duration Duration

The duration of the animation.

(Inherited from KeyFrameAnimation)

ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

InitialValueExpressions InitialValueExpressions InitialValueExpressions

Gets the initial values for the animation.

(Inherited from CompositionAnimation)
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

IterationBehavior IterationBehavior IterationBehavior

The iteration behavior for the key frame animation.

(Inherited from KeyFrameAnimation)

IterationCount IterationCount IterationCount

The number of times to repeat the key frame animation.

(Inherited from KeyFrameAnimation)

KeyFrameCount KeyFrameCount KeyFrameCount

The number of key frames in the KeyFrameAnimation.

(Inherited from KeyFrameAnimation)

Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)

StopBehavior StopBehavior StopBehavior

Specifies how to set the property value when StopAnimation is called.

(Inherited from KeyFrameAnimation)

Target Target Target

The target of the animation.

(Inherited from CompositionAnimation)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

See Also