Home > Working with SGWorld > Creator (ICreator6) > CreatePolygon

CreatePolygon

Create a  polygon in the 3D Window.

 

JavaScript

 

CreatePolygon(   

      Geometry,

      LineColor ,

      FillColor ,

      AltitudeType ,

      GroupID ,

      Description )

 

C#

 

ITerrainPolygon6 CreatePolygon(    

      IGeometry         Geometry,

      object            LineColor = -16711936,

      object            FillColor = -10197916,

      AltitudeTypeCode AltitudeType = AltitudeTypeCode.ATC_ON_TERRAIN,

      int               GroupID = 0,

      string            Description = "")

 

C++

 

HRESULT CreatePolygon(

       IGeometry *          Geometry,

       VARIANT              LineColor,

       VARIANT              FillColor,

       AltitudeTypeCode     AltitudeType,

       LONG_PTR             GroupID,

       BSTR                 Description,

       ITerrainPolygon6 **  pITerrainPolygon6 

Parameters

Geometry

An IGeometry representing geometric properties of the polygon.

LineColor

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

AltitudeType

An enum that determines the altitude type to be used by the polygon. The following are the possible AltitudeTypeCode values:

·         ATC_TERRAIN_RELATIVE = 0
Places the polygon’s pivot point at a specified altitude above the ground.

·         ATC_PIVOT_RELATIVE = 1
Places each point of the polygon at a specified altitude above the pivot point altitude, defined by its Point Altitude. The pivot is located at the center of the polygon.

·         ATC_ON_TERRAIN = 2
Creates the polygon on the terrain itself.

·         ATC_TERRAIN_ABSOLUTE = 3
Places the polygon’s pivot point at a specified altitude above the terrain database vertical datum base ellipsoid.

·         ATC_DEFAULT = 999

GroupID

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

Return Value

pITerrainPolygon6

An ITerrainPolygon6, representing the newly created polygon.

Exceptions

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