Animation Class

Definition

Namespace:Avalonia.Animation

Assembly:Avalonia.Base

Package:Avalonia

Tracks the progress of an animation.

public class Animation

Inheritance: object -> AvaloniaObject -> Animation

Implements:IAnimation

Constructors

Name	Description
Animation	No summary available.

Animation Constructor

public Animation()

Methods

Name	Description
RegisterCustomAnimator	No summary available.
RunAsync	No summary available.
SetAnimator	Sets the value of the Animator attached property for a setter.
Bind (8 overloads)	Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
Equals	Compares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValue	Inherited from AvaloniaObject.
GetHashCode	Gets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimating	Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSet	Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)	Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)	Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccess	Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

RegisterCustomAnimator Method

public void RegisterCustomAnimator<T, TAnimator>()

Type Parameters

T

TAnimator

RunAsync Method

public System.Threading.Tasks.Task RunAsync(Avalonia.Animation.Animatable control, System.Threading.CancellationToken cancellationToken)

Parameters

control Avalonia.Animation.Animatable

cancellationToken System.Threading.CancellationToken

Returns

System.Threading.Tasks.Task

SetAnimator Method

Sets the value of the Animator attached property for a setter.

public void SetAnimator(Avalonia.Animation.IAnimationSetter setter, Avalonia.Animation.ICustomAnimator value)

Parameters

setter Avalonia.Animation.IAnimationSetter

The animation setter.

value Avalonia.Animation.ICustomAnimator

The property animator value.

Properties

Name	Description
Children	Gets the children of the Avalonia.Animation.Animation.
Delay	Gets or sets the initial delay time for this animation.
DelayBetweenIterations	Gets or sets the delay time in between iterations.
Duration	Gets or sets the active time of this animation.
Easing	Gets or sets the easing function to be used for this animation.
FillMode	Gets or sets the value fill mode for this animation.
IterationCount	Gets or sets the repeat count for this animation.
PlaybackBehavior	Gets or sets the playback behavior for this animation. When set to Avalonia.Animation.PlaybackBehavior.Auto, manually started animations and animations targeting Avalonia.Visual.IsVisibleProperty always play, while style-applied animations pause when the control is not effectively visible (see Avalonia.Visual.IsEffectivelyVisible).
PlaybackDirection	Gets or sets the playback direction for this animation.
SpeedRatio	Gets or sets the speed multiple for this animation.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Item	Inherited from AvaloniaObject.

Children Property

Gets the children of the Avalonia.Animation.Animation.

public Avalonia.Animation.KeyFrames Children { get; set; }

Delay Property

Gets or sets the initial delay time for this animation.

public TimeSpan Delay { get; set; }

DelayBetweenIterations Property

Gets or sets the delay time in between iterations.

public TimeSpan DelayBetweenIterations { get; set; }

Duration Property

Gets or sets the active time of this animation.

public TimeSpan Duration { get; set; }

Easing Property

Gets or sets the easing function to be used for this animation.

public Avalonia.Animation.Easings.Easing Easing { get; set; }

FillMode Property

Gets or sets the value fill mode for this animation.

public Avalonia.Animation.FillMode FillMode { get; set; }

IterationCount Property

Gets or sets the repeat count for this animation.

public Avalonia.Animation.IterationCount IterationCount { get; set; }

PlaybackBehavior Property

Gets or sets the playback behavior for this animation. When set to Avalonia.Animation.PlaybackBehavior.Auto, manually started animations and animations targeting Avalonia.Visual.IsVisibleProperty always play, while style-applied animations pause when the control is not effectively visible (see Avalonia.Visual.IsEffectivelyVisible).

public Avalonia.Animation.PlaybackBehavior PlaybackBehavior { get; set; }

PlaybackDirection Property

Gets or sets the playback direction for this animation.

public Avalonia.Animation.PlaybackDirection PlaybackDirection { get; set; }

SpeedRatio Property

Gets or sets the speed multiple for this animation.

public double SpeedRatio { get; set; }

Fields

Name	Description
DelayBetweenIterationsProperty	Defines the Avalonia.Animation.Animation.DelayBetweenIterations property.
DelayProperty	Defines the Avalonia.Animation.Animation.Delay property.
DurationProperty	Defines the Avalonia.Animation.Animation.Duration property.
EasingProperty	Defines the Avalonia.Animation.Animation.Easing property.
FillModeProperty	Defines the Avalonia.Animation.Animation.FillMode property.
IterationCountProperty	Defines the Avalonia.Animation.Animation.IterationCount property.
PlaybackBehaviorProperty	Defines the Avalonia.Animation.Animation.PlaybackBehavior property.
PlaybackDirectionProperty	Defines the Avalonia.Animation.Animation.PlaybackDirection property.
SpeedRatioProperty	Defines the Avalonia.Animation.Animation.SpeedRatio property.

DelayBetweenIterationsProperty Field

Defines the Avalonia.Animation.Animation.DelayBetweenIterations property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, TimeSpan> DelayBetweenIterationsProperty

DelayProperty Field

Defines the Avalonia.Animation.Animation.Delay property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, TimeSpan> DelayProperty

DurationProperty Field

Defines the Avalonia.Animation.Animation.Duration property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, TimeSpan> DurationProperty

EasingProperty Field

Defines the Avalonia.Animation.Animation.Easing property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, Avalonia.Animation.Easings.Easing> EasingProperty

FillModeProperty Field

Defines the Avalonia.Animation.Animation.FillMode property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, Avalonia.Animation.FillMode> FillModeProperty

IterationCountProperty Field

Defines the Avalonia.Animation.Animation.IterationCount property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, Avalonia.Animation.IterationCount> IterationCountProperty

PlaybackBehaviorProperty Field

Defines the Avalonia.Animation.Animation.PlaybackBehavior property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, Avalonia.Animation.PlaybackBehavior> PlaybackBehaviorProperty

PlaybackDirectionProperty Field

Defines the Avalonia.Animation.Animation.PlaybackDirection property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, Avalonia.Animation.PlaybackDirection> PlaybackDirectionProperty

SpeedRatioProperty Field

Defines the Avalonia.Animation.Animation.SpeedRatio property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Animation.Animation, double> SpeedRatioProperty

Events

Name	Description
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.