Class KeyFrameAnimation

Namespace

Avalonia.Rendering.Composition.Animations

Assembly

Avalonia.Base.dll

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 abstract class KeyFrameAnimation : CompositionAnimation, ICompositionAnimationBase

Inheritance

object

CompositionObject

CompositionAnimation

KeyFrameAnimation

Implements

ICompositionAnimationBase

Derived

BooleanKeyFrameAnimation

ColorKeyFrameAnimation

DoubleKeyFrameAnimation

QuaternionKeyFrameAnimation

ScalarKeyFrameAnimation

Vector2KeyFrameAnimation

Vector3DKeyFrameAnimation

Vector3KeyFrameAnimation

Vector4KeyFrameAnimation

VectorKeyFrameAnimation

Inherited Members

CompositionAnimation.ClearAllParameters()

CompositionAnimation.ClearParameter(string)

CompositionAnimation.SetColorParameter(string, Color)

CompositionAnimation.SetMatrix3x2Parameter(string, Matrix3x2)

CompositionAnimation.SetMatrix4x4Parameter(string, Matrix4x4)

CompositionAnimation.SetQuaternionParameter(string, Quaternion)

CompositionAnimation.SetReferenceParameter(string, CompositionObject)

CompositionAnimation.SetScalarParameter(string, float)

CompositionAnimation.SetVector2Parameter(string, Vector2)

CompositionAnimation.SetVector3Parameter(string, Vector3)

CompositionAnimation.SetVector4Parameter(string, Vector4)

CompositionAnimation.Target

CompositionObject.Dispose()

CompositionObject.StartAnimation(string, CompositionAnimation)

CompositionObject.StartAnimationGroup(ICompositionAnimationBase)

CompositionObject.RegisterForSerialization()

CompositionObject.ImplicitAnimations

CompositionObject.Compositor

CompositionObject.IsDisposed

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

DelayBehavior

The delay behavior of the key frame animation.

public AnimationDelayBehavior DelayBehavior { get; set; }

Property Value

AnimationDelayBehavior

DelayTime

Delay before the animation starts after StartAnimation(string, CompositionAnimation) is called.

public TimeSpan DelayTime { get; set; }

Property Value

TimeSpan

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.

public PlaybackDirection Direction { get; set; }

Property Value

PlaybackDirection

Duration

The duration of the animation. Minimum allowed value is 1ms and maximum allowed value is 24 days.

public TimeSpan Duration { get; set; }

Property Value

TimeSpan

IterationBehavior

The iteration behavior for the key frame animation.

public AnimationIterationBehavior IterationBehavior { get; set; }

Property Value

AnimationIterationBehavior

IterationCount

The number of times to repeat the key frame animation.

public int IterationCount { get; set; }

Property Value

int

StopBehavior

Specifies how to set the property value when animation is stopped

public AnimationStopBehavior StopBehavior { get; set; }

Property Value

AnimationStopBehavior

Methods

InsertExpressionKeyFrame(float, string, Easing?)

Inserts an expression keyframe.

public void InsertExpressionKeyFrame(float normalizedProgressKey, string value, Easing? easingFunction = null)

Parameters

normalizedProgressKey float

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 string

The expression used to calculate the value of the key frame.

easingFunction Easing

The easing function to use when interpolating between frames.