polygonClip Method

Clip a polygon to the planes of the clip plane set.

  • For a convex input polygon, the output polygon is also convex.
  • For non-convex input, the output polygon may have double-back edges along plane intersections. This is still a valid clip in a parity sense (overlapping regions cancel).

polygonClip(input: Point3d[] | GrowableXYZArray, output: GrowableXYZArray, work?: GrowableXYZArray, planeToSkip?: ClipPlane, tolerance: numberGeometry.smallMetricDistance): void

@see appendPolygonClip

Parameter Type Description
input Point3d[] | GrowableXYZArray polygon, usually convex. Unchanged.
output GrowableXYZArray output polygon
work GrowableXYZArray optional work array.
planeToSkip ClipPlane if this plane is found in the convex set, it is NOT applied.
This is useful when caller knows the polygon lies in one of the instance planes.
tolerance number distance tolerance for "on plane" decision. Default value is smallMetricDistance.

Returns - void

Defined in

Last Updated: 07 October, 2025