Struct AnimationLibrary

pub struct AnimationLibrary { /* private fields */ }

The animation library is the global store for clips and animations.

When the SpritesheetAnimationPlugin is added to the app, the AnimationLibrary becomes available as a resource.

You can then use it to register new clips and animations, and create new markers.

Example

fn my_system(mut library: ResMut<AnimationLibrary>) {
    // Create a marker

    let marker_id = library.new_marker();

    // Create a clip and attach the marker created above

    let clip = Clip::from_frames([0, 1, 2, 3])
        .with_marker(marker_id, 5);

    let clip_id = library.register_clip(clip);

    // Create an animation that uses the clip

    let animation = Animation::from_clip(clip_id);

    let animation_id = library.register_animation(animation);

    // ... Assign the animation to a SpritesheetAnimation component ...
}

Implementations

impl AnimationLibrary

pub fn register_clip(&mut self, clip: Clip) -> ClipId

Registers a Clip and returns its ID.

The clip can then be referenced in one or several Animations.

Example

let clip = Clip::from_frames([4, 5, 6]).with_repetitions(10);

let clip_id = library.register_clip(clip);

let animation = Animation::from_clip(clip_id);

// ...

pub fn deregister_clip(&mut self, clip_id: ClipId)

Deregisters a clip from the library.

Example

let clip = Clip::from_frames([1, 2, 3]);

let clip_id = library.register_clip(clip);

library.deregister_clip(clip_id);

// TODO should return an Option
// assert!(library.get_clip(clip_id).is_none());

pub fn name_clip( &mut self, clip_id: ClipId, name: impl Into<String>, ) -> Result<(), LibraryError>

Associates a unique name to a clip.

The clip ID can then later be queried from that name with AnimationLibrary::clip_with_name.

Returns a LibraryError::NameAlreadyTaken error if the name is already in use.

Arguments

• clip_id - the ID of the clip to name
• name - the name to assign

Example

let clip = Clip::from_frames([1, 2, 3]);
let clip_id = library.register_clip(clip);

library.name_clip(clip_id, "jump");

assert_eq!(library.clip_with_name("jump"), Some(clip_id));
assert!(library.is_clip_name(clip_id, "jump"));

pub fn clip_names(&self) -> &HashMap<ClipId, String>

Returns all the clip names registered in the library.

pub fn clip_with_name(&self, name: impl AsRef<str>) -> Option<ClipId>

Returns the ID of the clip with the given name if it exists.

Arguments

• name - the clip name

pub fn get_clip_name(&self, clip_id: ClipId) -> Option<&str>

Returns the name of the clip with the given ID if it exists.

Arguments

• clip_id - the clip id

pub fn is_clip_name(&self, clip_id: ClipId, name: impl AsRef<str>) -> bool

Returns true if a clip has the given name.

Arguments

• clip_id - the ID of the clip to check the name of
• name - the name to check

pub fn clips(&self) -> &HashMap<ClipId, Clip>

Returns all the clips registered in the library.

pub fn get_clip(&self, clip_id: ClipId) -> &Clip

Returns a clip registered in the library.

pub fn register_animation(&mut self, animation: Animation) -> AnimationId

Registers an new Animation and returns its ID.

The animation can then be referenced in SpritesheetAnimation components.

Example

fn f(
    mut commands: Commands,
    mut library: AnimationLibrary,
    // ...
) {
    let clip = Clip::from_frames([4, 5, 6]);

    let clip_id = library.register_clip(clip);

    let animation = Animation::from_clip(clip_id)
        .with_duration(AnimationDuration::PerRepetition(1500));

    let animation_id = library.register_animation(animation);

    // The animation can then be assigned to an entity

    // ... omitted: load an image and create a texture atlas for the sprite ...

    commands.spawn((
        Sprite::from_atlas_image(image, atlas),
        SpritesheetAnimation::from_id(animation_id)
    ));
}

pub fn deregister_animation(&mut self, animation_id: AnimationId)

Deregisters an animation from the library.

This also deregisters all the clips associated with the animation.

Example

fn f(
    mut commands: Commands,
    mut library: AnimationLibrary,
    // ...
) {
    let clip = Clip::from_frames([4, 5, 6]);

    let clip_id = library.register_clip(clip);

    let animation = Animation::from_clip(clip_id)
        .with_duration(AnimationDuration::PerRepetition(1500));

    let animation_id = library.register_animation(animation);

    // Later, when finished with the animation, deregister it.

    library.deregister_animation(animation_id);

    // The animation and its clips are no longer available in the library.
    // TODO should return an Option
    // assert!(library.get_animation(animation_id).is_none());
    // assert!(library.get_clip(clip_id).is_none());
}

pub fn name_animation( &mut self, animation_id: AnimationId, name: impl Into<String>, ) -> Result<(), LibraryError>

Associates a unique name to an animation.

The animation ID can then later be queried from that name with AnimationLibrary::animation_with_name.

Returns a LibraryError::NameAlreadyTaken error if the name is already in use.

