API Reference › core-geometry› Curve › CurveChainWithDistanceIndex › ClosestPointXY

closestPointXY Method

Search for the curve point that is closest to the spacePoint as viewed in the xy-plane (ignoring z).

  • The CurveChainWithDistanceIndex invokes the base class CurvePrimitive method, which (via a handler) determines a CurveLocation detail among the children.
  • The returned detail directly identifies fractional position along the CurveChainWithDistanceIndex and has pointer to an additional detail for the child curve.

closestPointXY(spacePoint: Point3d, extend: VariantCurveExtendParameter = false, result?: CurveLocationDetail): undefined | CurveLocationDetail

@returns details of the closest point.

Parameter Type Description
spacePoint Point3d point in space.
extend VariantCurveExtendParameter (optional) compute the closest point to the curve extended according to variant type (default false).
result CurveLocationDetail (optional) pre-allocated detail to populate and return.

Returns - undefined | CurveLocationDetail

details of the closest point.

Defined in

Last Updated: 13 March, 2026