Struct zng_var::animation::AnimationHandle

pub struct AnimationHandle(/* private fields */);

Represents a running animation.

Drop all clones of this handle to stop the animation, or call perm to drop the handle but keep the animation alive until it is stopped from the inside.

Implementations

impl AnimationHandle

pub fn dummy() -> Self

Create dummy handle that is always in the stopped state.

Note that Option<AnimationHandle> takes up the same space as AnimationHandle and avoids an allocation.

pub fn perm(self)

Drops the handle but does not stop.

The animation stays in memory for the duration of the app or until another handle calls stop.

pub fn is_permanent(&self) -> bool

If another handle has called perm.

If true the animation will stay active until the app exits, unless stop is called.

pub fn stop(self)

Drops the handle and forces the animation to drop.

pub fn is_stopped(&self) -> bool

If another handle has called stop.

The animation is already dropped or will be dropped in the next app update, this is irreversible.

pub fn downgrade(&self) -> WeakAnimationHandle

Create a weak handle.

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 animation stops.

Returns the handler if the animation has already stopped.

Trait Implementations

impl Clone for AnimationHandle

fn clone(&self) -> AnimationHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnimationHandle

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

Formats the value using the given formatter.

impl Default for AnimationHandle

fn default() -> Self

dummy.

impl Hash for AnimationHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AnimationHandle

fn eq(&self, other: &AnimationHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AnimationHandle

impl StructuralPartialEq for AnimationHandle