Struct rin::graphics::Polyline

pub struct Polyline<T = f32> where
    T: 'static + RealField + Debug,  { /* fields omitted */ }

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

Has methods to do calculations over such geometrical shapes

Implementations

impl<T> Polyline<T> where
    T: RealField + NumCast, 

pub fn new() -> Polyline<T>

creates an empty polyline

pub fn new_from_disordered_points(
    points: Vec<Point<T, U2>, Global>,
    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) -> Point<T, U2>

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: Point<T, U2>)

add a new point at the end of the polyline

pub fn remove(&mut self, idx: usize) -> Point<T, U2>

removes a new point at the end of the polyline

pub fn extend<I>(&mut self, vertices: I) where
    I: IntoIterator<Item = Point<T, U2>>, 

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<'_, Point<T, U2>>

pub fn iter_mut(&mut self) -> IterMut<'_, Point<T, U2>>

pub fn windows(&self, size: usize) -> Windows<'_, Point<T, U2>>

pub fn first(&self) -> Option<&Point<T, U2>>

pub fn first_mut(&mut self) -> Option<&mut Point<T, U2>>

pub fn last(&self) -> Option<&Point<T, U2>>

pub fn last_mut(&mut self) -> Option<&mut Point<T, U2>>

pub fn is_empty(&self) -> bool

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

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

pub fn simplify(&mut self, epsilon: T)

pub fn retain<F>(&mut self, f: F) where
    F: FnMut(&Point<T, U2>) -> bool, 

impl<T> Polyline<T> where
    T: NumCast + RealField, 

pub fn tangent_at(
    &self,
    idx: usize
) -> Option<Matrix<T, U2, U1, <DefaultAllocator as Allocator<T, U2, U1>>::Buffer>>

Tangent at the point in the passed index if it exists

pub fn lerped_tangent_at(
    &self,
    fidx: T
) -> Option<Matrix<T, U2, U1, <DefaultAllocator as Allocator<T, U2, U1>>::Buffer>>

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

Trait Implementations

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

pub fn as_ref(&self) -> &[Point<T, U2>]

Performs the conversion.

impl<T> Clone for Polyline<T> where
    T: 'static + Clone + RealField + Debug, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Polyline<T> where
    T: 'static + Debug + RealField, 

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Polyline<T> where
    T: 'static + RealField + Debug + Deserialize<'de>, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Polyline<T>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Creates a value from an iterator.

impl<T> Index<usize> for Polyline<T> where
    T: RealField, 

type Output = Point<T, U2>

The returned type after indexing.

pub fn index(&self, idx: usize) -> &Point<T, U2>

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Polyline<T> where
    T: RealField, 

pub fn index_mut(&mut self, idx: usize) -> &mut Point<T, U2>

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

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

pub fn into(self) -> Vec<Point<T, U2>, Global>

Performs the conversion.

impl<T> IntoIterator for Polyline<T> where
    T: RealField, 

type Item = Point<T, U2>

The type of the elements being iterated over.

type IntoIter = IntoIter<Point<T, U2>, Global>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> IntoIter<Point<T, U2>, Global>

Creates an iterator from a value.

impl<T> Serialize for Polyline<T> where
    T: 'static + RealField + Debug + Serialize, 

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

Serialize this value into the given Serde serializer.