CreateArrow

Creates a 2-dimensional arrow and places it in the 3D Window.

 

JavaScript
CreateArrow(       Position,       Length,       Style ,       LineColor ,       FillColor ,       GroupID ,         Description )

 

C#
ITerrainArrow6 CreateArrow(       IPosition6 Position,       double Length,       int Style = 4,       object LineColor = -16711936,       object FillColor = -10197916,       int GroupID = 0,       string Description = "")

 

C++
HRESULT CreateArrow(       IPosition6 * Position,       double Length,       long Style,       VARIANT LineColor,       VARIANT FillColor,       LONG_PTR GroupID,       BSTR Description,       ITerrainArrow6 ** pITerrainArrow6)

Parameters

Position

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

Length

The length of the arrow from head to tail in meters.

Style

The style of the arrow. Can be one of the following:
 

LineColor

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

Return Value

pITerrainArrow6

An ITerrainArrow6, representing the newly created arrow.

Exceptions

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

Remarks

At creation time, the elevation parameter indicates the tip of the arrow’s head above the terrain. If the client wants to later change that (via the object’s SetPosition() method), the height is measured from the center of the arrow.