Struct bevy_internal::animation::prelude::AnimationPlayer

pub struct AnimationPlayer { /* private fields */ }

Animation controls

Implementations

impl AnimationPlayer

pub fn start(&mut self, handle: Handle<AnimationClip>) -> &mut AnimationPlayer

Start playing an animation, resetting state of the player. This will use a linear blending between the previous and the new animation to make a smooth transition.

pub fn start_with_transition( &mut self, handle: Handle<AnimationClip>, transition_duration: Duration ) -> &mut AnimationPlayer

Start playing an animation, resetting state of the player. This will use a linear blending between the previous and the new animation to make a smooth transition.

pub fn play(&mut self, handle: Handle<AnimationClip>) -> &mut AnimationPlayer

Start playing an animation, resetting state of the player, unless the requested animation is already playing.

pub fn play_with_transition( &mut self, handle: Handle<AnimationClip>, transition_duration: Duration ) -> &mut AnimationPlayer

Start playing an animation, resetting state of the player, unless the requested animation is already playing. This will use a linear blending between the previous and the new animation to make a smooth transition

pub fn animation_clip(&self) -> &Handle<AnimationClip>

Handle to the animation clip being played.

pub fn is_playing_clip(&self, handle: &Handle<AnimationClip>) -> bool

Check if the given animation clip is being played.

pub fn is_finished(&self) -> bool

Check if the playing animation has finished, according to the repetition behavior.

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

Sets repeat to RepeatAnimation::Forever.

See also Self::set_repeat.

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

Set the repetition behaviour of the animation.

pub fn repeat_mode(&self) -> RepeatAnimation

Repetition behavior of the animation.

pub fn completions(&self) -> u32

Number of times the animation has completed.

pub fn is_playback_reversed(&self) -> bool

Check if the animation is playing in reverse.

pub fn pause(&mut self)

Pause the animation

pub fn resume(&mut self)

Unpause the animation

pub fn is_paused(&self) -> bool

Is the animation paused

pub fn speed(&self) -> f32

Speed of the animation playback

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

Set the speed of the animation playback

pub fn elapsed(&self) -> f32

Time elapsed playing the animation

pub fn seek_time(&self) -> f32

Seek time inside of the animation. Always within the range [0.0, clip duration].

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

Seek to a specific time in the animation.

pub fn replay(&mut self)

Reset the animation to its initial state, as if no time has elapsed.

Trait Implementations

impl Component for AnimationPlayer

where AnimationPlayer: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Default for AnimationPlayer

fn default() -> AnimationPlayer

Returns the “default value” for a type.

impl FromReflect for AnimationPlayer

where AnimationPlayer: Any + Send + Sync, bool: FromReflect + TypePath, PlayingAnimation: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<AnimationPlayer>

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 AnimationPlayer: Any + Send + Sync, bool: FromReflect + TypePath, PlayingAnimation: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for AnimationPlayer

where AnimationPlayer: Any + Send + Sync, bool: FromReflect + TypePath, PlayingAnimation: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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 apply(&mut self, value: &(dyn Reflect + 'static))

Applies 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<AnimationPlayer>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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 AnimationPlayer: Any + Send + Sync, bool: FromReflect + TypePath, PlayingAnimation: FromReflect + TypePath,

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

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 + 'static)>

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 + 'static)>

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 + 'static)>

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 AnimationPlayer: 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 AnimationPlayer: Any + Send + Sync, bool: FromReflect + TypePath, PlayingAnimation: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.