Struct mutiny::animation::path_follower::Path

pub struct Path(_);

Methods from Deref<Target = Polyline>

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 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 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 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 Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Deref for Path

type Target = Polyline

The resulting type after dereferencing.

fn deref(&self) -> &Polyline

Dereferences the value.

impl DerefMut for Path

fn deref_mut(&mut self) -> &mut Polyline

Mutably dereferences the value.

impl Component for Path

type Storage = DenseVec<Path>

fn type_name() -> &'static str

fn id() -> TypeId

impl<'a> DebugParameter for Path

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

impl Serialize for Path

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Path

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

Deserialize this value from the given Serde deserializer.