CreateCylinder

The CreateCylinder method creates a cylinder in the 3D Window.

 

JavaScript
CreateCylinder(       Position,       Radius,       ObjectHeight ,       LineColor ,       FillColor ,       NumOfSegments ,       GroupID ,       Description )

 

C#
ITerrain3DRegBase6 CreateCylinder(       IPosition6 Position,       double Radius,       double ObjectHeight = 20,       object LineColor = -16711936,       object FillColor = -10197916,       int    NumOfSegments = -1,       int    GroupID = 0,       string Description = "")

 

C++

HRESULT CreateCylinder(        IPosition6 *           Position,        double                 Radius,        double                 ObjectHeight,        VARIANT                LineColor,        VARIANT                FillColor,        long                   NumOfSegments,        LONG_PTR               GroupID,        BSTR                   Description,        ITerrain3DRegBase6 **  pITerrain3DRegBase6 )

Parameters

Position

An IPosition6 representing the position and orientation of the object on the terrain.

Radius

The radius of the cylinder in meters.

ObjectHeight

The height of the cylinder in meters.

NumOfSegments

The number of segments the cylinder has. The more segments, the smoother and more circular it appears.

LineColor

The color of the lines that make up the cylinder. 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 cylinder 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 cylinder 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 cylinder as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

Return Value

pITerrain3DRegBase6

An ITerrain3DRegBase6, representing the newly created cylinder.

Exceptions

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