Skip to main content

SequenceBuilder

Struct SequenceBuilder 

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

Builder for an AnimationSequence. Steps play in the order they are added; build rejects authoring errors.

Implementations§

Source§

impl SequenceBuilder

Source

pub fn loop_mode(self, loop_mode: SequenceLoop) -> Self

Set the loop mode (default SequenceLoop::Once).

Source

pub fn play_frames( self, frames: impl Into<Vec<usize>>, frame_duration: f32, ) -> Self

Play an explicit frame order, holding each frame for frame_duration seconds.

Source

pub fn play_frame_range( self, first: usize, last: usize, frame_duration: f32, ) -> Self

Play the inclusive frame range first..=last.

Source

pub fn pause(self, duration: f32) -> Self

Hold for duration seconds.

Source

pub fn random_pause(self, min: f32, max: f32) -> Self

Hold for a duration in [min, max] when the step is entered; floating-point rounding can reach max.

Source

pub fn action(self, id: u32) -> Self

Queue id for the caller when playback reaches this point.

Source

pub fn build(self) -> Result<AnimationSequence, SequenceError>

Validate and build. An empty step list, an empty PlayFrames step, and a negative or NaN duration are authoring errors, not runtime states.

Trait Implementations§

Source§

impl Clone for SequenceBuilder

Source§

fn clone(&self) -> Self

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 SequenceBuilder

Source§

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

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

impl Default for SequenceBuilder

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

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.