CreateEllipse

The CreateEllipse method creates an ellipse in the 3D Window.

 

JavaScript
CreateEllipse(       Position,       RadiusX,       RadiusY,       LineColor ,       FillColor ,       NumOfSegments ,       GroupID ,       Description )

 

C#
ITerrainEllipse6 CreateEllipse(       IPosition6 Position,       double   RadiusX,       double   RadiusY,       object   LineColor = -16711936,       object   FillColor = -10197916,       int      NumOfSegments = -1,       int      GroupID = 0,       string   Description = "")

 

C++
HRESULT CreateEllipse(        IPosition6 *          Position,        double                RadiusX,        double                RadiusY,        VARIANT               LineColor,        VARIANT               FillColor,        long                  NumOfSegments,        LONG_PTR              GroupID,        BSTR                  Description,        ITerrainEllipse6 **   pITerrainEllipse6)

 

Parameters

Position

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

RadiusX

The radius of the ellipse along the x-axis in meters.

RadiusY

The radius of the ellipse along the y-axis in meters.

LineColor

The color of the lines that make up the ellipse. 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 ellipse 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.

NumOfSegments

The number of segments the ellipse has. The more segments, the smoother it appears.

GroupID

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

Return Value

pITerrainEllipse6

An ITerrainEllipse6, representing the newly created ellipse.

Exceptions

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