Creates a new sphere object on the terrain.
createSphere(position, radius, [sphereStyle], [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 sphere radius |
sphereStyle |
Optional, default: sgSphereStyleNormal Can be one of the following: sgSphereStyleNormal, sgSphereStyleUpperHalf, sgSphereStyleUpperHalfWithBase, sgSphereStyleLowerHalf, sgSphereStyleLowerHalfWithBase |
lineColor |
Optional, default: sgLime It 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 sphere, access the node innerObj. See SGNode.innerObj property and ITerrainSphere5 interface for more details.
Unlike a 2D object (e.g., rectangle), a 3D object has volume and cannot be drawn on the terrain surface. Therefore, if specifying the position of a 3D object using SGCoord2D, its height will be set to 0 and its height type will we set to sgHeightRelative.