Struct Animation 

pub struct Animation { /* private fields */ }

Tracks the progress of an animation.

Implementations

impl Animation

pub const TYPE: &'static TypeInfo = <Animation as crate::StaticType>::TYPE

The runtime type of this class.

pub fn to_ref(&self) -> Ref<Animation>

Returns a strong reference to this object.

impl Animation

pub fn duration_property() -> &'static DirectProperty<Animation, TimeSpan>

Defines the Duration property: the active time of one iteration.

pub fn duration(&self) -> TimeSpan

pub fn set_duration(&self, value: TimeSpan)

pub fn iteration_count_property() -> &'static DirectProperty<Animation, IterationCount>

Defines the IterationCount property: the repeat count.

pub fn iteration_count(&self) -> IterationCount

pub fn set_iteration_count(&self, value: IterationCount)

pub fn playback_direction_property() -> &'static DirectProperty<Animation, PlaybackDirection>

Defines the PlaybackDirection property.

pub fn playback_direction(&self) -> PlaybackDirection

pub fn set_playback_direction(&self, value: PlaybackDirection)

pub fn playback_behavior_property() -> &'static DirectProperty<Animation, PlaybackBehavior>

Defines the PlaybackBehavior property: whether the animation pauses when its target is not effectively visible.

pub fn playback_behavior(&self) -> PlaybackBehavior

pub fn set_playback_behavior(&self, value: PlaybackBehavior)

pub fn fill_mode_property() -> &'static DirectProperty<Animation, FillMode>

Defines the FillMode property: the value fill mode.

pub fn fill_mode(&self) -> FillMode

pub fn set_fill_mode(&self, value: FillMode)

pub fn delay_property() -> &'static DirectProperty<Animation, TimeSpan>

Defines the Delay property: the initial delay time.

pub fn delay(&self) -> TimeSpan

pub fn set_delay(&self, value: TimeSpan)

pub fn delay_between_iterations_property() -> &'static DirectProperty<Animation, TimeSpan>

Defines the DelayBetweenIterations property.

pub fn delay_between_iterations(&self) -> TimeSpan

pub fn set_delay_between_iterations(&self, value: TimeSpan)

pub fn easing_property() -> &'static DirectProperty<Animation, Easing>

Defines the Easing property: the easing function to be used.

pub fn speed_ratio_property() -> &'static DirectProperty<Animation, f64>

Defines the SpeedRatio property: the speed multiple.

pub fn construct() -> Self

Creates the class data; see FerroObject::construct.

pub fn new() -> Ref<Self>

pub fn easing(&self) -> Easing

The easing function to be used for this animation.

pub fn set_easing(&self, value: impl Into<Easing>)

pub fn speed_ratio(&self) -> f64

The speed multiple for this animation.

pub fn set_speed_ratio(&self, value: f64)

pub fn children(&self) -> KeyFrames

The children of the animation: its key frames.

pub fn apply( &self, control: &Animatable, clock: Option<Rc<dyn IClock>>, match_: Rc<dyn IObservable<bool>>, on_complete: Option<Rc<dyn Fn()>>, is_manually_started: bool, ) -> Rc<dyn IDisposable>

Applies the animation to control: it runs while match_ is true, on clock (or on the control’s clock, or on the global clock). on_complete runs when the animation ends by itself. is_manually_started tells an animation started by code from one started by a style. Disposing the result removes the animation.

pub fn apply_for_preview( &self, control: &Animatable, clock: Option<Rc<dyn IClock>>, on_complete: Option<Rc<dyn Fn()>>, ) -> Rc<dyn IDisposable>

Applies an isolated snapshot using the framework animators, retaining final fill and automatically created transforms at animation priority. Disposing the result restores the control’s underlying values and bindings, including after completion. This is intended for interactive authoring and inspection; ordinary apply retains its application semantics, including committing forward fill to a local value.

pub fn run_async( &self, control: &Animatable, cancellation_token: CancellationToken, ) -> AnimationTask

Starts the animation on control and returns a task that completes when it has ended or cancellation_token was cancelled.

pub fn run_async_with_clock( &self, control: &Animatable, clock: Option<Rc<dyn IClock>>, cancellation_token: CancellationToken, ) -> AnimationTask

run_async on an explicit clock.

impl Animation

pub fn set_animator( setter: &Rc<dyn IAnimationSetter>, value: Rc<dyn ICustomAnimator>, )

Sets the value of the Animator attached property for a setter: the custom animator that animates the setter’s property instead of the one selected by the property’s type.

pub fn register_custom_animator<TAnimator: InterpolatingAnimator + Default>()

