Struct bevy_animation::AnimationPlayer

pub struct AnimationPlayer { /* private fields */ }

Animation controls

Implementations

impl AnimationPlayer

pub fn start(&mut self, animation: AnimationNodeIndex) -> &mut ActiveAnimation

Start playing an animation, restarting it if necessary.

pub fn play(&mut self, animation: AnimationNodeIndex) -> &mut ActiveAnimation

Start playing an animation, unless the requested animation is already playing.

pub fn stop(&mut self, animation: AnimationNodeIndex) -> &mut Self

Stops playing the given animation, removing it from the list of playing animations.

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

Stops all currently-playing animations.

pub fn playing_animations( &self ) -> impl Iterator<Item = (&AnimationNodeIndex, &ActiveAnimation)>

Iterates through all animations that this AnimationPlayer is currently playing.

pub fn playing_animations_mut( &mut self ) -> impl Iterator<Item = (&AnimationNodeIndex, &mut ActiveAnimation)>

Iterates through all animations that this AnimationPlayer is currently playing, mutably.

pub fn is_playing_animation(&self, animation: AnimationNodeIndex) -> bool

Check if the given animation node is being played.

pub fn all_finished(&self) -> bool

Check if all playing animations have finished, according to the repetition behavior.

pub fn all_paused(&self) -> bool

Check if all playing animations are paused.

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

Resume all playing animations.

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

Resume all active animations.

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

Rewinds all active animations.

pub fn adjust_speeds(&mut self, factor: f32) -> &mut Self

Multiplies the speed of all active animations by the given factor.

pub fn seek_all_by(&mut self, amount: f32) -> &mut Self

Seeks all active animations forward or backward by the same amount.

To seek forward, pass a positive value; to seek negative, pass a negative value. Values below 0.0 or beyond the end of the animation clip are clamped appropriately.

pub fn animation( &self, animation: AnimationNodeIndex ) -> Option<&ActiveAnimation>

Returns the ActiveAnimation associated with the given animation node if it’s currently playing.

If the animation isn’t currently active, returns None.

pub fn animation_mut( &mut self, animation: AnimationNodeIndex ) -> Option<&mut ActiveAnimation>

Returns a mutable reference to the ActiveAnimation associated with the given animation node if it’s currently active.

If the animation isn’t currently active, returns None.

pub fn animation_is_playing(&self, animation: AnimationNodeIndex) -> bool

Returns true if the animation is currently playing or paused, or false if the animation is stopped.

Trait Implementations

impl Clone for AnimationPlayer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for AnimationPlayer

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Default for AnimationPlayer

fn default() -> AnimationPlayer

Returns the “default value” for a type.

impl FromReflect for AnimationPlayer

where Self: Any + Send + Sync, BTreeMap<AnimationNodeIndex, ActiveAnimation>: FromReflect + TypePath + RegisterForReflection, HashMap<AnimationNodeIndex, f32>: 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 AnimationPlayer

where Self: Any + Send + Sync, BTreeMap<AnimationNodeIndex, ActiveAnimation>: FromReflect + TypePath + RegisterForReflection, HashMap<AnimationNodeIndex, f32>: 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 AnimationPlayer

where Self: Any + Send + Sync, BTreeMap<AnimationNodeIndex, ActiveAnimation>: FromReflect + TypePath + RegisterForReflection, HashMap<AnimationNodeIndex, f32>: 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 AnimationPlayer

where Self: Any + Send + Sync, BTreeMap<AnimationNodeIndex, ActiveAnimation>: FromReflect + TypePath + RegisterForReflection, HashMap<AnimationNodeIndex, f32>: 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 AnimationPlayer

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 AnimationPlayer

where Self: Any + Send + Sync, BTreeMap<AnimationNodeIndex, ActiveAnimation>: FromReflect + TypePath + RegisterForReflection, HashMap<AnimationNodeIndex, f32>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.