Struct rin::math::Polyline

pub struct Polyline<T: Real = f32> { /* fields omitted */ }

An open or closed collection of vertices that represents a polyline or polygon

Has methods to do calculations over such geometrical shapes

Methods

impl<T: Real + NumCast> Polyline<T>

pub fn new() -> Polyline<T>

creates an empty polyline

pub fn new_from_disordered_points(     points: Vec<Pnt2<T>>,     closed: bool ) -> Polyline<T>

creates a new polyline from the vector of points but orders them CCW first

pub fn area(&self) -> T

returns the area of the polygon, only works if the polyline represents a polygon

pub fn centroid(&self) -> Pnt2<T>

centroid of the polyline, should work for any collection of points although it will only make sense if it's a polygon

pub fn close(&mut self)

mark this polyline as being a closed shape, although not necesarily a polygon. Any rendering or calculation will take into account that the first and last points are joined

pub fn is_closed(&self) -> bool

returns true if the polyline is closed

pub fn len(&self) -> usize

returns total number of points

pub fn push(&mut self, p: Pnt2<T>)

add a new point at the end of the polyline

pub fn smoothed(&self, window_size: usize, window_shape: T) -> Polyline<T>

Returns a smoothed version of the polyline.

window_size is the size of the smoothing window. So if window_size is 2, then 2 points from the left, 1 in the center, and 2 on the right (5 total) will be used for smoothing each point.

window_shape describes whether to use a triangular window (0) or box window (1) or something in between (for example, .5).

pub fn subdivide_linear(&self, resolution: usize) -> Polyline<T>

pub fn iter(&self) -> Iter<Pnt2<T>>

pub fn first(&self) -> Option<&Pnt2<T>>

pub fn first_mut(&mut self) -> Option<&mut Pnt2<T>>

pub fn last(&self) -> Option<&Pnt2<T>>

pub fn last_mut(&mut self) -> Option<&mut Pnt2<T>>

pub fn is_empty(&self) -> bool

pub fn lerped_point_at(&self, fidx: T) -> Option<Pnt2<T>>

Returns the point at an index + a normalized pct

pub fn segment_length(&self, idx: usize) -> Option<T>

Returns the length of the segment at the passed index or None if such segment doesn't exist

pub fn segment_length_squared(&self, idx: usize) -> Option<T>

Returns the square length of the segment at the passed index or None if such segment doesn't exist

pub fn clear(&mut self)

Removes all points from the polyline

pub fn wrap_index(&self, idx: isize) -> Option<usize>

Returns an index wrapped around a closed polygon or clamped on a polyline. Will return None if the polyline is empty

pub fn next_non_zero_segment(&self, idx: usize) -> Option<usize>

Finds the next segment which length is different than 0 starting from the passed index and wrapping around on closed polygons

pub fn prev_non_zero_segment(&self, idx: usize) -> Option<usize>

Finds the previous segment which length is different than 0 starting from the passed index and wrapping around on closed polygons

impl<T: Real + NumCast + Float> Polyline<T>

pub fn tangent_at(&self, idx: usize) -> Option<Vec2<T>>

Tangent at the point in the passed index if it exists

pub fn lerped_tangent_at(&self, fidx: T) -> Option<Vec2<T>>

Tangent at the lerped point at the passed index + normalized pct

Trait Implementations

impl<T> Into<Vec<Point<T, U2>>> for Polyline<T> where     T: Real,

Important traits for Vec<u8>

impl Write for Vec<u8>

fn into(self) -> Vec<Pnt2<T>>

Performs the conversion.

impl<T: Real> AsRef<[Point<T, U2>]> for Polyline<T>

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

fn as_ref(&self) -> &[Pnt2<T>]

Performs the conversion.

impl<T: Clone + Real> Clone for Polyline<T>

fn clone(&self) -> Polyline<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Real> IntoIterator for Polyline<T>

type Item = Pnt2<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Pnt2<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<Pnt2<T>>

Creates an iterator from a value.

impl<T: Debug + Real> Debug for Polyline<T>

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

Formats the value using the given formatter.

impl<T: Real> Index<usize> for Polyline<T>

type Output = Pnt2<T>

The returned type after indexing.

fn index(&self, idx: usize) -> &Pnt2<T>

Performs the indexing (container[index]) operation.

impl<T: Real> IndexMut<usize> for Polyline<T>

fn index_mut(&mut self, idx: usize) -> &mut Pnt2<T>

Performs the mutable indexing (container[index]) operation.

impl<T> FromIterator<Point<T, U2>> for Polyline<T> where     T: Real,

fn from_iter<I>(iter: I) -> Polyline<T> where     I: IntoIterator<Item = Pnt2<T>>,

Creates a value from an iterator.

impl<T: Real> Serialize for Polyline<T> where     T: Serialize,

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

Serialize this value into the given Serde serializer.

impl<'de, T: Real> Deserialize<'de> for Polyline<T> where     T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.