Struct bevy::animation::prelude::AnimationTransitions

pub struct AnimationTransitions { /* private fields */ }

Manages fade-out of animation blend factors, allowing for smooth transitions between animations.

To use this component, place it on the same entity as the AnimationPlayer and bevy_asset::Handle<AnimationGraph>. It’ll take responsibility for adjusting the weight on the ActiveAnimation in order to fade out animations smoothly.

When using an AnimationTransitions component, you should play all animations through the AnimationTransitions::play method, rather than by directly manipulating the AnimationPlayer. Playing animations through the AnimationPlayer directly will cause the AnimationTransitions component to get confused about which animation is the “main” animation, and transitions will usually be incorrect as a result.

Implementations

impl AnimationTransitions

pub fn new() -> AnimationTransitions

Creates a new AnimationTransitions component, ready to be added to an entity with an AnimationPlayer.

pub fn play<'p>( &mut self, player: &'p mut AnimationPlayer, new_animation: NodeIndex, transition_duration: Duration ) -> &'p mut ActiveAnimation

Plays a new animation on the given AnimationPlayer, fading out any existing animations that were already playing over the transition_duration.

Pass Duration::ZERO to instantly switch to a new animation, avoiding any transition.

pub fn get_main_animation(&self) -> Option<NodeIndex>

Obtain the currently playing main animation.

Trait Implementations

impl Clone for AnimationTransitions

fn clone(&self) -> AnimationTransitions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for AnimationTransitions

where AnimationTransitions: 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 AnimationTransitions

fn default() -> AnimationTransitions

Returns the “default value” for a type.

impl FromReflect for AnimationTransitions

where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + RegisterForReflection,

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

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 AnimationTransitions

where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + RegisterForReflection, Vec<AnimationTransition>: 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 AnimationTransitions

where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + RegisterForReflection, Vec<AnimationTransition>: 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<AnimationTransitions>) -> 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<AnimationTransitions>) -> 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 try_apply( &mut self, value: &(dyn Reflect + 'static) ) -> 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<AnimationTransitions>) -> 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 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 AnimationTransitions

where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + RegisterForReflection,

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 AnimationTransitions

where AnimationTransitions: 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 AnimationTransitions

where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.