Struct CycleCompletedEvent 

pub struct CycleCompletedEvent {
    pub anim_entity: Entity,
    pub target: AnimTargetKind,
}

Event raised when an animation completed a single cycle.

This event is raised when a Tweenable animation completed a single cycle. In case the animation direction changes each cycle (RepeatStrategy::MirroredRepeat), a cycle corresponds to a single progress from one endpoint value of the lens to the other, whatever the direction. Therefore a complete loop start -> end -> start counts as 2 cycles and raises 2 events (one when reaching the end value, one when reaching back the start value).

Note

The semantic is different from TweenState::Completed, which indicates that the tweenable has finished stepping and do not need to be updated anymore, a state which is never reached for looping animation. Here the CycleCompletedEvent instead marks the end of a single cycle.

Fields

anim_entity: Entity

The entity owning the tweenable animation which completed.

This is the entity owning the TweenAnim component that the tweenable which completed is part of.

target: AnimTargetKind

The target the tweenable which completed and the TweenAnim it’s part of are mutating. Note that an actual AnimTarget component might not be spawned in the ECS world, if the target is a component on the same entity as the one owning the TweenAnim (“implicit component targetting”). But this field is always equal to the valid value that would otherwise exist as component.

Trait Implementations

impl Clone for CycleCompletedEvent

fn clone(&self) -> CycleCompletedEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl EntityEvent for CycleCompletedEvent

where Self: Send + Sync + 'static,

fn event_target(&self) -> Entity

The Entity “target” of this EntityEvent. When triggered, this will run observers that watch for this specific entity.

fn event_target_mut(&mut self) -> &mut Entity

Returns a mutable reference to the Entity “target” of this EntityEvent. When triggered, this will run observers that watch for this specific entity.

impl Event for CycleCompletedEvent

where Self: Send + Sync + 'static,

type Trigger<'a> = EntityTrigger

Defines which observers will run, what data will be passed to them, and the order they will be run in. See Trigger for more info.

impl Copy for CycleCompletedEvent

impl Message for CycleCompletedEvent

where Self: Send + Sync + 'static,