Struct zng_var::animation::ModifyInfo

pub struct ModifyInfo { /* private fields */ }

Represents the current modify operation when it is applying.

Implementations

impl ModifyInfo

pub fn never() -> Self

Initial value, is always of lowest importance.

pub fn importance(&self) -> usize

Indicates the override importance of the operation, when two animations target a variable only the newer one must apply, and all running animations are overridden by a later modify/set operation.

Variables ignore modify requests from lower importance closures.

pub fn is_animating(&self) -> bool

Indicates if the modify request was made from inside an animation, if true the importance is for that animation, even if the modify request is from the current frame.

You can clone this info to track this animation, when it stops or is dropped this returns false. Note that sleeping animations still count as animating.

pub fn animation_eq(&self, other: &Self) -> bool

Returns true if self and other have the same animation or are both not animating.

pub fn hook_animation_stop( &self, handler: Box<dyn FnOnce() + Send>, ) -> Result<(), Box<dyn FnOnce() + Send>>

Register a handler to be called once when the current animation stops.

Trait Implementations

impl Clone for ModifyInfo

fn clone(&self) -> ModifyInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModifyInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.