CompositionAnimation CompositionAnimation CompositionAnimation CompositionAnimation CompositionAnimation Class

Definition

Represents the base animation class.

public : class CompositionAnimation : CompositionObject, ICompositionAnimation, ICompositionAnimation2, ICompositionAnimation3, ICompositionAnimationBase
struct winrt::Windows::UI::Composition::CompositionAnimation : CompositionObject, ICompositionAnimation, ICompositionAnimation2, ICompositionAnimation3, ICompositionAnimationBase
public class CompositionAnimation : CompositionObject, ICompositionAnimation, ICompositionAnimation2, ICompositionAnimation3, ICompositionAnimationBase
Public Class CompositionAnimation Inherits CompositionObject Implements ICompositionAnimation, ICompositionAnimation2, ICompositionAnimation3, ICompositionAnimationBase
// This class does not provide a public constructor.
Inheritance
CompositionAnimationCompositionAnimationCompositionAnimationCompositionAnimationCompositionAnimation
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Properties

Comment Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Dispatcher Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
InitialValueExpressions InitialValueExpressions InitialValueExpressions InitialValueExpressions InitialValueExpressions

Gets the initial values for the animation.

Properties Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
Target Target Target Target Target

The target of the animation.

Methods

ClearAllParameters() ClearAllParameters() ClearAllParameters() ClearAllParameters() ClearAllParameters()

Clears all of the parameters of the animation.

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

Clears a parameter from the animation.

Close Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
SetBooleanParameter(String, Boolean) SetBooleanParameter(String, Boolean) SetBooleanParameter(String, Boolean) SetBooleanParameter(String, Boolean) SetBooleanParameter(String, Boolean)

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

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

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

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

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

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

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

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

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

SetReferenceParameter(String, CompositionObject) SetReferenceParameter(String, CompositionObject) 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.

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

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

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

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

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

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

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

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

StartAnimation(String,CompositionAnimation) StartAnimation(String,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)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) 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)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

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

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

Returns an AnimationController for the animation running on the specified property.

(Inherited from CompositionObject)

See Also