Struct bevy_spritesheet_animation::animation::Animation

pub struct Animation { /* private fields */ }

A playable animation to assign to a SpritesheetAnimation component.

An animation is composed of one or several AnimationStages.

Parameters like duration, repeat, direction and easing can be specified.

If specified, they will be combined with the parameters of the underlying AnimationStages and AnimationClips.

Example

let animation_id = library.new_animation(|animation| {
    let mut stage1 = AnimationStage::from_clip(some_clip_id);
    stage1
        .set_duration(AnimationDuration::PerCycle(2000))
        .set_easing(Easing::In(EasingVariety::Quadratic));

    let mut stage2 = AnimationStage::from_clip(another_clip_id);
    stage2
        .set_repeat(10)
        .set_direction(AnimationDirection::PingPong);

    animation
        .add_stage(stage1)
        .add_stage(stage2)
        .set_repeat(AnimationRepeat::Cycles(5));
});

Implementations

impl Animation

pub fn add_stage(&mut self, stage: AnimationStage) -> &mut Self

Adds a stage to the animation.

Stages are played in the same order that they are added.

Arguments

stage - the stage to add to the animation

Example

let animation_id = library.new_animation(|animation| {
    // Directly add a first clip to the animation as a stage

    animation.add_stage(some_clip_id.into());

    // Add a second clip
    //
    // This time, we create an explicit stage to tweak the clip's parameters

    let mut stage = AnimationStage::from_clip(some_clip_id);
    stage.set_direction(AnimationDirection::Backwards);

    animation.add_stage(stage);
});

pub fn stages(&self) -> &[AnimationStage]

pub fn set_duration(&mut self, duration: AnimationDuration) -> &mut Self

pub fn duration(&self) -> &Option<AnimationDuration>

pub fn set_repeat(&mut self, repeat: AnimationRepeat) -> &mut Self

pub fn repeat(&self) -> &Option<AnimationRepeat>

pub fn set_direction(&mut self, direction: AnimationDirection) -> &mut Self

pub fn direction(&self) -> &Option<AnimationDirection>

pub fn set_easing(&mut self, easing: Easing) -> &mut Self

pub fn easing(&self) -> &Option<Easing>

Trait Implementations

impl Clone for Animation

fn clone(&self) -> Animation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Animation

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

Formats the value using the given formatter.