com.esri.arcgis.globecore
Interface IGlobeDisplay

All Superinterfaces:
IViewers3D, Serializable
All Known Subinterfaces:
IGlobeDisplay2, IGlobeDisplay3
All Known Implementing Classes:
GlobeDisplay

public interface IGlobeDisplay
extends IViewers3D, Serializable

Provides access to members that manipulate the globe display.

Superseded By

IGlobeDisplay3

Description

IGlobeDisplay interface provides access to members that control the Globe. IGlobeDisplay interface has the following non-inherited properties and methods:

AdvancedOptions property to access the globe’s data processing and management options, CacheUsage (CachePath, bUpdate ) – current disk cache usage (in Mbytes) for the specified path, CachePath - a true value to the argument bUpdate will update the CacheUsage, EnableMessages – indicates if warning messages and questions related to refreshing a layer or displaying vector data should be enabled, Globe – a container for display and manuiplation of data, ImmediateDataFetching – indicates if pending requests for tiles should complete before navigation, SelectionColor – the selction color selected features show with.

Clear(bRecycleBasicObjects) a method to stop all pending requests for tile fetches - a false value to bRecycleBasicObjects will stop the loading thread in addition, GetSurfaceElevation - finds the elevation (including the highest resolution, if specified) of the surface at the given longitude and latitude, GetSurfacePoint -returns a point given the x and y position (in local coordinates) of the viewer. In addition, the methods Locate, LocateFeature, LocateMultiple and LocateLayers all return a set of objects hit by the line of sight from the observer location within the window coordinates of xView and yView in the viewer pViewer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void clear(boolean bRecycleBasicObjects)
          Clear the display objects.
 IGlobeAdvancedOptions getAdvancedOptions()
          The data processing and management options.
 double getCacheUsage(String cachePath, boolean bUpdate)
          The disk cache usage in Mb (will return the current one if path is empty string).
 IGlobe getGlobe()
          The globe container.
 IColor getSelectionColor()
          The selection color.
 void getSurfaceElevation(double longitude, double latitude, boolean bGetMaxResolution, double[] pElevationInMeters)
          Find the elevation of a point in the given geographical location.
 void getSurfacePoint(double xView, double yView, int internalGlobe, IPoint[] ppIntersec)
          Locate a point in the position x,y within the view (x and y in the interval 0-1).
 boolean isEnableMessages()
          Indicates if the warning and question messages are enabled.
 boolean isImmediateDataFetching()
          Indicates whether in immediate data fetching mode.
 void locate(ISceneViewer pViewer, int xView, int yView, boolean bGetTransformed, boolean bGetEmptyGlobe, IPoint[] ppPoint, Object[] ppOwner, Object[] ppObject)
          Find the object and location in the line of sight.
 void locateFeature(ISceneViewer pViewer, int xView, int yView, Object[] ppOwner, Object[] ppObject)
          Find the object and location in the line of sight.
 void locateLayers(ISceneViewer pViewer, int xView, int yView, IEnumLayer pLayers, boolean bGetLocation, boolean bGetTransformed, boolean bGetEmptyGlobe, boolean bFeaturesOnly, boolean bTopMost, IHit3DSet[] ppHits, ITrackCancel pTrackCancel)
          Find the object and location in the line of sight.
 void locateMultiple(ISceneViewer pViewer, int xView, int yView, boolean bGetLocation, boolean bGetTransformed, boolean bGetEmptyGlobe, boolean bFeaturesOnly, IHit3DSet[] ppHits)
          Find the object and location in the line of sight.
 void refreshTextureObjects()
          Deletes all the textures to force them to reload.
 void setAdvancedOptions(IGlobeAdvancedOptions ppOptions)
          The data processing and management options.
 void setEnableMessages(boolean pbEnableMessages)
          Indicates if the warning and question messages are enabled.
 void setGlobeByRef(IGlobe ppGlobe)
          The globe container.
 void setImmediateDataFetching(boolean pbImmediate)
          Indicates whether in immediate data fetching mode.
 void setSelectionColor(IColor pSelectionColor)
          The selection color.
 void startPrintingExporting(double cullArea)
          Start exporting/printing with an extending cull area.
 void stopPrintingExporting()
          Stop Exporting/printing with extending culling area-- restore defaults.
 
