Creates a new circle object on the terrain.
createCircle(position, radius, [lineColor], [fillColor], [name]);
|
Parameter |
Description |
|
position |
The position of the object, defined by its coordinates in the 3D world Can be one of the following: SGCoord3D, SGCoord2D, SGPosition |
|
radius |
The radius of the circle |
|
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 circle, access the node innerObj. See SGNode.innerObj property and ITerrainRegularPolygon5 interface for more details.
The default circle 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 circle will be drawn on the terrain surface.