Struct benimator::SpriteSheetAnimation

pub struct SpriteSheetAnimation {
    pub frames: Vec<Frame>,
    pub mode: AnimationMode,
    // some fields omitted
}

Component to animate the TextureAtlasSprite of the same entity

See crate level documentation for usage

Fields

frames: Vec<Frame>

Frames

mode: AnimationMode

Animation mode

Implementations

impl SpriteSheetAnimation

pub fn from_frames(frames: Vec<Frame>) -> Self

Create a new animation from frames

pub fn from_range(
    index_range: RangeInclusive<u32>,
    frame_duration: Duration
) -> Self

Create a new animation from index-range, using the same frame duration for each frame.

For more granular configuration, see from_frames

pub fn once(self) -> Self

Set the animation mode to AnimationMode::Once

pub fn repeat(self) -> Self

Set the animation mode to AnimationMode::Repeat

Trait Implementations

impl Clone for SpriteSheetAnimation

fn clone(&self) -> SpriteSheetAnimation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSheetAnimation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpriteSheetAnimation

fn default() -> SpriteSheetAnimation

Returns the “default value” for a type.

impl GetTypeRegistration for SpriteSheetAnimation

fn get_type_registration() -> TypeRegistration

impl Reflect for SpriteSheetAnimation

fn type_name(&self) -> &str

fn any(&self) -> &dyn Any

fn any_mut(&mut self) -> &mut dyn Any

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

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

fn apply(&mut self, value: &dyn Reflect)

fn reflect_ref(&self) -> ReflectRef<'_>

fn reflect_mut(&mut self) -> ReflectMut<'_>

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

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

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

impl Struct for SpriteSheetAnimation

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

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

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

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

fn name_at(&self, index: usize) -> Option<&str>

fn field_len(&self) -> usize

fn iter_fields(&self) -> FieldIter<'_>

fn clone_dynamic(&self) -> DynamicStruct