CreateBox

The CreateBox method creates a box in the 3D Window.

HRESULT CreateBox (

[in] double X,

[in] double Y,

[in] double Elevation,

[in] double ObjectWidth,

[in] double ObjectDepth,

[in] double ObjectHeight,

[in, defaultvalue(0)] double Yaw,

[in, defaultvalue(0x0000ff00)] long LineColor,

[in, defaultvalue(FT_NONE)] double FillOpacity,

[in, defaultvalue(0x00646464)] long FillColor,

[in, defaultvalue(0)] HeightStyleCode HeightStyle,

[in, defaultvalue(0)] long GroupID,

[in, defaultvalue("")] BSTR Description,

[out, retval] ITerrain3DRectBase5** pITerrain3DRectBase5)

Parameters:

• X – The West-East coordinate of the center of the box represented in MPT units. You can use the ITerrain interface to retrieve information about the MPT units. If you are working in Lat-Long format, the Lat-Long values are in decimal Lat-Long.

• Y – The North-South coordinate of the center of the box represented in MPT units. You can use the ITerrain interface to retrieve information about the MPT units. If you are working in Lat-Long format, the Lat-Long values are in decimal Lat-Long.

• Elevation – The elevation of the box relative to the terrain.

• ObjectWidth – The width of the box (in meters).

• ObjectDepth – The depth of the box (in meters).

• ObjectHeight – The height of the box (in meters).

• Yaw – The Yaw angle of the plane. See: “Yaw, Pitch and Roll Angles”.

• LineColor – The color of the lines that make up the box. The color value is used to specify an RGB color. When specifying an explicit RGB color, the color value has the following hexadecimal form: 0x00bbggrr. The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; and the third byte contains a value for blue. The high-order byte must be zero. The maximum value for a single byte is 0xFF.

• FillOpacity – Determines the opacity or transparency of the fill of the box. This value can be any value between 0, for transparent, and 1 for opaque.

• FillColor – The color with which the box is filled if the FillOpacity value is greater than 0. The color value is used to specify an RGB color. When specifying an explicit RGB color, the color value has the following hexadecimal form: 0x00bbggrr. The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; and the third byte contains a value for blue. The high-order byte must be zero. The maximum value for a single byte is 0xFF.

• HeightStyle – An enum determining how the box is placed on the terrain.

The HeightStyleCode enum can use any of the following values:

• HSC_TERRAIN_RELATIVE = 0
  The height above the terrain of the box’s pivot (the center of its base), is determined by the Elevation parameter. Each of the base vertices lies in the same plane as the object’s pivot.

• HSC_TERRAIN_ABSOLUTE = 3
  The height relative to the terrain database vertical datum base ellipsoid of the box’s pivot (the center of its base), is determined by the Elevation parameter. Each of the base vertices lies in the same plane as the object’s pivot.

• GroupID – The Information Tree group in which the box 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 the IInformationTree5::CreateGroup.

• If you know the name of the group, find it using IInformationTree5::FindItem.

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

• Description – The name of the box as it appears in the Information Window. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

• pITerrain3DRectBase5 – An interface pointer to the newly created box. This parameter must not be Null.

Return Values:

The return value obtained from the returned HRESULT can be one of the following: