Struct rin::graphics::PolylineSlice [−][src]
pub struct PolylineSlice<'a, 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
This type doesn’t own the points and is usually a view on
a PolylineSlice
Implementations
impl<'a, T> PolylineSlice<'a, T> where
T: RealField + NumCast,
[src]
impl<'a, T> PolylineSlice<'a, T> where
T: RealField + NumCast,
[src]pub fn new(points: &[Point<T, U2>], closed: bool) -> PolylineSlice<'_, T>
[src]
creates a new polyline from the vector of points that must be ordered for the polyline methods to work correctly
pub fn area(&self) -> T
[src]
returns the area of the polygon, only works if the polyline represents a polygon
pub fn centroid(&self) -> Point<T, U2>
[src]
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)
[src]
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
[src]
returns true if the polyline is closed
pub fn len(&self) -> usize
[src]
returns total number of points
pub fn to_owned(&self) -> Polyline<T>
[src]
pub fn smoothed(&self, window_size: usize, window_shape: T) -> Polyline<T>
[src]
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>
[src]
pub fn iter(&self) -> Iter<'_, Point<T, U2>>
[src]
pub fn first(&self) -> Option<&Point<T, U2>>
[src]
pub fn last(&self) -> Option<&Point<T, U2>>
[src]
pub fn is_empty(&self) -> bool
[src]
pub fn lerped_point_at(&self, fidx: T) -> Option<Point<T, U2>>
[src]
Returns the point at an index + a normalized pct
pub fn segment_length(&self, idx: usize) -> Option<T>
[src]
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>
[src]
Returns the square length of the segment at the passed index or None if such segment doesn’t exist
pub fn wrap_index(&self, idx: isize) -> Option<usize>
[src]
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>
[src]
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>
[src]
Finds the previous segment which length is different than 0 starting from the passed index and wrapping around on closed polygons
impl<'a, T> PolylineSlice<'a, T> where
T: NumCast + RealField,
[src]
impl<'a, T> PolylineSlice<'a, T> where
T: NumCast + RealField,
[src]pub fn tangent_at(
&self,
idx: usize
) -> Option<Matrix<T, U2, U1, <DefaultAllocator as Allocator<T, U2, U1>>::Buffer>>
[src]
&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>>
[src]
&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<'a, T> Clone for PolylineSlice<'a, T> where
T: 'static + Clone + RealField + Debug,
[src]
impl<'a, T> Clone for PolylineSlice<'a, T> where
T: 'static + Clone + RealField + Debug,
[src]pub fn clone(&self) -> PolylineSlice<'a, T>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a, T> Debug for PolylineSlice<'a, T> where
T: 'static + Debug + RealField,
[src]
impl<'a, T> Debug for PolylineSlice<'a, T> where
T: 'static + Debug + RealField,
[src]impl<'a, T> Index<usize> for PolylineSlice<'a, T> where
T: RealField,
[src]
impl<'a, T> Index<usize> for PolylineSlice<'a, T> where
T: RealField,
[src]impl<'a, T> IntoIterator for PolylineSlice<'a, T> where
T: RealField,
[src]
impl<'a, T> IntoIterator for PolylineSlice<'a, T> where
T: RealField,
[src]impl<'a, T> Copy for PolylineSlice<'a, T> where
T: 'static + Copy + RealField + Debug,
[src]
T: 'static + Copy + RealField + Debug,
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for PolylineSlice<'a, T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<'a, T> Send for PolylineSlice<'a, T>
impl<'a, T> Sync for PolylineSlice<'a, T>
impl<'a, T> Unpin for PolylineSlice<'a, T>
impl<'a, T> UnwindSafe for PolylineSlice<'a, T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
Blanket Implementations
impl<T> DowncastSync for T where
T: Any + Send + Sync,
[src]
impl<T> DowncastSync for T where
T: Any + Send + Sync,
[src]impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn is_in_subset(&self) -> bool
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn from_subset(element: &SS) -> SP
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn is_in_subset(&self) -> bool
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn from_subset(element: &SS) -> SP
[src]
impl<T> Slottable for T where
T: Copy,
[src]
T: Copy,