Globe (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore
Class Globe

java.lang.Object
  com.esri.arcgis.globecore.Globe

All Implemented Interfaces:: java.util.EventListener, IActiveView, IAGAnimationContainer, IAGAnimationTracks, IAnimationTracks, IBasicMap, IBasicScene, IBasicScene2, IConnectionPointContainer, IGlobe, IGlobe2, IMapGeographicTransformations, IPersist, IPersistStream, IRelationshipClassCollection, IScene, ISceneBookmarks, ISelectionEvents, IStandaloneTableCollection, ISupportErrorInfo, ITableCollection, java.io.Serializable

public class Globe
extends java.lang.Object
implements IGlobe2, IScene, IBasicScene2, IActiveView, IBasicMap, ISelectionEvents, ITableCollection, IStandaloneTableCollection, IRelationshipClassCollection, ISceneBookmarks, IAnimationTracks, IAGAnimationTracks, IAGAnimationContainer, ISupportErrorInfo, IConnectionPointContainer, IPersistStream, IMapGeographicTransformations

A container for the display and manipulation of data in the Globe.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The Globe object is central to the ArcGlobe application. It's analogous to Map and Scene objects in ArcMap and ArcScene. It's used to add and retrieve layers and to manipulate document level properties.

See Also:: Serialized Form

Constructor Summary
`Globe()` Constructs a Globe using ArcGIS Engine.
`Globe(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary
`void`	`activate(int hWnd)` Gives this view control of the specified window.
`void`	`addBookmark(IBookmark3D pBookmark)` Adds a bookmark to the collection.
`void`	`addIActiveViewEventsListener(IActiveViewEvents theListener)`
`void`	`addLayer(ILayer pLayer)` Adds a layer to the map.
`void`	`addLayer(ILayer pLayer, boolean autoArrange)` Adds a layer to the scene.
`void`	`addLayers(IEnumLayer layers, boolean autoArrange)` Adds multiple layers to the scene, optionally arranging them automatically.
`void`	`addLayerType(ILayer pLayer, int layerType, boolean autoArrange)` Add layer to globe as specified type.
`void`	`addStandaloneTable(IStandaloneTable table)` Adds a standalone table to the collection.
`void`	`addTable(ITable table)` Adds a table to the collection.
`void`	`addTrack(IAGAnimationTrack pTrack)` Adds a track to the collection.
`void`	`addTrack(IAnimationTrack pTrack)` Adds a track to the collection.
`boolean`	`applies(java.lang.Object object)` Indicates if the given object is supported by the scene.
`void`	`applyTracks(boolean bApplyToAllViewers, double time)` Uses the enabled animation tracks for the given time.
`void`	`applyTracks(ISceneViewer pViewer, double time, double duration)` Plays the enabled animation tracks in the given viewer (in all if null).
`void`	`changePriority(IAGAnimationTrack pTrack, boolean bAbsolute, boolean bInSameType, int changeInIndex)` Changes the priority (index) of the track.
`void`	`changePriority(IAnimationTrack pTrack, boolean bAbsolute, boolean bInSameType, int changeInIndex)` Changes the priority (index) of the track.
`void`	`clear()` Empties the view contents.
`void`	`clearLayers()` Removes all layers from the scene.
`void`	`clearSelection()` Clears the scene's selection.
`void`	`contentsChanged()` Called by clients when view objects are modified.
`IAGAnimationTrack`	`createTrack(IAGAnimationType pType)` Creates a new track and adds it to the collection.
`void`	`deactivate()` Another view takes over the associated window.
`void`	`delayEvents(boolean delay)` Used to batch operations together in order to minimize system notifications.
`void`	`deleteLayer(ILayer layer)` Deletes a layer from the scene.
`void`	`detachObject(java.lang.Object pObject)` Detach an object from all tracks it is attached to.
`void`	`draw(int hdc, ITrackCancel trackCancel)` Draws the view to the specified device context.
`void`	`drawGraphsToDC(int hDC)` Draw datagraphs to specified device context.
`void`	`drawPageLayoutToDC(int hDC)` Draw the page layout to specified device context.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` Supported Platforms
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`void`	`findBookmark(java.lang.String name, IBookmark3D[] ppBookmark)` Finds a bookmark by name.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` Supported Platforms
`IEnumRelationshipClass`	`findRelationshipClasses(IObjectClass objectClass, int role)` Finds all relationship classes in the collection that reference the given object class in the specified role.
`void`	`findTrack(java.lang.String name, IAGAnimationTrack[] ppTrack)` Finds a track by name.
`void`	`findTrack(java.lang.String name, IAnimationTrack[] ppTrack)` Finds a track by name.
`ILayer`	`getActiveGraphicsLayer()` The active graphics layer.
`IArray`	`getAGTracks()` The animation tracks.
`IArray`	`getAllViews()` All the viewers.
`IAnimationExtension`	`getAnimationExtension()` The animation extension containing tracks and environment settings.
`java.lang.String`	`getAnimationFileExtension()` The extension for the animation files.
`java.lang.String`	`getAnimationFileFilter(boolean bAllVersions)` The filter for browing animation files.
`IAGAnimationContainer`	`getAnimationObjectContainer()` The container of the animation objects attached to the tracks.
`IArray`	`getAnimationTypes()` The objects that describe the registered types of animation.
`IEnvelope`	`getAreaOfInterest()` The area of interest for the scene.
`IActiveView`	`getAsIActiveView()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IAGAnimationContainer`	`getAsIAGAnimationContainer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IAGAnimationTracks`	`getAsIAGAnimationTracks()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IAnimationTracks`	`getAsIAnimationTracks()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IBasicMap`	`getAsIBasicMap()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IBasicScene2`	`getAsIBasicScene2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IConnectionPointContainer`	`getAsIConnectionPointContainer()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGlobe2`	`getAsIGlobe2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IMapGeographicTransformations`	`getAsIMapGeographicTransformations()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPersistStream`	`getAsIPersistStream()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRelationshipClassCollection`	`getAsIRelationshipClassCollection()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IScene`	`getAsIScene()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISceneBookmarks`	`getAsISceneBookmarks()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISelectionEvents`	`getAsISelectionEvents()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IStandaloneTableCollection`	`getAsIStandaloneTableCollection()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISupportErrorInfo`	`getAsISupportErrorInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITableCollection`	`getAsITableCollection()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IViewers3D`	`getBasicDisplay()` The basic 3D display used by the scene.
`IGraphicsLayer`	`getBasicGraphicsLayer()` The basic graphics layer.
`int`	`getBookmarkCount()` The number of bookmarks.
`IArray`	`getBookmarks()` The bookmarks.
`void`	`getClassID(GUID[] pClassID)` Supported Platforms
`static java.lang.String`	`getClsid()`
`void`	`getContextMenu(double x, double y, IUID[] clsidMenu)` Called when a context menu should be displayed at the given xy location.
`java.lang.Object`	`getCurrentView()` The current active viewer.
`int`	`getDanglingCachesCount()` Returns the count of globe caches which are not saved.
`void`	`getDefaultBackgroundColor(float[] red, float[] green, float[] blue)` Returns the default background color.
`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.
`java.lang.String`	`getDescription()` The description of the scene.
`double`	`getExaggerationFactor()` The vertical exaggeration of the scene.
`tagRECT`	`getExportFrame()` The device rectangle to export.
`IEnvelope`	`getExtent()` The extent of the scene.
`IExtentStack`	`getExtentStack()` The extent stack.
`ISelection`	`getFeatureSelection()` The scene's feature selection.
`IMap`	`getFocusMap()` The map that tools and controls act on.
`IEnvelope`	`getFullExtent()` The full extent rectangle.
`IGeoTransformationOperationSet`	`getGeographicTransformations()` On-the-fly geographic transformations.
`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.
`IGraphicsContainer`	`getGraphicsContainer()` The active graphics container.
`ILayer`	`getLayer(int index)` The layer corresponding to a given index.
`int`	`getLayerCount()` The number of layers in the scene.
`IEnumLayer`	`getLayers(IUID uid, boolean recursive)` The layers in the scene of the type specified in the UID.
`java.lang.String`	`getName()` The name of the scene.
`IEnumRelationshipClass`	`getRelationshipClasses()` The memory relationship classes.
`ISceneGraph`	`getSceneGraph()` The scene's scenegraph.
`short`	`getScreenCacheID(int phase, java.lang.Object data)` The screen cache ID that is used to draw the specified phase.
`IScreenDisplay`	`getScreenDisplay()` The screen display used by the view.
`ISelection`	`getSelection()` The selection.
`int`	`getSelectionCount()` The number of selected features.
`int`	`getShowGlobeTips()` Show globe tips.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` Supported Platforms
`IArray`	`getSpatialBookmarks()` The spatial bookmarks that can be used to define animations.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the scene.
`IStandaloneTable`	`getStandaloneTable(int index)` The standalone table at the given index.
`int`	`getStandaloneTableCount()` Number of standalone tables.
`ITable`	`getTable(int index)` The table at the given index.
`int`	`getTableCount()` Number of tables.
`java.lang.String`	`getTipText(double x, double y)` The tip text to display at the given location.
`int`	`getTrackCount()` The number of tracks.
`IArray`	`getTracks()` The animation tracks.
`IArray`	`getTracksOfType(IAGAnimationType pType)` The animation tracks of a given type.
`IArray`	`getTracksOfType(IAnimationType pType)` The animation tracks of a given type.
`java.lang.Object`	`getViewController(java.lang.Object pViewer)` The controller object (Camera) of a viewer.
`int`	`getWindowHandle(java.lang.Object pView)` The window handle associated with the given view.
`int`	`hashCode()` the hashcode for this object
`IMap`	`hitTestMap(IPoint location)` Returns any maps present in the view at the given location.
`void`	`interfaceSupportsErrorInfo(GUID riid)` Supported Platforms
`boolean`	`isActive()` Indicates if view is active or not.
`void`	`isDirty()` Supported Platforms
`boolean`	`isGestureEnabled()` Indicates if interactive gestures are enabled.
`boolean`	`isMapActivated()` Indicates if the focus map is activated.
`boolean`	`isReportLayersInDrawingOrder()` Controls if layers are reported in drawing order.
`boolean`	`isShowRulers()` Indicates if rulers are visible.
`boolean`	`isShowScrollBars()` Indicates if scrollbars are visible.
`boolean`	`isShowSelection()` Indicates if selection is visible.
`void`	`load(IStream pstm)` Supported Platforms
`void`	`loadAnimation(java.lang.String pFilename)` Load the animation from a file.
`void`	`loadBookmarks(IStream pStm)` Load the bookmarks from a stream.
`void`	`loadTracks(IStream pStm)` Load the animation tracks from a stream.
`void`	`moveLayer(ILayer layer, int toIndex)` Moves a layer to another position within the Table Of Contents.
`void`	`onMessage(int msg, int wParam, int lParam)` Call from your application's message loop to enable automatic resizing and keyboard accelerators.
`void`	`output(int hdc, int dpi, tagRECT pixelBounds, IEnvelope visibleBounds, ITrackCancel trackCancel)` Renders the view to the specified DC.
`void`	`partialRefresh(int phase, java.lang.Object data, IEnvelope envelope)` Draws the specified view phase.
`void`	`printerChanged(IPrinter printer)` Called by application when printer changes.
`void`	`proposeSpatialReference(ISpatialReference pProposedSR, boolean[] pbChanged)` Proposes a spatial reference for the scene.
`void`	`putIsAnimating(boolean bAnimating, boolean bFullQuality)` Indicates if the animation is active, and if full quality rendering is used (for video).
`void`	`recalculateExtent()` Forces the scene's extent to be recalculated.
`void`	`refresh()` Causes the entire view to draw.
`void`	`refreshAttachedObjects()` Detaches from the tracks those objects that no longer exist.
`void`	`refreshGroupLayer(ILayer pLayer)` Refresh globe group layer.
`void`	`refreshObject(java.lang.Object pObject)` Container-specific actions to refresh object.
`void`	`refreshViews(boolean bRefreshAllViewers)` Refresh the active viewer or all viewers.
`void`	`removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)` Remove all animation time string from the display.
`void`	`removeAllBookmarks()` Removes all bookmarks.
`void`	`removeAllStandaloneTables()` Removes all standalone tables from the collection.
`void`	`removeAllTables()` Removes all tables from the collection.
`void`	`removeAllTracks()` Removes all tracks.
`void`	`removeBookmark(IBookmark3D bookmark)` Removes a bookmark from the collection.
`void`	`removeIActiveViewEventsListener(IActiveViewEvents theListener)`
`void`	`removeStandaloneTable(IStandaloneTable table)` Removes the standalone table from the collection.
`void`	`removeTable(ITable table)` Removes a table from the collection.
`void`	`removeTrack(IAGAnimationTrack pTrack)` Removes a track from the collection.
`void`	`removeTrack(IAnimationTrack pTrack)` Removes a track from the collection.
`void`	`removeTrackTimeDisplay(IAGAnimationTrack pTrack)` Remove a single animation track time string from the display.
`void`	`restoreViewerStates(boolean bApplyRestored)` Restore the current state of the viewers.
`void`	`save(IStream pstm, int fClearDirty)` Supported Platforms
`void`	`saveAnimation(java.lang.String pFilename)` Save the animation to a file.
`void`	`saveBookmarks(IStream pStm)` Save the bookmarks to a stream.
`void`	`saveTracks(IStream pStm)` Save the animation tracks to a stream.
`void`	`saveViewerStates()` Save the current state of the viewers.
`void`	`selectByShape(IGeometry shape, ISelectionEnvironment env, boolean justOne)` Selects features in the scene given a shape and an optional selection environment.
`void`	`selectFeature(ILayer layer, IFeature pFeature)` Selects a feature.
`void`	`selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)` Call this function to fire the selection changed event.
`void`	`setActiveGraphicsLayerByRef(ILayer ppLayer)` The active graphics layer.
`void`	`setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)` The container of the animation objects attached to the tracks.
`void`	`setAnimationTime(IStringArray rhs1)` Set the animation time string.
`void`	`setAreaOfInterest(IEnvelope aoi)` The area of interest for the scene.
`void`	`setDefaultBackgroundColor(float red, float green, float blue)` Sets the default background color.
`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`	`setDescription(java.lang.String descr)` The description of the scene.
`void`	`setExaggerationFactor(double exaggerationFactor)` The vertical exaggeration of the scene.
`void`	`setExtent(IEnvelope extent)` The visible extent rectangle.
`void`	`setFeatureSelectionByRef(ISelection selection)` The scene's feature selection.
`void`	`setFocusMapByRef(IMap activeMap)` The map that tools and controls act on.
`void`	`setFullExtent(IEnvelope extent)` The full extent rectangle.
`void`	`setGlobeUnits(int pUnits)` The linear units used in the globe.
`void`	`setIsGestureEnabled(boolean pbGestureEnabled)` Indicates if interactive gestures are enabled.
`void`	`setIsMapActivated(boolean isMapActivated)` Indicates if the focus map is activated.
`void`	`setName(java.lang.String name)` The name of the scene.
`void`	`setReportLayersInDrawingOrder(boolean bTyped)` Controls if layers are reported in drawing order.
`void`	`setSelectionByRef(ISelection selection)` The selection.
`void`	`setShowGlobeTips(int pTipsType)` Show globe tips.
`void`	`setShowRulers(boolean showRulers)` Indicates if rulers are visible.
`void`	`setShowScrollBars(boolean showScrollBars)` Indicates if scrollbars are visible.
`void`	`setShowSelection(boolean showRulers)` Indicates if selection is visible.
`void`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` The spatial reference of the scene.
`void`	`suggestExaggerationFactor(double aspectRatio, double[] exaggerationFactor)` Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Globe

public Globe()
      throws java.io.IOException,
             java.net.UnknownHostException

Constructs a Globe using ArcGIS Engine.
Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

Globe

public Globe(java.lang.Object obj)
      throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.; Construct a Globe using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Globe.
Globe theGlobe = (Globe) obj;
Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIGlobe2

public IGlobe2 getAsIGlobe2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIScene

public IScene getAsIScene()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIBasicScene2

public IBasicScene2 getAsIBasicScene2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIActiveView

public IActiveView getAsIActiveView()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIBasicMap

public IBasicMap getAsIBasicMap()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISelectionEvents

public ISelectionEvents getAsISelectionEvents()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITableCollection

public ITableCollection getAsITableCollection()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIStandaloneTableCollection

public IStandaloneTableCollection getAsIStandaloneTableCollection()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRelationshipClassCollection

public IRelationshipClassCollection getAsIRelationshipClassCollection()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISceneBookmarks

public ISceneBookmarks getAsISceneBookmarks()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAnimationTracks

public IAnimationTracks getAsIAnimationTracks()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGAnimationTracks

public IAGAnimationTracks getAsIAGAnimationTracks()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGAnimationContainer

public IAGAnimationContainer getAsIAGAnimationContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMapGeographicTransformations

public IMapGeographicTransformations getAsIMapGeographicTransformations()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws java.io.IOException

Throws:: java.io.IOException

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws java.io.IOException

Throws:: java.io.IOException

refreshGroupLayer

public void refreshGroupLayer(ILayer pLayer)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IGlobe2

Refresh globe group layer.

Specified by:: refreshGroupLayer in interface IGlobe2

Parameters:: pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setReportLayersInDrawingOrder

public void setReportLayersInDrawingOrder(boolean bTyped)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IGlobe2

Controls if layers are reported in drawing order.

Specified by:: setReportLayersInDrawingOrder in interface IGlobe2

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

isReportLayersInDrawingOrder

public boolean isReportLayersInDrawingOrder()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IGlobe2

Controls if layers are reported in drawing order.

Specified by:: isReportLayersInDrawingOrder in interface IGlobe2

Returns:: The bTyped
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDanglingCachesCount

public int getDanglingCachesCount()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IGlobe2

Returns the count of globe caches which are not saved.

Specified by:: getDanglingCachesCount in interface IGlobe2

Returns:: The count
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getGlobeLayers

public IEnumLayer getGlobeLayers(IUID pUid,
                                 boolean bRecursive,
                                 boolean bInBaseGlobe,
                                 boolean bSortedByDrawingPriority)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IGlobe

The globe layers by UID and internal grouping.

Supported Platforms

Windows, Solaris, Linux

Description

Returns layers of the specified type that reside in the globe document.

pUID is the interface identifier (IID) for the desired layer type. For example, the IID for IRasterLayer is
{D02371C7-35F7-11D2-B1F2-00C04F8EDEFF}. This is the value to use when you desire the collection of raster layers in the globe document.

bRecursive indictates whether the contents of group layers should be searched for candidates. Set to TRUE if the contents of group layers should be used, FALSE if not.

bInBaseGlobe is used to make a distinction between layers belonging to the base globe, elevation and draped layers, and those independent of the base globe, the floating layers. Set to TRUE for elevation or draped layers. Set to FALSE to return only floating layers.

bSortedByDrawingPriority controls the return order of draped layers. Set to TRUE if they should be returned based on drawing order, which matches the order of draped layers in the Type tab of the Table of Contents (TOC).

Specified by:: getGlobeLayers in interface IGlobe

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

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IGlobe

The globe display.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGlobeDisplay in interface IGlobe

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

getDefaultGlobeBackgroundOption

public int getDefaultGlobeBackgroundOption()
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IGlobe

The default background option.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: getDefaultGlobeBackgroundOption in interface IGlobe

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

setDefaultGlobeBackgroundOption

public void setDefaultGlobeBackgroundOption(int pOption)
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IGlobe

The default background option.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultGlobeBackgroundOption in interface IGlobe

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

setDefaultHighBackgroundColor

public void setDefaultHighBackgroundColor(float red,
                                          float green,
                                          float blue)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IGlobe

The default high altitude background color.

Specified by:: setDefaultHighBackgroundColor in interface IGlobe

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

getDefaultHighBackgroundColor

public void getDefaultHighBackgroundColor(float[] red,
                                          float[] green,
                                          float[] blue)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IGlobe

The default high altitude background color.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: getDefaultHighBackgroundColor in interface IGlobe

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

setDefaultLowBackgroundColor

public void setDefaultLowBackgroundColor(float red,
                                         float green,
                                         float blue)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IGlobe

The default low altitude background color.

Specified by:: setDefaultLowBackgroundColor in interface IGlobe

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

getDefaultLowBackgroundColor

public void getDefaultLowBackgroundColor(float[] red,
                                         float[] green,
                                         float[] blue)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IGlobe

The default low altitude background color.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: getDefaultLowBackgroundColor in interface IGlobe

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

setDefaultBackgTransitionDistances

public void setDefaultBackgTransitionDistances(float lowAltitute,
                                               float highAltitude)
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IGlobe

The altitude values in kilometers for the transition in the background color.

Specified by:: setDefaultBackgTransitionDistances in interface IGlobe

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

getDefaultBackgTransitionDistances

public void getDefaultBackgTransitionDistances(float[] pLowAltitute,
                                               float[] pHighAltitude)
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IGlobe

The altitude values in kilometers for the transition in the background color.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: getDefaultBackgTransitionDistances in interface IGlobe

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

setGlobeUnits

public void setGlobeUnits(int pUnits)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IGlobe

The linear units used in the globe.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setGlobeUnits in interface IGlobe

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

getGlobeUnits

public int getGlobeUnits()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGlobe

The linear units used in the globe.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: getGlobeUnits in interface IGlobe

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

addLayerType

public void addLayerType(ILayer pLayer,
                         int layerType,
                         boolean autoArrange)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGlobe

Add layer to globe as specified type.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: addLayerType in interface IGlobe

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

setShowGlobeTips

public void setShowGlobeTips(int pTipsType)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGlobe

Show globe tips.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowGlobeTips in interface IGlobe

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

getShowGlobeTips

public int getShowGlobeTips()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IGlobe

Show globe tips.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:: getShowGlobeTips in interface IGlobe

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

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IScene

The extent of the scene.

Supported Platforms

Windows, Solaris, Linux

Remarks

The returned envelope represents the extent of the scene in X, Y, and Z.

The ZMin and ZMax of the envelope take into consideration the 3D properties of the scene's layers (base heights, extrusion, etc.).

The ZMin and ZMax of the envelope do not take into consideration the scene's vertical exaggeration.

Specified by:: getExtent in interface IScene

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

suggestExaggerationFactor

public void suggestExaggerationFactor(double aspectRatio,
                                      double[] exaggerationFactor)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IScene

Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.

Supported Platforms

Windows, Solaris, Linux

Specified by:: suggestExaggerationFactor in interface IScene

Parameters:: aspectRatio - The aspectRatio (in); exaggerationFactor - The exaggerationFactor (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getExaggerationFactor

public double getExaggerationFactor()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IScene

The vertical exaggeration of the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExaggerationFactor in interface IScene

Returns:: The exaggerationFactor
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExaggerationFactor

public void setExaggerationFactor(double exaggerationFactor)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IScene

The vertical exaggeration of the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExaggerationFactor in interface IScene

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

applies

public boolean applies(java.lang.Object object)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IScene

Indicates if the given object is supported by the scene.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Applies member is used to determine whether the passed Layer, DatasetName, or GxLayer is supported.

Specified by:: applies in interface IScene

Parameters:: object - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IScene

The name of the scene.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Name is in reference to the string displayed at the top of the Scene's table of contents (TOC). When setting a new name call ISxDocument.UpdateContents to refresh the TOC display so the new name becomes visible.

Specified by:: getName in interface IScene

Returns:: The name
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IScene

The name of the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface IScene

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

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IScene

The description of the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDescription in interface IScene

Returns:: The descr
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setDescription

public void setDescription(java.lang.String descr)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IScene

The description of the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDescription in interface IScene

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

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IScene

The area of interest for the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaOfInterest in interface IScene

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IScene

The area of interest for the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAreaOfInterest in interface IScene

Parameters:: aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getLayerCount

public int getLayerCount()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IScene

The number of layers in the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayerCount in interface IScene

Returns:: The pcLayers
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IScene

The layer corresponding to a given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayer in interface IScene

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.ILayer
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLayers

public IEnumLayer getLayers(IUID uid,
                            boolean recursive)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IScene

The layers in the scene of the type specified in the UID. If 'recursive' is true, includes layers in group layers.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayers in interface IScene

Parameters:: uid - A reference to a com.esri.arcgis.system.IUID (in, optional, pass null if not required); recursive - The recursive (in, optional, pass false if not required)
Returns:: A reference to a com.esri.arcgis.carto.IEnumLayer
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

addLayer

public void addLayer(ILayer pLayer,
                     boolean autoArrange)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IScene

Adds a layer to the scene.

Supported Platforms

Windows, Solaris, Linux

Remarks

Specified by:: addLayer in interface IScene

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

addLayers

public void addLayers(IEnumLayer layers,
                      boolean autoArrange)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IScene

Adds multiple layers to the scene, optionally arranging them automatically.

Supported Platforms

Windows, Solaris, Linux

Remarks

The autoArrange parameter controls the ordering of the layers. If autoArrange is set to TRUE, the layers are added in the proper position as by their 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.

Specified by:: addLayers in interface IScene

Parameters:: layers - A reference to a com.esri.arcgis.carto.IEnumLayer (in); autoArrange - The autoArrange (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteLayer

public void deleteLayer(ILayer layer)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IScene

Deletes a layer from the scene.

Supported Platforms

Windows, Solaris, Linux

Remarks

<PRE>

public void deleteLayer(ILayer layer) {

IScene pScene;

ILayer pLayer;

// get IScene ......

if (pScene.LayerCount > 0) {

pLayer = pScene.getLayer(0);

pScene.deleteLayer(pLayer);

}

</PRE>

Specified by:: deleteLayer in interface IScene

Parameters:: layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

moveLayer

public void moveLayer(ILayer layer,
                      int toIndex)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IScene

Moves a layer to another position within the Table Of Contents.

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveLayer in interface IScene

Parameters:: layer - A reference to a com.esri.arcgis.carto.ILayer (in); toIndex - The toIndex (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

clearLayers

public void clearLayers()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IScene

Removes all layers from the scene.

Supported Platforms

Windows, Solaris, Linux

The following example shows how to remove all layers from the scene:

<PRE>

public void clearLayers(ILayer layer) throws IOException, AutomationException

{

IScene pScene;

ILayer pLayer;

//get IScene ......

pScene.clearLayers();

}

</PRE>

Specified by:: clearLayers in interface IScene

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IScene

The spatial reference of the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IScene

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IScene

The spatial reference of the scene.

Specified by:: setSpatialReferenceByRef in interface IScene

Parameters:: spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

proposeSpatialReference

public void proposeSpatialReference(ISpatialReference pProposedSR,
                                    boolean[] pbChanged)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IScene

Proposes a spatial reference for the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: proposeSpatialReference in interface IScene

Parameters:: pProposedSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); pbChanged - The pbChanged (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getBasicGraphicsLayer

public IGraphicsLayer getBasicGraphicsLayer()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IScene

The basic graphics layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBasicGraphicsLayer in interface IScene

Returns:: A reference to a com.esri.arcgis.carto.IGraphicsLayer
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getActiveGraphicsLayer

public ILayer getActiveGraphicsLayer()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IScene

The active graphics layer. If no graphic layers exist, a basic memory graphics layer will be created.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getActiveGraphicsLayer in interface IScene

Returns:: A reference to a com.esri.arcgis.carto.ILayer
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setActiveGraphicsLayerByRef

public void setActiveGraphicsLayerByRef(ILayer ppLayer)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IScene

The active graphics layer. If no graphic layers exist, a basic memory graphics layer will be created.

Specified by:: setActiveGraphicsLayerByRef in interface IScene

Parameters:: ppLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

delayEvents

public void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IScene

Used to batch operations together in order to minimize system notifications.

Supported Platforms

Windows, Solaris, Linux

Specified by:: delayEvents in interface IScene

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

getSelectionCount

public int getSelectionCount()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IScene

The number of selected features.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionCount in interface IScene

Returns:: The count
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectFeature

public void selectFeature(ILayer layer,
                          IFeature pFeature)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IScene

Selects a feature.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectFeature in interface IScene

Parameters:: layer - A reference to a com.esri.arcgis.carto.ILayer (in); pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

clearSelection

public void clearSelection()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IScene

Clears the scene's selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: clearSelection in interface IScene

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

getFeatureSelection

public ISelection getFeatureSelection()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IScene

The scene's feature selection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureSelection in interface IScene

Returns:: A reference to a com.esri.arcgis.carto.ISelection
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFeatureSelectionByRef

public void setFeatureSelectionByRef(ISelection selection)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IScene

The scene's feature selection.

Specified by:: setFeatureSelectionByRef in interface IScene

Parameters:: selection - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

selectByShape

public void selectByShape(IGeometry shape,
                          ISelectionEnvironment env,
                          boolean justOne)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IScene

Selects features in the scene given a shape and an optional selection environment.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectByShape in interface IScene

Parameters:: shape - A reference to a com.esri.arcgis.geometry.IGeometry (in); env - A reference to a com.esri.arcgis.carto.ISelectionEnvironment (in); justOne - The justOne (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

recalculateExtent

public void recalculateExtent()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IScene

Forces the scene's extent to be recalculated.

Supported Platforms

Windows, Solaris, Linux

Specified by:: recalculateExtent in interface IScene

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

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IScene

The scene's scenegraph.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSceneGraph in interface IScene

Returns:: A reference to a com.esri.arcgis.analyst3d.ISceneGraph
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultBackgroundColor

public void setDefaultBackgroundColor(float red,
                                      float green,
                                      float blue)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IScene

Sets the default background color.

Specified by:: setDefaultBackgroundColor in interface IScene

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

getDefaultBackgroundColor

public void getDefaultBackgroundColor(float[] red,
                                      float[] green,
                                      float[] blue)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IScene

Returns the default background color.

Supported Platforms

Windows, Solaris, Linux

Remarks

The values for the red, green, and blue components will fall between 0 and 1 inclusive. A value of 1 represents 100% saturation of that component.

The DefaultBackgroundColor is that used by new scenes. It does not necessarilly indicate the background color of the current scene.

If you want to know the background color of the current scene use ISceneGraph.GetBackgroundColor.

Specified by:: getDefaultBackgroundColor in interface IScene

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

getAnimationExtension

public IAnimationExtension getAnimationExtension()
                                          throws java.io.IOException,
                                                 AutomationException

Description copied from interface: IBasicScene2

The animation extension containing tracks and environment settings.

Specified by:: getAnimationExtension in interface IBasicScene2

Returns:: A reference to a com.esri.arcgis.animation.IAnimationExtension
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBasicDisplay

public IViewers3D getBasicDisplay()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IBasicScene

The basic 3D display used by the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBasicDisplay in interface IBasicScene

Returns:: A reference to a com.esri.arcgis.analyst3d.IViewers3D
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

saveAnimation

public void saveAnimation(java.lang.String pFilename)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IBasicScene

Save the animation to a file.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveAnimation in interface IBasicScene

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

loadAnimation

public void loadAnimation(java.lang.String pFilename)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IBasicScene

Load the animation from a file.

Supported Platforms

Windows, Solaris, Linux

Specified by:: loadAnimation in interface IBasicScene

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

getFullExtent

public IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IActiveView

The full extent rectangle.

Supported Platforms

Windows, Solaris, Linux

Remarks

The full extent of the view. In ArcMap's data view, the full extent is the full extent of all layers and it is automatically calculated whenever the spatial reference changes and when layers are added or removed with AddLayer, AddLayers, or DeleteLayer. In layout view, the full extent is the page size expanded some and it is automatically set whenever the page size changes.

This property is a shortcut to the bounds of the ActiveView's ScreenDisplay (accessed via IDisplayTransformation::Bounds) .

Specified by:: getFullExtent in interface IActiveView

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFullExtent

public void setFullExtent(IEnvelope extent)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IActiveView

The full extent rectangle.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFullExtent in interface IActiveView

Parameters:: extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setExtent

public void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IActiveView

The visible extent rectangle.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExtent in interface IActiveView

Parameters:: extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getScreenDisplay

public IScreenDisplay getScreenDisplay()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IActiveView

The screen display used by the view.

Supported Platforms

Windows, Solaris, Linux

Remarks

Each view has a ScreenDisplay object which controls drawing in the application's window. Use this property to get a reference to the ScreenDisplay object associated with the view you are currently working with. For example, to draw a polygon in data view, you must get an IActiveView reference on the focus Map object and then get a reference to its ScreenDisplay object via this property. If you are in data view and you mistakenly get an IActiveView reference on the PageLayout object, you will not see the polygon as you are drawing in the wrong view.

Each ScreenDisplay object has a DisplayTransformation object which is accessible via IDisplay::DisplayTransformation (ScreenDisplay inherits from Display ). Each DisplayTransformation related to a Map, holds onto the map's spatial reference (IDisplayTransformation::SpatialReference ) and has useful methods for converting between device units and map units. The PageLayout's DisplayTransformation does not have a spatial reference, the property returns nothing, and in this case its members map between device units and page units.

Specified by:: getScreenDisplay in interface IActiveView

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

getGraphicsContainer

public IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IActiveView

The active graphics container.

Supported Platforms

Windows, Solaris, Linux

Remarks

Both the Map and PageLayout objects are graphics containers - both implement the IGraphicsContainer interface.

The Map has a Basics Graphics Layer and this property returns a reference to that object (see CompositeGraphicsLayer and IMap::BasicGraphicsLayer). When working with a Map object, you can also perform a query interface from any of the interfaces the Map implements, IMap for example, to IGraphicsContainer. The QI also takes you to the CompositeGraphicsLayer object. These are both possible because the Map aggregates the Basic Graphics Layer.

The PageLayout object works differently. The PageLayout does not have a Basics Graphics Layer; instead, the PageLayout object is its own graphics container having its own implementation of IGraphicsContainer. A QI from IPageLayout to IGraphicsContainer connects you with the graphics container associated strictly with the PageLayout. However, this property, IActiveView::GraphicsContainer, on the PageLayout object has two possible outcomes. If a Map is activated (IActiveView::IsMapActivated), the property will return a reference to the focus Map's active graphics layer (IMap::ActiveGraphicsLayer ). If no Map is activated, the property will return a reference to the PageLayout's graphics container - the same as the QI case.

Specified by:: getGraphicsContainer in interface IActiveView

Returns:: A reference to a com.esri.arcgis.carto.IGraphicsContainer
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getFocusMap

public IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IActiveView

The map that tools and controls act on.

Supported Platforms

Windows, Solaris, Linux

Remarks

A user's map may comprise one or more Map objects. Each Map object typically holds layers of data as well as several MapSurround objects such as a Legend. This property returns an IMap reference to the Map object that currently has focus. In ArcMap, the focus map is the one visible in data view and the one selected in layout view.

Changing the focus map fires the IActiveViewEvents::FocusMapChanged event. In ArcMap, the focus map is automatically set to any new Map added.

IMxDocument::FocusMap is a read-only short cut to this property.

Specified by:: getFocusMap in interface IActiveView

Returns:: A reference to a com.esri.arcgis.carto.IMap
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setFocusMapByRef

public void setFocusMapByRef(IMap activeMap)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IActiveView

The map that tools and controls act on.

Specified by:: setFocusMapByRef in interface IActiveView

Parameters:: activeMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isMapActivated

public boolean isMapActivated()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IActiveView

Indicates if the focus map is activated.

Specified by:: isMapActivated in interface IActiveView

Returns:: The isMapActivated
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setIsMapActivated

public void setIsMapActivated(boolean isMapActivated)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IActiveView

Indicates if the focus map is activated.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIsMapActivated in interface IActiveView

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

getSelection

public ISelection getSelection()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IActiveView

The selection.

Supported Platforms

Windows, Solaris, Linux

Remarks

ArcMap has two different selection types, a feature selection and an element selection. Two different objects represent these selections and both implement the ISelection interface. The feature selection object additionally implements IEnumFeature and the element selection object IEnumElement. The ISelection interface is used for clipboard type operations and the IEnum interfaces are used to loop through the items in the collection.

Each active view object, the PageLayout and all Maps, have their own selection objects. Actually, the PageLayout only has an element selection but each Map has a unique feature and element selection. When working with selections make sure you have the correct active view object.

For a Map, only one of the selections can be active at a time. As mentioned above, this interface provides an ISelection reference to either an element or feature selection depending on which one is currently active. To simplify the matter, IMap has a FeatureSelection property which always returns an ISelection on the feature selection, from which you can obtain an IEnumFeature reference. Just make sure you have the correct Map, usually the FocusMap. To get a Map's element selection, use IViewManager::ElementSelection.

Note: The features returned as part of IEnumFeature are in the spatial reference of the map, so they have the coordinate system and the resolution (1/precision) of the map.

Specified by:: getSelection in interface IActiveView

Returns:: A reference to a com.esri.arcgis.carto.ISelection
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.
See Also:: IMap.getFeatureSelection()

setSelectionByRef

public void setSelectionByRef(ISelection selection)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IActiveView

The selection.

Specified by:: setSelectionByRef in interface IActiveView

Parameters:: selection - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getTipText

public java.lang.String getTipText(double x,
                                   double y)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IActiveView

The tip text to display at the given location.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the tip text (through ILayer::TipText) for the first feature found at the given coordinate. This property only works for a Map object. This property returns an empty string for PageLayout objects.

Specified by:: getTipText in interface IActiveView

Parameters:: x - The x (in); y - The y (in)
Returns:: The tipText
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getExportFrame

public tagRECT getExportFrame()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IActiveView

The device rectangle to export.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the area of the view to be exported.

For Maps, this is always the area corresponding to the constrained bounds (IDisplayTransformation::ContstrainedBounds), i.e., the visible bounds intersected with the full bounds. The coordinates are automatically converted, using IDisplayTransformation::TransformRect, from world units to device units.

For PageLayout, this is always the height and width of the page in device units (pixels) when the layout is zoomed to 100%. Because these values are independent of the layout's current zoom level and always correspond to the page instead of the full client area of the application, they are ideal for use when exporting a map to a graphics file. Assign the values of the ExportFrame property to the Export object's PixelBounds property.

Specified by:: getExportFrame in interface IActiveView

Returns:: A Structure: com.esri.arcgis.display.tagRECT
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isShowScrollBars

public boolean isShowScrollBars()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IActiveView

Indicates if scrollbars are visible.

Supported Platforms

Windows, Solaris, Linux

Remarks

IActiveView::ShowScrollBars is a short cut to IScreenDisplay::UseScrollBars. Changes to this property are not reflected until the active view changes. For example, when in layout view in ArcMap, programmatically changing the PageLayout to not show its scrollbar will have no effect until the next time the active view is set to the PageLayout - calling IActiveView::Refresh has no effect.

ArcMap uses this property to hide Map's scroll bars when in layout view. Programmatically trying to display a Map's scroll bar in layout view will have no effect, for Maps this setting is only honored in data view and again it requires an active view change before the setting is reflected in the applications window.

Specified by:: isShowScrollBars in interface IActiveView

Returns:: The showScrollBars
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setShowScrollBars

public void setShowScrollBars(boolean showScrollBars)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IActiveView

Indicates if scrollbars are visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowScrollBars in interface IActiveView

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

isShowRulers

public boolean isShowRulers()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IActiveView

Indicates if rulers are visible.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is a boolean flag that applications use to determine whether or not to draw rulers.

This property cannot be set for Maps, they always have rulers turned off.

The PageLayout is the only active view with rulers; an active view change is required before the setting is reflected in the applications window.

Specified by:: isShowRulers in interface IActiveView

Returns:: The showRulers
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowRulers

public void setShowRulers(boolean showRulers)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IActiveView

Indicates if rulers are visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowRulers in interface IActiveView

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

isShowSelection

public boolean isShowSelection()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IActiveView

Indicates if selection is visible.

Supported Platforms

Windows, Solaris, Linux

Description

This property is primarily used to hide a Map's element selection in layout view unless a Map has been activated.

When in layout view, the PageLayout always has its ShowSelection set to true, setting it to false has no effect. Similarly, when in data view, the focus Map always has its ShowSelection set to true and this cannot be overridden.

Specified by:: isShowSelection in interface IActiveView

Returns:: The showRulers
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setShowSelection

public void setShowSelection(boolean showRulers)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IActiveView

Indicates if selection is visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowSelection in interface IActiveView

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

getExtentStack

public IExtentStack getExtentStack()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IActiveView

The extent stack.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns a reference to the active view's extent stack. Each active view has an extent stack which remembers previous extents so that users can 'go back' and then 'go forward' to previous extents.

Specified by:: getExtentStack in interface IActiveView

Returns:: A reference to a com.esri.arcgis.carto.IExtentStack
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getScreenCacheID

public short getScreenCacheID(int phase,
                              java.lang.Object data)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IActiveView

The screen cache ID that is used to draw the specified phase.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is widely used during invalidation (refresh) operations. For example, IScreenDisplay::Invalidate requires a cacheIndex. Use this property to get the cacheIndex for the desired draw phase you wish to refresh. The valid draw phases are held in the esriViewDrawPhase enumeration.

Use the data parameter to invalidate just a specific piece of data. For example, if a layer is loaded and its cache property is set to TRUE, this layer alone can be invalidated. A tracking layer is a good example of this.

Specified by:: getScreenCacheID in interface IActiveView

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in)
Returns:: The cacheID
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.
See Also:: esriViewDrawPhase

hitTestMap

public IMap hitTestMap(IPoint location)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IActiveView

Returns any maps present in the view at the given location. Return value may be zero if there are no maps or the coordinate is not over a map.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use this method on a PageLayout to find the nearest Map based on a point location. For example, when ArcMap's identify tool is used in Layout view, the tool first finds the Map clicked on before it searches for features in the Map.

When using this method on a PageLayout, for the Location parameter, set up the Point in page coordinates. To convert from device coordinates to page coordinates:

Get the ScreenDisplay from the PageLayout using IActiveView::ScreenDisplay.
Get the DisplayTransformation from the ScreenDisplay using IScreenDisplay::DisplayTransformation.
Convert device coordinates (for example from a mouse move) to page coordinates using IDisplayTransformation::ToMapPoint.

Use this method on a Map to obtain a reference to it through IMap.

Specified by:: hitTestMap in interface IActiveView

Parameters:: location - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:: A reference to a com.esri.arcgis.carto.IMap
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isActive

public boolean isActive()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IActiveView

Indicates if view is active or not.

Specified by:: isActive in interface IActiveView

Returns:: The isActive
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

activate

public void activate(int hWnd)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IActiveView

Gives this view control of the specified window.

Supported Platforms

Windows, Solaris, Linux

Remarks

Called to establish the current object as the active view. For example, view commands deactivate (IActiveView::Deactivate) the current view (IMxDocument::ActiveView) before calling Activate on their own associated view.

When working with the IActiveView interface on a MapDocument object, you should always first call IActiveView::Activate() in order to properly initialize the display of the PageLayout or Map object. The MxDocument and MapServer objects and the MapControl and PageLayoutControl all initialize display objects automatically after opening an MXD, but MapDocument does not do this, so you should call Activate() before working with any other members of IActiveView. If your application has a user interface, you should call Activate() with the hWnd of the application's client area. If your application runs in the background and has no windows, you can always get a valid hWnd from the GDI GetDesktopWindow() function, part of the Win32 API.

Specified by:: activate in interface IActiveView

Parameters:: hWnd - The hWnd (A COM typedef) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IActiveView

Another view takes over the associated window.

Supported Platforms

Windows, Solaris, Linux

Remarks

Called to deactivate the current active view. For example, view commands deactivate (IActiveView::Deactivate) the current view (IMxDocument::ActiveView) before calling Activate on their own associated view.

Specified by:: deactivate in interface IActiveView

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

draw

public void draw(int hdc,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IActiveView

Draws the view to the specified device context.

Supported Platforms

Windows, Solaris, Linux

Specified by:: draw in interface IActiveView

Parameters:: hdc - The hdc (A COM typedef) (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

output

public void output(int hdc,
                   int dpi,
                   tagRECT pixelBounds,
                   IEnvelope visibleBounds,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IActiveView

Renders the view to the specified DC.

Supported Platforms

Windows, Solaris, Linux

Description

This method is used to draw to a non-app window hDC (see Windows GDI for more info). The ArcMap printing and exporting commands use this method. When drawing to an hWnd, normally IActiveView::Draw is used instead of this method because it handles caching and scrollbars.

Remarks

Parameter use is as follows:

hDC - Output device.
dpi - Dots per inch (resolution). If Null is passed then this defaults to the resolution of the hDC. If that cannot be sampled, then this defaults to the window resolution.
pixelBounds - Device rectangle specified in pixels.
VisibleBounds - Zoom extent. If Null is passed then this defaults to the current visible extent.

All other display attributes are copied from the ActiveView.

If you want to draw the data frame to a 640x480 bitmap for example, specify the following parameter values:

dpi - 0
pixel bounds - { 0, 0, 640, 480 }
visible bounds - 0

If you want to create a bitmap that will print 8.5 x 11 on a 300 DPI printer, specify the following parameter values:

dpi - 300
pixel bounds - { 0, 0, 8.5 * dpi, 11 * dpi }
visible bounds - 0

If you want to zoom to a certain location and draw it on a 300x300 bitmap, specify the following parameter values:

dpi - 0
pixel bounds - { 0, 0, 300, 300 }
visible bounds - { -45.0, 44.0, -44.0, 45.0 }

The value of IDisplayTransformation::Resolution does not affect the results of this method.

The value of IOutputRasterSettings::ResampleRatio does affect the results of the this method. When rasters are drawn, they get resampled as specified in this attribute.

Specified by:: output in interface IActiveView

Parameters:: hdc - The hdc (A COM typedef) (in); dpi - The dpi (in); pixelBounds - A Structure: com.esri.arcgis.display.tagRECT (in); visibleBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IActiveView

Causes the entire view to draw.

Supported Platforms

Windows, Solaris, Linux

Remarks

IActiveView::Refresh invalidates all of the caches. This is a very inefficient operation; typically data from just one source has to be reread from the database and the rest can be drawn from cache. IActiveView::PartialRefresh uses it's knowledge of the cache layout to invalidate as little as possible and should be used whenever possible.

Specified by:: refresh in interface IActiveView

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

partialRefresh

public void partialRefresh(int phase,
                           java.lang.Object data,
                           IEnvelope envelope)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IActiveView

Draws the specified view phase. Use an envelope of zero to draw the entire phase.

Supported Platforms

Windows, Solaris, Linux

Remarks

The main application window is controlled by a view (IActiveView). ArcMap currently has two view objects: Map (data view) and PageLayout (layout view). Each view has a ScreenDisplay object which performs drawing operations. The ScreenDisplay object also makes it possible for clients to create any number of caches. A cache is an off screen bitmap representing the application's window. Instead of drawing directly to the screen, graphics are drawn into caches, then the caches are drawn on the screen. When the application's window is obscured and requires redrawing, it is done so from the caches instead of from a database. In this way, caches improve drawing performance - bitmap rendering is faster than reading and displaying data from a database.

In general, the Map creates three caches: one for all the layers, another if there are annotation or graphics, and a third cache if there is a feature selection. A layer can create its own private cache if it sets ILayer::Cached equal to TRUE. In this case, the Map will create a separate cache for the layer and groups the layers above and below it into different caches.

IActiveView::PartialRefresh uses its knowledge of the cache layout to invalidate as little as possible. IActiveView::Refresh , on the other hand, invalidates all the caches which is very inefficient. Use PartialRefresh whenever possible.

Both PartialRefresh and Refresh call IScreenDisplay::Invalidate which sets a flag clients watch for. Clients draw a cache from scratch (the database) if its flag is set to true, and from cache if the flag is set to false.

The following table shows the phases each view supports and what they map to:

phase	Map	Layout
esriViewBackground	Map grids	Page/snap grid
esriViewGeography	Layers	Unused
*esriViewGeoSelection	Feature selection	Unused
esriViewGraphics	Labels/graphics	Graphics
esriViewGraphicSelection	Graphic selection	Element selection
esriViewForeground	Unused	Snap guides

To specify multiple draw phases, combine individual phases together using a bitwise OR. This is equivalent to adding together the integer enumeration values. For example, pass 6 to invalidate both the esriViewGeography (2) and esriViewGeoSelection (4) phases.

The envelope parameter specifies a region to invalidate. For example, if a graphic element is added, it is usually only necessary to invalidate the immediate area surrounding the new graphic.

Both the data and envelope parameters are optional.

*When selecting features, you must call PartialRefresh twice, once before and once after the selection operation.

Specified by:: partialRefresh in interface IActiveView

Parameters:: phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in); data - A reference to another Object (IUnknown) (in); envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IActiveView

Empties the view contents.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Map object's implementation of Clear deletes all of the Layers in the Map (IMap::ClearLayers ), removes all MapSurrounds (IMap::ClearSurrounds ), removes all bookmarks (IMapBookMarks::RemoveAllBookMarks), and resets the extent stack. Clear does not refresh the active view however.

Clear on PageLayout deletes all Elements, including MapFrames which hold a Map, resets the extent stack, and a new Map is created - there must always be a focus map.

Specified by:: clear in interface IActiveView

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

printerChanged

public void printerChanged(IPrinter printer)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IActiveView

Called by application when printer changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:: printerChanged in interface IActiveView

Parameters:: printer - A reference to a com.esri.arcgis.output.IPrinter (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

contentsChanged

public void contentsChanged()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IActiveView

Called by clients when view objects are modified.

Supported Platforms

Windows, Solaris, Linux

Remarks

After modifying the contents view (table of contents), use this method to fire the IActiveViewEvents::ContentsChanged event so that clients listening for this event can respond accordingly.

Specified by:: contentsChanged in interface IActiveView

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IActiveViewEvents.contentsChanged(com.esri.arcgis.carto.IActiveViewEventsContentsChangedEvent)

onMessage

public void onMessage(int msg,
                      int wParam,
                      int lParam)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IActiveView

Call from your application's message loop to enable automatic resizing and keyboard accelerators.

Supported Platforms

Windows, Solaris, Linux

Specified by:: onMessage in interface IActiveView

Parameters:: msg - The msg (in); wParam - The wParam (A COM typedef) (in); lParam - The lParam (A COM typedef) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getContextMenu

public void getContextMenu(double x,
                           double y,
                           IUID[] clsidMenu)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IActiveView

Called when a context menu should be displayed at the given xy location. Return menu that should be displayed.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getContextMenu in interface IActiveView

Parameters:: x - The x (in); y - The y (in); clsidMenu - A reference to a com.esri.arcgis.system.IUID (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

addLayer

public void addLayer(ILayer pLayer)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IBasicMap

Adds a layer to the map.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addLayer in interface IBasicMap

Parameters:: pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

selectionChanged

public void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ISelectionEvents

Call this function to fire the selection changed event.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectionChanged in interface ISelectionEvents

Parameters:: theEvent - The event
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getTableCount

public int getTableCount()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ITableCollection

Number of tables.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTableCount in interface ITableCollection

Returns:: The count
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getTable

public ITable getTable(int index)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ITableCollection

The table at the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTable in interface ITableCollection

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.ITable
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addTable

public void addTable(ITable table)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: ITableCollection

Adds a table to the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addTable in interface ITableCollection

Parameters:: table - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeTable

public void removeTable(ITable table)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: ITableCollection

Removes a table from the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeTable in interface ITableCollection

Parameters:: table - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAllTables

public void removeAllTables()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: ITableCollection

Removes all tables from the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllTables in interface ITableCollection

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

getStandaloneTableCount

public int getStandaloneTableCount()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IStandaloneTableCollection

Number of standalone tables.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getStandaloneTableCount in interface IStandaloneTableCollection

Returns:: The count
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

public IStandaloneTable getStandaloneTable(int index)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IStandaloneTableCollection

The standalone table at the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getStandaloneTable in interface IStandaloneTableCollection

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IStandaloneTable
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

addStandaloneTable

public void addStandaloneTable(IStandaloneTable table)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IStandaloneTableCollection

Adds a standalone table to the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addStandaloneTable in interface IStandaloneTableCollection

Parameters:: table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

removeStandaloneTable

public void removeStandaloneTable(IStandaloneTable table)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IStandaloneTableCollection

Removes the standalone table from the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeStandaloneTable in interface IStandaloneTableCollection

Parameters:: table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAllStandaloneTables

public void removeAllStandaloneTables()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IStandaloneTableCollection

Removes all standalone tables from the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllStandaloneTables in interface IStandaloneTableCollection

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

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws java.io.IOException,
                                                     AutomationException

Description copied from interface: IRelationshipClassCollection

The memory relationship classes.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelationshipClasses in interface IRelationshipClassCollection

Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

findRelationshipClasses

public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
                                                      int role)
                                               throws java.io.IOException,
                                                      AutomationException

Description copied from interface: IRelationshipClassCollection

Finds all relationship classes in the collection that reference the given object class in the specified role.

Supported Platforms

Windows, Solaris, Linux

Specified by:: findRelationshipClasses in interface IRelationshipClassCollection

Parameters:: objectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in); role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getBookmarks

public IArray getBookmarks()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISceneBookmarks

The bookmarks.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBookmarks in interface ISceneBookmarks

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addBookmark

public void addBookmark(IBookmark3D pBookmark)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: ISceneBookmarks

Adds a bookmark to the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addBookmark in interface ISceneBookmarks

Parameters:: pBookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

findBookmark

public void findBookmark(java.lang.String name,
                         IBookmark3D[] ppBookmark)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISceneBookmarks

Finds a bookmark by name.

Supported Platforms

Windows, Solaris, Linux

Specified by:: findBookmark in interface ISceneBookmarks

Parameters:: name - The name (in); ppBookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeBookmark

public void removeBookmark(IBookmark3D bookmark)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISceneBookmarks

Removes a bookmark from the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeBookmark in interface ISceneBookmarks

Parameters:: bookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeAllBookmarks

public void removeAllBookmarks()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ISceneBookmarks

Removes all bookmarks.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllBookmarks in interface ISceneBookmarks

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

getBookmarkCount

public int getBookmarkCount()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: ISceneBookmarks

The number of bookmarks.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBookmarkCount in interface ISceneBookmarks

Returns:: The pBookmarkCount
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

saveBookmarks

public void saveBookmarks(IStream pStm)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ISceneBookmarks

Save the bookmarks to a stream.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveBookmarks in interface ISceneBookmarks

Parameters:: pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

loadBookmarks

public void loadBookmarks(IStream pStm)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ISceneBookmarks

Load the bookmarks from a stream.

Supported Platforms

Windows, Solaris, Linux

Specified by:: loadBookmarks in interface ISceneBookmarks

Parameters:: pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationTypes

public IArray getAnimationTypes()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAnimationTracks

The objects that describe the registered types of animation.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAnimationTypes in interface IAnimationTracks

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTrackCount

public int getTrackCount()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAnimationTracks

The number of tracks.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTrackCount in interface IAnimationTracks

Returns:: The pCount
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTracks

public IArray getTracks()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAnimationTracks

The animation tracks.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTracks in interface IAnimationTracks

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTracksOfType

public IArray getTracksOfType(IAnimationType pType)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAnimationTracks

The animation tracks of a given type.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTracksOfType in interface IAnimationTracks

Parameters:: pType - A reference to a com.esri.arcgis.analyst3d.IAnimationType (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

addTrack

public void addTrack(IAnimationTrack pTrack)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IAnimationTracks

Adds a track to the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addTrack in interface IAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

findTrack

public void findTrack(java.lang.String name,
                      IAnimationTrack[] ppTrack)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IAnimationTracks

Finds a track by name.

Supported Platforms

Windows, Solaris, Linux

Specified by:: findTrack in interface IAnimationTracks

Parameters:: name - The name (in); ppTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

removeTrack

public void removeTrack(IAnimationTrack pTrack)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAnimationTracks

Removes a track from the collection.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeTrack in interface IAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

removeAllTracks

public void removeAllTracks()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IAnimationTracks

Removes all tracks.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllTracks in interface IAnimationTracks

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

saveTracks

public void saveTracks(IStream pStm)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IAnimationTracks

Save the animation tracks to a stream.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveTracks in interface IAnimationTracks

Parameters:: pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

loadTracks

public void loadTracks(IStream pStm)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IAnimationTracks

Load the animation tracks from a stream.

Supported Platforms

Windows, Solaris, Linux

Specified by:: loadTracks in interface IAnimationTracks

Parameters:: pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

detachObject

public void detachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAnimationTracks

Detach an object from all tracks it is attached to.

Supported Platforms

Windows, Solaris, Linux

Specified by:: detachObject in interface IAnimationTracks

Parameters:: pObject - A reference to another Object (IUnknown) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

refreshAttachedObjects

public void refreshAttachedObjects()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IAnimationTracks

Detaches from the tracks those objects that no longer exist.

Supported Platforms

Windows, Solaris, Linux

Specified by:: refreshAttachedObjects in interface IAnimationTracks

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

applyTracks

public void applyTracks(ISceneViewer pViewer,
                        double time,
                        double duration)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAnimationTracks

Plays the enabled animation tracks in the given viewer (in all if null).

Supported Platforms

Windows, Solaris, Linux

Specified by:: applyTracks in interface IAnimationTracks

Parameters:: pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in); time - The time (in); duration - The duration (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

changePriority

public void changePriority(IAnimationTrack pTrack,
                           boolean bAbsolute,
                           boolean bInSameType,
                           int changeInIndex)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAnimationTracks

Changes the priority (index) of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:: changePriority in interface IAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (in); bAbsolute - The bAbsolute (in); bInSameType - The bInSameType (in); changeInIndex - The changeInIndex (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationObjectContainer

public IAGAnimationContainer getAnimationObjectContainer()
                                                  throws java.io.IOException,
                                                         AutomationException

Description copied from interface: IAGAnimationTracks

The container of the animation objects attached to the tracks.

Specified by:: getAnimationObjectContainer in interface IAGAnimationTracks

Returns:: A reference to a com.esri.arcgis.animation.IAGAnimationContainer
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAnimationObjectContainerByRef

public void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IAGAnimationTracks

The container of the animation objects attached to the tracks.

Specified by:: setAnimationObjectContainerByRef in interface IAGAnimationTracks

Parameters:: ppContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAGTracks

public IArray getAGTracks()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGAnimationTracks

The animation tracks.

Remarks

This property returns the animation tracks in the animation track container, which is an IArray object.

Specified by:: getAGTracks in interface IAGAnimationTracks

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTracksOfType

public IArray getTracksOfType(IAGAnimationType pType)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAGAnimationTracks

The animation tracks of a given type.

Remarks

This property returns all the tracks of a given type in the animation track container, which is an IArray object.

Specified by:: getTracksOfType in interface IAGAnimationTracks

Parameters:: pType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

createTrack

public IAGAnimationTrack createTrack(IAGAnimationType pType)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IAGAnimationTracks

Creates a new track and adds it to the collection.

Specified by:: createTrack in interface IAGAnimationTracks

Parameters:: pType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)
Returns:: A reference to a com.esri.arcgis.animation.IAGAnimationTrack
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addTrack

public void addTrack(IAGAnimationTrack pTrack)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IAGAnimationTracks

Adds a track to the collection.

Specified by:: addTrack in interface IAGAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findTrack

public void findTrack(java.lang.String name,
                      IAGAnimationTrack[] ppTrack)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IAGAnimationTracks

Finds a track by name.

Specified by:: findTrack in interface IAGAnimationTracks

Parameters:: name - The name (in); ppTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeTrack

public void removeTrack(IAGAnimationTrack pTrack)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAGAnimationTracks

Removes a track from the collection.

Specified by:: removeTrack in interface IAGAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applyTracks

public void applyTracks(boolean bApplyToAllViewers,
                        double time)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAGAnimationTracks

Uses the enabled animation tracks for the given time.

Specified by:: applyTracks in interface IAGAnimationTracks

Parameters:: bApplyToAllViewers - The bApplyToAllViewers (in); time - The time (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

changePriority

public void changePriority(IAGAnimationTrack pTrack,
                           boolean bAbsolute,
                           boolean bInSameType,
                           int changeInIndex)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAGAnimationTracks

Changes the priority (index) of the track.

Specified by:: changePriority in interface IAGAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in); bAbsolute - The bAbsolute (in); bInSameType - The bInSameType (in); changeInIndex - The changeInIndex (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getCurrentView

public java.lang.Object getCurrentView()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IAGAnimationContainer

The current active viewer.

Specified by:: getCurrentView in interface IAGAnimationContainer

Returns:: A reference to another Object (IUnknown)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getAllViews

public IArray getAllViews()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGAnimationContainer

All the viewers.

Specified by:: getAllViews in interface IAGAnimationContainer

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getViewController

public java.lang.Object getViewController(java.lang.Object pViewer)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IAGAnimationContainer

The controller object (Camera) of a viewer.

Specified by:: getViewController in interface IAGAnimationContainer

Parameters:: pViewer - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

refreshViews

public void refreshViews(boolean bRefreshAllViewers)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAGAnimationContainer

Refresh the active viewer or all viewers.

Specified by:: refreshViews in interface IAGAnimationContainer

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

refreshObject

public void refreshObject(java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGAnimationContainer

Container-specific actions to refresh object.

Specified by:: refreshObject in interface IAGAnimationContainer

Parameters:: pObject - A reference to another Object (IUnknown) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

saveViewerStates

public void saveViewerStates()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGAnimationContainer

Save the current state of the viewers.

Specified by:: saveViewerStates in interface IAGAnimationContainer

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

restoreViewerStates

public void restoreViewerStates(boolean bApplyRestored)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGAnimationContainer

Restore the current state of the viewers.

Specified by:: restoreViewerStates in interface IAGAnimationContainer

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

putIsAnimating

public void putIsAnimating(boolean bAnimating,
                           boolean bFullQuality)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAGAnimationContainer

Indicates if the animation is active, and if full quality rendering is used (for video).

Specified by:: putIsAnimating in interface IAGAnimationContainer

Parameters:: bAnimating - The bAnimating (in); bFullQuality - The bFullQuality (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isGestureEnabled

public boolean isGestureEnabled()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGAnimationContainer

Indicates if interactive gestures are enabled.

Specified by:: isGestureEnabled in interface IAGAnimationContainer

Returns:: The pbGestureEnabled
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setIsGestureEnabled

public void setIsGestureEnabled(boolean pbGestureEnabled)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGAnimationContainer

Indicates if interactive gestures are enabled.

Specified by:: setIsGestureEnabled in interface IAGAnimationContainer

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

getWindowHandle

public int getWindowHandle(java.lang.Object pView)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAGAnimationContainer

The window handle associated with the given view.

Specified by:: getWindowHandle in interface IAGAnimationContainer

Parameters:: pView - A reference to another Object (IUnknown) (in)
Returns:: The phWnd (A COM typedef)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationFileExtension

public java.lang.String getAnimationFileExtension()
                                           throws java.io.IOException,
                                                  AutomationException

Description copied from interface: IAGAnimationContainer

The extension for the animation files.

Specified by:: getAnimationFileExtension in interface IAGAnimationContainer

Returns:: The pExt
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationFileFilter

public java.lang.String getAnimationFileFilter(boolean bAllVersions)
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IAGAnimationContainer

The filter for browing animation files.

Specified by:: getAnimationFileFilter in interface IAGAnimationContainer

Parameters:: bAllVersions - The bAllVersions (in)
Returns:: The pFilter
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getSpatialBookmarks

public IArray getSpatialBookmarks()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IAGAnimationContainer

The spatial bookmarks that can be used to define animations.

Specified by:: getSpatialBookmarks in interface IAGAnimationContainer

Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

removeAllAnimationTimeStrings

public void removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IAGAnimationContainer

Remove all animation time string from the display.

Specified by:: removeAllAnimationTimeStrings in interface IAGAnimationContainer

Parameters:: pTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

removeTrackTimeDisplay

public void removeTrackTimeDisplay(IAGAnimationTrack pTrack)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IAGAnimationContainer

Remove a single animation track time string from the display.

Specified by:: removeTrackTimeDisplay in interface IAGAnimationContainer

Parameters:: pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setAnimationTime

public void setAnimationTime(IStringArray rhs1)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGAnimationContainer

Set the animation time string.

Specified by:: setAnimationTime in interface IAGAnimationContainer

Parameters:: rhs1 - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

drawGraphsToDC

public void drawGraphsToDC(int hDC)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAGAnimationContainer

Draw datagraphs to specified device context.

Specified by:: drawGraphsToDC in interface IAGAnimationContainer

Parameters:: hDC - The hDC (A COM typedef) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

drawPageLayoutToDC

public void drawPageLayoutToDC(int hDC)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IAGAnimationContainer

Draw the page layout to specified device context.

Specified by:: drawPageLayoutToDC in interface IAGAnimationContainer

Parameters:: hDC - The hDC (A COM typedef) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

Parameters:: ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: findConnectionPoint in interface IConnectionPointContainer

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in); ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getGeographicTransformations

public IGeoTransformationOperationSet getGeographicTransformations()
                                                            throws java.io.IOException,
                                                                   AutomationException

Description copied from interface: IMapGeographicTransformations

On-the-fly geographic transformations.

Supported Platforms

Windows, Solaris, Linux

Description

Each Map has a set of active geographic transformations. The active GeoTransformations are stored in a GeoTransformationOperationSet. If the geographic coordinate systems of a layer and the data frame match a GeoTransformation and its direction in the GeoTransformationOperationSet, the transformation is applied automatically while displaying the layer in the data frame.

Specified by:: getGeographicTransformations in interface IMapGeographicTransformations

Returns:: A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore Class Globe

Product Availability

Supported Platforms

Description

Globe

Globe

getClsid

getAsIGlobe2

getAsIScene

getAsIBasicScene2

getAsIActiveView

getAsIBasicMap

getAsISelectionEvents

getAsITableCollection

getAsIStandaloneTableCollection

getAsIRelationshipClassCollection

getAsISceneBookmarks

getAsIAnimationTracks

getAsIAGAnimationTracks

getAsIAGAnimationContainer

getAsISupportErrorInfo

getAsIConnectionPointContainer

getAsIPersistStream

getAsIMapGeographicTransformations

equals

hashCode

addIActiveViewEventsListener

removeIActiveViewEventsListener

refreshGroupLayer

setReportLayersInDrawingOrder

isReportLayersInDrawingOrder

getDanglingCachesCount

getGlobeLayers

Supported Platforms

Description

getGlobeDisplay

Supported Platforms

getDefaultGlobeBackgroundOption

Supported Platforms

Description

setDefaultGlobeBackgroundOption

Supported Platforms

setDefaultHighBackgroundColor

getDefaultHighBackgroundColor

Supported Platforms

Description

setDefaultLowBackgroundColor

getDefaultLowBackgroundColor

Supported Platforms

Description

setDefaultBackgTransitionDistances

getDefaultBackgTransitionDistances

Supported Platforms

Description

setGlobeUnits

Supported Platforms

getGlobeUnits

Supported Platforms

Description

addLayerType

Supported Platforms

Description

setShowGlobeTips

Supported Platforms

getShowGlobeTips

Supported Platforms

Description

getExtent

Supported Platforms

Remarks

suggestExaggerationFactor

Supported Platforms

getExaggerationFactor

Supported Platforms

setExaggerationFactor

Supported Platforms

applies

Supported Platforms

Remarks

getName

com.esri.arcgis.globecore
Class Globe