Registers a user-provided animator for properties of its value type. It takes precedence over the animators registered before it.

Methods from Deref<Target = FerroObject>

pub fn dispatcher(&self) -> &Arc<Dispatcher>

Returns the Dispatcher that this object is associated with: the dispatcher of the thread that owns the object.

pub fn check_access(&self) -> bool

Returns whether the calling thread is the thread that owns this object.

pub fn verify_access(&self)

Checks that the calling thread is the thread that owns this object.

Panics

Panics when it is not.

pub fn to_ref(&self) -> Ref<FerroObject>

A strong reference to this object.

pub fn to_weak(&self) -> WeakRef<FerroObject>

A weak reference to this object.

pub fn get_type(&self) -> &'static TypeInfo

The runtime type of the object.

pub fn is<T: ObjectType>(&self) -> bool

Whether the object is of class T or a class derived from it.

pub fn downcast_ref<T: ObjectType>(&self) -> Option<&T>

Returns the object viewed as class T if it is one.

pub fn on_property_changed(&self, change: &FerroPropertyChangedEventArgs<'_>)

Invokes the on_property_changed virtual member.

pub fn inheritance_parent(&self) -> Option<Ref<FerroObject>>

The parent object that inherited property values are inherited from.

pub fn set_inheritance_parent(&self, value: impl Into<Nullable<FerroObject>>)

Sets the parent object that inherited property values are inherited from.

pub fn clear_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, )

Clears a property’s local value.

pub fn get_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, ) -> T

Gets a property value.

pub fn get_base_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, ) -> Option<T>

Gets a property’s base value: the value excluding animated values. Returns None if the value comes from inheritance or the default.

pub fn is_animating(&self, property: &FerroProperty) -> bool

Checks whether a property is animating.

pub fn is_set(&self, property: &FerroProperty) -> bool

Checks whether a styled property has a value assigned to it or a binding targeting it.

pub fn has_local_value_binding(&self, property: &FerroProperty) -> bool

Whether a local-value binding targets this property, including direct properties and observable bindings. Unlike is_set, this does not rely on a styled property’s effective-value entry. It does not inspect bindings at style/template priorities.

pub fn set_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, )

Sets a property value with local value priority.

pub fn set_value_with_priority<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

Sets a property value with the given priority. For priorities other than local value, disposing the returned handle removes the value.

pub fn set_current_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, value: T, )

Sets the value of a property without changing its value source.

This is used by a component that programmatically sets the value of one of its own properties without disabling an application’s declared use of the property: the effective value changes, but existing bindings and styles continue to work. The new value has the property’s current priority.

pub fn bind_binding( &self, property: &'static FerroProperty, binding: &dyn BindingBase, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding. Returns the binding expression which represents the binding instance on this object.

pub fn bind_binding_with_anchor( &self, property: &'static FerroProperty, binding: &dyn BindingBase, anchor: Option<&Ref<FerroObject>>, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding.

Some bindings need context to locate their source: a data context, named elements or resources. If this object is not an element, or is not yet attached to the tree, anchor provides that context.

pub fn bind_binding_with_priority( &self, property: &'static FerroProperty, binding: &dyn BindingBase, priority: BindingPriority, anchor: Option<&Ref<FerroObject>>, ) -> Rc<dyn BindingExpressionBase>

Binds a property to a binding at the given priority, whatever the default priority of the binding is. Disposing the returned expression removes the binding.

An addition (no upstream counterpart): the values of WinUI’s visual states are bound at BindingPriority::Animation.

pub fn indexer(&self, binding: &IndexerDescriptor) -> IndexerBinding

Gets a binding to a property of this object: the indexer taking an IndexerDescriptor (source[!Property] is source.indexer(&Property.bind())).

pub fn bind_indexer( &self, binding: &IndexerDescriptor, value: &dyn BindingBase, ) -> Rc<dyn BindingExpressionBase>

Binds the property of an IndexerDescriptor to a binding: the setter of the indexer (target[!Property] = binding is target.bind_indexer(&Property.bind(), &binding)).

pub fn bind<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<T>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable.

pub fn bind_value<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<BindingValue<T>>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of binding values.

pub fn bind_untyped<T: PropertyValue>( &self, property: &'static StyledProperty<T>, source: Rc<dyn IObservable<BoxedValue>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of untyped values.

pub fn coerce_value(&self, property: &'static FerroProperty)

Coerces the specified property.

pub fn get_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, ) -> T

Gets a direct property value.

pub fn set_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, value: T, )

Sets a direct property value.

pub fn clear_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, )

Resets a direct property to its unset value.

pub fn bind_direct<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<T>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable.

pub fn bind_direct_value<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<BindingValue<T>>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable of binding values.

pub fn bind_direct_untyped<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, source: Rc<dyn IObservable<BoxedValue>>, ) -> Rc<dyn IDisposable>

Binds a direct property to an observable of untyped values.

pub fn set_and_raise<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, field: &RefCell<T>, value: T, ) -> bool