Methods inherited from interface com.esri.arcgis.analyst3d.IViewers3D
findViewer, getActiveViewer, getAllViewers, getBackgroundColor, getScene, isGestureEnabled, isNavigating, refreshViewers, registerViewer, replayFrame, setActiveViewerByRef, setBackgroundColor, setGestureEnabled, setIsNavigating, setSceneByRef, unregisterViewer
 

Method Detail

getGlobe

IGlobe getGlobe()
                throws IOException,
                       AutomationException
The globe container.

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.IGlobe
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobeByRef

void setGlobeByRef(IGlobe ppGlobe)
                   throws IOException,
                          AutomationException
The globe container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppGlobe - A reference to a com.esri.arcgis.globecore.IGlobe (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

void clear(boolean bRecycleBasicObjects)
           throws IOException,
                  AutomationException
Clear the display objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSurfacePoint

void getSurfacePoint(double xView,
                     double yView,
                     int internalGlobe,
                     IPoint[] ppIntersec)
                     throws IOException,
                            AutomationException
Locate a point in the position x,y within the view (x and y in the interval 0-1).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
xView - The xView (in)
yView - The yView (in)
internalGlobe - The internalGlobe (in)
ppIntersec - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSurfaceElevation

void getSurfaceElevation(double longitude,
                         double latitude,
                         boolean bGetMaxResolution,
                         double[] pElevationInMeters)
                         throws IOException,
                                AutomationException
Find the elevation of a point in the given geographical location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
longitude - The longitude (in)
latitude - The latitude (in)
bGetMaxResolution - The bGetMaxResolution (in)
pElevationInMeters - The pElevationInMeters (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionColor

void setSelectionColor(IColor pSelectionColor)
                       throws IOException,
                              AutomationException
The selection color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pSelectionColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionColor

IColor getSelectionColor()
                         throws IOException,
                                AutomationException
The selection color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setAdvancedOptions

void setAdvancedOptions(IGlobeAdvancedOptions ppOptions)
                        throws IOException,
                               AutomationException
The data processing and management options.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppOptions - A reference to a com.esri.arcgis.globecore.IGlobeAdvancedOptions (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAdvancedOptions

IGlobeAdvancedOptions getAdvancedOptions()
                                         throws IOException,
                                                AutomationException
The data processing and management options.

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.IGlobeAdvancedOptions
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImmediateDataFetching

void setImmediateDataFetching(boolean pbImmediate)
                              throws IOException,
                                     AutomationException
Indicates whether in immediate data fetching mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isImmediateDataFetching

boolean isImmediateDataFetching()
                                throws IOException,
                                       AutomationException
Indicates whether in immediate data fetching mode.

Remarks

A True value indicates that pending requests for tiles should complete before navigation can proceed.The default value is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pbImmediate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheUsage

double getCacheUsage(String cachePath,
                     boolean bUpdate)
                     throws IOException,
                            AutomationException
The disk cache usage in Mb (will return the current one if path is empty string).

Product Availability

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

Parameters:
cachePath - The cachePath (in)
bUpdate - The bUpdate (in)
Returns:
The pCacheUsageInMb
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnableMessages

boolean isEnableMessages()
                         throws IOException,
                                AutomationException
Indicates if the warning and question messages are enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pbEnableMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnableMessages

void setEnableMessages(boolean pbEnableMessages)
                       throws IOException,
                              AutomationException
Indicates if the warning and question messages are enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

refreshTextureObjects

void refreshTextureObjects()
                           throws IOException,
                                  AutomationException
Deletes all the textures to force them to reload.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startPrintingExporting

void startPrintingExporting(double cullArea)
                            throws IOException,
                                   AutomationException
Start exporting/printing with an extending cull area.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

stopPrintingExporting

void stopPrintingExporting()
                           throws IOException,
                                  AutomationException
Stop Exporting/printing with extending culling area-- restore defaults.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locate

void locate(ISceneViewer pViewer,
            int xView,
            int yView,
            boolean bGetTransformed,
            boolean bGetEmptyGlobe,
            IPoint[] ppPoint,
            Object[] ppOwner,
            Object[] ppObject)
            throws IOException,
                   AutomationException
Find the object and location in the line of sight.

Description

This method returns the closest object (ppObject) hit by the line of sight from the observer location in the window coordinates xView, yView in the viewer, pViewer.

ppPoint is a point representing the hit location coordinates.


If bGetTransformed is True, it indicates that the returned coordinates must be in the internal geocentric coordinate system. If bGetTransformed = False, the returned hit point coordinates are in the Globe Spatial Reference: longitude, latitude and altitude are in kilometers.


If bGetEmptyGlobe is True, a hit will be added for the base globe surface, even if it doesn't contain any layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)
xView - The xView (in)
yView - The yView (in)
bGetTransformed - The bGetTransformed (in)
bGetEmptyGlobe - The bGetEmptyGlobe (in)
ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
ppOwner - A reference to another Object (IUnknown) (out: use single element array)
ppObject - A reference to another Object (IUnknown) (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateMultiple

void locateMultiple(ISceneViewer pViewer,
                    int xView,
                    int yView,
                    boolean bGetLocation,
                    boolean bGetTransformed,
                    boolean bGetEmptyGlobe,
                    boolean bFeaturesOnly,
                    IHit3DSet[] ppHits)
                    throws IOException,
                           AutomationException
Find the object and location in the line of sight.

Description

This method returns a set of objects (ppHits) hit by the line of sight from the observer location and the window coordinates xView, yView in pViewer.

If bGetLocation = True, it indicates that the hit point coordinates must be returned.
If both bGetLocation and bGetTransformed are True, it indicates that the returned coordinates must be in the internal geocentric coordinate system. If bGetTransformed = False, the returned hit point coordinates are in the Globe Spatial Reference: longitude, latitude and altitude in kilometers.
If bGetEmptyGlobe is True, a hit will be added for the base globe surface, even if it doesn't contain any layer.
If bFeaturesOnly is True, only hits to features will be returned (hits to elevation surfaces will not).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)
xView - The xView (in)
yView - The yView (in)
bGetLocation - The bGetLocation (in)
bGetTransformed - The bGetTransformed (in)
bGetEmptyGlobe - The bGetEmptyGlobe (in)
bFeaturesOnly - The bFeaturesOnly (in)
ppHits - A reference to a com.esri.arcgis.analyst3d.IHit3DSet (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateLayers

void locateLayers(ISceneViewer pViewer,
                  int xView,
                  int yView,
                  IEnumLayer pLayers,
                  boolean bGetLocation,
                  boolean bGetTransformed,
                  boolean bGetEmptyGlobe,
                  boolean bFeaturesOnly,
                  boolean bTopMost,
                  IHit3DSet[] ppHits,
                  ITrackCancel pTrackCancel)
                  throws IOException,
                         AutomationException
Find the object and location in the line of sight.

Description

This method returns a set of objects (ppHits) hit by the line of sight from the observer location in the window coordinates xView, yView in pViewer. It will return hits only in the layer pLayers.

If bGetLocation is True, it indicates that the hit point coordinates must be returned.
If both bGetLocation and bGetTransformed are True, it indicates that the returned coordinates must be in the internal geocentric coordinate system. If bGetTransformed = False, the returned hit point coordinates are in the Globe Spatial Reference: longitude, latitude and altitude in kilometers.
If bGetEmptyGlobe is True, a hit will be added for the base globe surface, even if it doesn't contain any layer.

If bTopMost is True, it will return only one hit to the topmost layer.
If bFeaturesOnly is True, only hits to features will be returned (hits to elevation surfaces will not).

pTrackCancel allows the user to cancel the method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)
xView - The xView (in)
yView - The yView (in)
pLayers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)
bGetLocation - The bGetLocation (in)
bGetTransformed - The bGetTransformed (in)
bGetEmptyGlobe - The bGetEmptyGlobe (in)
bFeaturesOnly - The bFeaturesOnly (in)
bTopMost - The bTopMost (in)
ppHits - A reference to a com.esri.arcgis.analyst3d.IHit3DSet (out: use single element array)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateFeature

void locateFeature(ISceneViewer pViewer,
                   int xView,
                   int yView,
                   Object[] ppOwner,
                   Object[] ppObject)
                   throws IOException,
                          AutomationException
Find the object and location in the line of sight.

Description

This method returns a hit to the closest feature (ppObject), hit by the line of sight from the observer location in the window coordinates xView, yView in the viewer, pViewer.

ppOwner is the layer hit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)
xView - The xView (in)
yView - The yView (in)
ppOwner - A reference to another Object (IUnknown) (out: use single element array)
ppObject - A reference to another Object (IUnknown) (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.