CreatePyramid

Creates a pyramid in the 3D Window.

 

JavaScript

 

CreatePyramid(

       Position,

       ObjectWidth,

       ObjectDepth,

       ObjectHeight,

       LineColor,

       FillColor,

       GroupID,

       Description )

 

C#

 

ITerrain3DRectBase80 CreatePyramid(

       IPosition80 Position,

       double ObjectWidth,

       double ObjectDepth,

       double ObjectHeight,

       object LineColor = -16711936,

       object FillColor = -10197916,

       string GroupID = "",

       string Description = "")

 

C++

 

HRESULT CreatePyramid(

       IPosition80* Position,

       double ObjectWidth,

       double ObjectDepth,

       double ObjectHeight,

       VARIANT LineColor,

       VARIANT FillColor,

       BSTR GroupID,

       BSTR Description,

       ITerrain3DRectBase80** pITerrain3DRectBase80)

 

Parameters

Position

An IPosition80 representing the position and orientation of the pyramid on the terrain.

ObjectWidth

The width of the pyramid in meters.

ObjectDepth

The depth of the pyramid in meters.

ObjectHeight

The height of the pyramid in meters.

LineColor

The color of the lines that make up the pyramid. 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 pyramid, 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 pyramid is created. If it is set to an empty string, the object 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 pyramid as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

Return Value

pITerrain3DRectBase80

An ITerrain3DRectBase80 representing the newly created pyramid.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.