Skip to main content Module overlay Copy item path Source ArcArrangement The plane cut by several simple arc rings. ArcCheckOptions Options of check_arc_polygon_with ArcOverlayEvidence Evidence that the arc path did what it claims. ArcOverlayResult The result of an arc-aware boolean. ArcPolygon An arc-aware region: one outer boundary and its holes. ArcPolygonCheck The result of check_arc_polygon ArcRing A closed boundary whose edges may be arcs. ArcRingContact A point where two different rings meet. ArcVertex One boundary vertex and the bulge of the edge leaving it. ArrangementEdge One piece of the subdivision: part of one or more input edges, running
between two vertices with no other ring’s boundary crossing it. ArrangementEdgeUse One use of a piece in a region boundary. ArrangementRegion A region of the subdivision: an outer boundary and its holes. Bridge A segment added across a gap narrower than the closing width. CircleEvidence Which points determine the circle and how exact the output is. DroppedRing One input ring an operation left out, and why. EdgeSource Where a piece of the subdivision came from. EnclosingCircle A circle by its centre and radius. ExactPoint2 A planar point with exact rational coordinates. FreeFace A bounded free face. FreeFaceEvidence What the operation did besides the faces. FreeFaces The bounded free faces of a FreeSpaceInput FreeRing A closed boundary of a free face. FreeSpaceInput What blocks free space: obstacle polygons and open segments. Incidence One segment through a reported point. IntersectionPoint A point where two or more segments meet. MinimumCircle The circle and its evidence. MinimumRectangle The rectangle and its evidence. MorphologyBound How a disc morphology’s result relates to the exact one. OffsetEvidence What an offset actually did. OffsetResult Result of an offset. OrientedRectangle A rectangle by its centre, two unit axes and the half extents along
them. OverlayEvidence OverlayInput OverlayOptions Options for crate::overlay_withcrate::union_soup_with OverlayResult Polygon RectangleEvidence What the construction did and how exact its output is. Region A validated planar region: a normalised set of polygons with holes,
whose holes lie apart inside their outer rings and whose polygons do
not overlap (#448). RegionEvidence What an operation did to produce a region. ReportedOverlay An overlay’s result and the rings it dropped (#256). ReportedUnion A soup union’s polygons and the rings it dropped (#256). Ring SegmentIntersections The result of segment_intersections SegmentOverlap A collinear piece shared by two or more segments. SweepEvidence What the sweep did, for measurement. ArcPolygonDefect Why an ArcPolygon ArcRingRef A ring of an ArcPolygonk. BarrierDefect Why a barrier is refused. BoundSide Which side of the exact disc morphology a region lies on. CapStyle How an open stroke terminates. CircleError Why no circle was built. DegenerateRings What an operation does with a degenerate input ring (#256). DropReason Why a ring was dropped. FaceLocation Where a point lies relative to a FreeFaces FillRule FreeFacesError Why no free faces were built. JoinStyle How the outline turns a corner. MinkowskiError Why a Minkowski operation was refused. MorphologyMode How the disc morphology (Region::erode_inner_with OverlayError OverlayOperand Which operand a dropped ring came from. OverlayOperation OverlayRefusal Why a budgeted overlay gave no result. PieceSource The input an edge of a free face lies on. RectangleError Why no rectangle was built. RingRole Which ring of its polygon a dropped ring was. SegmentLocation Where on a segment an incidence lies, in the segment’s own direction
(Start is the segment’s first point as given). SegmentSweepError Why the sweep refused its input. VisibilityError Why no visibility polygon was built. arc_edge_radius Arc radius implied by an edge, or None for a straight edge. arc_overlay Boolean of two arc-capable regions. arc_ring_area Signed area enclosed by an arc ring. check_arc_polygon Exact validity of an arc polygon: rings simple, holes nested. check_arc_polygon_with check_arc_polygoncheck_arc_polygonArcCheckOptions::with_clearancefree_faces The bounded free faces of input, closing gaps narrower than gap. free_faces_within free_facesexecution.tolerance().minimum_area_rectangle The minimum-area rectangle enclosing points. minimum_enclosing_circle The minimum circle enclosing points. offset_polygons Offset closed polygons by distance. overlay Performs a neutral planar overlay. Output ordering is deterministic: polygons sort by outer-ring lexicographic start, rings are canonicalized CCW/CW. overlay_with overlayoverlayoverlay_within overlay_withExecutionOptions::toleranceExecutionOptions::with_memory_budgetOverlayRefusal::BudgetExceededoverlay_withOverlayRefusal::Invalidoverlay_withpolygon_area Net area of a polygon: outer boundary minus its holes. reverse_arc_ring Reverse a ring’s orientation, preserving its geometry. ring_area Absolute area of a ring. segment_intersections Every intersection among segments, exactly, by a Bentley–Ottmann
sweep in O((n + k) log n) time for k reported incidences. stroke_polyline Sweep an open polyline into a closed region of the given width. total_area Total net area across a set of polygons. union_soup Union a set of individually-valid rings that may overlap each other. union_soup_with union_soupunion_soupunion_soup_within union_soup_withoverlay_withinoverlay_withExecutionOptions::toleranceOverlayRefusal::BudgetExceededunion_soup_withvalidate_arc_ring Validate an arc ring against the same contract as crate::Ring