Struct freya_hooks::UseAnimator

pub struct UseAnimator<Animated: PartialEq + Clone + 'static> { /* private fields */ }

Animate your elements. Use use_animation to use this.

Implementations

impl<Animated: PartialEq + Clone + 'static> UseAnimator<Animated>

pub fn get(&self) -> Animated

Get the animated value.

pub fn reset(&self)

Reset the animation to the default state.

pub fn run_update(&self)

Update the animation.

pub fn is_running(&self) -> bool

Checks if there is any animation running.

pub fn has_run_yet(&self) -> bool

Checks if it has run yet, by subscribing.

pub fn peek_has_run_yet(&self) -> bool

Checks if it has run yet, doesn’t subscribe. Useful for when you just mounted your component.

pub fn reverse(&self)

Runs the animation in reverse direction.

pub fn start(&self)

Runs the animation normally.

pub fn run(&self, direction: AnimDirection)

Run the animation with a given AnimDirection

Trait Implementations

impl<Animated: Clone + PartialEq + Clone + 'static> Clone for UseAnimator<Animated>

fn clone(&self) -> UseAnimator<Animated>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Animated: PartialEq + PartialEq + Clone + 'static> PartialEq for UseAnimator<Animated>

fn eq(&self, other: &UseAnimator<Animated>) -> 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<T: PartialEq + Clone + 'static> Copy for UseAnimator<T>

impl<Animated: PartialEq + Clone + 'static> StructuralPartialEq for UseAnimator<Animated>