ChangeAltitudeType

Converts the altitude type of the caller to a new altitude type. The caller’s altitude is also changed as a result.  

 

JavaScript

 

ChangeAltitudeType(

       AltitudeType)

 

C#

 

void ChangeAltitudeType(

       AltitudeTypeCode AltitudeType)

 

C++

 

HRESULT ChangeAltitudeType(

       AltitudeTypeCode AltitudeType)

Parameters

AltitudeType

An enum determining how the altitude is interpreted. The following are the possible values:

·          ATC_TERRAIN_RELATIVE = 0
Places the object’s pivot point at a specified altitude above the ground.

·          ATC_PIVOT_RELATIVE    = 1
Places each point of the object at a specified altitude above the pivot point altitude, defined by its Point Altitude. The pivot is located at the center of the object.

·          ATC_ON_TERRAIN           = 2
Creates the object on the terrain itself.

·          ATC_TERRAIN_ABSOLUTE = 3
Places the object’s pivot point at a specified altitude above the terrain database vertical datum base ellipsoid.

·          ATC_3DML_RELATIVE    = 4
Places the object's pivot point at a specified altitude above the 3DML layer.

Note:    ATC_PIVOT_RELATIVE and ATC_ON_TERRAIN values apply only for 2D shapes and polygons. ATC_3DML_RELATIVE only applies to image and text labels.

Exceptions

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