Struct Transition 

pub struct Transition<T: Lerp + Send + Sync + 'static> {
    pub from: T,
    pub to: T,
    pub start: Instant,
    pub duration: Duration,
    pub easing: Easing,
}

One-shot transition between two values of a tween-able type.

Use Transition::new to construct or From<(T, T, Duration)> for the common linear case. Transition::sample returns the eased value at any instant; Transition::done returns true once elapsed time has met or exceeded duration so the caller can despawn the component and stop tweening.

Fields

from: T

Value at start.

to: T

Value at start + duration.

start: Instant

Wall-clock instant the transition began.

duration: Duration

Total length of the transition.

easing: Easing

Curve applied to the linear progress fraction.

Implementations

impl<T: Lerp + Send + Sync + 'static> Transition<T>

pub fn new(from: T, to: T, duration: Duration, easing: Easing) -> Self

Construct a transition that starts at now() and runs over duration with easing.

pub fn progress(&self, now: Instant) -> f32

Linear fraction of total duration elapsed at now, clamped to [0, 1]. Zero-duration transitions report 1 immediately so they surface their to value without dividing by zero.

pub fn sample(&self, now: Instant) -> T

Eased value at now.

pub fn done(&self, now: Instant) -> bool

true once the transition has met or exceeded duration.

Trait Implementations

impl<T: Clone + Lerp + Send + Sync + 'static> Clone for Transition<T>

fn clone(&self) -> Transition<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Lerp + Send + Sync + 'static> Component for Transition<T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl<T: Debug + Lerp + Send + Sync + 'static> Debug for Transition<T>

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

Formats the value using the given formatter.

impl<T: Lerp + Send + Sync + 'static> From<(T, T, Duration)> for Transition<T>

fn from((from, to, duration): (T, T, Duration)) -> Self

Convenience: (from, to, duration).into() builds a Easing::Linear transition starting at now().

impl<T: Copy + Lerp + Send + Sync + 'static> Copy for Transition<T>