CompositionAnimation Class

Definition

Namespace:Avalonia.Rendering.Composition.Animations

Assembly:Avalonia.Base

Package:Avalonia

Source:CompositionAnimation.cs

This is the base class for ExpressionAnimation and KeyFrameAnimation.

public class CompositionAnimation

Inheritance: object -> CompositionObject -> CompositionAnimation

Derived types: ExpressionAnimation, KeyFrameAnimation

Implements:ICompositionAnimationBase

Remarks

Use the Avalonia.Rendering.Composition.CompositionObject.StartAnimation(string,Avalonia.Rendering.Composition.Animations.CompositionAnimation) method to start the animation. Value parameters (as opposed to reference parameters which are set using Avalonia.Rendering.Composition.Animations.CompositionAnimation.SetReferenceParameter(string,Avalonia.Rendering.Composition.CompositionObject)) are copied and "embedded" into an expression at the time CompositionObject.StartAnimation is called. Changing the value of the variable after Avalonia.Rendering.Composition.CompositionObject.StartAnimation(string,Avalonia.Rendering.Composition.Animations.CompositionAnimation) is called will not affect the value of the ExpressionAnimation. See the remarks section of ExpressionAnimation for additional information.

Methods

Name	Description
ClearAllParameters	Clears all of the parameters of the animation.
ClearParameter	Clears a parameter from the animation.
SetColorParameter	No summary available.
SetMatrix3x2Parameter	No summary available.
SetMatrix4x4Parameter	No summary available.
SetQuaternionParameter	No summary available.
SetReferenceParameter	No summary available.
SetScalarParameter	No summary available.
SetVector2Parameter	No summary available.
SetVector3Parameter	No summary available.
SetVector4Parameter	No summary available.
StartAnimation	Connects an animation with the specified property of the object and starts the animation. Inherited from CompositionObject.
StartAnimationGroup	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	Disconnects an animation from the specified property and stops the animation. Inherited from CompositionObject.
StopAnimationGroup	Stops an animation group. Inherited from CompositionObject.

ClearAllParameters Method

Clears all of the parameters of the animation.

public void ClearAllParameters()

ClearParameter Method

Clears a parameter from the animation.

public void ClearParameter(string key)

Parameters

key string

SetColorParameter Method

public void SetColorParameter(string key, Avalonia.Media.Color value)

Parameters

key string

value Avalonia.Media.Color

SetMatrix3x2Parameter Method

public void SetMatrix3x2Parameter(string key, System.Numerics.Matrix3x2 value)

Parameters

key string

value System.Numerics.Matrix3x2

SetMatrix4x4Parameter Method

public void SetMatrix4x4Parameter(string key, System.Numerics.Matrix4x4 value)

Parameters

key string

value System.Numerics.Matrix4x4

SetQuaternionParameter Method

public void SetQuaternionParameter(string key, System.Numerics.Quaternion value)

Parameters

key string

value System.Numerics.Quaternion

SetReferenceParameter Method

public void SetReferenceParameter(string key, Avalonia.Rendering.Composition.CompositionObject compositionObject)

Parameters

key string

compositionObject Avalonia.Rendering.Composition.CompositionObject

SetScalarParameter Method

public void SetScalarParameter(string key, float value)

Parameters

key string

value float

SetVector2Parameter Method

public void SetVector2Parameter(string key, System.Numerics.Vector2 value)

Parameters

key string

value System.Numerics.Vector2

SetVector3Parameter Method

public void SetVector3Parameter(string key, System.Numerics.Vector3 value)

Parameters

key string

value System.Numerics.Vector3

SetVector4Parameter Method

public void SetVector4Parameter(string key, System.Numerics.Vector4 value)

Parameters

key string

value System.Numerics.Vector4

Properties

Name	Description
Target	No summary available.
Compositor	The associated Compositor Inherited from CompositionObject.
ImplicitAnimations	The collection of implicit animations attached to this object. Inherited from CompositionObject.
IsDisposed	Inherited from CompositionObject.

Target Property

public string Target { get; set; }