Arguments

• animation_id - the ID of the animation to name
• name - the name to assign

Example

let animation = Animation::from_clip(clip_id);

let animation_id = library.register_animation(animation);

library.name_animation(animation_id, "crouch");

assert_eq!(library.animation_with_name("crouch"), Some(animation_id));
assert!(library.is_animation_name(animation_id, "crouch"));

pub fn animation_names(&self) -> &HashMap<AnimationId, String>

Returns all the animation names registered in the library.

pub fn animation_with_name(&self, name: impl AsRef<str>) -> Option<AnimationId>

Returns the ID of the animation with the given name if it exists.

Arguments

• name - the animation name

pub fn get_animation_name(&self, animation_id: AnimationId) -> Option<&str>

Returns the name of the animation with the given ID if it exists.

Arguments

• animation_id - the animation id

pub fn is_animation_name( &self, animation_id: AnimationId, name: impl AsRef<str>, ) -> bool

Returns true if an animation has the given name.

Arguments

• animation_id - the ID of the animation to check the name of
• name - the name to check

pub fn animations(&self) -> &HashMap<AnimationId, Animation>

Returns all the animations registered in the library.

pub fn get_animation(&self, animation_id: AnimationId) -> &Animation

Returns an animation registered in the library.

pub fn new_marker(&mut self) -> AnimationMarkerId

Creates a new animation marker and returns a unique ID to refer to it.

The marker can then be inserted into Clips and an AnimationEvent::MarkerHit event will be emitted whenever an animation reaches it.

For more details, see the documentation of AnimationEvent.

Example

let marker = library.new_marker();

let clip = Clip::from_frames([7, 8, 9, 10, 11, 12])
    .with_marker(marker, 3);

pub fn name_marker( &mut self, marker_id: AnimationMarkerId, name: impl Into<String>, ) -> Result<(), LibraryError>

Associates a unique name to an animation marker.

The marker ID can then later be queried from that name with AnimationLibrary::marker_with_name.

Returns a LibraryError::NameAlreadyTaken error if the name is already in use.

Arguments

• marker_id - the ID of the marker to name
• name - the name to assign

Example

let marker_id = library.new_marker();

library.name_marker(marker_id, "raise sword");

assert_eq!(library.marker_with_name("raise sword"), Some(marker_id));
assert!(library.is_marker_name(marker_id, "raise sword"));

pub fn marker_names(&self) -> &HashMap<AnimationMarkerId, String>

Returns all the marker names registered in the library.

pub fn marker_with_name( &self, name: impl AsRef<str>, ) -> Option<AnimationMarkerId>

Returns the ID of the marker with the given name if it exists.

Arguments

• name - the marker name

pub fn get_marker_name(&self, marker_id: AnimationMarkerId) -> Option<&str>

Returns the name of the marker with the given ID if it exists.

Arguments

• marker_id - the marker id

pub fn is_marker_name( &self, marker_id: AnimationMarkerId, name: impl AsRef<str>, ) -> bool

Returns true if an animation marker has the given name.

Arguments

• marker_id - the ID of the marker to check the name of
• name - the name to check

pub fn markers(&self) -> &HashSet<AnimationMarkerId>

Returns all the animation markers registered in the library.

Trait Implementations

impl Default for AnimationLibrary

fn default() -> AnimationLibrary

Returns the “default value” for a type.

impl FromReflect for AnimationLibrary

where AnimationLibrary: Any + Send + Sync, HashMap<ClipId, Clip>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<ClipId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Animation>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<AnimationMarkerId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationMarkerId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Arc<AnimationCache>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AtomicUsize: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for AnimationLibrary

where AnimationLibrary: Any + Send + Sync, HashMap<ClipId, Clip>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<ClipId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Animation>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<AnimationMarkerId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationMarkerId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Arc<AnimationCache>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AtomicUsize: FromReflect + TypePath + MaybeTyped + 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 PartialReflect for AnimationLibrary

where AnimationLibrary: Any + Send + Sync, HashMap<ClipId, Clip>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<ClipId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Animation>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<AnimationMarkerId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationMarkerId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Arc<AnimationCache>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AtomicUsize: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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 is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for AnimationLibrary

where AnimationLibrary: Any + Send + Sync, HashMap<ClipId, Clip>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<ClipId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Animation>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<AnimationMarkerId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationMarkerId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Arc<AnimationCache>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AtomicUsize: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for AnimationLibrary

where AnimationLibrary: Any + Send + Sync, HashMap<ClipId, Clip>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<ClipId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Animation>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<AnimationMarkerId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationMarkerId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Arc<AnimationCache>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AtomicUsize: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

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

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

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

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

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 to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for AnimationLibrary

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

where AnimationLibrary: Any + Send + Sync, HashMap<ClipId, Clip>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<ClipId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Animation>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<AnimationMarkerId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationMarkerId, String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashMap<AnimationId, Arc<AnimationCache>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AtomicUsize: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for AnimationLibrary

where Self: Send + Sync + 'static,