Home > Working with SGWorld > Creator (ICreator6) > CreateSphere
The CreateSphere method creates a sphere in the 3D Window.
JavaScript |
|
CreateSphere( Position, Radius, Style , LineColor , FillColor , SegmentDensity , GroupID , Description ) |
C# |
|
ITerrainSphere6 CreateSphere( IPosition6 Position, double Radius, SphereStyle Style = SphereStyle.SPHERE_NORMAL, object LineColor = -16711936, object FillColor = -10197916, int SegmentDensity = -1, int GroupID = 0, string Description = "") |
C++ |
|
HRESULT CreateSphere( IPosition6* Position, double Radius, SphereStyle Style, VARIANT LineColor, VARIANT FillColor, long SegmentDensity, LONG_PTR GroupID, BSTR Description, ITerrainSphere6** pITerrainSphere6) |
Parameters
Position
An IPosition6 representing the position and orientation of the sphere on the terrain.
Radius
The radius of the sphere in meters.
Style
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.
FillColor
The color with which the sphere is filled if the alpha 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.
GroupID
The Project 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 using IProjectTree6.CreateGroup.
§ Find the group, if you know the name, using IProjectTree6.FindItem.
§ Traverse the Tree using IProjectTree6 methods such as GetNextItem(), until you come to the desired GroupID.
Description
The name of the sphere as it appears in the Project Tree. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.
Return Value
pITerrainSphere6
An ITerrainSphere6 representing the newly created sphere.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.