ITerrainSphere

This interface gives the client access to the sphere object.

 

 

Properties

 

Action

An IAction representing the operation that takes place when the object is clicked in the Project Tree.

Attachment

An IAttachment representing the attachment behavior of the sphere.

FillStyle

An IFillStyle representing the fill color and texture of the sphere.

ID

Gets the ID of the sphere. (Inherited from ITerraExplorerObject)

LineStyle

An ILineStyle representing the style of the sphere outline.

Message

An IMessageObject representing the message object assigned to the sphere object.

ObjectType

Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject)

Position

An IPosition representing the position and orientation of the sphere on the terrain.

Radius

Gets and sets the radius of the sphere, in the units set by ISGWorld.SetOptionParam.

SaveInFlyFile

Gets and sets a Boolean that determines whether the sphere is saved in the Fly file. (Inherited from ITerraExplorerObject)

SegmentDensity

Gets and sets the density of the sphere’s mesh.

Style

Gets and sets which part of the sphere is visible.

Terrain

An ITerrainObject representing terrain properties including draw order and ground object status.

Timespan

An ITimeSpan representing the timespan in which the sphere is visible on the terrain.

Tooltip

An ITooltip representing the tooltip that displays when a mouse cursor is placed over the sphere in the 3D Window.

TreeItem

An ITreeItem describing the representation of the sphere in the Project Tree.

Visibility

An IVisibility representing the visibility of the sphere at different distances.

 

Methods

 

GetClientData

Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject)

GetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject)

SetClientData

Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject)

SetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject)

Radius

Gets and sets the radius of the sphere, in the units set by ISGWorld.SetOptionParam.

 

JavaScript

 

 

 

Radius

 

C#

 

 

 

double Radius { get; set; }

 

C++

 

 

 

HRESULT Radius([out, retval] double* pVal)

HRESULT Radius([in] double pVal)

SegmentDensity

Gets and sets the density of the sphere’s mesh. The density can be any number between 1 and 10, with 4 being the default. The higher this number is the denser the mesh. A sphere with higher density has a higher visual quality but is more expensive to render.

 

JavaScript

 

 

 

SegmentDensity

 

C#

 

 

 

int SegmentDensity { get; set; }

 

C++

 

 

 

HRESULT SegmentDensity([out, retval] long* pVal)

HRESULT SegmentDensity([in] long pVal)

Style

Gets and sets which part of the sphere is visible. The Style can have any of 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.

 

JavaScript

 

 

 

Style

 

C#

 

 

 

int Style { get; set; }

 

C++

 

 

 

 

HRESULT Style([out, retval] long* pVal)

HRESULT Style([in] long pVal)