CreatePolyline

The CreatePolyline method creates a polyline in the 3D Window.

 

JavaScript
CreatePolyline(       Geometry ,       LineColor ,       AltitudeType ,       GroupID ,       Description )

 

C#
ITerrainPolyline6 CreatePolyline(       IGeometry Geometry = null,       object LineColor = -16711936,       AltitudeTypeCode AltitudeType = AltitudeTypeCode.ATC_ON_TERRAIN,       int GroupID = 0,       string Description = "")

 

C++
HRESULT CreatePolyline(       IGeometry* pIGeometry,       VARIANT LineColor,       AltitudeTypeCode AltitudeType,       LONG_PTR GroupID,       BSTR Description,       ITerrainPolyline6** pITerrainPolyline6)

 

Parameters

Geometry

An IGeometry representing geometric properties of the polyline.

LineColor

The color of the lines that make up the polyline. 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 shape. The following are the possible AltitudeTypeCode values:

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

§  ATC_PIVOT_RELATIVE = 1
Places each point of the polyline at a specified altitude above the pivot point altitude, defined by its Point Altitude. The pivot is located at the center of the polyline. You can use this feature to create horizontal polylines in mountainous terrain.

§  ATC_ON_TERRAIN = 2
Creates the polyline on the terrain itself. This selection also changes the drawing method of the polyline. Instead of straight lines between the polyline’s points, it paints the terrain in the selected color. It is recommended to use this feature to improve performance.

§  ATC_TERRAIN_ABSOLUTE = 3
Places the polyline’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 the polyline 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 polyline as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

Return Value

pITerrainPolyline6

An ITerrainPolyline6, representing the newly created polyline.

Exceptions

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