Skip to main content

MotionRuntime

Struct MotionRuntime 

Source
pub struct MotionRuntime { /* private fields */ }

Implementations§

Source§

impl MotionRuntime

Source

pub fn new(preference: MotionPreference) -> Self

Source

pub fn set_preference(&mut self, preference: MotionPreference)

Source

pub fn request_preference(&mut self, preference: MotionPreference)

Source

pub const fn preference(&self) -> MotionPreference

Source

pub fn set_quality(&mut self, quality: MotionQuality)

Source

pub const fn quality(&self) -> MotionQuality

Source

pub fn start( &mut self, component: ComponentInstancePath, source: MotionSource, now: Instant, ) -> Result<MotionKey, MotionError>

Start or retarget a keyed animation at the sampled current value.

§Errors

Returns MotionError for non-finite values or invalid spring parameters.

Source

pub fn start_with_replay( &mut self, component: ComponentInstancePath, declaration: MotionSource, replay_key: Option<String>, now: Instant, ) -> Result<MotionKey, MotionError>

Start or retarget while including an explicit declarative replay key.

§Errors

Returns MotionError for an invalid source.

Source

pub fn cancel(&mut self, key: &MotionKey)

Source

pub fn start_timeline( &mut self, component: ComponentInstancePath, spec: MotionTimeline, now: Instant, ) -> Result<MotionHandle, MotionError>

Register or replace a named timeline in one retained node scope.

§Errors

Returns an invalid timeline error before changing the active registry.

Source

pub fn play_timeline( &mut self, handle: &MotionHandle, now: Instant, ) -> Result<(), MotionError>

Resume or begin a timeline.

§Errors

Returns MotionError::UnknownTimeline for a stale handle.

Source

pub fn pause_timeline( &mut self, handle: &MotionHandle, now: Instant, ) -> Result<(), MotionError>

Pause a timeline at its current deterministic clock position.

§Errors

Returns MotionError::UnknownTimeline for a stale handle.

Source

pub fn seek_timeline( &mut self, handle: &MotionHandle, position_ms: u64, now: Instant, ) -> Result<(), MotionError>

Seek to an absolute timeline position in milliseconds.

§Errors

Returns a stale-handle or invalid-position error.

Source

pub fn restart_timeline( &mut self, handle: &MotionHandle, now: Instant, ) -> Result<(), MotionError>

Restart a timeline from zero and enter the playing state.

§Errors

Returns MotionError::UnknownTimeline for a stale handle.

Source

pub fn cancel_timeline( &mut self, handle: &MotionHandle, ) -> Result<(), MotionError>

Cancel a timeline and enqueue one post-frame cancellation event.

§Errors

Returns MotionError::UnknownTimeline for a stale handle.

Source

pub fn timeline_state( &self, handle: &MotionHandle, ) -> Option<MotionPlaybackState>

Source

pub fn timeline_handle_for_owner( &self, domain: &str, owner: &ComponentInstancePath, incarnation: ComponentIncarnation, generation: ScriptGeneration, name: &str, ) -> Result<MotionHandle, MotionError>

Resolve one unique named timeline below a view root.

§Errors

Returns an explicit error for missing or duplicate names.

Source

pub fn drain_timeline_events(&mut self) -> Vec<MotionTimelineEvent>

Source

pub fn drain_timeline_events_for_domain( &mut self, domain: &str, ) -> Vec<MotionTimelineEvent>

Source

pub fn resource_usage(&self) -> MotionResourceUsage

Source

pub fn retain_keys(&mut self, keys: &BTreeSet<MotionKey>)

Source

pub fn retain_node_scope(&mut self, path: &str, keys: &BTreeSet<MotionKey>)

Source

pub fn retain_timeline_scope( &mut self, path: &str, handles: &BTreeSet<MotionHandle>, )

Source

pub fn cancel_node_scope(&mut self, path: &str)

Source

pub fn is_node_scope_active(&self, path: &str) -> bool

Source

pub fn suspend_node_scope(&mut self, path: &str, now: Instant)

Source

pub fn resume_node_scope(&mut self, path: &str, now: Instant)

Source

pub fn delay_node_scope(&mut self, path: &str, delay: Duration)

Compatibility for internal callers that already measured a pause.

Source

pub fn snapshot(&self, now: Instant) -> BTreeMap<MotionKey, f64>

Source

pub fn inspect(&self, now: Instant) -> Vec<MotionSnapshot>

Source

pub fn inspect_timelines(&self, now: Instant) -> Vec<MotionTimelineSnapshot>

Source

pub fn sample(&self, key: &MotionKey, now: Instant) -> Option<f64>

Source

pub fn tick(&mut self, now: Instant) -> MotionFrame

Source

pub fn tick_scope(&mut self, now: Instant, path: &str) -> MotionFrame

Trait Implementations§

Source§

impl Debug for MotionRuntime

Source§

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

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

impl Default for MotionRuntime

Source§

fn default() -> Self

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

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<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