createClippersForRegionsClosestToCurvePrimitivesXY MethodStatic
Creates clippers for regions closest to the children of a curve chain.
- For best results, each child should have length larger than
distanceTol.
createClippersForRegionsClosestToCurvePrimitivesXY(curveChain: CurveChain, strokeOptions?: StrokeOptions, distanceTol: numberGeometry.smallMetricDistance, boundingBox?: Readonly<WritableLowAndHighXY>): undefined | UnionOfConvexClipPlaneSets[]
@returns An ordered array of clippers, each of which represents the region closest to the corresponding primitive in the input chain, or undefined if the input is invalid.
| Parameter | Type | Description |
|---|---|---|
| curveChain | CurveChain | A curve chain; xy-only (z-coordinate is ignored). Must have at least 2 children. |
| strokeOptions | StrokeOptions | Optional stroke options to control the sampling of the curve chain. |
| distanceTol | number | Optional distance tolerance to use when comparing points; default is smallMetricDistance. |
| boundingBox | Readonly<WritableLowAndHighXY> | Optional nominal xy-bounding box for the clipper regions; default is maximal clipper regions. |
Returns - undefined | UnionOfConvexClipPlaneSets[]
An ordered array of clippers, each of which represents the region closest to the corresponding primitive in the input chain, or undefined if the input is invalid.
Defined in
- clipping/ClipUtils.ts Line 1126
Last Updated: 09 October, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.