CreateSphere

The CreateSphere method creates a sphere in the 3D Window.

HRESULT CreateSphere (

[in] double X,

[in] double Y,

[in] double Elevation,

[in] double Radius,

[in, defaultvalue(0)] SphereStyle Style,

[in, defaultvalue(4)] int SegmentDensity,

[in, defaultvalue(0x0000ff00)] long LineColor,

[in, defaultvalue(FT_NONE)] double FillOpacity,

[in, defaultvalue(0x00646464)] long FillColor,

[in, defaultvalue(0)] HeightStyleCode HeightStyle,

[in, defaultvalue(0)] long GroupID,

[in, defaultvalue("")] BSTR Description,

[out, retval] ITerrainSphere5** pITerrainSphere5)

Parameters:

• X – The West-East coordinate of the center of the sphere represented in MPT units. You can use the ITerrain interface to retrieve information about the MPT units. If you are working in Lat-Long format, the Lat-Long values are in decimal Lat-Long.

• Y – The North-South coordinate of the center of the sphere represented in MPT units. You can use the ITerrain interface to retrieve information about the MPT units. If you are working in Lat-Long format, the Lat-Long values are in decimal Lat-Long.

• Elevation – The elevation of the sphere relative to the terrain.

• Radius – The radius of the sphere (in meters).

• SphereStyle – An enum that determines which part of the sphere is visible. The SphereStyle enum has the following values:

• SPHERE_NORMAL = 0
  The entire sphere is visible.

• SPHERE_UPPER_HALF = 1
  The top half is visible.

• SPHERE_LOWER_HALF = 2
  The lower half is visible.

• SPHERE_ UPPER_HALF_BASE = 3
  The upper half, with a base, is visible.

• SPHERE_LOWER_HALF_BASE = 4
  The lower half, with a base, is visible.

• SegmentDensity – Determines the density of the mesh that composes the sphere. The density can be any number between 1 and 10, with 4 being the default.

• LineColor – The color of the lines that make up the sphere. The color value is used to specify an RGB color. When specifying an explicit RGB color, the color value has the following hexadecimal form: 0x00bbggrr. The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; and the third byte contains a value for blue. The high-order byte must be zero. The maximum value for a single byte is 0xFF.

• FillOpacity – Determines the opacity or transparency of the fill of the sphere. This value can be any value between 0, for transparent, and 1 for opaque.

• FillColor – The color with which the sphere is filled if the FillOpacity value is greater than 0. The color value is used to specify an RGB color. When specifying an explicit RGB color, the color value has the following hexadecimal form: 0x00bbggrr. The low-order byte contains a value for the relative intensity of red; the second byte contains a value for green; and the third byte contains a value for blue. The high-order byte must be zero. The maximum value for a single byte is 0xFF.

• HeightStyle – An enum determining how the sphere is placed on the terrain.

The HeightStyleCode enum can use any of the following values:

• HSC_TERRAIN_RELATIVE = 0
  The height above the terrain of the sphere’s pivot (its lowest point), is determined by the Elevation parameter.

• HSC_TERRAIN_ABSOLUTE = 3
  The height relative to the terrain database vertical datum base ellipsoid of the box’s pivot (its lowest point), is determined by the Elevation parameter.

• GroupID – The Information Tree group in which the sphere is created. If it is set to zero, the object is created under the root. You can obtain the GroupID by one of the following methods:

• Create the group the IInformationTree5::CreateGroup.

• If you know the name of the group, find it using IInformationTree5::FindItem.

• Traverse the Tree using IInformationTree5 methods such as GetNextItem, until you come to the desired GroupID.

• Description – The name of the sphere as it appears in the Information Window. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

• pITerrainSphere5 – An interface pointer to the newly created sphere. This parameter must not be Null.

Return Values:

The return value obtained from the returned HRESULT can be one of the following: