Creates a new arrow object on the terrain.
createArrow(headPosition, direction, length, arrowStyle, [lineColor], [fillColor], [name]);
|
Parameter |
Description |
|
headPosition |
The position of the arrow head Can be one of the following: SGCoord3D, SGCoord2D, SGPosition |
|
direction |
The arrow direction An angle between 0º and 360º, where 0º is North and 180º is South |
|
length |
The arrow length from head to tail |
|
arrowStyle |
The arrow style Can be one of the following: sgArrowStyleLine , sgArrowStyleLineTail, sgArrowStyleWide, sgArrowStyleWideAngular Optional, default: sgArrowStyleWideAngular |
|
lineColor |
Optional. default: sgLime The color of the object outline Can be one of the following: SGColor, HTML color string (e.g., “#FF0000”), a number that represents ABGR color (e.g., 0xAA0000FF) or one of the predefined Skyline Globe colors (e.g., sgRed). For a complete list of the predefined colors, see Skyline Globe Colors |
|
fillColor |
Optional, default: sgDimgray The color of the object filling Can be one of the following: SGColor, HTML color string (e.g., “#FF0000”), a number that represents ABGR color (e.g., 0xAA0000FF) or one of the predefined Skyline Globe colors (e.g., sgRed). For a complete list of the predefined colors, see Skyline Globe Colors |
|
name |
Optional The node name |
Return Value
An SGNode object. If the method fails, the return value is null. SGWorld.lastError will contain the failure reason.
Remarks
To modify other properties of the arrow, access the node innerObj. See SGNode.innerObj property and ITerrainArrow5 interface for more details.
The default arrow is drawn on the terrain surface. To modify this behavior, change the heightType property of the position parameter (SGCoord3D and SGPosition object only). If SGCoord2D is entered as the first parameter, the arrow will be drawn on the terrain surface.