Skip to main content

TypedTimeline

Struct TypedTimeline 

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

Kit executor clock around a shared heterogeneous timeline.

Implementations§

Source§

impl TypedTimeline

Source

pub fn now(&self, cx: &App) -> Duration

Native timestamp for playback controls.

Source

pub fn frame(&mut self, window: &mut Window, cx: &App)

Samples all typed tracks using Kit’s reduced-motion preference.

Source

pub fn speed(&mut self, speed: f64, cx: &App) -> Result<(), AnimationError>

Changes playback speed using this adapter’s clock.

Methods from Deref<Target = TypedTimeline>§

Source

pub fn at<T, const N: usize>( &mut self, start: Duration, initial: T, clip: TypedAnimation<T, N>, ) -> TrackId<T, N>
where T: MotionData<N>,

Adds a typed track at an absolute playhead position, with its initial value.

Source

pub fn after<T, const N: usize>( &mut self, seconds: f64, initial: T, clip: TypedAnimation<T, N>, ) -> Result<TrackId<T, N>, AnimationError>
where T: MotionData<N>,

Adds after the preceding track’s end, with positive delay or negative overlap. Fails without mutation after a forever track or for a negative/invalid time.

Source

pub fn label( &mut self, name: impl Into<String>, at: Duration, ) -> Result<(), AnimationError>

Records a unique label at an absolute position.

Source

pub fn at_label<T, const N: usize>( &mut self, name: &str, seconds: f64, initial: T, clip: TypedAnimation<T, N>, ) -> Result<TrackId<T, N>, AnimationError>
where T: MotionData<N>,

Adds at a label with a signed seconds offset; missing labels fail transactionally.

Source

pub fn sample(&mut self, now: Duration, reduced: bool)

Samples all tracks and dispatches completion observers at the end.

Source

pub fn value<T, const N: usize>(&self, id: TrackId<T, N>) -> Option<T>
where T: MotionData<N>,

Reads a sampled typed value; foreign track identities return None.

Source

pub fn pause(&mut self, now: Duration)

Pauses the shared clock.

Source

pub fn play(&mut self, now: Duration)

Resumes the shared clock.

Source

pub fn seek(&mut self, time: Duration, now: Duration)

Seeks without replacing prepared tracks.

Source

pub fn set_speed( &mut self, speed: f64, now: Duration, ) -> Result<(), AnimationError>

Changes speed, including zero and reverse playback.

Source

pub fn restart(&mut self, now: Duration)

Restarts and rearms reduced-motion completion.

Source

pub fn completion(&mut self) -> Completion ⓘ

Completion observer for this run. Dropping this timeline cancels observers.

Source

pub fn is_animating(&self) -> bool

Whether another sample is required, including upcoming delayed tracks.

Trait Implementations§

Source§

impl Debug for TypedTimeline

Source§

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

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

impl Default for TypedTimeline

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Deref for TypedTimeline

Source§

type Target = TypedTimeline

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl DerefMut for TypedTimeline

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more