Struct bevy_animation::ActiveAnimation

pub struct ActiveAnimation { /* private fields */ }

An animation that an AnimationPlayer is currently either playing or was playing, but is presently paused.

An stopped animation is considered no longer active.

Implementations

impl ActiveAnimation

pub fn is_finished(&self) -> bool

Check if the animation has finished, based on its repetition behavior and the number of times it has repeated.

Note: An animation with RepeatAnimation::Forever will never finish.

pub fn replay(&mut self)

Reset back to the initial state as if no time has elapsed.

pub fn weight(&self) -> f32

Returns the current weight of this animation.

pub fn set_weight(&mut self, weight: f32)

Sets the weight of this animation.

pub fn pause(&mut self) -> &mut Self

Pause the animation.

pub fn resume(&mut self) -> &mut Self

Unpause the animation.

pub fn is_paused(&self) -> bool

Returns true if this animation is currently paused.

Note that paused animations are still ActiveAnimations.

pub fn set_repeat(&mut self, repeat: RepeatAnimation) -> &mut Self

Sets the repeat mode for this playing animation.

pub fn repeat(&mut self) -> &mut Self

Marks this animation as repeating forever.

pub fn repeat_mode(&self) -> RepeatAnimation

Returns the repeat mode assigned to this active animation.

pub fn completions(&self) -> u32

Returns the number of times this animation has completed.

pub fn is_playback_reversed(&self) -> bool

Returns true if the animation is playing in reverse.

pub fn speed(&self) -> f32

Returns the speed of the animation playback.

pub fn set_speed(&mut self, speed: f32) -> &mut Self

Sets the speed of the animation playback.

pub fn elapsed(&self) -> f32

Returns the amount of time the animation has been playing.

pub fn seek_time(&self) -> f32

Returns the seek time of the animation.

This is nonnegative and no more than the clip duration.

pub fn seek_to(&mut self, seek_time: f32) -> &mut Self

Seeks to a specific time in the animation.

pub fn rewind(&mut self) -> &mut Self

Seeks to the beginning of the animation.

Trait Implementations

impl Clone for ActiveAnimation

fn clone(&self) -> ActiveAnimation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActiveAnimation

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

Formats the value using the given formatter.

impl Default for ActiveAnimation

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for ActiveAnimation

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection, RepeatAnimation: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for ActiveAnimation

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection, RepeatAnimation: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Reflect for ActiveAnimation

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection, RepeatAnimation: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for ActiveAnimation

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection, RepeatAnimation: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for ActiveAnimation

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ActiveAnimation

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection, RepeatAnimation: FromReflect + TypePath + RegisterForReflection, u32: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ActiveAnimation