Description

Returns the altitude at the specified position relative to the input reference surface. If the specified position is outside terrain sources, the altitude of 0.0 relative to the default reference ellipsoid (WGS84 for Earth) is returned.

Syntax

[Visual Basic .NET]
Public Function GetAltitude( _ ByVal Lat As System.Object, _ ByVal Lon As System.Object, _ ByVal AltRef As AgEAltRefType _ ) As Double

[Visual Basic .NET]

Public Function GetAltitude( _
    ByVal Lat As System.Object, _
    ByVal Lon As System.Object, _
    ByVal AltRef As AgEAltRefType _
) As Double

[C#]
public double GetAltitude( System.Object Lat, System.Object Lon, AgEAltRefType AltRef );

[Managed C++]
public: double GetAltitude( VARIANT Lat, VARIANT Lon, AgEAltRefType AltRef );

[Unmanaged C++]
public: HRESULT GetAltitude( VARIANT Lat, VARIANT Lon, AgEAltRefType AltRef, double * pRetVal );

[Unmanaged C++]

public: HRESULT GetAltitude(
    VARIANT Lat,
    VARIANT Lon,
    AgEAltRefType AltRef,
    double * pRetVal
);

[Java]
public double getAltitude( AgVariant Lat, AgVariant Lon, AgEAltRefType AltRef );

[Python - STK API ]
def GetAltitude(self, Lat:typing.Any, Lon:typing.Any, AltRef:"AgEAltRefType") -> float:

Parameters

Lat
Lon
AltRef

Example

Gets the altitude of the terrain at a single location and in batches.

[C#]

IAgScenario scenario = (IAgScenario)root.CurrentScenario;

// If you haven't done so, add the terrain to your scenario (for example .PDTT)
IAgCentralBodyTerrainCollectionElement earthTerrain = scenario.Terrain["Earth"];
earthTerrain.TerrainCollection.Add(terrainFile, AgETerrainFileType.ePDTTTerrainFile);

// Get single altitude
double altitude = earthTerrain.GetAltitude(latitude, longitude, AgEAltRefType.eMSL);

// Get points in batches.
Array specifiedPositions = new object[,]
{
    { 40.0386, -75.5966 },
    { 28.5383, -81.3792 },
    { 37.7749, -122.4194 }
};

Array altitudes = earthTerrain.GetAltitudeBatch(ref specifiedPositions, AgEAltRefType.eWGS84);

// GetAltitudeBatch returns a one-dimensional array of altitude values in the distance unit perference.
int numPoints = altitudes.GetLength(0);
for (int i = 0; i < numPoints; ++i)
{
    Console.WriteLine("Latitude={0}, Longitude={1}, Altitude={2}", specifiedPositions.GetValue(i, 0), specifiedPositions.GetValue(i, 1), altitudes.GetValue(i));
}