Struct choreographer::engine::Sequence

pub struct Sequence<R, const N: usize> { /* fields omitted */ }

A sequence of Actions with maximum length N.

The total Sequence also has a LoopBehavior that describes the looping behavior of the entire sequence (e.g. play the sequence N times, once, forever).

LoopBehavior: LoopBehavior) Sequence: Sequence

Implementations

impl<R, const N: usize> Sequence<R, N>

pub const fn new() -> Self

Create a new, empty sequence

pub const fn new_array<const M: usize>() -> [Self; M]

Create an array of new, empty sequences.

This is often useful when creating an array for multiple LEDs. Alternatively, call Default::default() for the same effect.

Example

Creating an array of Sequences and setting each one to a script:

let mut leds: [Sequence<MicroTimer, 8>; 16] = Sequence::new_array();
for led in leds.iter_mut() {
    led.set(&script!(
        | action |  color | duration_ms | period_ms_f | phase_offset_ms | repeat |
        |  solid |  BLACK |        1000 |         0.0 |               0 |   once |
        |    sin |  WHITE |        2500 |      2500.0 |               0 |   once |
        |  solid |  BLACK |        1000 |         0.0 |               0 |   once |
    ), LoopBehavior::OneShot);

}

impl<R, const N: usize> Sequence<R, N> where
    R: RollingTimer<Tick = u32> + Default + Clone, 

pub fn empty() -> Self

Create a new, empty sequence

pub fn clear(&mut self)

Clear the current set of actions, leaving the Sequence empty

pub fn set(&mut self, actions: &[Action<R>], behavior: LoopBehavior)

Clear the current set of actions, and fill the sequence with the given new actions.

If actions is larger than the capacity of self, remaining items will be ignored

pub fn poll(&mut self) -> Option<RGB8>

Poll the currently active Action, potentially also moving to the next Action if necessary.

When any Action is active, an RGB8 will be returned

Trait Implementations

impl<R: Clone, const N: usize> Clone for Sequence<R, N>

fn clone(&self) -> Sequence<R, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R, const N: usize> Default for Sequence<R, N> where
    R: RollingTimer<Tick = u32> + Default + Clone, 

fn default() -> Self

Returns the “default value” for a type.