CreateRegularPolygon
Creates a polygon with equal-length segments in the 3D Window.
|
JavaScript |
|
|
CreateRegularPolygon( Position, Radius, NumOfSegments, LineColor, FillColor, GroupID, Description ) |
|
|
C# |
|
|
ITerrainRegularPolygon80 CreateRegularPolygon( IPosition80 Position, double Radius, int NumOfSegments, object LineColor = -16711936, object FillColor = -10197916, string GroupID = "", string Description = "") |
|
|
C++ |
|
|
HRESULT CreateRegularPolygon( IPosition80* Position, double Radius, long NumOfSegments, VARIANT LineColor, VARIANT FillColor, BSTR GroupID, BSTR Description, ITerrainRegularPolygon80** pITerrainRegPolygon80) |
|
Parameters
Position
An IPosition80 representing the position and orientation of the polygon on the terrain.
Radius
The radius of the regular polygon in meters.
NumOfSegments
The number of segments the regular polygon has. The more segments, the smoother and more circular it appears.
LineColor
The color of the lines that make up the regular polygon. The color value is used to specify color and transparency values. This parameter can be any of the following:
· An IColor80 object.
· A number which represents the color in ABGR format (0xAABBGGRR). The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; the third byte contains a value for blue. The high-order byte contains a value for alpha.
· A string that represents HTML color format (“#RRGGBB”).
FillColor
The color which fills the regular polygon, if the alpha value is greater than zero. The color value is used to specify color and transparency values. This parameter can be any of the following:
· An IColor80 object.
· A number which represents the color in ABGR format (0xAABBGGRR). The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; the third byte contains a value for blue. The high-order byte contains a value for alpha.
· A string that represents HTML color format (“#RRGGBB”).
GroupID
The Project Tree group in which the regular polygon is created. If it is set to an empty string, the object is created under the root. You can obtain the GroupID by one of the following methods:
· Create the group using IProjectTree80.CreateGroup.
· Find the group, if you know the name, using IProjectTree80.FindItem.
· Traverse the Tree using IProjectTree80 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
PITerrainRegPolygon80
An ITerrainRegularPolygon80 representing the newly created regular polygon.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.