Module cavalier_contours::polyline

This module has all the types and functions associated with polylines, polyline vertexes, and polyline segments.

Modules

• internal
  Internal polyline modules made public for visualization, benchmarking, and testing purposes.

Structs

• BooleanPlineSlice
  Open polyline slice created in the process of performing a polyline boolean operation.
• BooleanResult
  Result of performing a boolean operation between two polylines.
• BooleanResultPline
  Represents one of the polyline results from a boolean operation between two polylines.
• ClosestPointResult
  Result from calling PlineSource::closest_point.
• FindIntersectsOptions
• PlineBasicIntersect
  Represents a polyline intersect at a single point.
• PlineBooleanOptions
• PlineIntersectsCollection
  Represents a collection of basic and overlapping polyline intersects.
• PlineOffsetOptions
  Struct to hold options parameters when performing polyline offset.
• PlineOverlappingIntersect
  Represents an overlapping polyline intersect segment.
• PlineSegIndexIterator
  An iterator that traverses all segment vertex pair index positions.
• PlineSelfIntersectOptions
• PlineVertex
  A polyline vertex is represented by an x, y, and bulge value.
• PlineView
  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.
• PlineViewData
  Structure to hold the minimum data required to create view as a partial selection over a source polyline. This structure is detached from the source polyline unlike PlineView.
• Polyline
  Basic polyline data representation that implements the core polyline traits: PlineSource, PlineSourceMut, and PlineCreation. See the traits documentation for all the polyline methods/operations available.
• SegmentIter
  An iterator that traverses polyline segments (as pairs of vertexes).
• SplitResult
  Result from splitting a segment using seg_split_at_point.
• VertexIter
  An iterator that traverses polyline vertexes.

Enums

• BooleanOp
  Boolean operation to apply to polylines.
• BooleanResultInfo
  Information about what happened during the boolean operation.
• PlineIntersect
  Represents a polyline intersect that may be either a PlineBasicIntersect or PlineOverlappingIntersect.
• PlineOrientation
  Represents the orientation of a polyline.
• PlineSegIntr
  Holds the result of finding the intersect between two polyline segments.
• SelfIntersectsInclude
  Enum to control which self intersects to include.
• ViewDataValidation
  Enum used for view data validation debugging and asserting.

Traits

• PlineCreation
  Trait representing a creatable source of polyline data. This trait acts as a mutable polyline source and also exposes associated functions for construction. This trait is used when new polylines need to be returned from a function.
• PlineIntersectVisitor
  Trait for visiting polyline intersects.
• PlineSegVisitor
  Trait for visiting polyline segments (two consecutive vertexes).
• PlineSource
  Trait representing a readonly source of polyline data. This trait has all the methods and operations that can be performed on a readonly polyline.
• PlineSourceMut
  Trait representing a mutable source of polyline data. This trait has all the methods and operations that can be performed on a mutable polyline.
• PlineVertexVisitor
  Trait for visiting polyline vertexes.

Functions

• pline_seg_intr
  Finds the intersects between two polyline segments.
• seg_arc_radius_and_center
  Get the arc radius and center of an arc polyline segment defined by v1 to v2. Behavior undefined (may panic or return without error) if v1.bulge is zero.
• seg_bounding_box
  Computes the axis aligned bounding box of a polyline segment defined by v1 to v2.
• seg_closest_point
  Find the closest point on a polyline segment defined by v1 to v2 to point given. If there are multiple closest points then one is chosen (which is chosen is not defined).
• seg_fast_approx_bounding_box
  Computes a fast approximate axis aligned bounding box of a polyline segment defined by v1 to v2.
• seg_length
  Calculate the path length of the polyline segment defined by v1 to v2.
• seg_midpoint
  Find the midpoint for the polyline segment defined by v1 to v2.
• seg_split_at_point
  Splits a polyline segment defined by v1 to v2 at the point_on_seg given. Assumes the point_on_seg lies on the segment.
• seg_tangent_vector
  Find the tangent direction vector on a polyline segment defined by v1 to v2 at point_on_seg.