Struct rosu_map::section::hit_objects::SliderPath

pub struct SliderPath { /* private fields */ }

The path of a HitObjectSlider.

Implementations

impl SliderPath

pub const fn new( control_points: Vec<PathControlPoint>, expected_dist: Option<f64>, ) -> Self

Creates a new SliderPath.

The contained Curve will not necessarily be calculated yet, only when accessing it with methods such as SliderPath::curve.

pub fn control_points(&self) -> &[PathControlPoint]

Returns an immutable reference to the control points.

pub const fn expected_dist(&self) -> Option<f64>

Returns the expected distance.

pub fn curve(&mut self) -> &Curve

Returns a reference to the Curve.

If the curve has not yet been accessed, it needs to be calculated first.

In case curves of multiple slider paths are being calculated, it is recommended to initialize CurveBuffers and pass a mutable reference of it to SliderPath::curve_with_bufs so the buffers are re-used for all sliders.

Alternatively, to avoid storing the curve altogether because it will be accessed only once, using SliderPath::borrowed_curve should be preferred.

pub fn curve_with_bufs(&mut self, bufs: &mut CurveBuffers) -> &Curve

Returns a reference to the Curve.

If the curve has not yet been accessed, it needs to be calculated first.

In case the curve will be accessed only once, using SliderPath::borrowed_curve should be preferred.

pub fn borrowed_curve<'a, 'b: 'a>( &'a self, bufs: &'b mut CurveBuffers, ) -> BorrowedCurve<'_>

Returns a BorrowedCurve.

If the curve has been calculated before, the returned curve will borrow from it. Otherwise, it will be calculated and returned without storing it by borrowing from the given CurveBuffers.

This should be preferred over SliderPath::curve_with_bufs if the curve will be accessed only once.

pub fn control_points_mut(&mut self) -> &mut Vec<PathControlPoint>

Returns a mutable reference to the control points.

Note that calling this method will invalidate the stored curve so it must be recalculated on its next access.

pub fn expected_dist_mut(&mut self) -> &mut Option<f64>

Returns a mutable reference to the expected distance.

Note that calling this method will invalidate the stored curve so it must be recalculated on its next access.

pub fn clear_curve(&mut self)

Remove the stored curve so that it has to be re-calculated when accessing it the next time.

Trait Implementations

impl Clone for SliderPath

fn clone(&self) -> SliderPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SliderPath

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

Formats the value using the given formatter.

impl PartialEq for SliderPath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.