Struct bevy::animation::AnimationTarget

pub struct AnimationTarget {
    pub id: AnimationTargetId,
    pub player: Entity,
}

An entity that can be animated by an AnimationPlayer.

These are frequently referred to as bones or joints, because they often refer to individually-animatable parts of an armature.

Asset loaders for armatures are responsible for adding these as necessary. Typically, they’re generated from hashed versions of the entire name path from the root of the armature to the bone. See the AnimationTargetId documentation for more details.

By convention, asset loaders add AnimationTarget components to the descendants of an AnimationPlayer, as well as to the AnimationPlayer entity itself, but Bevy doesn’t require this in any way. So, for example, it’s entirely possible for an AnimationPlayer to animate a target that it isn’t an ancestor of. If you add a new bone to or delete a bone from an armature at runtime, you may want to update the AnimationTarget component as appropriate, as Bevy won’t do this automatically.

Note that each entity can only be animated by one animation player at a time. However, you can change AnimationTarget’s player property at runtime to change which player is responsible for animating the entity.

Fields

id: AnimationTargetId

The ID of this animation target.

Typically, this is derived from the path.

player: Entity

The entity containing the AnimationPlayer.

Trait Implementations

impl Clone for AnimationTarget

fn clone(&self) -> AnimationTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for AnimationTarget

where AnimationTarget: 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 FromReflect for AnimationTarget

where AnimationTarget: Any + Send + Sync, AnimationTargetId: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection,

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

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 AnimationTarget

where AnimationTarget: Any + Send + Sync, AnimationTargetId: FromReflect + TypePath + RegisterForReflection, Entity: 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 MapEntities for AnimationTarget

fn map_entities<M>(&mut self, entity_mapper: &mut M)

where M: EntityMapper,

Updates all Entity references stored inside using entity_mapper.

impl Reflect for AnimationTarget

where AnimationTarget: Any + Send + Sync, AnimationTargetId: FromReflect + TypePath + RegisterForReflection, Entity: 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<AnimationTarget>) -> 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<AnimationTarget>) -> 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<AnimationTarget>) -> 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 AnimationTarget

where AnimationTarget: Any + Send + Sync, AnimationTargetId: FromReflect + TypePath + RegisterForReflection, Entity: 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 AnimationTarget

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

where AnimationTarget: Any + Send + Sync, AnimationTargetId: FromReflect + TypePath + RegisterForReflection, Entity: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for AnimationTarget