CompositionAnimation Class

Definition

Namespace:

Windows.UI.Composition

Represents the base animation class.

public ref class CompositionAnimation : CompositionObject, ICompositionAnimationBase

/// [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 CompositionAnimation : CompositionObject, ICompositionAnimationBase

[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 CompositionAnimation : CompositionObject, ICompositionAnimationBase

Public Class CompositionAnimation
Inherits CompositionObject
Implements ICompositionAnimationBase

Inheritance

Object Platform::Object IInspectable CompositionObject CompositionAnimation

Derived

Windows.UI.Composition.ExpressionAnimation

Windows.UI.Composition.KeyFrameAnimation

Windows.UI.Composition.NaturalMotionAnimation

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

ICompositionAnimationBase

Windows requirements

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

Remarks

This is the base class for ExpressionAnimation and KeyFrameAnimation.

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

Value parameters (as opposed to reference parameters which are set using SetReferenceParameter) are copied and "embedded" into an expression at the time CompositionObject.StartAnimation is called. Changing the value of the variable after CompositionObject.StartAnimation is called will not affect the value of the ExpressionAnimation. See the remarks section of ExpressionAnimation for additional information.

For a list of animatable properties, see the remarks on CompostionObject.StartAnimation.

Version history

Windows version	SDK version	Value added
1607	14393	SetBooleanParameter
1607	14393	Target
1709	16299	InitialValueExpressions
1809	17763	SetExpressionReferenceParameter

Properties

Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
Dispatcher	The dispatcher for the CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompostionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
InitialValueExpressions	Gets the initial values for the animation.
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
Target	The target of the animation.

Methods

ClearAllParameters()	Clears all of the parameters of the animation.
ClearParameter(String)	Clears a parameter from the animation.
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)
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.
SetColorParameter(String, Color)	Sets a Color value parameter for use with an ExpressionAnimation or an expression keyframe.
SetExpressionReferenceParameter(String, IAnimationObject)	Sets an object that implements IAnimationObject as a reference parameter in an ExpressionAnimation.
SetMatrix3x2Parameter(String, Matrix3x2)	Sets a Matrix3x2 value parameter for use with an ExpressionAnimation or an expression keyframe.
SetMatrix4x4Parameter(String, Matrix4x4)	Sets a Matrix4x4 value parameter for use with an ExpressionAnimation or an expression keyframe.
SetQuaternionParameter(String, Quaternion)	Sets a Quaternion value for use with an ExpressionAnimation or an expression keyframe.
SetReferenceParameter(String, CompositionObject)	Sets a reference to a Composition object for use with an ExpressionAnimation or an expression keyframe.
SetScalarParameter(String, Single)	Sets a Scalar value parameter for use with an ExpressionAnimation or an expression keyframe.
SetVector2Parameter(String, Vector2)	Sets a Vector2 value parameter for use with an ExpressionAnimation or an expression keyframe.
SetVector3Parameter(String, Vector3)	Sets a Vector3 value parameter for use with an ExpressionAnimation or an expression keyframe.
SetVector4Parameter(String, Vector4)	Sets a Vector4 value parameter for use with an ExpressionAnimation or an expression keyframe.
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)

See also

• ExpressionAnimation
• KeyFrameAnimation
• CompositionObject
• IClosable
• Composition Animations Overview