Struct raui_core::animator::Animator [−][src]
pub struct Animator<'a> { /* fields omitted */ }
Expand description
Allows manipulating widget animations
An Animator
can be used inside of the WidgetMountOrChangeContext
that is provided when
setting widget lifecycle handlers.
Example
fn my_widget(context: WidgetContext) -> WidgetNode { // When my_widget changes context.life_cycle.change(|change_context| { // Get the `Animator` let animator = change_context.animator; // Stop "my_animation" animator.change("my_animation", None); }); widget! { () } }
Animations & Values
The animator can manage any number of different animations identified by a string anim_id
.
Additionally each animation can have more than one value that is animated and each of these
values has a value_name
that can be used to get the animated value.
Implementations
Check whether or not the widget has an animation with the given anim_id
Change the animation associated to a given anim_id
pub fn value_progress(
&self,
anim_id: &str,
value_name: &str
) -> Option<AnimatedValueProgress>
[src]
pub fn value_progress(
&self,
anim_id: &str,
value_name: &str
) -> Option<AnimatedValueProgress>
[src]Get the current progress of the animation of a given value
This will return None
if the value is not currently being animated.
Same as value_progress_factor
but returning default
instead of None
Same as value_progress_factor
but returning 0
instead of None
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Animator<'a>
impl<'a> !UnwindSafe for Animator<'a>