Struct Notes

pub struct Notes { /* private fields */ }

The objects set for querying by lane or time.

Implementations

impl Notes

pub fn new() -> Self

Creates a new notes dictionary.

pub fn into_all_notes(self) -> Vec<Obj>

Converts into the notes sorted by time.

pub fn all_notes(&self) -> impl Iterator<Item = &Obj>

Returns the iterator having all of the notes sorted by time.

pub fn bgms(&self) -> &BTreeMap<ObjTime, Vec<ObjId>>

Returns all the bgms in the score.

pub fn bpm_changes(&self) -> &BTreeMap<ObjTime, BpmChangeObj>

Returns the bpm change objects.

pub fn section_len_changes(&self) -> &BTreeMap<Track, SectionLenChangeObj>

Returns the section len change objects.

pub fn stops(&self) -> &BTreeMap<ObjTime, StopObj>

Returns the scroll stop objects.

pub fn bga_changes(&self) -> &BTreeMap<ObjTime, BgaObj>

Returns the bga change objects.

pub fn next_obj_by_key(&self, key: Key, time: ObjTime) -> Option<&Obj>

Finds next object on the key Key from the time ObjTime.

pub fn push_note(&mut self, note: Obj)

Adds the new note object to the notes.

pub fn remove_latest_note(&mut self, id: ObjId) -> Option<Obj>

Removes the latest note from the notes.

pub fn remove_note(&mut self, id: ObjId) -> Vec<Obj>

Removes the note from the notes.

pub fn push_bpm_change(&mut self, bpm_change: BpmChangeObj)

Adds a new BPM change object to the notes.

pub fn push_scrolling_factor_change(&mut self, bpm_change: ScrollingFactorObj)

Adds a new scrolling factor change object to the notes.

pub fn push_spacing_factor_change(&mut self, bpm_change: SpacingFactorObj)

Adds a new spacing factor change object to the notes.

pub fn push_section_len_change( &mut self, section_len_change: SectionLenChangeObj, )

Adds a new section length change object to the notes.

pub fn push_stop(&mut self, stop: StopObj)

Adds a new stop object to the notes.

pub fn push_bga_change(&mut self, bga: BgaObj)

Adds a new bga change object to the notes.

pub fn push_extended_message(&mut self, message: ExtendedMessageObj)

Adds the new extended message object to the notes.

pub fn last_visible_time(&self) -> Option<ObjTime>

Gets the time of last visible object.

pub fn last_bgm_time(&self) -> Option<ObjTime>

Gets the time of last BGM object.

You can’t use this to find the length of music. Because this doesn’t consider that the length of sound. And visible notes may ring after all BGMs.

pub fn last_obj_time(&self) -> Option<ObjTime>

Gets the time of last any object including visible, BGM, BPM change, section length change and so on.

You can’t use this to find the length of music. Because this doesn’t consider that the length of sound.

pub fn resolution_for_pulses(&self) -> u32

Calculates a required resolution to convert the notes time into pulses, which split one quarter note evenly.

Trait Implementations

impl Debug for Notes

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

Formats the value using the given formatter.

impl Default for Notes

fn default() -> Notes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Notes

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Notes

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.