Struct cavalier_contours::polyline::PlineView

pub struct PlineView<'a, P>where
    P: PlineSource + ?Sized,{
    pub source: &'a P,
    pub data: PlineViewData<P::Num>,
}

A PlineView represents a partial selection or subpart of a source polyline without copying. This structure borrows a source polyline to access vertex data for iteration and operations.

See PlineViewData for how to create different types of views/selections.

Fields

source: &'a P

Reference to the source polyline for this view.

data: PlineViewData<P::Num>

View data used for indexing into the source polyline.

Implementations

impl<'a, P> PlineView<'a, P>where P: PlineSource + ?Sized,

pub fn new(source: &'a P, data: PlineViewData<P::Num>) -> Self

Create a new view with the given source and data.

pub fn detach(self) -> PlineViewData<P::Num>

Consume the view (releasing the borrow on the source polyline) and returning the associated view data.

Trait Implementations

impl<'a, P> Clone for PlineView<'a, P>where P: PlineSource + ?Sized + Clone, P::Num: Clone,

fn clone(&self) -> PlineView<'a, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, P> Debug for PlineView<'a, P>where P: PlineSource + ?Sized + Debug, P::Num: Debug,

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

Formats the value using the given formatter.

impl<'a, P> PlineSource for PlineView<'a, P>where P: PlineSource + ?Sized,

type Num = <P as PlineSource>::Num

Numeric type used for the polyline.

type OutputPolyline = Polyline<<P as PlineSource>::Num>

Type used for output when invoking methods that return a new polyline.

fn vertex_count(&self) -> usize

Total number of vertexes.

fn is_closed(&self) -> bool

Whether the polyline is closed (true) or open (false).

fn get(&self, index: usize) -> Option<PlineVertex<Self::Num>>

Get the vertex at given index position. Returns None if index out of bounds.

fn at(&self, index: usize) -> PlineVertex<Self::Num>

Same as PlineSource::get but panics if index is out of bounds.

fn iter_segments(&self) -> SegmentIter<'_, Self>

Return iterator to iterate over all the polyline segments.

fn iter_vertexes(&self) -> VertexIter<'_, Self>

Return iterator to iterate over all the polyline vertexes.

fn is_empty(&self) -> bool

Returns true if vertex count is 0.

fn fuzzy_eq_eps<P>(&self, other: &P, eps: Self::Num) -> boolwhere P: PlineSource<Num = Self::Num> + ?Sized,

Fuzzy compare with another polyline using eps epsilon value for fuzzy comparison of vertexes.

fn fuzzy_eq<P>(&self, other: &P) -> boolwhere P: PlineSource<Num = Self::Num> + ?Sized,

Same as PlineSource::fuzzy_eq_eps but uses default Self::Num::fuzzy_epsilon().

fn last(&self) -> Option<PlineVertex<Self::Num>>

Get the last vertex of the polyline or None if polyline is empty.

fn segment_count(&self) -> usize

Total number of segments in the polyline.

fn iter_segment_indexes(&self) -> PlineSegIndexIterator

Iterate through all the polyline segment vertex positional indexes.

fn next_wrapping_index(&self, i: usize) -> usize

Returns the next wrapping vertex index for the polyline.

fn prev_wrapping_index(&self, i: usize) -> usize

Returns the previous wrapping vertex index for the polyline.

fn fwd_wrapping_dist(&self, start_index: usize, end_index: usize) -> usize

Returns the forward wrapping distance between two vertex indexes.

fn fwd_wrapping_index(&self, start_index: usize, offset: usize) -> usize

Returns the vertex index after applying offset to start_index in a wrapping manner.

fn extents(&self) -> Option<AABB<Self::Num>>

Compute the XY extents of the polyline.

fn path_length(&self) -> Self::Num

Returns the total path length of the polyline.

fn area(&self) -> Self::Num

Compute the closed signed area of the polyline.

fn orientation(&self) -> PlineOrientation

Returns the orientation of the polyline.

fn remove_repeat_pos( &self, pos_equal_eps: Self::Num ) -> Option<Self::OutputPolyline>

Remove all repeat position vertexes from the polyline.

fn remove_redundant( &self, pos_equal_eps: Self::Num ) -> Option<Self::OutputPolyline>

Remove all redundant vertexes from the polyline.

fn rotate_start( &self, start_index: usize, point: Vector2<Self::Num>, pos_equal_eps: Self::Num ) -> Option<Self::OutputPolyline>

Rotates the vertexes in a closed polyline such that the first vertex’s position is at point. start_index indicates which segment point lies on before rotation. This does not change the shape of the polyline curve. pos_equal_eps is epsilon value used for comparing the positions of points. None is returned if the polyline is not closed, the polyline length is less than 2, or the start_index is out of bounds.

fn create_approx_aabb_index(&self) -> Option<StaticAABB2DIndex<Self::Num>>

Creates a fast approximate spatial index of all the polyline segments.

fn create_aabb_index(&self) -> Option<StaticAABB2DIndex<Self::Num>>

Creates a spatial index of all the polyline segments.

fn closest_point( &self, point: Vector2<Self::Num>, pos_equal_eps: Self::Num ) -> Option<ClosestPointResult<Self::Num>>

Find the closest segment point on a polyline to a point given.

fn winding_number(&self, point: Vector2<Self::Num>) -> i32

Calculate the winding number for a point relative to the polyline.

fn arcs_to_approx_lines( &self, error_distance: Self::Num ) -> Option<Self::OutputPolyline>

Returns a new polyline with all arc segments converted to line segments with some error_distance or None if T fails to cast to or from usize.

fn visit_self_intersects<C, V>(&self, visitor: &mut V) -> Cwhere C: ControlFlow, V: PlineIntersectVisitor<Self::Num, C>,

Visit self intersects of the polyline using default options.

fn visit_self_intersects_opt<C, V>( &self, visitor: &mut V, options: &PlineSelfIntersectOptions<'_, Self::Num> ) -> Cwhere C: ControlFlow, V: PlineIntersectVisitor<Self::Num, C>,

Visit self intersects of the polyline using options provided.

fn find_intersects<P>(&self, other: &P) -> PlineIntersectsCollection<Self::Num>where P: PlineSource<Num = Self::Num> + ?Sized,

Find all intersects between two polylines using default options.

fn find_intersects_opt<P>( &self, other: &P, options: &FindIntersectsOptions<'_, Self::Num> ) -> PlineIntersectsCollection<Self::Num>where P: PlineSource<Num = Self::Num> + ?Sized,

Find all intersects between two polylines using the options provided.

fn parallel_offset(&self, offset: Self::Num) -> Vec<Self::OutputPolyline>

Compute the parallel offset polylines of the polyline using default options.

fn parallel_offset_opt( &self, offset: Self::Num, options: &PlineOffsetOptions<'_, Self::Num> ) -> Vec<Self::OutputPolyline>

Compute the parallel offset polylines of the polyline with options given.

fn boolean<P>( &self, other: &P, operation: BooleanOp ) -> BooleanResult<Self::OutputPolyline>where P: PlineSource<Num = Self::Num> + ?Sized,

Perform a boolean operation between this polyline and another using default options.

fn boolean_opt<P>( &self, other: &P, operation: BooleanOp, options: &PlineBooleanOptions<'_, Self::Num> ) -> BooleanResult<Self::OutputPolyline>where P: PlineSource<Num = Self::Num> + ?Sized,

Perform a boolean operation between this polyline and another with options provided.

fn find_point_at_path_length( &self, target_path_length: Self::Num ) -> Result<(usize, Vector2<Self::Num>), Self::Num>

Find the segment index and point on the polyline corresponding to the path length given.

impl<'a, P> Copy for PlineView<'a, P>where P: PlineSource + ?Sized + Copy, P::Num: Copy,