Struct Presence 

pub struct Presence<T>
where
    T: Animatable,
{ /* private fields */ }

Coordinates mounting and visibility around enter and exit animations.

Examples

use aura_anim_core::{MotionRuntime, Presence, timing::Timing};
use std::time::Duration;

let mut runtime = MotionRuntime::new();
let mut presence = Presence::new(&mut runtime, 0.0_f32, 1.0, Timing::new(100.0));

presence.show(&mut runtime).unwrap();
assert!(presence.is_mounted());
runtime.tick(Duration::from_millis(100));
assert_eq!(*presence.value(&runtime).unwrap(), 1.0);

presence.hide(&mut runtime).unwrap();
runtime.tick(Duration::from_millis(100));
presence.sync(&runtime).unwrap();
assert!(!presence.is_mounted());

Implementations

impl<T> Presence<T>

where T: Animatable,

pub fn new( runtime: &mut MotionRuntime, hidden: T, visible: T, timing: Timing, ) -> Presence<T>

Creates a hidden, unmounted presence controller.

pub fn motion(&self) -> Motion<T>

Returns the runtime motion controlled by this presence value.

pub fn value<'a>( &self, runtime: &'a MotionRuntime, ) -> Result<&'a T, MotionError>

Returns the current animated value.

pub const fn is_mounted(&self) -> bool

Returns whether the associated content should be mounted.

pub const fn is_visible(&self) -> bool

Returns whether the presence target is visible.

pub fn set_visible( &mut self, visible: bool, runtime: &mut MotionRuntime, ) -> Result<bool, MotionError>

Updates the target visibility when it differs from the current target.

Returns Ok(false) without starting a new playback when the requested visibility is already current.

pub fn toggle( &mut self, runtime: &mut MotionRuntime, ) -> Result<bool, MotionError>

Toggles the target visibility using the default transition.

pub fn show(&mut self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Mounts the content and transitions toward the visible value.

pub fn hide(&mut self, runtime: &mut MotionRuntime) -> Result<(), MotionError>

Transitions toward the hidden value.

pub fn show_with<P, Kind>( &mut self, animation: P, runtime: &mut MotionRuntime, ) -> Result<(), MotionError>

where P: IntoMotionAnimation<T, Kind>,

Mounts the content and plays a custom enter animation source.

pub fn hide_with<P, Kind>( &mut self, animation: P, runtime: &mut MotionRuntime, ) -> Result<(), MotionError>

where P: IntoMotionAnimation<T, Kind>,

Plays a custom exit animation source.

pub fn handle_event(&mut self, event: &MotionEvent) -> bool

Applies one runtime event and returns whether mounted state changed.

Only completion of the current exit playback unmounts content. Events from interrupted or superseded exits are ignored.

pub fn sync(&mut self, runtime: &MotionRuntime) -> Result<(), MotionError>

Unmounts hidden content after its animation completes.