Struct Tween

Source

pub struct Tween<T: Interpolable + Copy> { /* private fields */ }

Expand description

A generic tween interpolating a value of type T from a start to an end value over a fixed duration, driven by an Easing curve.

Works with any type implementing Interpolable — the engine provides implementations for f64, Vector2D, Vector3D, and Color.

§Why hand-written accessors

Lombok’s Data derive is intentionally not applied here for the same reason as EngineCell: the derive does not propagate generic bounds, so deriving on Tween<T> would force T: Default-style bounds that Interpolable types do not carry. The accessor pairs below follow the same naming contract as the Lombok-generated ones (get_* / set_*).

Implementations§

Source §

impl<T: Interpolable + Copy> Tween<T>

Implements creation, playback control, and value sampling for Tween.

Source

pub fn get_from(&self) -> T

Returns the value at the start of the tween.

§Returns

T: The start value.

Source

pub fn get_to(&self) -> T

Returns the value at the end of the tween.

§Returns

T: The end value.

Source

pub fn get_easing(&self) -> Easing

Returns the easing curve applied to the normalized time.

§Returns

Easing: The easing curve.

Source

pub fn get_delay(&self) -> f64

Returns the start delay in seconds before interpolation begins.

§Returns

f64: The delay in seconds.

Source

pub fn get_elapsed(&self) -> f64

Returns the time elapsed since creation, including the delay phase.

§Returns

f64: The elapsed time in seconds.

Source

pub fn get_elapsed_mut(&mut self) -> &mut f64

Returns a mutable reference to the elapsed time.

§Returns

&mut f64: The mutable elapsed time in seconds.

Source

pub fn get_mode(&self) -> AnimationMode

Returns what happens when the tween reaches the end of its duration.

§Returns

AnimationMode: The completion mode.

Source

pub fn get_direction(&self) -> f64

Returns the current playback direction for ping-pong mode.

§Returns

f64: The playback direction (1.0 = forward, -1.0 = backward).

Source

pub fn try_get_on_complete(&self) -> &Option<Rc<dyn Fn()>>

Returns a reference to the optional completion callback slot.

§Returns

&Option<Rc<dyn Fn()>>: The completion callback slot.

Source

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

Sets the easing curve applied to the normalized time.

§Arguments

Easing: The easing curve to apply.

Source

pub fn set_delay(&mut self, delay: f64)

Sets the start delay in seconds before interpolation begins.

§Arguments

f64: The delay in seconds.

Source

pub fn set_elapsed(&mut self, elapsed: f64)

Sets the time elapsed since creation.

§Arguments

f64: The elapsed time in seconds.

Source

pub fn set_state(&mut self, state: TweenState)

Sets the current playback state.

§Arguments

TweenState: The new playback state.

Source

pub fn set_mode(&mut self, mode: AnimationMode)

Sets what happens when the tween reaches the end of its duration.

§Arguments

AnimationMode: The completion mode.

Source

pub fn set_direction(&mut self, direction: f64)

Sets the current playback direction for ping-pong mode.

§Arguments

f64: The playback direction (1.0 = forward, -1.0 = backward).

Source

pub fn set_on_complete(&mut self, on_complete: Option<Rc<dyn Fn()>>)

Sets the optional completion callback.

§Arguments

Option<Rc<dyn Fn()>>: The completion callback.

Source

pub fn create(from: T, to: T, duration: f64) -> Tween<T>

Creates a new linear tween from from to to over duration seconds.

The tween starts in the Delayed state only when a delay is later attached via Tween::with_delay; by default it starts Running.

§Arguments

T: Interpolable + Copy - The start value.
T: Interpolable + Copy - The end value.
f64 - The interpolation duration in seconds.

§Returns

Tween<T: Interpolable + Copy> - The new tween.

Source

pub fn with_easing(self, easing: Easing) -> Tween<T>

Sets the easing curve, replacing the default Easing::Linear.

§Arguments

Easing - The easing curve to apply.

§Returns

Tween<T> - The tween, for chaining.

Source

pub fn with_delay(self, delay: f64) -> Tween<T>

Sets a start delay in seconds. While the delay elapses the tween reports its from value and stays in the Delayed state.

§Arguments

f64 - The delay in seconds.

§Returns

Tween<T> - The tween, for chaining.

Source

pub fn with_mode(self, mode: AnimationMode) -> Tween<T>

Sets the completion mode (Once, Loop, or PingPong), replacing the default AnimationMode::Once.

§Arguments

AnimationMode - The completion mode.

§Returns

Tween<T> - The tween, for chaining.

Source

pub fn with_on_complete(self, on_complete: Rc<dyn Fn()>) -> Tween<T>

Attaches a callback fired every time the tween completes a cycle (once for Once mode, every wrap for Loop and PingPong).

§Arguments

Rc<dyn Fn()> - The completion callback.

§Returns

Tween<T> - The tween, for chaining.

Source

pub fn update(&mut self, delta_time: f64) -> T

Advances the tween by the given delta time and returns the current eased value.

Has no effect while the tween is Paused or Finished.

§Arguments

f64 - The time elapsed since the last update, in seconds.

§Returns

T: Interpolable + Copy - The current interpolated value.

Source

pub fn value(&self) -> T

Returns the current interpolated value without advancing time.

§Returns

T: Interpolable + Copy - The current eased value.

Source

pub fn eased_progress(&self) -> f64

Returns the eased progress of the current cycle in the range 0.0 to 1.0.

§Returns

f64 - The eased progress.

Source

pub fn raw_progress(&self) -> f64

Returns the raw (uneased) progress of the current cycle.

§Returns

f64 - The raw progress in the range 0.0 to 1.0.

Source

pub fn pause(&mut self)

Pauses the tween.

Source

pub fn resume(&mut self)

Resumes a paused tween.

Source

pub fn reset(&mut self)

Resets the tween to its initial state so it can be replayed.

Source

pub fn is_finished(&self) -> bool

Returns whether the tween has finished (AnimationMode::Once only).

§Returns

bool - True if the tween is finished.

Source

pub fn get_state(&self) -> TweenState

Returns the current playback state.

§Returns

TweenState - The playback state.

Source

pub fn get_duration(&self) -> f64

Returns the configured duration in seconds.

§Returns

f64 - The duration.

Trait Implementations§

Source §

impl<T: Interpolable + Copy> Clone for Tween<T>

Source §

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

Clones the Tween by reusing shared, cheap-to-clone state where possible.

§Returns

Tween<T> - A clone that shares the same underlying storage where applicable.

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<T: Interpolable + Copy + Debug> Debug for Tween<T>

Source §

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

Formats the Tween via the supplied formatter.

§Arguments

&mut Formatter<'_> - The formatter receiving the formatted output.

§Returns

fmt::Result - Result of the formatting operation.

Source §

impl<T: Interpolable + Copy> Updatable for Tween<T>

Forwards Tween::update through the Updatable trait so tweens can participate in the same generic update loop as entities, animators, scenes, and physics worlds.

Source §