QueryPointAndDistance3D(Multipart,SegmentExtensionType,MapPoint,AsRatioOrLength,Double,Double) Method

In This Topic

Finds the point on the curve closest to inPoint, then copies that point to outPoint. The operation is performed in 3D space. Also calculates related items.

Syntax

C#
Visual Basic (Declaration)

MapPoint QueryPointAndDistance3D( 
   Multipart multipart,
   SegmentExtensionType extensionType,
   MapPoint inPoint,
   AsRatioOrLength asRatioOrLength,
   out double distanceAlongCurve,
   out double distanceFromCurve
)

Overloads Function QueryPointAndDistance3D( _
   ByVal multipart As Multipart, _
   ByVal extensionType As SegmentExtensionType, _
   ByVal inPoint As MapPoint, _
   ByVal asRatioOrLength As AsRatioOrLength, _
   ByRef distanceAlongCurve As Double, _
   ByRef distanceFromCurve As Double _
) As MapPoint

Parameters

multipart: The curve on which to find the closest point. The curve may be extended.
extensionType: Describes if, how and where to extend segments.
inPoint: The input point.
asRatioOrLength: Determines whether the distanceAlongCurve is returned as a ratio of the curve length or as length from the start point.
distanceAlongCurve: Describes the distance from the start point of the multipart to the input point, either as a ratio or length. If the input point is not on the multipart, then the nearest location on the line from the point is used.
distanceFromCurve: Describes how far the point is from the curve.

Return Value

MapPoint representing the closest point on the curve.

Exceptions

Exception	Description
System.ArgumentNullException	Either multipart or inPoint or both are null or empty.
System.InvalidOperationException	multipart is not Z-Aware.
ArcGIS.Core.Geometry.Exceptions.OperationException	Cannot do 3D operations on curve segments.
System.NotImplementedException	Spatial reference of multipartis an image coordinate system.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

IGeometryEngine Interface
IGeometryEngine Members
Overload List

Send feedback