GeodeticDistance Method (GeometryEngine)

In This Topic

Gets the shortest geodetic distance between two geometries.

Syntax

C#
Visual Basic (Declaration)

public double GeodeticDistance( 
   Geometry geometry1,
   Geometry geometry2,
   LinearUnit distanceUnit,
   GeodeticCurveType curveType
)

Public Function GeodeticDistance( _
   ByVal geometry1 As Geometry, _
   ByVal geometry2 As Geometry, _
   ByVal distanceUnit As LinearUnit, _
   ByVal curveType As GeodeticCurveType _
) As Double

Parameters

geometry1: The first input geometry. Cannot be null.
geometry2: The second input geometry. Cannot be null.
distanceUnit: The units of the output. If null, then the output is in meters.
curveType: The GeodeticCurveType to use when calculating the distance. The ShapePreserving type is equivalent to Geodesic for this method.

Return Value

The calculated geodetic distance between the two geometries in . If is null, then the distance is in meters.

If at least one geometry is empty, then NaN is returned.

Exceptions

Exception	Description
System.ArgumentNullException	Geometry is null or both geometry's spatial references are null.
System.InvalidOperationException	The spatial references are not equal.
System.NotImplementedException	The method is not implemented for GeometryBag or Multipatch.
System.NotImplementedException	Spatial reference of at least one of the geometries is an image coordinate system.

Remarks

If one of the spatial references is null and the other is not null and not an image coordinate system, then the non-null spatial reference is used. If both spatial references are null, then an exception is thrown. If both spatial references are not null but not equal, then an exception is thrown. If one of the spatial references is an image coordinate system, then an exception is thrown.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

GeometryEngine Class
GeometryEngine Members

Send feedback