Struct oxygengine_user_interface::raui::core::animator::AnimatorState

pub struct AnimatorState { /* private fields */ }

The state of a single animation in a component

This is most often accessed though AnimatorStates in the WidgetContext.

Implementations

impl AnimatorState

pub fn in_progress(&self) -> bool

Returns whether or not the animations is in-progress

pub fn is_done(&self) -> bool

Returns true if this animation is not in-progress

pub fn value_progress(&self, name: &str) -> Option<AnimatedValueProgress>

Get the current progress of the animation of a given value

This will return None if the value is not currently being animated.

pub fn value_progress_factor(&self, name: &str) -> Option<f32>

Get the current progress factor of the animation of a given value

If the value is currently being animated this will return Some Scalar between 0 and 1 with 0 meaning just started and 1 meaning finished.

If the value is not currently being animated None will be returned

pub fn value_progress_factor_or(&self, name: &str, default: f32) -> f32

Same as value_progress_factor but returning default instead of None

pub fn value_progress_factor_or_zero(&self, name: &str) -> f32

Same as value_progress_factor but returning 0 instead of None

Trait Implementations

impl Clone for AnimatorState

fn clone(&self) -> AnimatorState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnimatorState

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

Formats the value using the given formatter.

impl Default for AnimatorState

fn default() -> AnimatorState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnimatorState

fn deserialize<__D>( __deserializer: __D ) -> Result<AnimatorState, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AnimatorState

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.