MeasureTerrainGroundDistance

Measures the distance along a line path taking into account the terrain contour.

 

JavaScript

 

 

 

MeasureTerrainGroundDistance (

       pIGeometry,

       sampleInterval,

       IncludeGroundObjects)

 

C#

 

 

 

double MeasureTerrainGroundDistance(

       IGeometry pIGeometry,

       double sampleInterval,

       bool IncludeGroundObjects = false)

 

C++

 

 

 

HRESULT MeasureTerrainGroundDistance (

       IGeometry* pIGeometry,

       double SampleInterval,

       VARIANT_BOOL IncludeGroundObjects,

       double* pVal)

Parameters

pIGeometry

An IGeometry representing the geometric properties of the defined path. Only ILineString geometries are accepted.

sampleInterval

The distance between terrain sample points. Pass zero (0) for automatic interval.

IncludeGroundObjects

A Boolean that determines if ground objects are taken into account in calculating the distance measurement.

Return Value

pVal

The resulting value of the terrain ground distance measurement.     

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.