CreateElevationLayer

Loads an elevation layer into the project. Adding the elevation source uses a set of plugins that support multiple file formats. The coordinates of the source can be passed via the UpperLeftX/Y and LowerRightX/Y parameters. If all four coordinate field values are zero, the coordinate information, if available, is read from the file. If the source file coordinate system is not the same as the MPT file Terrain Coordinate system, you can reproject it using ITerrainRasterLayer80. CoordinateSystem.

For advanced layers, e.g. from WMS and SGS, string parameters must be passed that describe the plugins used to read the files and their persistence strings (InitParam and PlugName). To retrieve these parameter values, add layers of the required types from TerraExplorer GUI, and then call ITerrainRasterLayer.InitParam and ITerrainRasterLayer.PlugName. You can then use the values returned by these properties to create additional advanced layers.

 

JavaScript

 

CreateElevationLayer(

       ElevationFileName,

       UpperLeftX,

       UpperLeftY,

       LowerRightX,

       LowerRightY,

       InitParam,

       PlugName,

       GroupID,

       Description,

       HScale,

       HOffset )

 

C#

 

ITerrainRasterLayer80 CreateElevationLayer(

       string        ElevationFileName,

       double        UpperLeftX,

       double        UpperLeftY,

       double        LowerRightX,

       double        LowerRightY,

       object        InitParam = "",

       object        PlugName = "",

       string        GroupID = "",

       string        Description = "",

       double        HScale = 1,

       double        HOffset = 0)

 

C++

 

HRESULT CreateElevationLayer(

       BSTR          ElevationFileName,

       double        UpperLeftX,

       double        UpperLeftY,

       double        LowerRightX,

       double        LowerRightY,

       VARIANT      InitParam,

       VARIANT      PlugName,

       BSTR          GroupID,

       BSTR          Description,

       double        HScale,

       double        HOffset,

       ITerrainRasterLayer80 **   pITerrainRasterLayer80) 

 

Parameters

ElevationFileName

A full path name to the elevation to import to the terrain.

UpperLeftX

The West-East coordinate of the elevation layer’s upper left corner in the project’s coordinate system units. If all four coordinate field values are zero, the coordinate information, if available, is read from the file.

UpperLeftY

The North-South coordinate of the elevation layer’s upper left corner in the project’s coordinate system units. If all four coordinate field values are zero, the coordinate information, if available, is read from the file.

LowerRightX

The West-East coordinate of the elevation lower right corner in the project’s coordinate system units. If all four coordinate field values are zero, the coordinate information, if available, is read from the file.

LowerRightY

The North-South coordinate of the elevation lower right corner in the project’s coordinate system units. If all four coordinate field values are zero, the coordinate information, if available, is read from the file.   

InitParam

The persistence string used by some plugins, e.g., to describe layer information, for layers not stored on a local storage drive, such as WMS or SGS layers. This string can be retrieved by ITerrainRasterLayer.InitParam.

PlugName

The name of the plugin used to read the file, e.g., “gdlplg.rct“. The available plugins are files with RCT extension that exist in the “TBPlugs directory. This string can be retrieved by ITerrainRasterLayer.PlugName. If an empty string is passed into this parameter, the default plugin for the file type is used.

GroupID

The Project Tree group in which the elevation layer is created. If it is set to an empty string, the object is created under the root. You can obtain the GroupID by one of the following methods:

·          Create the group using IProjectTree80.CreateGroup.

·          Find the group, if you know the name, using IProjectTree80.FindItem.

·          Traverse the Tree using IProjectTree80 methods such as GetNextItem, until you come to the desired GroupID.

Description

The name of the elevation layer as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

HScale

The scale factor for the elevation value.

HOffset

The offset for the elevation value.

Return Value

pITerrainRasterLayer80

An ITerrainRasterLayer80, representing the newly created elevation layer.

Exceptions

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