The CreateHoleOnTerrain method creates a Hole On Terrain object in the 3D Window.
See: “Hole On Terrain” section under the “Terrain Objects” chapter of the User Manual.
HRESULT CreateHoleOnTerrain(
[in, optional, defaultvalue(0)] VARIANT SafeArrayVertices,
[in, optional, defaultvalue(0)] long GroupID,
[in, optional, defaultvalue("")] BSTR Description,
[out, retval] ITerrainHole5** pITerrainHole5)
HRESULT CreateTerrainModifier(
Parameters:
SafeArrayVertices – An
array that contains triplets of doubles. Each triplet is composed
of an x-coordinate, a height, and a y-coordinate. The Hole On
Terrain is always drawn on the terrain surface. Therefore, all of
the height coordinates in the array are ignored. The COM interface
represents the height in meters while the x- and y-coordinates are
represented in MPT units. You can use the ITerrain interface to
retrieve information about the MPT units. If you are working in a
Lat-Long format, the Lat-Long values are given in decimal degrees.
If this parameter is zero, the object manager creates an empty
polyline to which the client can later add vertices.
See: “Creating a
Polyline Using a Safe Array of Vertices”.
GroupID – The Information Tree group in which the hole on terrain is created. If it is set to zero, the object is created under the root. You can obtain the GroupID by one of the following methods:
Create the group using IInformationTree5::CreateGroup.
Find the group if you know the name of the group using IInformationTree5::FindItem.
Traverse the Tree using IInformationTree5 methods such as GetNextItem(), until you come to the desired GroupID.
Description – The name of the Hole on Terrain as it appears in the Information Window. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.
pITerrainHole5 – An interface pointer to the newly created Hole on Terrain. This parameter must not be Null.
Return Values:
The return value obtained from the returned HRESULT can be one of the following:
|
Return value |
Meaning |
|
S_OK |
Success. |
|
E_FAIL |
Catastrophic failure. |
|
TE_E_MPTNOTLOADED |
An MPT file must be loaded in TerraExplorer for this method to work. |
|
TE_E_INFOTREE_PARENTNOTGROUP |
The group ID entered does not represent a valid group in the information tree. |
|
TE_E_INTERNAL |
TerraExplorer was unable to create the object. To get more information about this error use the IErrorInfo Interface. |
|
TE_E_NOLICENCE |
Your license does not allow the use of this feature. |