Struct libosu::TimingPoint

pub struct TimingPoint {
    pub time: TimeLocation,
    pub kiai: bool,
    pub sample_set: SampleSet,
    pub sample_index: u32,
    pub volume: u16,
    pub mpb: f64,
    pub kind: TimingPointKind,
}

A timing point, which represents configuration settings for a timing section.

This is a generic timing point struct representing both inherited and uninherited timing points, distinguished by the kind field.

Fields

time: TimeLocation

The timestamp of this timing point, represented as a TimeLocation.

kiai: bool

Whether or not Kiai time should be on for this timing point.

sample_set: SampleSet

The sample set associated with this timing section.

sample_index: u32

Index (if using a custom sample)

volume: u16

Volume of this timing section.

mpb: f64

Milliseconds per beat

kind: TimingPointKind

The type of this timing point. See TimingPointKind.

Methods

impl TimingPoint

pub fn from_osz(     input: impl AsRef<str>,     parent: &Option<TimingPoint> ) -> Result<TimingPoint, Error>

Creates a TimingPoint from the *.osz format

pub fn as_osz(&self) -> Result<String, Error>

Serializes this TimingPoint into the *.osz format.

impl TimingPoint

pub fn set_parent(&mut self, tp: &TimingPoint)

Sets the parent of this TimingPoint to the given TimingPoint.

pub fn get_uninherited_ancestor(&self) -> &TimingPoint

Gets the closest parent that is an uninherited timing point.

pub fn get_bpm(&self) -> f64

Gets the BPM of this timing section by climbing the timing section tree.

pub fn get_meter(&self) -> u32

Gets the meter of this timing section by climbing the timing section tree.

pub fn get_beat_duration(&self) -> f64

Returns the number of milliseconds in a beat for this timing section.

Trait Implementations

impl Clone for TimingPoint

fn clone(&self) -> TimingPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimingPoint

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

Formats the value using the given formatter.

impl Eq for TimingPoint

impl PartialEq for TimingPoint

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for TimingPoint

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialOrd for TimingPoint

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for TimingPoint

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

Serialize this value into the given Serde serializer.