KeyFrameAnimation Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A time-based animation with one or more key frames. These frames are markers, allowing developers to specify values at specific times for the animating property. KeyFrame animations can be further customized by specifying how the animation interpolates between keyframes.
public ref class KeyFrameAnimation : CompositionAnimation/// [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 KeyFrameAnimation : CompositionAnimation/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 131072)]
class KeyFrameAnimation : CompositionAnimation[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 class KeyFrameAnimation : CompositionAnimation[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 131072)]
public class KeyFrameAnimation : CompositionAnimationPublic Class KeyFrameAnimation
Inherits CompositionAnimation- Inheritance
- Derived
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
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. See Composition Animations Overview for additional information on ExpressionAnimations.
A KeyFrameAnimation does not stop automatically when an app's process is suspended. You must subscribe to app state events and stop or pause your animations before the app is suspended. For more info about app suspension, see App lifecycle.
Version history
| Windows version | SDK version | Value added |
|---|---|---|
| 1607 | 14393 | Direction |
| 1703 | 15063 | DelayBehavior |
Properties
| Comment |
A string to associate with the CompositionObject. (Inherited from CompositionObject) |
| Compositor |
The Compositor used to create this CompositionObject. (Inherited from CompositionObject) |
| DelayBehavior |
The delay behavior of the key frame animation. |
| DelayTime |
Delay before the animation starts after CompositionObject.StartAnimation is called. |
| 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. |
| Dispatcher |
The dispatcher for the CompositionObject. (Inherited from CompositionObject) |
| DispatcherQueue |
Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject) |
| Duration |
The duration of the animation. |
| ImplicitAnimations |
The collection of implicit animations attached to this object. (Inherited from CompositionObject) |
| InitialValueExpressions |
Gets the initial values for the animation. (Inherited from CompositionAnimation) |
| IterationBehavior |
The iteration behavior for the key frame animation. |
| IterationCount |
The number of times to repeat the key frame animation. |
| KeyFrameCount |
The number of key frames in the KeyFrameAnimation. |
| Properties |
The collection of properties associated with the CompositionObject. (Inherited from CompositionObject) |
| StopBehavior |
Specifies how to set the property value when StopAnimation is called. |
| Target |
The target of the animation. (Inherited from CompositionAnimation) |
Methods
| ClearAllParameters() |
Clears all of the parameters of the animation. (Inherited from CompositionAnimation) |
| ClearParameter(String) |
Clears a parameter from the animation. (Inherited from CompositionAnimation) |
| Close() |
Closes the CompositionObject and releases system resources. (Inherited from CompositionObject) |
| ConnectAnimation(String, CompositionAnimation) |
Connects and animation. (Inherited from CompositionObject) |
| DisconnectAnimation(String) |
Disconnects an animation. (Inherited from CompositionObject) |
| Dispose() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject) |
| InsertExpressionKeyFrame(Single, String, CompositionEasingFunction) |
Inserts an expression keyframe. |
| InsertExpressionKeyFrame(Single, String) |
Inserts an expression key frame. |
| PopulatePropertyInfo(String, AnimationPropertyInfo) |
Defines a property that can be animated. (Inherited from CompositionObject) |
| SetBooleanParameter(String, Boolean) |
Sets a boolean value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetColorParameter(String, Color) |
Sets a Color value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetExpressionReferenceParameter(String, IAnimationObject) |
Sets an object that implements IAnimationObject as a reference parameter in an ExpressionAnimation. (Inherited from CompositionAnimation) |
| SetMatrix3x2Parameter(String, Matrix3x2) |
Sets a Matrix3x2 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetMatrix4x4Parameter(String, Matrix4x4) |
Sets a Matrix4x4 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetQuaternionParameter(String, Quaternion) |
Sets a Quaternion value for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| 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) |
Sets a Scalar value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetVector2Parameter(String, Vector2) |
Sets a Vector2 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetVector3Parameter(String, Vector3) |
Sets a Vector3 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| SetVector4Parameter(String, Vector4) |
Sets a Vector4 value parameter for use with an ExpressionAnimation or an expression keyframe. (Inherited from CompositionAnimation) |
| StartAnimation(String, CompositionAnimation, AnimationController) |
Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject) |
| StartAnimation(String, CompositionAnimation) |
Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject) |
| 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) |
| StopAnimation(String) |
Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject) |
| StopAnimationGroup(ICompositionAnimationBase) |
Stops an animation group. (Inherited from CompositionObject) |
| TryGetAnimationController(String) |
Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject) |