Create3DArrow
Creates a 3-dimensional arrow and places it in the 3D Window.
JavaScript |
|
Create3DArrow( Position, Length, Style, ObjectHeight, LineColor, FillColor, GroupID, Description |
C# |
|
ITerrain3DArrow80 Create3DArrow( IPosition80 Position, double Length, int Style = 4, double ObjectHeight = 10, object LineColor = -16711936, object FillColor = -10197916, string GroupID = "", string Description = "") |
C++ |
|
HRESULT Create3DArrow( IPosition80 * Position, double Length, long Style, double ObjectHeight, VARIANT LineColor, VARIANT FillColor, BSTR GroupID, BSTR Description, ITerrain3DArrow80 ** pITerrain3DArrow80) |
Parameters
Position
An IPosition80 representing the 3D arrow’s head position and the 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:
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 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 3-dimensional arrow, 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 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 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 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
pITerrain3DArrow80
An ITerrain3DArrow80 representing the newly created 3-dimensional arrow.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.