Struct Motions 

pub struct Motions<K> { /* private fields */ }

Component-owned keyed transitions using the shared engine and Kit’s clock.

Batch results follow declaration order; stable keys preserve interruption history through reordering. Omitted entries stay retained. Cleanup and capacity methods are available through core::Motions. Retain this collection in the view and notify after changing model targets.

Implementations

impl<K> Motions<K>

pub fn new() -> Self

Creates an empty collection without allocating.

pub fn with_capacity(capacity: usize) -> Self

Reserves space for at least capacity keys, without creating trajectories.

impl<K: Eq + Hash> Motions<K>

pub fn frame<const N: usize>( &mut self, declarations: [(K, Motion); N], window: &mut Window, cx: &App, ) -> [Frame; N]

Samples a batch during render using one executor timestamp and Kit’s reduced-motion preference. Requests one frame if any returned frame is active. Omitted entries do not request frames. Do not mix with explicit sample times.

Panics

Panics on duplicate keys. Earlier entries may already have been sampled.

pub fn frame_one( &mut self, key: K, motion: Motion, window: &mut Window, cx: &App, ) -> Frame

Samples one native entry. Use Self::frame to synchronize several entries.

pub fn sample<const N: usize>( &mut self, declarations: [(K, Motion); N], now: Duration, reduced_motion: bool, ) -> [Frame; N]

Samples explicit elapsed time, returning Kit-ready frames. Do not mix this clock with Self::frame. See the shared engine for lifecycle details.

Panics

Panics on duplicate keys. Earlier entries may already have been sampled.

pub fn sample_one( &mut self, key: K, motion: Motion, now: Duration, reduced_motion: bool, ) -> Frame

Samples one key at explicit elapsed time, returning a Kit-ready frame.

Methods from Deref<Target = Motions<K>>

pub fn len(&self) -> usize

Number of retained keys, including settled or absent objects.

pub fn is_empty(&self) -> bool

Whether no keys are retained.

pub fn capacity(&self) -> usize

Number of keys that fit before the hash table must grow.

pub fn clear(&mut self)

Cancels all trajectories and drops their keys, keeping table capacity. The collection’s clock continues. Call Self::shrink_to_fit to release unused table storage, or drop the collection to release everything.

pub fn sample<const N: usize>( &mut self, declarations: [(K, Motion); N], now: Duration, reduced_motion: bool, ) -> [Frame; N]

Samples a batch at one absolute monotonic timestamp, returning owned frames.

Springs preserve velocity when retargeted. Reduced motion snaps each submitted entry; backward timestamps clamp to the collection’s last sample. An empty batch is valid and leaves entries retained. Expected cost is O(N) hash lookups plus sampling, independent of the number of omitted entries. Do not mix explicit timestamps with native frame calls on this collection.

Panics

Panics if a key occurs twice in this batch. This is a declaration error, not a transaction: entries preceding the duplicate may already be sampled.

pub fn sample_one( &mut self, key: K, motion: Motion, now: Duration, reduced_motion: bool, ) -> Frame

Samples one key, creating its state on first use. Repeated calls for the same key are allowed; each declaration retargets the same trajectory. Uses the same clock and interruption contract as Self::sample.

pub fn contains_key(&self, key: &K) -> bool

Whether this key has retained state, including a completed exit.

pub fn remove(&mut self, key: &K) -> bool

Immediately cancels and removes a key; returns whether it existed. Reusing a removed key starts fresh, including its initial declaration. For animated removal, wait until its sampled frame is no longer mounted. Hash table capacity is preserved.

pub fn retain(&mut self, keep: impl FnMut(&K) -> bool)

Immediately removes keys for which keep returns false, preserving capacity. This does not wait for exits; keep exiting keys until their final sample. Iteration order is unspecified; visits the table in O(capacity) time.

pub fn reserve(&mut self, additional: usize)

Reserves space for at least additional new keys beyond the current length.

pub fn shrink_to_fit(&mut self)

Releases unused table capacity as far as the standard hash table allows. Retained trajectories are unchanged. Do this after cleanup, outside a hot sampling loop; it can allocate and move entries.

Trait Implementations

impl<K: Debug> Debug for Motions<K>

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

Formats the value using the given formatter.

impl<K> Default for Motions<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K> Deref for Motions<K>

type Target = Motions<K>

The resulting type after dereferencing.

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

Dereferences the value.

impl<K> DerefMut for Motions<K>

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

Mutably dereferences the value.