API Reference › core-geometry› CartesianGeometry › PolygonOps › IntersectSegment

intersectSegment MethodStatic

Compute the intersection of a line (parameterized as a line segment) with the plane of this polygon.

intersectSegment(polygon: IndexedXYZCollection | Point3d[], point0: Point3d, point1: Point3d, tolerance: numberGeometry.smallMetricDistance, result?: PolygonLocationDetail): PolygonLocationDetail

@returns details d of the line-plane intersection d.point:

  • d.isValid() returns true if and only if the line intersects the plane.
  • d.code indicates where the intersection lies with respect to the polygon.
  • d.a is the segment intersection parameter. If d.a is in [0,1], the segment intersects the plane of the polygon.
  • d.edgeIndex and d.edgeParam specify the location of the closest point on the polygon to the intersection, within distTol.

@see intersectRay3d

Parameter Type Description
polygon IndexedXYZCollection | Point3d[] points of the polygon, closure point optional
point0 Point3d start point of segment on line to intersect
point1 Point3d end point of segment on line to intersect
tolerance number optional distance tolerance to determine point-vertex and point-edge coincidence.
result PolygonLocationDetail optional pre-allocated object to fill and return

Returns - PolygonLocationDetail

details d of the line-plane intersection d.point:

  • d.isValid() returns true if and only if the line intersects the plane.
  • d.code indicates where the intersection lies with respect to the polygon.
  • d.a is the segment intersection parameter. If d.a is in [0,1], the segment intersects the plane of the polygon.
  • d.edgeIndex and d.edgeParam specify the location of the closest point on the polygon to the intersection, within distTol.

Defined in

Last Updated: 14 November, 2024