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

Create3DArrow

The Create3DArrow method creates a 3-dimensional arrow and places it in the 3D Window.

 

JavaScript

 

Create3DArrow(Position, Length, Style, ObjectHeight, LineColor, FillColor, GroupID, Description

 

C#

 

ITerrain3DArrow6 Create3DArrow(

      IPosition6 Position,

      double Length,

      int Style = 4,

      double ObjectHeight = 10,

      object LineColor = -16711936,

      object FillColor = -10197916,

      int GroupID = 0,

      string Description = "")

 

C++

 

HRESULT Create3DArrow(

       IPosition6 *     Position,

       double     Length,

       long       Style,

       double     ObjectHeight,

       VARIANT    LineColor,

       VARIANT    FillColor,

       LONG_PTR   GroupID,

       BSTR       Description,

       ITerrain3DArrow6 **    pITerrain3DArrow6) 

 

Parameters

Position

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

Length

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

Style

The style of the 3-dimensional arrow. Can be one of the following when looking at the arrow from a top-view:
 3d-Arrow-Style-COM 

ObjectHeight

The height of the 3-dimensional arrow in meters.

LineColor

The color of the lines that make up the 3-dimensional 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 3-dimensional 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 3-dimensional arrow is created. If it is set to zero, the arrow 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 3-dimensional 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

pITerrain3DArrow6

An ITerrain3DArrow6 representing the newly created 3-dimensional arrow.

Exceptions

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