Struct PatternRow 

pub struct PatternRow {

    pub pattern_id: u8,
    pub repetitions: u8,
    pub unused_1: u8,
    pub mute_mask: u8,
    pub unused_2: u8,
    pub tempo_1: u8,
    pub tempo_2: u8,
    pub scene_a: u8,
    pub scene_b: u8,
    pub unused_3: u8,
    pub offset: u8,
    pub unused_4: u8,
    pub length: u8,
    pub midi_transpose: [u8; 8],
}

Pattern Row = play this pattern, with these settings, when playing this row of the arrangement. Pretty simple.

Does not have any new methods – create the struct by hand.

Fields

pattern_id: u8

Which Pattern should be played at this point. Patterns are indexed from 0 (A01) -> 256 (P16).

Validation

Checked by the Self::validate method

repetitions: u8

How many times to play this arrangement row.

Validation

Checked by the Self::validate method

unused_1: u8

unused – have to retain this, see rant in Self

Validation

Not checked by the Self::validate method

mute_mask: u8

How track muting is applied during this arrangement row.

Validation

Not checked by the Self::validate method

unused_2: u8

unused – have to retain this, see rant in Self

Validation

Not checked by the Self::validate method

tempo_1: u8

First part of the Tempo mask for this row. Needs to be combined with tempo_2 to work out the actual tempo (not sure how it works yet).

Validation

Not checked by the Self::validate method

tempo_2: u8

Second part of the Tempo mask for this row. Needs to be combined with tempo_1 to work out the actual tempo (not sure how it works yet).

Validation

Not checked by the Self::validate method

scene_a: u8

Which scene is assigned to Scene slot A when this arrangement row is playing.

Validation

Checked by the Self::validate method

scene_b: u8

Which scene is assigned to Scene slot B when this arrangement row is playing.

Validation

Checked by the Self::validate method

unused_3: u8

unused – have to retain this, see rant in Self

Validation

Not checked by the Self::validate method

offset: u8

Which trig to start Playing the pattern on. todo: is there a maximum for this?

Validation

Not (currently) checked by the Self::validate method

unused_4: u8

unused – have to retain this, see rant in Self

Validation

Not checked by the Self::validate method

length: u8

How many trigs to play the pattern for. Note that this value always has offset added to it. So a length on the machine display of 64 when the offset is 32 will result in a value of 96 in the file data. todo: is there a maximum for this?

Validation

Not (currently) checked by the Self::validate method

midi_transpose: [u8; 8]

MIDI Track transposes for all 8 midi channels.

• 0 -> no transpose
• 1 -> 48 values are positive transpose settings
• 255 (-1) -> 207 (-48) values are negative transpose settings.

Validation

Checked by the Self::validate method

Implementations

impl PatternRow

pub fn validate(&self) -> Result<(), OtToolsIoError>

Run validation on relevant fields, see the documentation on fields in Self to find out what is actually validated.

Trait Implementations

impl AsMut<PatternRow> for PatternRow

fn as_mut(&mut self) -> &mut PatternRow

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<PatternRow> for PatternRow

fn as_ref(&self) -> &PatternRow

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PatternRow

fn clone(&self) -> PatternRow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PatternRow

impl Debug for PatternRow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PatternRow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PatternRow

impl Hash for PatternRow

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PatternRow

fn cmp(&self, other: &PatternRow) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PatternRow

fn eq(&self, other: &PatternRow) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for PatternRow

fn partial_cmp(&self, other: &PatternRow) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PatternRow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PatternRow