CreateCircle

CreateCircle creates a circle in the 3D Window.

 

JavaScript
CreateCircle(       Position,       Radius,       LineColor ,       FillColor ,       GroupID ,       Description )

 

C#
ITerrainRegularPolygon6 CreateCircle(       IPosition6   Position,       double       Radius,       object       LineColor = -16711936,       object       FillColor = -10197916,       int          GroupID = 0,       string       Description = "")

 

C++
HRESULT CreateCircle(        IPosition6* Position,        double Radius,        VARIANT LineColor,        VARIANT FillColor,        LONG_PTR GroupID,        BSTR Description,        ITerrainRegularPolygon6** pITerrainRegPolygon6)

Parameters

Position

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

Radius

The radius of the object in meters.

LineColor

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

Return Value

PITerrainRegularPolygon6

An ITerrainRegularPolygon6, representing the newly created regular polygon.

Remarks:

The CreateCircle() method is essentially the same as CreateRegularPolygon(). The only difference between the two is the fact that the CreateCircle() method has 12 segments as its default number of segments.

Exceptions

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