Sets the backing field of a direct property, raising a change notification if the value changed. Returns true if it changed.

pub fn set_and_raise_cell<T: PropertyValue + Copy>( &self, property: &'static DirectPropertyBase<T>, field: &Cell<T>, value: T, ) -> bool

set_and_raise for Copy values stored in a Cell.

pub fn get_value_untyped(&self, property: &'static FerroProperty) -> BoxedValue

Gets a property value as an untyped value.

pub fn set_value_untyped( &self, property: &'static FerroProperty, value: &dyn Any, priority: BindingPriority, ) -> Option<Rc<dyn IDisposable>>

Sets a property from an untyped value, which must hold exactly the property’s value type or the unset marker.

pub fn set_current_value_untyped( &self, property: &'static FerroProperty, value: &dyn Any, )

set_current_value with an untyped value.

pub fn clear_value_untyped(&self, property: &'static FerroProperty)

Clears a property’s local value.

pub fn bind_property_untyped( &self, property: &'static FerroProperty, source: Rc<dyn IObservable<BoxedValue>>, priority: BindingPriority, ) -> Rc<dyn IDisposable>

Binds a property to an observable of untyped values.

pub fn property_changed( &self, handler: impl Fn(&FerroPropertyChangedEventArgs<'_>) + 'static, ) -> Rc<dyn IDisposable>

Subscribes to property changes on this object. Disposing the returned handle unsubscribes.

pub fn add_property_changed_handler( &self, handler: Rc<dyn Fn(&FerroPropertyChangedEventArgs<'_>)>, ) -> u64

Subscribes handler to property changes on this object and returns the token that remove_property_changed_handler takes: property_changed for a subscriber that keeps the object and the token itself, so that no handle is made.

pub fn remove_property_changed_handler(&self, token: u64) -> bool

Ends a subscription of add_property_changed_handler.

pub fn property_changed_subscriber_count(&self) -> usize

The number of subscribers to property changes on this object (a diagnostics member, used by tests to verify that subscriptions are released).

pub fn raise_property_changed<T: PropertyValue>( &self, property: &'static FerroProperty, old_value: Option<&T>, new_value: &T, priority: BindingPriority, is_effective_value: bool, )

Raises a property changed notification.

pub fn raise_direct_property_changed<T: PropertyValue>( &self, property: &'static DirectPropertyBase<T>, old_value: &T, new_value: &T, )

Raises a property changed notification for a direct property.

Trait Implementations

impl Deref for Animation

type Target = FerroObject

The resulting type after dereferencing.

fn deref(&self) -> &FerroObject

Dereferences the value.

impl FerroObjectImpl for Animation

fn constructed(this: &Self)

Called once, right after the object has been allocated. This is where constructor logic that needs a reference to the object runs. Overrides must call parent_constructed first.

fn on_property_changed_core( this: &Self, change: &FerroPropertyChangedEventArgs<'_>, )

Called for every property change on the object, including changes of non-effective (base) values. Overriding this is rarely needed; override on_property_changed instead.

fn on_property_changed(this: &Self, change: &FerroPropertyChangedEventArgs<'_>)

Called when the effective value of a property changes on the object.

fn update_data_validation( this: &Self, property: &'static FerroProperty, state: BindingValueType, error: Option<&BindingError>, )

Called to update the validation state for properties for which data validation is enabled.

impl ObjectType for Animation

type Parent = FerroObject

The base class. The root class is its own parent.

type VTable = <FerroObject as ObjectType>::VTable

The virtual table of the class.

fn vtable() -> &'static Self::VTable

The virtual table used by instances whose most-derived class is Self.

fn register_class()

The static initialisation of the class. The first call on a thread, after doing the same for the base class:

impl StaticType for Animation

const TYPE: &'static TypeInfo

The runtime type.

impl<T> Subclassable<T> for Animation

where FerroObject: Subclassable<T>,

impl Upcast<Animation> for Animation

fn upcast(&self) -> &Animation

impl<T: ?Sized> Upcast<T> for Animation

where FerroObject: Upcast<T>,

fn upcast(&self) -> &T