com.esri.arcgis.globecore
Interface IGlobeDisplay3

All Superinterfaces:

IGlobeDisplay, IGlobeDisplay2, IViewers3D, Serializable

All Known Implementing Classes:

GlobeDisplay

public interface IGlobeDisplay3
extends IGlobeDisplay2, Serializable

Provides access to members that manipulate the globe display.

When To Use

The only additional property available on IGlobeDisplay3 that is NOT on IGlobeDisplay or IGlobeDisplay2 is the DraftMode property, which allows you to increase rendering performance in your 3D globe view without invalidating your caches.

Product Availability

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

Method Summary

boolean	isDirectOpenGLDraw() Indicates if the direct OpenGL draw mode is active.
boolean	isDraftMode() Indicates if the draft display mode is active.
boolean	isFetchingSuspendedWhenNavigating() Indicates if tile fetching is disabled while navigating.
void	locateLayersEx(ISceneViewer pViewer, int xView, int yView, int searchTolPixels, 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 with a tolerance.
void	pickGraphic(ISceneViewer pViewer, int xView, int yView, IGraphicsContainer3D[] owner, int[] elementIndex) Picks a single graphic element.
void	queryLocation(ISceneViewer pViewer, int x, int y, int mode, boolean bGetTransformed, IPoint pPt) Locates a single object.
void	setDirectOpenGLDraw(boolean pbDirectMode) Indicates if the direct OpenGL draw mode is active.
void	setDraftMode(boolean pbDraft) Indicates if the draft display mode is active.
void	setIsFetchingSuspendedWhenNavigating(boolean bSuspended) Indicates if tile fetching is disabled while navigating.

Methods inherited from interface com.esri.arcgis.globecore.IGlobeDisplay2

isPauseCaching, isPauseFetching, setPauseCaching, setPauseFetching

Methods inherited from interface com.esri.arcgis.globecore.IGlobeDisplay

clear, getAdvancedOptions, getCacheUsage, getGlobe, getSelectionColor, getSurfaceElevation, getSurfacePoint, isEnableMessages, isImmediateDataFetching, locate, locateFeature, locateLayers, locateMultiple, refreshTextureObjects, setAdvancedOptions, setEnableMessages, setGlobeByRef, setImmediateDataFetching, setSelectionColor, startPrintingExporting, stopPrintingExporting

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

locateLayersEx

void locateLayersEx(ISceneViewer pViewer,
                    int xView,
                    int yView,
                    int searchTolPixels,
                    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 with a tolerance.

Product Availability

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

Parameters:

pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

xView - The xView (in)

yView - The yView (in)

searchTolPixels - The searchTolPixels (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.

queryLocation

void queryLocation(ISceneViewer pViewer,
                   int x,
                   int y,
                   int mode,
                   boolean bGetTransformed,
                   IPoint pPt)
                   throws IOException,
                          AutomationException

Locates a single object.

Product Availability

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

Parameters:

pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

x - The x (in)

y - The y (in)

mode - A com.esri.arcgis.analyst3d.esriScenePickMode constant (in)

bGetTransformed - The bGetTransformed (in)

pPt - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDraftMode

boolean isDraftMode()
                    throws IOException,
                           AutomationException

Indicates if the draft display mode is active.

Description

When the DraftMode property is set to True, a number of settings are applied to the layers in the view in an attempt to improve rendering speed.

The DraftMode settings operate as overrides. That is, they do not actually change layer properties, but rather apply themselves after the layer is read. The increase in rendering speed will be a factor of the layer types and symbology used in the view, and will vary greatly from document to document.

The DraftMode overrides are:

• Reducing the Level Of Detail for images and elevation layers.
• Disabling 3D marker symbols.
• Disabling 3D object textures.
• Disabling vector line densification.
• Drawing a fraction of features.

Remarks

• None of the DraftMode overrides will invalidate the cache.
• The DraftMode property is saved with a 3dd file and is not persisted in the normal.
• Not all layer types have DraftMode overrides and will therefore not be effected by the setting.
• A subset of the DraftMode overrides can be used by changing the DraftMode registry settings in HKEY_CURRENT_USER\Software\ESRI\ArcGlobe\Settings.

Product Availability

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

Returns:

The pbDraft

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDraftMode

void setDraftMode(boolean pbDraft)
                  throws IOException,
                         AutomationException

Indicates if the draft display mode is active.

Product Availability

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

Parameters:

pbDraft - The pbDraft (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirectOpenGLDraw

boolean isDirectOpenGLDraw()
                           throws IOException,
                                  AutomationException

Indicates if the direct OpenGL draw mode is active.

Product Availability

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

Returns:

The pbDirectMode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectOpenGLDraw

void setDirectOpenGLDraw(boolean pbDirectMode)
                         throws IOException,
                                AutomationException

Indicates if the direct OpenGL draw mode is active.

Product Availability

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

Parameters:

pbDirectMode - The pbDirectMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pickGraphic

void pickGraphic(ISceneViewer pViewer,
                 int xView,
                 int yView,
                 IGraphicsContainer3D[] owner,
                 int[] elementIndex)
                 throws IOException,
                        AutomationException

Picks a single graphic element.

Product Availability

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

Parameters:

pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

xView - The xView (in)

yView - The yView (in)

owner - A reference to a com.esri.arcgis.analyst3d.IGraphicsContainer3D (out: use single element array)

elementIndex - The elementIndex (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFetchingSuspendedWhenNavigating

boolean isFetchingSuspendedWhenNavigating()
                                          throws IOException,
                                                 AutomationException

Indicates if tile fetching is disabled while navigating.

Description

ArcGlobe uses two threads – one for display and one for fetching tiles. When this option is set to True, the tile fetching thread is completely suspended while navigating, thereby freeing up hardware resources for the display thread. When navigation halts, the tile fetching thread is re-enabled and ArcGlobe will use the appropriate level-of-detail for displaying the current view.

Tile fetching is occurring when retrieving existing tiles from the disk cache, or when generating new tiles as the user visits a new geographic region. Note that any tiles that are already in physical memory (RAM) will continue to display when this option is enabled, but no additional tiles will be read from disk or generated for display.

The view is said to be navigating when the Globe Camera is moving continuously. For example, using the Fly Tool will set the ‘while navigating’ state to true and cause tile fetching to be suspended appropriately. When the Fly Tool halts, the ‘while navigating’ state is set to false and tile fetching will resume. An example of a navigation technique which does not set the ‘while navigating’ state to true is the mouse-wheel zoom in. This functionality uses discrete steps to zoom in and is therefore not a continuous navigation event.

This option is not recommended when outputting animation video files, as the animation framework will set the ‘while navigating’ status to true and the resulting video will only use tiles that are in memory when generating the video. This will most likely be a lower resolution display than required.

To disable tile fetching on a per-layer basis, see the IsFetchingSuspendedWhenNavigating property for IGlobeLayerProperties2.

Product Availability

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

Returns:

The bSuspended

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFetchingSuspendedWhenNavigating

void setIsFetchingSuspendedWhenNavigating(boolean bSuspended)
                                          throws IOException,
                                                 AutomationException

Indicates if tile fetching is disabled while navigating.

Product Availability

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

Parameters:

bSuspended - The bSuspended (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.