sycamore::motion

Struct Tweened

source
pub struct Tweened<T: Lerp + Clone + 'static>(/* private fields */);
Expand description

A state that is interpolated when it is set.

Implementations§

source§

impl<T: Lerp + Clone> Tweened<T>

source

pub fn set(&self, _new_value: T)

Set the target value for the Tweened. The existing value will be interpolated to the target value with the specified transition_duration and easing_fn.

If the value is being interpolated already due to a previous call to set(), the previous task will be canceled.

To immediately set the value without interpolating the value, use signal().set(...) instead.

If not running on wasm32-unknown-unknown, does nothing.

source

pub fn get(&self) -> T
where T: Copy,

Alias for signal().get().

source

pub fn get_untracked(&self) -> T
where T: Copy,

Alias for signal().get_untracked().

source

pub fn signal(&self) -> Signal<T>

Get the inner signal backing the state.

source

pub fn is_tweening(&self) -> bool

Returns true if the value is currently being tweened/interpolated. This value is reactive and can be tracked.

Trait Implementations§

source§

impl<T: Lerp + Clone + 'static> Clone for Tweened<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Lerp + Clone> Debug for Tweened<T>

source§

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

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

impl<T: Lerp + Clone + 'static> Copy for Tweened<T>

Auto Trait Implementations§

§

impl<T> Freeze for Tweened<T>

§

impl<T> !RefUnwindSafe for Tweened<T>

§

impl<T> !Send for Tweened<T>

§

impl<T> !Sync for Tweened<T>

§

impl<T> Unpin for Tweened<T>
where T: Unpin,

§

impl<T> !UnwindSafe for Tweened<T>

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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.