Skip to main content

Tween

Struct Tween 

Source
pub struct Tween { /* private fields */ }
Expand description

Scalar tween from one number to another.

Implementations§

Source§

impl Tween

Source

pub fn new(from: f32, to: f32, duration: f32) -> Self

Create a scalar tween.

Source

pub fn update(&self, dt: f32) -> bool

Advance by dt seconds.

Source

pub fn value(&self) -> f32

Current animated value.

Source

pub fn progress(&self) -> f32

Current raw progress in [0, 1].

Source

pub fn eased_progress(&self) -> f32

Current eased progress in [0, 1].

Source

pub fn state(&self) -> String

Current runtime state.

Source

pub fn easing(&self) -> String

Easing name for this tween.

Source

pub fn is_complete(&self) -> bool

Whether playback is complete.

Source

pub fn pause(&self)

Pause playback.

Source

pub fn resume(&self)

Resume playback.

Source

pub fn reset(&self)

Reset to the beginning.

Source

pub fn reverse(&self)

Reverse direction while preserving progress.

Source

pub fn seek(&self, progress: f32)

Seek to normalized progress.

Source

pub fn set_easing(&self, name: &str) -> Result<(), JsValue>

Set easing by name.

Source

pub fn set_cubic_bezier(&self, x1: f32, y1: f32, x2: f32, y2: f32)

Set CSS cubic-bezier easing.

Source

pub fn set_time_scale(&self, scale: f32)

Set playback time scale.

Source

pub fn set_delay(&self, delay: f32)

Set start delay in seconds.

Source

pub fn set_loop_count(&self, count: u32)

Loop a fixed number of passes.

Source

pub fn set_loop_mode(&self, mode: &str) -> Result<(), JsValue>

Set loop mode by string: once, forever, pingPong, or timesN.

Source

pub fn set_ping_pong(&self)

Use ping-pong looping.

Source

pub fn set_forever(&self)

Use infinite looping.

Trait Implementations§

Source§

impl Clone for Tween

Source§

fn clone(&self) -> Tween

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Tween

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Tween> for JsValue

Source§

fn from(value: Tween) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for Tween

Source§

type Abi = WasmPtr<WasmRefCell<Tween>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for Tween

Source§

type Abi = WasmPtr<WasmRefCell<Tween>>

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for Tween

Source§

type Abi = WasmPtr<WasmRefCell<Tween>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<Tween>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for Tween

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for Tween

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for Tween

Source§

type Abi = WasmPtr<WasmRefCell<Tween>>

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<Tween>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for Tween

Source§

type Abi = WasmPtr<WasmRefCell<Tween>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<Tween>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl TryFromJsValue for Tween

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for Tween

Source§

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

Source§

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Tween]>

Source§

impl VectorIntoWasmAbi for Tween

Source§

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

Source§

fn vector_into_abi(vector: Box<[Tween]>) -> Self::Abi

Source§

impl WasmDescribe for Tween

Source§

impl WasmDescribeVector for Tween

Source§

impl SupportsConstructor for Tween

Source§

impl SupportsInstanceProperty for Tween

Source§

impl SupportsStaticProperty for Tween

Auto Trait Implementations§

§

impl Freeze for Tween

§

impl RefUnwindSafe for Tween

§

impl Send for Tween

§

impl Sync for Tween

§

impl Unpin for Tween

§

impl UnsafeUnpin for Tween

§

impl UnwindSafe for Tween

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more