createPyramid Method

Creates a pyramid object on the terrain.

createPyramid(position, width, depth, height, [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

width

The width of the object

depth

The depth of the object

height

The height of the object from top to bottom (not its height above the ground)

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 pyramid, access the node innerObj. See SGNode.innerObj property and ITerrain3DRectBase5 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.