com.esri.arcgis.globecore
Interface IGlobe

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGlobe2
All Known Implementing Classes:
Globe

public interface IGlobe
extends Serializable

Provides access to members that control the globe.

Superseded By

IGlobe2

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addLayerType(ILayer pLayer, int layerType, boolean autoArrange)
          Add layer to globe as specified type.
 void getDefaultBackgTransitionDistances(float[] pLowAltitute, float[] pHighAltitude)
          The altitude values in kilometers for the transition in the background color.
 int getDefaultGlobeBackgroundOption()
          The default background option.
 void getDefaultHighBackgroundColor(float[] red, float[] green, float[] blue)
          The default high altitude background color.
 void getDefaultLowBackgroundColor(float[] red, float[] green, float[] blue)
          The default low altitude background color.
 IGlobeDisplay getGlobeDisplay()
          The globe display.
 IEnumLayer getGlobeLayers(IUID pUid, boolean bRecursive, boolean bInBaseGlobe, boolean bSortedByDrawingPriority)
          The globe layers by UID and internal grouping.
 int getGlobeUnits()
          The linear units used in the globe.
 int getShowGlobeTips()
          Show globe tips.
 void setDefaultBackgTransitionDistances(float lowAltitute, float highAltitude)
          The altitude values in kilometers for the transition in the background color.
 void setDefaultGlobeBackgroundOption(int pOption)
          The default background option.
 void setDefaultHighBackgroundColor(float red, float green, float blue)
          The default high altitude background color.
 void setDefaultLowBackgroundColor(float red, float green, float blue)
          The default low altitude background color.
 void setGlobeUnits(int pUnits)
          The linear units used in the globe.
 void setShowGlobeTips(int pTipsType)
          Show globe tips.
 

Method Detail

getGlobeLayers

IEnumLayer getGlobeLayers(IUID pUid,
                          boolean bRecursive,
                          boolean bInBaseGlobe,
                          boolean bSortedByDrawingPriority)
                          throws IOException,
                                 AutomationException
The globe layers by UID and internal grouping.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pUid - A reference to a com.esri.arcgis.system.IUID (in)
bRecursive - The bRecursive (in)
bInBaseGlobe - The bInBaseGlobe (in)
bSortedByDrawingPriority - The bSortedByDrawingPriority (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeDisplay

IGlobeDisplay getGlobeDisplay()
                              throws IOException,
                                     AutomationException
The globe display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.globecore.IGlobeDisplay
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultGlobeBackgroundOption

int getDefaultGlobeBackgroundOption()
                                    throws IOException,
                                           AutomationException
The default background option.

Description

Controls whether the background sky color is based on a transition between two colors assigned to observer altitude or is a constant single color.

The esriGlobeBackgroundOption enumeration provides the definition for the two options available. These are esriGlobeBackgroundTransition, the default, and esriGlobeBackgroundSingle.

When using esriGlobeBackgroundTransition consider the related IGlobe interface members to set or get the background colors and transition distances.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultGlobeBackgroundOption

void setDefaultGlobeBackgroundOption(int pOption)
                                     throws IOException,
                                            AutomationException
The default background option.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pOption - A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultHighBackgroundColor

void setDefaultHighBackgroundColor(float red,
                                   float green,
                                   float blue)
                                   throws IOException,
                                          AutomationException
The default high altitude background color.

Description

Sets the default RGB color of the display background, or sky, when the observer is at high altitude.

RGB values are floating point between 0 and 1 inclusive.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
red - The red (in)
green - The green (in)
blue - The blue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultHighBackgroundColor

void getDefaultHighBackgroundColor(float[] red,
                                   float[] green,
                                   float[] blue)
                                   throws IOException,
                                          AutomationException
The default high altitude background color.

Description

Returns the default RGB color of the display background, or sky, when the observer is at high altitude.

RGB values are floating point between 0 and 1 inclusive.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
red - The red (out: use single element array)
green - The green (out: use single element array)
blue - The blue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultLowBackgroundColor

void setDefaultLowBackgroundColor(float red,
                                  float green,
                                  float blue)
                                  throws IOException,
                                         AutomationException
The default low altitude background color.

Description

Sets the default RGB color of the display background, or sky, when the observer is at low altitude.

RGB values are floating point between 0 and 1 inclusive.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
red - The red (in)
green - The green (in)
blue - The blue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultLowBackgroundColor

void getDefaultLowBackgroundColor(float[] red,
                                  float[] green,
                                  float[] blue)
                                  throws IOException,
                                         AutomationException
The default low altitude background color.

Description

Returns the default RGB color of the display background, or sky, when the observer is at low altitude.

RGB values are floating point between 0 and 1 inclusive.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
red - The red (out: use single element array)
green - The green (out: use single element array)
blue - The blue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultBackgTransitionDistances

void setDefaultBackgTransitionDistances(float lowAltitute,
                                        float highAltitude)
                                        throws IOException,
                                               AutomationException
The altitude values in kilometers for the transition in the background color.

Description

Sets the high and low transition distances for changing between background sky colors. These represent the altitude of the virtual camera.

Values are in kilometers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
lowAltitute - The lowAltitute (in)
highAltitude - The highAltitude (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultBackgTransitionDistances

void getDefaultBackgTransitionDistances(float[] pLowAltitute,
                                        float[] pHighAltitude)
                                        throws IOException,
                                               AutomationException
The altitude values in kilometers for the transition in the background color.

Description

Returns the high and low transition distances for changing between background sky colors. These represent the altitude of the virtual camera.

Values are in kilometers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pLowAltitute - The pLowAltitute (out: use single element array)
pHighAltitude - The pHighAltitude (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobeUnits

void setGlobeUnits(int pUnits)
                   throws IOException,
                          AutomationException
The linear units used in the globe.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pUnits - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeUnits

int getGlobeUnits()
                  throws IOException,
                         AutomationException
The linear units used in the globe.

Description

GlobeUnits are the measurement units used when reporting the distance of the virtual camera from the globe surface (in the lower right hand side of the status bar) and the distance of the Measure tool.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayerType

void addLayerType(ILayer pLayer,
                  int layerType,
                  boolean autoArrange)
                  throws IOException,
                         AutomationException
Add layer to globe as specified type.

Description

Adds a layer to the globe. The type of layer is specified by esriGlobeLayerType. This determines how the layer will be used in the globe document: as globe surface elevation, as a draped layer, or as a floating layer.

The autoArrange parameter controls the ordering of the layers. If autoArrange is set to TRUE, the layer is added in the proper position as by its weight specified via ILayerPosition::LayerWeight. By default, this means that the layers are sorted by layer type - Annotation layers on top, followed by Point geometry layers, Polyline geometry layers, and at the bottom Polygon geometry layers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
layerType - A com.esri.arcgis.globecore.esriGlobeLayerType constant (in)
autoArrange - The autoArrange (in, optional, pass false if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowGlobeTips

void setShowGlobeTips(int pTipsType)
                      throws IOException,
                             AutomationException
Show globe tips.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pTipsType - A com.esri.arcgis.globecore.esriGlobeTipsType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShowGlobeTips

int getShowGlobeTips()
                     throws IOException,
                            AutomationException
Show globe tips.

Description

Used to indicate whether or not globe tips are used, and if so, what type of tips. The option is given by the esriGlobeTipTypes enumeration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.globecore.esriGlobeTipsType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.