CreateRectangle

CreateRectangle creates a rectangle in the 3D Window.

HRESULT CreateRectangle(

[in] double X,

[in] double Y,

[in] double Elevation,

[in] double ObjectWidth,

[in] double ObjectDepth,

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

[in, defaultvalue(FT_NONE)] double FillOpacity,

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

[in, defaultvalue(HSC_TERRAIN_RELATIVE)] HeightStyleCode HeightStyle,

[in, defaultvalue(0)] long GroupID,

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

[out, retval] ITerrainRectangle5** pITerrainRectangle5)

Parameters:

• X – The West-East coordinate of the center of the rectangle 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 rectangle 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 rectangle, which is interpreted using the HeightStyle parameter.

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

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

• LineColor – The color of the lines that make up the rectangle. 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 object. This value can be any value between 0, for transparent, and 1 for opaque.

• FillColor – The color with which the rectangle 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 rectangle is placed on the terrain.

The HeightStyleCode enum can use any of the following values:

• HSC_TERRAIN_RELATIVE = 0

• Each of the rectangle’s vertices has a height relative to the terrain (determined by the Elevation parameter).

• HSC_PIVOT_RELATIVE = 1
  The height of the rectangle pivot (the center of the rectangle) is determined by the elevation parameter. Each of the rectangle’s vertices lies on the same plan as the rectangle pivot.

• HSC_ON_TERRAIN = 2
  The rectangle vertices are placed on the terrain.

• HSC_TERRAIN_ABSOLUTE = 3
  Each of the rectangle’s vertices has a height relative to the terrain database vertical datum base ellipsoid.

• GroupID – The Information Tree group in which the rectangle 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 rectangle as it appears in the Information Window. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

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

Return Values:

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

Remarks:

The rectangle is initially created with its orientation aligned with the north. The client can then change its orientation using the SetPosition() method.