CreateBox

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

 

JavaScript
CreateBox(       Position,       ObjectWidth,       ObjectDepth,       ObjectHeight,       LineColor ,       FillColor ,       GroupID ,       Description )

 

C#
ITerrain3DRectBase6 CreateBox(       IPosition6 Position,       double    ObjectWidth,       double    ObjectDepth,       double    ObjectHeight,       object    LineColor = -16711936,       object    FillColor = -10197916,       int       GroupID = 0,       string    Description = "")

 

C++

HRESULT CreateBox(       IPosition6 *           Position,       double                 ObjectWidth,       double                 ObjectDepth,       double                 ObjectHeight,       VARIANT                LineColor,       VARIANT                FillColor,       LONG_PTR               GroupID,       BSTR                   Description,       ITerrain3DRectBase6 **      pITerrain3DRectBase6 )

Parameters

Position

An IPosition6 representing the position and orientation of the object on 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.

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.

FillColor

The color with which the box is filled if the alpha 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.

GroupID

The Project 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 using IProjectTree6.CreateGroup.

§  Find the group, if you know the name, using IProjectTree6.FindItem.

§  Traverse the Tree using IProjectTree6 methods such as GetNextItem(), until you come to the desired GroupID.

Description

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

Return Value

pITerrain3DRectBase6

An ITerrain3DRectBase6, representing the newly created box.

Exceptions

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