GeodesicDistance(Geometry,Geometry,LinearUnit) Method

Calculates the geodesic distance between two geometries.

Syntax

C#
Visual Basic (Declaration)

public double GeodesicDistance( 
   Geometry geometry1,
   Geometry geometry2,
   LinearUnit distanceUnit
)

Public Overloads Function GeodesicDistance( _
   ByVal geometry1 As Geometry, _
   ByVal geometry2 As Geometry, _
   ByVal distanceUnit As LinearUnit _
) As Double

Parameters

geometry1: The first geometry.
geometry2: The second geometry.
distanceUnit: The units of the output distance. If null, then the distance is in meters.

Return Value

The geodesic distance between the two geometries in . If is null, then the geodesic distance is returned in meters.

If either of the input geometries is empty, then NaN is returned.

Exceptions

Exception	Description
System.ArgumentNullException	Either geometry1 or geometry2 or both are null.
System.NotImplementedException	The method is not implemented for GeometryBag or Multipatch.
System.InvalidOperationException	Incompatible spatial references between the input geometries.
System.NotImplementedException	Spatial reference of geometry1or geometry2is an image coordinate system.

Remarks

Geodesic distance is the shortest distance between two points on the surface of the Earth.

Example

var point1 = MapPointBuilder.CreateMapPoint(-170, 45, SpatialReferences.WGS84);
var point2 = MapPointBuilder.CreateMapPoint(170, 45, SpatialReferences.WGS84);

var distances_meters = GeometryEngine.Instance.GeodesicDistance(point1, point2);
// distance is approximately 1572912.2066940258 in meters

var distance_feet = GeometryEngine.Instance.GeodesicDistance(point1, point2, LinearUnit.Feet);
// distance is approximately  5160473.11904786 in feet

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

GeometryEngine Class
GeometryEngine Members
Overload List