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:: IAnimationTracks, IBasicScene, IBasicScene2, IScene, ISceneBookmarks, ISceneBookmarks2, IAGAnimationContainer, IAGAnimationTracks, IActiveView, IBasicMap, IMap, IMapGeographicTransformations, IMapTimeDisplay, IMapTimeDisplay2, IRelationshipClassCollection, ISelectionEvents, IStandaloneTableCollection, ITableCollection, IConnectionPointContainer, IGlobe, IGlobe2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable, EventListener

public class Globe
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobe2, IScene, IBasicScene2, IActiveView, IBasicMap, IMap, ISelectionEvents, ITableCollection, IStandaloneTableCollection, IRelationshipClassCollection, ISceneBookmarks2, IAnimationTracks, IAGAnimationTracks, IAGAnimationContainer, ISupportErrorInfo, IConnectionPointContainer, IPersistStream, IMapGeographicTransformations, IMapTimeDisplay, IMapTimeDisplay2, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobe2, IScene, IBasicScene2, IActiveView, IBasicMap, IMap, ISelectionEvents, ITableCollection, IStandaloneTableCollection, IRelationshipClassCollection, ISceneBookmarks2, IAnimationTracks, IAGAnimationTracks, IAGAnimationContainer, ISupportErrorInfo, IConnectionPointContainer, IPersistStream, IMapGeographicTransformations, IMapTimeDisplay, IMapTimeDisplay2, Externalizable

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

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

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)` addIActiveViewEventsListener.
`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`	`addMapSurround(IMapSurround mapSurround)` Adds a map surround to the map.
`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(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`	`clearMapSurrounds()` Removes all map surrounds from the map.
`void`	`clearSelection()` Clears the scene's selection.
`double`	`computeDistance(IPoint p1, IPoint p2)` Computes the distance between two points on the map and returns the result.
`ITimeExtent`	`computeFullTimeExtent()` Returns the full time extent of the time-enabled layers in the map.
`void`	`contentsChanged()` Called by clients when view objects are modified.
`IMapSurround`	`createMapSurround(IUID clsid, IMapSurround optionalStyle)` Create and initialize a map surround.
`IAGAnimationTrack`	`createTrack(IAGAnimationType pType)` Creates a new track and adds it to the collection.
`void`	`deactivate()` Another view takes over the associated window.
`void`	`delayDrawing(boolean delay)` Suspends drawing.
`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`	`deleteMapSurround(IMapSurround mapSurround)` Deletes a map surround from the map.
`void`	`detachObject(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)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`void`	`findBookmark(String name, IBookmark3D[] ppBookmark)` Finds a bookmark by name.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`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(String name, IAGAnimationTrack[] ppTrack)` Finds a track by name.
`void`	`findTrack(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.
`String`	`getAnimationFileExtension()` The extension for the animation files.
`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.
`IAnnotateMap`	`getAnnotationEngine()` The annotation (label) engine the map will use.
`IEnvelope`	`getAreaOfInterest()` The area of interest for the scene.
`IBarrierCollection`	`getBarriers(IEnvelope pExtent)` The list of barriers and their weight for labeling.
`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)` getClassID
`IBorder`	`getClipBorder()` An optional border drawn around ClipGeometry.
`IGeometry`	`getClipGeometry()` A shape that layers in the map are clipped to.
`static String`	`getClsid()` getClsid.
`void`	`getContextMenu(double x, double y, IUID[] clsidMenu)` Called when a context menu should be displayed at the given xy location.
`ITimeExtent`	`getCurrentTimeExtent()` The current time extent of the map.
`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.
`double`	`getDefaultTimeInterval()` The time interval to be used by the time slider to animate the map.
`int`	`getDefaultTimeIntervalUnits()` The time interval units to be used to animate the map.
`double`	`getDefaultTimeWindow()` The time window used to display the data in the map.
`String`	`getDescription()` The description of the scene.
`String`	`getDisplayDateFormat()` The format of the date that is displayed on the time slider.
`int`	`getDisplaySpeed()` The speed of the slider on a scale of 1 to 10 with 10 being the fastest.
`String`	`getDisplayTimeFormat()` The format of the time that is displayed on the time slider.
`int`	`getDistanceUnits()` The distance units for the map.
`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.
`ITimeExtent`	`getFullTimeExtent()` Returns the full time extent of the time-enabled layers in the map.
`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.
`double`	`getMapScale()` The scale of the map as a representative fraction.
`IMapSurround`	`getMapSurround(int index)` The map surround at the given index.
`int`	`getMapSurroundCount()` Number of map surrounds associated with the map.
`int`	`getMapUnits()` The units for the map.
`String`	`getName()` The name of the scene.
`void`	`getPageSize(double[] widthInches, double[] heightInches)` Gets the page size for the map.
`int`	`getPlayOption()` The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.
`double`	`getReferenceScale()` The reference scale of the map as a representative fraction.
`IEnumRelationshipClass`	`getRelationshipClasses()` The memory relationship classes.
`ISceneGraph`	`getSceneGraph()` The scene's scenegraph.
`short`	`getScreenCacheID(int phase, 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)` getSizeMax
`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.
`ILayer`	`getTimeExtentDefinitionLayer()` The time-enabled layer that defines the time extent of the map.
`int`	`getTimeExtentOption()` Indicates how the time extent of the map is defined.
`ITimeReference`	`getTimeReference()` The time reference (time zone information, daylight savings, etc.) associated with the map.
`int`	`getTimeRelation()` Time relation used with the time window for the map.
`ITimeValue`	`getTimeValue()` The time extent for which the data is displayed in the map.
`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.
`Object`	`getViewController(Object pViewer)` The controller object (Camera) of a viewer.
`int`	`getWindowHandle(Object pView)` The window handle associated with the given view.
`int`	`hashCode()` the hashcode for this object
`boolean`	`hasTimeData()` Indicates whether the map has a time-enabled layer.
`IMap`	`hitTestMap(IPoint location)` Returns any maps present in the view at the given location.
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`boolean`	`isActive()` Indicates if view is active or not.
`void`	`isDirty()` isDirty
`boolean`	`isDisplayEachTimestamp()` Indicates whether data for each timestamp will be drawn when playing the time visualization.
`boolean`	`isDynamicTimeRefresh()` Indicates whether the data in the map refreshes when moving the time slider dynamically.
`boolean`	`isExpanded()` Indicates if the Map is expanded.
`boolean`	`isFramed()` Indicates if map is drawn in a frame rather than on the whole window.
`boolean`	`isGestureEnabled()` Indicates if interactive gestures are enabled.
`boolean`	`isHasLiveData()` Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
`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.
`boolean`	`isShowTime()` Indicates whether time is enabled on the map.
`boolean`	`isShowTimeOnDisplay()` Indicates whether time is displayed on the map.
`boolean`	`isSpatialReferenceLocked()` Indicates whether the spatial reference is prevented from being changed.
`boolean`	`isUseSymbolLevels()` Indicates if the Map draws using symbol levels.
`void`	`load(IStream pstm)` load
`void`	`loadAnimation(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`	`moveBookmarkTo(IBookmark3D bookmark, int index)` Moves a bookmark in the collection.
`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, 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`	`readExternal(ObjectInput in)`
`void`	`recalcFullExtent()` Forces the full extent to be recalculated.
`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(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)` removeIActiveViewEventsListener.
`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)` save
`void`	`saveAnimation(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)` Provides access to the animation time string.
`void`	`setAnnotationEngineByRef(IAnnotateMap annotateMap)` The annotation (label) engine the map will use.
`void`	`setAreaOfInterest(IEnvelope aoi)` The area of interest for the scene.
`void`	`setClipBorder(IBorder border)` An optional border drawn around ClipGeometry.
`void`	`setClipGeometry(IGeometry clipGeometry)` A shape that layers in the map are clipped to.
`void`	`setCurrentTimeExtentByRef(ITimeExtent timeExtent)` The current time extent of the map.
`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`	`setDefaultTimeInterval(double interval)` The time interval to be used by the time slider to animate the map.
`void`	`setDefaultTimeIntervalUnits(int units)` The time interval units to be used to animate the map.
`void`	`setDefaultTimeWindow(double duration)` The time window used to display the data in the map.
`void`	`setDescription(String descr)` The description of the scene.
`void`	`setDisplayDateFormat(String dateFormat)` The format of the date that is displayed on the time slider.
`void`	`setDisplayEachTimestamp(boolean value)` Indicates whether data for each timestamp will be drawn when playing the time visualization.
`void`	`setDisplaySpeed(int speed)` The speed of the slider on a scale of 1 to 10 with 10 being the fastest.
`void`	`setDisplayTimeFormat(String timeFormat)` The format of the time that is displayed on the time slider.
`void`	`setDistanceUnits(int unitsCode)` The distance units for the map.
`void`	`setDynamicTimeRefresh(boolean flag)` Indicates whether the data in the map refreshes when moving the time slider dynamically.
`void`	`setExaggerationFactor(double exaggerationFactor)` The vertical exaggeration of the scene.
`void`	`setExpanded(boolean expanded)` Indicates if the Map is expanded.
`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`	`setFullTimeExtentByRef(ITimeExtent timeExtent)` Returns the full time extent of the time-enabled layers in the map.
`void`	`setGlobeUnits(int pUnits)` The linear units used in the globe.
`void`	`setHasLiveData(boolean flag)` Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
`void`	`setIsFramed(boolean flag)` Indicates if map is drawn in a frame rather than on the whole window.
`void`	`setIsGestureEnabled(boolean pbGestureEnabled)` Indicates if interactive gestures are enabled.
`void`	`setIsMapActivated(boolean isMapActivated)` Indicates if the focus map is activated.
`void`	`setMapScale(double scaleRF)` The scale of the map as a representative fraction.
`void`	`setMapUnits(int unitsCode)` The units for the map.
`void`	`setName(String name)` The name of the scene.
`void`	`setPageSize(double widthInches, double heightInches)` Sets the page size for the map (optional).
`void`	`setPlayOption(int option)` The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.
`void`	`setReferenceScale(double scaleRF)` The reference scale of the map as a representative fraction.
`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`	`setShowTime(boolean flag)` Indicates whether time is enabled on the map.
`void`	`setShowTimeOnDisplay(boolean flag)` Indicates whether time is displayed on the map.
`void`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` The spatial reference of the scene.
`void`	`setSpatialReferenceLocked(boolean locked)` Indicates whether the spatial reference is prevented from being changed.
`void`	`setTimeExtentDefinitionLayerByRef(ILayer layer)` The time-enabled layer that defines the time extent of the map.
`void`	`setTimeExtentOption(int option)` Indicates how the time extent of the map is defined.
`void`	`setTimeReferenceByRef(ITimeReference timeReference)` The time reference (time zone information, daylight savings, etc.) associated with the map.
`void`	`setTimeRelation(int relation)` Time relation used with the time window for the map.
`void`	`setTimeValueByRef(ITimeValue time)` The time extent for which the data is displayed in the map.
`void`	`setUseSymbolLevels(boolean flag)` Indicates if the Map draws using symbol levels.
`void`	`sortBookmarks(boolean ascending)` Sorts bookmarks in the collection.
`void`	`suggestExaggerationFactor(double aspectRatio, double[] exaggerationFactor)` Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

Globe

public Globe()
      throws IOException,
             UnknownHostException

Constructs a Globe using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

Globe

public Globe(Object obj)
      throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Globe theGlobe = (Globe) obj;

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.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws IOException

addIActiveViewEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:: IOException - If there are communications problems.

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws IOException

removeIActiveViewEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:: IOException - If there are communications problems.

refreshGroupLayer

public void refreshGroupLayer(ILayer pLayer)
                       throws IOException,
                              AutomationException

Refresh globe group layer.

Product Availability

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

Specified by:: refreshGroupLayer in interface IGlobe2

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

setReportLayersInDrawingOrder

public void setReportLayersInDrawingOrder(boolean bTyped)
                                   throws IOException,
                                          AutomationException

Controls if layers are reported in drawing order.

Product Availability

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

Specified by:: setReportLayersInDrawingOrder in interface IGlobe2

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

isReportLayersInDrawingOrder

public boolean isReportLayersInDrawingOrder()
                                     throws IOException,
                                            AutomationException

Controls if layers are reported in drawing order.

Product Availability

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

Specified by:: isReportLayersInDrawingOrder in interface IGlobe2

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

getDanglingCachesCount

public int getDanglingCachesCount()
                           throws IOException,
                                  AutomationException

Returns the count of globe caches which are not saved.

Product Availability

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

Specified by:: getDanglingCachesCount in interface IGlobe2

Returns:: The count
Throws:: 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 IOException,
                                 AutomationException

The globe layers by UID and internal grouping.

Product Availability

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

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

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws IOException,
                                     AutomationException

The globe display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGlobeDisplay in interface IGlobe

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

getDefaultGlobeBackgroundOption

public int getDefaultGlobeBackgroundOption()
                                    throws IOException,
                                           AutomationException

The default background option.

Description

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefaultGlobeBackgroundOption in interface IGlobe

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

setDefaultGlobeBackgroundOption

public void setDefaultGlobeBackgroundOption(int pOption)
                                     throws IOException,
                                            AutomationException

The default background option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultGlobeBackgroundOption in interface IGlobe

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

setDefaultHighBackgroundColor

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

The default high altitude background color.

Description

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

RGB values are floating point between 0 and 1 inclusive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultHighBackgroundColor in interface IGlobe

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

getDefaultHighBackgroundColor

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

The default high altitude background color.

Description

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

RGB values are floating point between 0 and 1 inclusive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: 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 IOException,
                                         AutomationException

The default low altitude background color.

Description

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

RGB values are floating point between 0 and 1 inclusive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultLowBackgroundColor in interface IGlobe

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

getDefaultLowBackgroundColor

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

The default low altitude background color.

Description

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

RGB values are floating point between 0 and 1 inclusive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultBackgTransitionDistances

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

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

Description

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

Values are in kilometers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultBackgTransitionDistances in interface IGlobe

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

getDefaultBackgTransitionDistances

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

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

Description

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

Values are in kilometers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDefaultBackgTransitionDistances in interface IGlobe

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

setGlobeUnits

public void setGlobeUnits(int pUnits)
                   throws IOException,
                          AutomationException

The linear units used in the globe.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setGlobeUnits in interface IGlobe

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

getGlobeUnits

public int getGlobeUnits()
                  throws IOException,
                         AutomationException

The linear units used in the globe.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGlobeUnits in interface IGlobe

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

addLayerType

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

Add layer to globe as specified type.

Description

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setShowGlobeTips

public void setShowGlobeTips(int pTipsType)
                      throws IOException,
                             AutomationException

Show globe tips.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowGlobeTips in interface IGlobe

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

getShowGlobeTips

public int getShowGlobeTips()
                     throws IOException,
                            AutomationException

Show globe tips.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getShowGlobeTips in interface IGlobe

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

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the scene.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IScene
Specified by:: getExtent in interface IActiveView

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IDisplayTransformation.getVisibleBounds(), ITin.getExtent(), IActiveView.getExtent(), IFeatureClassManage.updateExtent(), IFeatureClassManage, IDisplayTransformation.getFittedBounds()

suggestExaggerationFactor

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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getExaggerationFactor

public double getExaggerationFactor()
                             throws IOException,
                                    AutomationException

The vertical exaggeration of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExaggerationFactor in interface IScene

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

setExaggerationFactor

public void setExaggerationFactor(double exaggerationFactor)
                           throws IOException,
                                  AutomationException

The vertical exaggeration of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExaggerationFactor in interface IScene

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

applies

public boolean applies(Object object)
                throws IOException,
                       AutomationException

Indicates if the given object is supported by the scene.

Remarks

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: applies in interface IScene

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the scene.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getName in interface IScene
Specified by:: getName in interface IBasicMap
Specified by:: getName in interface IMap

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface IScene
Specified by:: setName in interface IBasicMap
Specified by:: setName in interface IMap

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

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDescription in interface IScene
Specified by:: getDescription in interface IBasicMap
Specified by:: getDescription in interface IMap

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

setDescription

public void setDescription(String descr)
                    throws IOException,
                           AutomationException

The description of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDescription in interface IScene
Specified by:: setDescription in interface IBasicMap
Specified by:: setDescription in interface IMap

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

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The area of interest for the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaOfInterest in interface IScene

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

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The area of interest for the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAreaOfInterest in interface IScene
Specified by:: setAreaOfInterest in interface IBasicMap
Specified by:: setAreaOfInterest in interface IMap

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

getLayerCount

public int getLayerCount()
                  throws IOException,
                         AutomationException

The number of layers in the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLayerCount in interface IScene
Specified by:: getLayerCount in interface IBasicMap
Specified by:: getLayerCount in interface IMap

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

getLayer

public ILayer getLayer(int index)
                throws IOException,
                       AutomationException

The layer corresponding to a given index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:: getLayer in interface IScene
Specified by:: getLayer in interface IBasicMap
Specified by:: getLayer in interface IMap

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

getLayers

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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:: getLayers in interface IScene
Specified by:: getLayers in interface IBasicMap
Specified by:: getLayers in interface IMap

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

addLayer

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

Adds a layer to the scene.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

addLayers

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

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

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addLayers in interface IScene
Specified by:: addLayers in interface IBasicMap
Specified by:: addLayers in interface IMap

Parameters:: layers - A reference to a com.esri.arcgis.carto.IEnumLayer (in); autoArrange - The autoArrange (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.addLayer(com.esri.arcgis.carto.ILayer), IMap.getLayerCount()

deleteLayer

public void deleteLayer(ILayer layer)
                 throws IOException,
                        AutomationException

Deletes a layer from the scene.

Remarks

Example:

public void deleteLayer(ILayer layer) {

IScene pScene;

ILayer pLayer;

// get IScene ...

if (pScene.LayerCount > 0) {

   pLayer = pScene.getLayer(0);

   pScene.deleteLayer(pLayer);

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

<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
Specified by:: deleteLayer in interface IBasicMap
Specified by:: deleteLayer in interface IMap

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

moveLayer

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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveLayer in interface IScene
Specified by:: moveLayer in interface IMap

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

clearLayers

public void clearLayers()
                 throws IOException,
                        AutomationException

Removes all layers from the scene.

Example:

public void clearLayers(ILayer layer) throws IOException, AutomationException
  {
    IScene pScene;
    ILayer pLayer;

    //get IScene ......

    pScene.clearLayers();
  }

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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
Specified by:: clearLayers in interface IBasicMap
Specified by:: clearLayers in interface IMap

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IScene
Specified by:: getSpatialReference in interface IBasicMap
Specified by:: getSpatialReference in interface IMap

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws IOException,
                                     AutomationException

The spatial reference of the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceByRef in interface IScene
Specified by:: setSpatialReferenceByRef in interface IBasicMap
Specified by:: setSpatialReferenceByRef in interface IMap

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

proposeSpatialReference

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

Proposes a spatial reference for the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getBasicGraphicsLayer

public IGraphicsLayer getBasicGraphicsLayer()
                                     throws IOException,
                                            AutomationException

The basic graphics layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBasicGraphicsLayer in interface IScene
Specified by:: getBasicGraphicsLayer in interface IBasicMap
Specified by:: getBasicGraphicsLayer in interface IMap

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

getActiveGraphicsLayer

public ILayer getActiveGraphicsLayer()
                              throws IOException,
                                     AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getActiveGraphicsLayer in interface IScene
Specified by:: getActiveGraphicsLayer in interface IBasicMap
Specified by:: getActiveGraphicsLayer in interface IMap

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

setActiveGraphicsLayerByRef

public void setActiveGraphicsLayerByRef(ILayer ppLayer)
                                 throws IOException,
                                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setActiveGraphicsLayerByRef in interface IScene
Specified by:: setActiveGraphicsLayerByRef in interface IBasicMap
Specified by:: setActiveGraphicsLayerByRef in interface IMap

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

delayEvents

public void delayEvents(boolean delay)
                 throws IOException,
                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: delayEvents in interface IScene
Specified by:: delayEvents in interface IMap

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

getSelectionCount

public int getSelectionCount()
                      throws IOException,
                             AutomationException

The number of selected features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionCount in interface IScene
Specified by:: getSelectionCount in interface IBasicMap
Specified by:: getSelectionCount in interface IMap

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

selectFeature

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

Selects a feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectFeature in interface IScene
Specified by:: selectFeature in interface IMap

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

clearSelection

public void clearSelection()
                    throws IOException,
                           AutomationException

Clears the scene's selection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: clearSelection in interface IScene
Specified by:: clearSelection in interface IBasicMap
Specified by:: clearSelection in interface IMap

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

getFeatureSelection

public ISelection getFeatureSelection()
                               throws IOException,
                                      AutomationException

The scene's feature selection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFeatureSelection in interface IScene
Specified by:: getFeatureSelection in interface IBasicMap
Specified by:: getFeatureSelection in interface IMap

Returns:: A reference to a com.esri.arcgis.carto.ISelection
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IViewManager.setElementSelectionByRef(com.esri.arcgis.carto.ISelection), IActiveView.getSelection()

setFeatureSelectionByRef

public void setFeatureSelectionByRef(ISelection selection)
                              throws IOException,
                                     AutomationException

The scene's feature selection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFeatureSelectionByRef in interface IScene
Specified by:: setFeatureSelectionByRef in interface IBasicMap
Specified by:: setFeatureSelectionByRef in interface IMap

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

selectByShape

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

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectByShape in interface IScene
Specified by:: selectByShape in interface IBasicMap
Specified by:: selectByShape in interface IMap

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

recalculateExtent

public void recalculateExtent()
                       throws IOException,
                              AutomationException

Forces the scene's extent to be recalculated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: recalculateExtent in interface IScene

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

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws IOException,
                                 AutomationException

The scene's scenegraph.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSceneGraph in interface IScene

Returns:: A reference to a com.esri.arcgis.analyst3d.ISceneGraph
Throws:: 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 IOException,
                                      AutomationException

Sets the default background color.

Remarks

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

The DefaultBackgroundColor is that used by new scenes. Only when a new scene is created will the color set here be used.

If you want to set the background color of the existing scene use ISceneGraph.SetBackgroundColor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDefaultBackgroundColor in interface IScene

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

getDefaultBackgroundColor

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

Returns the default background color.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

getAnimationExtension

public IAnimationExtension getAnimationExtension()
                                          throws IOException,
                                                 AutomationException

The animation extension containing tracks and environment settings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:: getAnimationExtension in interface IBasicScene2

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

getBasicDisplay

public IViewers3D getBasicDisplay()
                           throws IOException,
                                  AutomationException

The basic 3D display used by the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBasicDisplay in interface IBasicScene

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

saveAnimation

public void saveAnimation(String pFilename)
                   throws IOException,
                          AutomationException

Save the animation to a file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveAnimation in interface IBasicScene

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

loadAnimation

public void loadAnimation(String pFilename)
                   throws IOException,
                          AutomationException

Load the animation from a file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: loadAnimation in interface IBasicScene

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

getFullExtent

public IEnvelope getFullExtent()
                        throws IOException,
                               AutomationException

The full extent rectangle.

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) .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFullExtent in interface IActiveView

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IDisplayTransformation.getBounds(), IDisplayTransformation, IActiveView.getFullExtent()

setFullExtent

public void setFullExtent(IEnvelope extent)
                   throws IOException,
                          AutomationException

The full extent rectangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFullExtent in interface IActiveView

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

setExtent

public void setExtent(IEnvelope extent)
               throws IOException,
                      AutomationException

The visible extent rectangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExtent in interface IActiveView

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

getScreenDisplay

public IScreenDisplay getScreenDisplay()
                                throws IOException,
                                       AutomationException

The screen display used by the view.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getScreenDisplay in interface IActiveView

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

getGraphicsContainer

public IGraphicsContainer getGraphicsContainer()
                                        throws IOException,
                                               AutomationException

The active graphics container.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGraphicsContainer in interface IActiveView

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

getFocusMap

public IMap getFocusMap()
                 throws IOException,
                        AutomationException

The map that tools and controls act on.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFocusMap in interface IActiveView

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

setFocusMapByRef

public void setFocusMapByRef(IMap activeMap)
                      throws IOException,
                             AutomationException

The map that tools and controls act on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFocusMapByRef in interface IActiveView

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

isMapActivated

public boolean isMapActivated()
                       throws IOException,
                              AutomationException

Indicates if the focus map is activated.

Remarks

In ArcMap's layout view, when the focus map is activated by double-clicking on it, new graphic elements are added to the Map's active graphics layer. When the focus map is not activated, the default, graphic elements are added to the PageLayout object. Both the Map and PageLayout objects are graphics containers, setting this property to TRUE diverts graphics from the PageLayout to the focus Map.

A Map can be activated in both layout and data views.

When this property is set to TRUE, IActiveView::PartialRefresh is called for the esriViewGraphicSelection draw phase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isMapActivated in interface IActiveView

Returns:: The isMapActivated
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: com.esri.arcgis.carto.IMxDocument

setIsMapActivated

public void setIsMapActivated(boolean isMapActivated)
                       throws IOException,
                              AutomationException

Indicates if the focus map is activated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIsMapActivated in interface IActiveView

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

getSelection

public ISelection getSelection()
                        throws IOException,
                               AutomationException

The selection.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelection in interface IActiveView

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

setSelectionByRef

public void setSelectionByRef(ISelection selection)
                       throws IOException,
                              AutomationException

The selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSelectionByRef in interface IActiveView

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

getTipText

public String getTipText(double x,
                         double y)
                  throws IOException,
                         AutomationException

The tip text to display at the given location.

Product Availability

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

Specified by:: getTipText in interface IActiveView

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

getExportFrame

public tagRECT getExportFrame()
                       throws IOException,
                              AutomationException

The device rectangle to export.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExportFrame in interface IActiveView

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

isShowScrollBars

public boolean isShowScrollBars()
                         throws IOException,
                                AutomationException

Indicates if scrollbars are visible.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowScrollBars in interface IActiveView

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

setShowScrollBars

public void setShowScrollBars(boolean showScrollBars)
                       throws IOException,
                              AutomationException

Indicates if scrollbars are visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowScrollBars in interface IActiveView

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

isShowRulers

public boolean isShowRulers()
                     throws IOException,
                            AutomationException

Indicates if rulers are visible.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowRulers in interface IActiveView

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

setShowRulers

public void setShowRulers(boolean showRulers)
                   throws IOException,
                          AutomationException

Indicates if rulers are visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowRulers in interface IActiveView

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

isShowSelection

public boolean isShowSelection()
                        throws IOException,
                               AutomationException

Indicates if selection is visible.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowSelection in interface IActiveView

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

setShowSelection

public void setShowSelection(boolean showRulers)
                      throws IOException,
                             AutomationException

Indicates if selection is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowSelection in interface IActiveView

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

getExtentStack

public IExtentStack getExtentStack()
                            throws IOException,
                                   AutomationException

The extent stack.

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.

Example:


Map map = new Map();
IExtentStack pExtentStack = map.getActiveView().getExtentStack();
if(pExtentStack.canUndo()){        
  pExtentStack.undo();      
}

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtentStack in interface IActiveView

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

getScreenCacheID

public short getScreenCacheID(int phase,
                              Object data)
                       throws IOException,
                              AutomationException

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

Product Availability

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

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

hitTestMap

public IMap hitTestMap(IPoint location)
                throws IOException,
                       AutomationException

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.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isActive

public boolean isActive()
                 throws IOException,
                        AutomationException

Indicates if view is active or not.

Remarks

In layout view, all of the Maps and the PageLayout are active. In data view, only the focus map is active.

The PageLayout object uses this property when adding Elements; if the PageLayout is active, new elements are activated (IElement::Activate).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isActive in interface IActiveView

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

activate

public void activate(int hWnd)
              throws IOException,
                     AutomationException

Gives this view control of the specified window.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: activate in interface IActiveView

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

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

Another view takes over the associated window.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deactivate in interface IActiveView

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

draw

public void draw(int hDC,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the view to the specified device context.

Product Availability

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

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:: 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 IOException,
                   AutomationException

Renders the view to the specified DC.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: output in interface IActiveView

Parameters:: hDC - The hDC (A COM typedef) (in); dpi - The dpi (in); pixelBounds - A Structure: com.esri.arcgis.system.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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Causes the entire view to draw.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: refresh in interface IActiveView

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: esriViewDrawPhase, IGlobeLayerProperties2, IActiveView.partialRefresh(int, java.lang.Object, com.esri.arcgis.geometry.IEnvelope), IScreenDisplay.invalidate(com.esri.arcgis.geometry.IEnvelope, boolean, short), IActiveView.getScreenCacheID(int, java.lang.Object), IActiveView.refresh()

partialRefresh

public void partialRefresh(int phase,
                           Object data,
                           IEnvelope envelope)
                    throws IOException,
                           AutomationException

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

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.

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.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: esriViewDrawPhase, IGlobeLayerProperties2, IActiveView.partialRefresh(int, java.lang.Object, com.esri.arcgis.geometry.IEnvelope), IScreenDisplay.invalidate(com.esri.arcgis.geometry.IEnvelope, boolean, short), IActiveView.getScreenCacheID(int, java.lang.Object), IActiveView.refresh()

clear

public void clear()
           throws IOException,
                  AutomationException

Empties the view contents.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clear in interface IActiveView

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

printerChanged

public void printerChanged(IPrinter printer)
                    throws IOException,
                           AutomationException

Called by application when printer changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: printerChanged in interface IActiveView

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

contentsChanged

public void contentsChanged()
                     throws IOException,
                            AutomationException

Called by clients when view objects are modified.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: contentsChanged in interface IActiveView

Throws:: 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 IOException,
                      AutomationException

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

Product Availability

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

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

getContextMenu

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

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

Product Availability

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

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

addLayer

public void addLayer(ILayer pLayer)
              throws IOException,
                     AutomationException

Adds a layer to the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addLayer in interface IBasicMap
Specified by:: addLayer in interface IMap

Parameters:: pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.addLayers(com.esri.arcgis.carto.IEnumLayer, boolean), IMap.getLayerCount()

getMapSurroundCount

public int getMapSurroundCount()
                        throws IOException,
                               AutomationException

Number of map surrounds associated with the map.

Remarks

MapSurround objects include Legends, North Arrows, Scale Bars, and Scale Text. Use this property in conjunction with the MapSurround property to loop through all of the MapSurround objects associated with a Map.

See AddMapSurround for information on adding new MapSurrounds to a Map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapSurroundCount in interface IMap

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.getMapSurround(int), IMap.addMapSurround(com.esri.arcgis.carto.IMapSurround)

getMapSurround

public IMapSurround getMapSurround(int index)
                            throws IOException,
                                   AutomationException

The map surround at the given index.

Product Availability

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

Specified by:: getMapSurround in interface IMap

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

getMapUnits

public int getMapUnits()
                throws IOException,
                       AutomationException

The units for the map.

Remarks

MapUnits is the predefined enumeration (esriUnits) data type currently associated with the Map object.

AddLayer automatically attempts to set the Map's SpatialReference property if a coordinate system has not yet been defined for the map. When the SpatialReference property is set, the Map's MapUnits and DistanceUnits properties are set as well.

When multiple layers are added simultaneously with AddLayers, the first spatial reference found is used.

If no layers have a spatial reference, AddLayer checks the extent of the first layer (ILayer::AreaOfInterest) and if it has coordinates that look like geographic coordinates (XMin >= -180 and XMax <= 180 and YMin >= -90 and YMax <= 90), ArcMap assumes the data is in decimal degrees and sets the MapUnits to esriDecimalDegrees and DistanceUnits to esriMiles.

If no spatial reference is found and the coordinates do not look like geographic coordinates, ArcMap sets no spatial reference and sets the MapUnits to esriMeters and the DistanceUnits to esriMeters.

Example:

 
MapControl m = new MapControl();   
IMap pMap;   
ISpatialReference pSpatialReference;   
IProjectedCoordinateSystem pProjectedCoordinateSystem;   
ILinearUnit pLinearUnit;   
ISpatialReferenceInfo pSpatialReferenceInfo; 
pMap = m.getMap();   
System.out.println(pMap.getMapUnits());
   
pSpatialReference = pMap.getSpatialReference();   
pProjectedCoordinateSystem =        
  new IProjectedCoordinateSystemProxy(pSpatialReference);
pLinearUnit = pProjectedCoordinateSystem.getCoordinateUnit();
pSpatialReferenceInfo =        
  new ISpatialReferenceInfoProxy(pLinearUnit);   
System.out.println(pSpatialReferenceInfo.getFactoryCode());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapUnits in interface IMap

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

setMapUnits

public void setMapUnits(int unitsCode)
                 throws IOException,
                        AutomationException

The units for the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMapUnits in interface IMap

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

getDistanceUnits

public int getDistanceUnits()
                     throws IOException,
                            AutomationException

The distance units for the map.

Description

The units - for example, feet, miles, meters, kilometers - ArcMap uses to report measurements, dimensions of shapes, and distance tolerances and offsets.

Remarks

DistanceUnits is the predefined enumeration (esriUnits) data type currently associated with the Map object.

When multiple layers are added simultaneously with AddLayers, the first spatial reference found is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDistanceUnits in interface IMap

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

setDistanceUnits

public void setDistanceUnits(int unitsCode)
                      throws IOException,
                             AutomationException

The distance units for the map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDistanceUnits in interface IMap

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

getMapScale

public double getMapScale()
                   throws IOException,
                          AutomationException

The scale of the map as a representative fraction.

Remarks

Scale is the relationship between the dimensions of features on a map and the geographic objects they represent on the earth, commonly expressed as a fraction or a ratio. A map scale of 1/100,000 or 1:100,000 means that one unit of measure on the map equals 100,000 of the same units on the earth.

The MapScale property is really a shortcut to IDisplayTransformation::ScaleRatio.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMapScale in interface IMap

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

setMapScale

public void setMapScale(double scaleRF)
                 throws IOException,
                        AutomationException

The scale of the map as a representative fraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMapScale in interface IMap

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

getReferenceScale

public double getReferenceScale()
                         throws IOException,
                                AutomationException

The reference scale of the map as a representative fraction.

Remarks

All symbols are drawn relative to the scale value set in this property. By default this value is zero. Symbol size is true at the reference scale. When the reference scale is 0, symbols are always drawn at the same size regardless of the map scale (ScaleRatio). For example, if you set your labels to display with 10 pt font, they will appear as 10 pt text at any map scale. When the reference scale is greater than 0, symbols are drawn at a size relative to the map scale. For example, if you set your labels to display with 10 pt font and have a reference scale of 10,000, the labels will appear as 10 pt only at that map scale; as you zoom in, the size of all symbols increases because the size of the symbols is based on the smaller scale.

The ReferenceScale property is a shortcut to IDisplayTransformation::ReferenceScale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getReferenceScale in interface IMap

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

setReferenceScale

public void setReferenceScale(double scaleRF)
                       throws IOException,
                              AutomationException

The reference scale of the map as a representative fraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setReferenceScale in interface IMap

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

isFramed

public boolean isFramed()
                 throws IOException,
                        AutomationException

Indicates if map is drawn in a frame rather than on the whole window.

Remarks

When creating a custom application, if you want the display to take over the window it's drawing in, set IsFramed to FALSE. This will add scrollbars (IScreenDisplay::UseScrollBars = TRUE) as necessary and keeps the device frame in sync with the window extent. Setting IsFramed to TRUE means that the display is drawing on some extent within the window. In this case, it won't show scrollbars and it won't automatically update the device frame.

For example, in the ArcMap application, in layout view where each Map resides inside a separate MapFrame, each Map has it IsFramed property set to TRUE. In data view, the opposite is true, a Map's display fits the entire window; in this view, all Map's have IsFramed set to FALSE, not just the focus map.

The IsFramed property also sets the IsFirstCacheTransparent property. When a Map is drawing in layout view, the PageLayout object has its ScreenDisplay and each Map has its own separate ScreenDisplay. This means that the layout has it's display cache(s) and the maps have their own. If the bottom cache of each map was opaque, you wouldn't be able to see through a map onto layout elements below it. Setting IsFirstCacheTransparent on the maps in layout view lets you see through the maps.

This property is really a shortcut to IScreenDisplay::IsFramed.

If you are working with Map's inside of ArcMap these settings should not be touched. Only use this property when building a low level appliation that uses a display to draw on a frame on a window.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isFramed in interface IMap

Returns:: The flag
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: com.esri.arcgis.carto.IScreenDisplay

setIsFramed

public void setIsFramed(boolean flag)
                 throws IOException,
                        AutomationException

Indicates if map is drawn in a frame rather than on the whole window.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIsFramed in interface IMap

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

getClipGeometry

public IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException

A shape that layers in the map are clipped to.

Remarks

Use the ClipGeometry property to shape the area the Map is drawn in. For example, if you had a map of the United States that contained many layers, you could set the Map's ClipGeometry equal to the geometry of a particular state thereby telling the map to only draw the map data falling within the particular state's area.

The scripts below demonstrate this.

In the ArcMap user interface, the same functionality is available on the map's data frame properties page. Right-click on a map in the table of contents and select Properties. Select the Data Frame tab and look at 'Clip to Shape'. Under 'Specify a Shape', select 'Outline of Data Graphics'. You can also specify a 'Custom Extent' or use the 'Outline of Features'.

The ClipBorder property puts a border around the cut out.

By default there is no clip geometry and no clip border.

Example:

 
MapControl pMapControl = new MapControl();   
IMap pMap;   
IViewManager pViewManager;   
IEnumElement pEnumElement;   
IElement pElement;   
IActiveView pActiveView;    IBorder pBorder;  
 
 pMap = pMapControl.getMap();
 pViewManager = new IViewManagerProxy(pMap);
 pEnumElement = new IEnumElementProxy( pViewManager.getElementSelection());
 pEnumElement.reset();
   
 pElement = pEnumElement.next();
 if(pElement != null){
   if(pElement.getGeometry().getGeometryType() == esriGeometryType.esriGeometryPolygon){
       pBorder = new SymbolBorder();
       pMap.setClipGeometry(pElement.getGeometry());
       pMap.setClipBorder(pBorder);
       pMapControl.getActiveView().refresh();
     }
   }

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClipGeometry in interface IMap

Returns:: A reference to a com.esri.arcgis.geometry.IGeometry
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.getClipBorder()

setClipGeometry

public void setClipGeometry(IGeometry clipGeometry)
                     throws IOException,
                            AutomationException

A shape that layers in the map are clipped to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setClipGeometry in interface IMap

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

createMapSurround

public IMapSurround createMapSurround(IUID clsid,
                                      IMapSurround optionalStyle)
                               throws IOException,
                                      AutomationException

Create and initialize a map surround. An optional style from the style gallery may be specified.

Remarks

The CreateMapSurround method creates a new MapSurround object based on the required GUID parameter. The optional style parameter specifies a partially initialized surround that comes from the style gallery. For example, there are an entire collection of north arrows in the style gallery, use this parameter to specify the desired one.

CreateMapSurround automatically calls AddMapSurround to associate the new surround with the Map.

In the ArcMap application, the model for MapSurround objects is that each surround is contained by a separate MapSurroundFrame which has a relation to a MapFrame which holds the Map. The CreateMapSurround method does not follow this model and is exposed for developers who want to create surrounds in a different window. To keep with ArcMap's surround model, use IMapFrame::CreateSurroundFrame. This method automatically creates a new MapSurroundFrame object with a MapSurround and associates them with the Map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: createMapSurround in interface IMap

Parameters:: clsid - A reference to a com.esri.arcgis.system.IUID (in); optionalStyle - A reference to a com.esri.arcgis.carto.IMapSurround (in)
Returns:: A reference to a com.esri.arcgis.carto.IMapSurround
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.createMapSurround(com.esri.arcgis.system.IUID, com.esri.arcgis.carto.IMapSurround), IMap.deleteMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.addMapSurround(com.esri.arcgis.carto.IMapSurround), IMapFrame.createSurroundFrame(com.esri.arcgis.system.IUID, com.esri.arcgis.carto.IMapSurround), IMap.clearMapSurrounds()

addMapSurround

public void addMapSurround(IMapSurround mapSurround)
                    throws IOException,
                           AutomationException

Adds a map surround to the map.

Remarks

Use this method to associate a new MapSurround object with the Map. Both IMap::CreateMapSurround and IMapFrame::CreateSurroundFrame automatically call this method to associate the surrounds they create with the Map.

Use IMap::MapSurroundCount to get the total number of surrounds associated with the Map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addMapSurround in interface IMap

Parameters:: mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.createMapSurround(com.esri.arcgis.system.IUID, com.esri.arcgis.carto.IMapSurround), IMap.deleteMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.addMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.clearMapSurrounds()

deleteMapSurround

public void deleteMapSurround(IMapSurround mapSurround)
                       throws IOException,
                              AutomationException

Deletes a map surround from the map.

Remarks

DeleteMapSurround method removes the MapSurround object from the Map and decrements the MapSurroundCount by 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteMapSurround in interface IMap

Parameters:: mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.createMapSurround(com.esri.arcgis.system.IUID, com.esri.arcgis.carto.IMapSurround), IMap.deleteMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.addMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.clearMapSurrounds()

clearMapSurrounds

public void clearMapSurrounds()
                       throws IOException,
                              AutomationException

Removes all map surrounds from the map.

Remarks

The ClearMapSurrounds removes all of the surrounds associated with a Map thus resetting the MapSurroundCount to 0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clearMapSurrounds in interface IMap

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.createMapSurround(com.esri.arcgis.system.IUID, com.esri.arcgis.carto.IMapSurround), IMap.deleteMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.addMapSurround(com.esri.arcgis.carto.IMapSurround), IMap.clearMapSurrounds()

computeDistance

public double computeDistance(IPoint p1,
                              IPoint p2)
                       throws IOException,
                              AutomationException

Computes the distance between two points on the map and returns the result.

Description

ComputeDistance computes and returns the distance between two input points. This method calculates the distance based on the current map units (IMap::MapUnits) and reports the distance using the current distance units (IMap::DistanceUnits).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: computeDistance in interface IMap

Parameters:: p1 - A reference to a com.esri.arcgis.geometry.IPoint (in); p2 - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:: The distance
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IMap.getDistanceUnits(), IMap.getMapUnits()

getClipBorder

public IBorder getClipBorder()
                      throws IOException,
                             AutomationException

An optional border drawn around ClipGeometry.

Remarks

If a ClipGeometry has been set, you have the option of drawing a border around the clipped map. Use the ClipBorder propety to specify the type of border drawn.

Use the ClipGeometry property to shape the area the Map is drawn in. For example, if you had a map of the United States that contained many layers, you could set the Map's ClipGeometry equal to the geometry of a particular state thereby telling the map to only draw the map data falling within the particular state's area.

By default there is no clip geometry or clip border.

Example:


MapControl pMapControl = new MapControl();   
IMap pMap;   
IViewManager pViewManager;   
IEnumElement pEnumElement;   
IElement pElement;   
IActiveView pActiveView;   
IBorder pBorder;   
pMap = pMapControl.getMap();   
pViewManager = new IViewManagerProxy(pMap);   
pEnumElement = new IEnumElementProxy( pViewManager.getElementSelection());   
pEnumElement.reset();
   
pElement = pEnumElement.next();   
if(pElement != null){     
  if(pElement.getGeometry().getGeometryType() == 
     esriGeometryType.esriGeometryPolygon){       
    pBorder = new SymbolBorder();       
    pMap.setClipGeometry(pElement.getGeometry());       
    pMap.setClipBorder(pBorder);       
    pMapControl.getActiveView().refresh();     
  }   
}

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClipBorder in interface IMap

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

setClipBorder

public void setClipBorder(IBorder border)
                   throws IOException,
                          AutomationException

An optional border drawn around ClipGeometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setClipBorder in interface IMap

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

setPageSize

public void setPageSize(double widthInches,
                        double heightInches)
                 throws IOException,
                        AutomationException

Sets the page size for the map (optional).

Remarks

SetPageSize sets the width and height of the Map in inches.

In the ArcMap application, the Map width and height are set to 0 inches by 0 inches in data view; in layout view, the Map's size is by default set to fit within the page size (IPage::QuerySize).

Developers creating their own application may use SetPageSize to set the size of the Map in their own page space.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setPageSize in interface IMap

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

getPageSize

public void getPageSize(double[] widthInches,
                        double[] heightInches)
                 throws IOException,
                        AutomationException

Gets the page size for the map.

Remarks

GetPageSize returns the width and height of the Map in inches.

In the ArcMap application, the Map width and height are set to 0 inches by 0 inches in data view; in layout view, the Map's size is by default set to fit within the page size (IPage::QuerySize).

Developers creating their own application may use SetPageSize to set the size of the Map in their own page space.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPageSize in interface IMap

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

getBarriers

public IBarrierCollection getBarriers(IEnvelope pExtent)
                               throws IOException,
                                      AutomationException

The list of barriers and their weight for labeling.

Product Availability

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

Specified by:: getBarriers in interface IMap

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

setUseSymbolLevels

public void setUseSymbolLevels(boolean flag)
                        throws IOException,
                               AutomationException

Indicates if the Map draws using symbol levels.

Remarks

UseSymbolLevels flag indicates if the order of symbols is to be drawn by their assign level value. When the flag is TRUE, symbols with lower level values get to be drawn first on the screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseSymbolLevels in interface IMap

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

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws IOException,
                                 AutomationException

Indicates if the Map draws using symbol levels.

Description

Determines whether Symbol Level Drawing is enabled for a Map.

Remarks

Symbol Level Drawing is useful when creating large scale maps with intersecting and overlapping line features. For example, on a large scale reference map with intersecting highways and streets, Symbol Level Drawing helps you create high-quality representations of the street and highway street intersections.

To set up Symbol Level Drawing:

Turn on Symbol Level Drawing using either for your layer using ISymbolLevels::UseSymbolLevels, or for your entire map using IMap::UseSymbolLevels.
For each layer that you want to set up symbol levels for, access that layer's renderer using IGeoFeatureLayer::Renderer.
Access your layer's symbol(s) through the renderer.
Using IMapLevel, set symbol levels on your layer's symbols. Symbols with MapLevel = 0 draw first, then symbols with MapLevel = 1, continuing until the highest MapLevel is reached. If two symbols have the same MapLevel, then the features drawn with these symbols are drawn in the normal layer order. A MapLevel of -1 for a multilayer symbol (MultiLayerMarkerSymbol, MultiLayerLineSymbol, MultiLayerFillSymbol) indicates that each of the symbol's individual layers are drawn with their individual MapLevel .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseSymbolLevels in interface IMap

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

setExpanded

public void setExpanded(boolean expanded)
                 throws IOException,
                        AutomationException

Indicates if the Map is expanded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setExpanded in interface IMap

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

isExpanded

public boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the Map is expanded.

Remarks

Use this property to expand or collapse the Map in the table of contents. By default a Map is expanded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isExpanded in interface IMap

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

setAnnotationEngineByRef

public void setAnnotationEngineByRef(IAnnotateMap annotateMap)
                              throws IOException,
                                     AutomationException

The annotation (label) engine the map will use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAnnotationEngineByRef in interface IMap

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

getAnnotationEngine

public IAnnotateMap getAnnotationEngine()
                                 throws IOException,
                                        AutomationException

The annotation (label) engine the map will use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAnnotationEngine in interface IMap

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

recalcFullExtent

public void recalcFullExtent()
                      throws IOException,
                             AutomationException

Forces the full extent to be recalculated.

Remarks

Recalculates the Map's full extent so that all of the Map's feature layers, fall within its bounds.

AddLayer, AddLayers, and DeleteLayer all call RecalcFullExtent automatically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: recalcFullExtent in interface IMap

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

delayDrawing

public void delayDrawing(boolean delay)
                  throws IOException,
                         AutomationException

Suspends drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: delayDrawing in interface IMap

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

setSpatialReferenceLocked

public void setSpatialReferenceLocked(boolean locked)
                               throws IOException,
                                      AutomationException

Indicates whether the spatial reference is prevented from being changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceLocked in interface IMap

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

isSpatialReferenceLocked

public boolean isSpatialReferenceLocked()
                                 throws IOException,
                                        AutomationException

Indicates whether the spatial reference is prevented from being changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSpatialReferenceLocked in interface IMap

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

selectionChanged

public void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Call this function to fire the selection changed event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectionChanged in interface ISelectionEvents

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

getTableCount

public int getTableCount()
                  throws IOException,
                         AutomationException

Number of tables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTableCount in interface ITableCollection

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

getTable

public ITable getTable(int index)
                throws IOException,
                       AutomationException

The table at the given index.

Product Availability

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

Specified by:: getTable in interface ITableCollection

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

addTable

public void addTable(ITable table)
              throws IOException,
                     AutomationException

Adds a table to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addTable in interface ITableCollection

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

removeTable

public void removeTable(ITable table)
                 throws IOException,
                        AutomationException

Removes a table from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeTable in interface ITableCollection

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

removeAllTables

public void removeAllTables()
                     throws IOException,
                            AutomationException

Removes all tables from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllTables in interface ITableCollection

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

getStandaloneTableCount

public int getStandaloneTableCount()
                            throws IOException,
                                   AutomationException

Number of standalone tables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getStandaloneTableCount in interface IStandaloneTableCollection

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

getStandaloneTable

public IStandaloneTable getStandaloneTable(int index)
                                    throws IOException,
                                           AutomationException

The standalone table at the given index.

Product Availability

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

Specified by:: getStandaloneTable in interface IStandaloneTableCollection

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

addStandaloneTable

public void addStandaloneTable(IStandaloneTable table)
                        throws IOException,
                               AutomationException

Adds a standalone table to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addStandaloneTable in interface IStandaloneTableCollection

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

removeStandaloneTable

public void removeStandaloneTable(IStandaloneTable table)
                           throws IOException,
                                  AutomationException

Removes the standalone table from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeStandaloneTable in interface IStandaloneTableCollection

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

removeAllStandaloneTables

public void removeAllStandaloneTables()
                               throws IOException,
                                      AutomationException

Removes all standalone tables from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllStandaloneTables in interface IStandaloneTableCollection

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

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws IOException,
                                                     AutomationException

The memory relationship classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getRelationshipClasses in interface IRelationshipClassCollection

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

findRelationshipClasses

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

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

Product Availability

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

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

moveBookmarkTo

public void moveBookmarkTo(IBookmark3D bookmark,
                           int index)
                    throws IOException,
                           AutomationException

Moves a bookmark in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:: moveBookmarkTo in interface ISceneBookmarks2

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

sortBookmarks

public void sortBookmarks(boolean ascending)
                   throws IOException,
                          AutomationException

Sorts bookmarks in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:: sortBookmarks in interface ISceneBookmarks2

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

getBookmarks

public IArray getBookmarks()
                    throws IOException,
                           AutomationException

The bookmarks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBookmarks in interface ISceneBookmarks

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

addBookmark

public void addBookmark(IBookmark3D pBookmark)
                 throws IOException,
                        AutomationException

Adds a bookmark to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addBookmark in interface ISceneBookmarks

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

findBookmark

public void findBookmark(String name,
                         IBookmark3D[] ppBookmark)
                  throws IOException,
                         AutomationException

Finds a bookmark by name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

removeBookmark

public void removeBookmark(IBookmark3D bookmark)
                    throws IOException,
                           AutomationException

Removes a bookmark from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeBookmark in interface ISceneBookmarks

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

removeAllBookmarks

public void removeAllBookmarks()
                        throws IOException,
                               AutomationException

Removes all bookmarks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllBookmarks in interface ISceneBookmarks

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

getBookmarkCount

public int getBookmarkCount()
                     throws IOException,
                            AutomationException

The number of bookmarks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBookmarkCount in interface ISceneBookmarks

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

saveBookmarks

public void saveBookmarks(IStream pStm)
                   throws IOException,
                          AutomationException

Save the bookmarks to a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveBookmarks in interface ISceneBookmarks

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

loadBookmarks

public void loadBookmarks(IStream pStm)
                   throws IOException,
                          AutomationException

Load the bookmarks from a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: loadBookmarks in interface ISceneBookmarks

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

getAnimationTypes

public IArray getAnimationTypes()
                         throws IOException,
                                AutomationException

The objects that describe the registered types of animation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAnimationTypes in interface IAnimationTracks
Specified by:: getAnimationTypes in interface IAGAnimationContainer

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

getTrackCount

public int getTrackCount()
                  throws IOException,
                         AutomationException

The number of tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTrackCount in interface IAnimationTracks
Specified by:: getTrackCount in interface IAGAnimationTracks

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

getTracks

public IArray getTracks()
                 throws IOException,
                        AutomationException

The animation tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTracks in interface IAnimationTracks

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

getTracksOfType

public IArray getTracksOfType(IAnimationType pType)
                       throws IOException,
                              AutomationException

The animation tracks of a given type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

addTrack

public void addTrack(IAnimationTrack pTrack)
              throws IOException,
                     AutomationException

Adds a track to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addTrack in interface IAnimationTracks

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

findTrack

public void findTrack(String name,
                      IAnimationTrack[] ppTrack)
               throws IOException,
                      AutomationException

Finds a track by name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

removeTrack

public void removeTrack(IAnimationTrack pTrack)
                 throws IOException,
                        AutomationException

Removes a track from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeTrack in interface IAnimationTracks

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

removeAllTracks

public void removeAllTracks()
                     throws IOException,
                            AutomationException

Removes all tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllTracks in interface IAnimationTracks
Specified by:: removeAllTracks in interface IAGAnimationTracks

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

saveTracks

public void saveTracks(IStream pStm)
                throws IOException,
                       AutomationException

Save the animation tracks to a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: saveTracks in interface IAnimationTracks
Specified by:: saveTracks in interface IAGAnimationTracks

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

loadTracks

public void loadTracks(IStream pStm)
                throws IOException,
                       AutomationException

Load the animation tracks from a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: loadTracks in interface IAnimationTracks
Specified by:: loadTracks in interface IAGAnimationTracks

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

detachObject

public void detachObject(Object pObject)
                  throws IOException,
                         AutomationException

Detach an object from all tracks it is attached to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: detachObject in interface IAnimationTracks
Specified by:: detachObject in interface IAGAnimationTracks

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

refreshAttachedObjects

public void refreshAttachedObjects()
                            throws IOException,
                                   AutomationException

Detaches from the tracks those objects that no longer exist.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: refreshAttachedObjects in interface IAnimationTracks
Specified by:: refreshAttachedObjects in interface IAGAnimationTracks

Throws:: 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 IOException,
                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

changePriority

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

Changes the priority (index) of the track.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getAnimationObjectContainer

public IAGAnimationContainer getAnimationObjectContainer()
                                                  throws IOException,
                                                         AutomationException

The container of the animation objects attached to the tracks.

Product Availability

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

Specified by:: getAnimationObjectContainer in interface IAGAnimationTracks

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

setAnimationObjectContainerByRef

public void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws IOException,
                                             AutomationException

The container of the animation objects attached to the tracks.

Product Availability

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

Specified by:: setAnimationObjectContainerByRef in interface IAGAnimationTracks

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

getAGTracks

public IArray getAGTracks()
                   throws IOException,
                          AutomationException

The animation tracks.

Remarks

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

Product Availability

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

Specified by:: getAGTracks in interface IAGAnimationTracks

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

getTracksOfType

public IArray getTracksOfType(IAGAnimationType pType)
                       throws IOException,
                              AutomationException

The animation tracks of a given type.

Product Availability

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

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

createTrack

public IAGAnimationTrack createTrack(IAGAnimationType pType)
                              throws IOException,
                                     AutomationException

Creates a new track and adds it to the collection.

Product Availability

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

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

addTrack

public void addTrack(IAGAnimationTrack pTrack)
              throws IOException,
                     AutomationException

Adds a track to the collection.

Product Availability

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

Specified by:: addTrack in interface IAGAnimationTracks

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

findTrack

public void findTrack(String name,
                      IAGAnimationTrack[] ppTrack)
               throws IOException,
                      AutomationException

Finds a track by name.

Product Availability

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

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

removeTrack

public void removeTrack(IAGAnimationTrack pTrack)
                 throws IOException,
                        AutomationException

Removes a track from the collection.

Product Availability

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

Specified by:: removeTrack in interface IAGAnimationTracks

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

applyTracks

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

Uses the enabled animation tracks for the given time.

Product Availability

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

Specified by:: applyTracks in interface IAGAnimationTracks

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

changePriority

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

Changes the priority (index) of the track.

Product Availability

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

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

getCurrentView

public Object getCurrentView()
                      throws IOException,
                             AutomationException

The current active viewer.

Product Availability

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

Specified by:: getCurrentView in interface IAGAnimationContainer

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

getAllViews

public IArray getAllViews()
                   throws IOException,
                          AutomationException

All the viewers.

Product Availability

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

Specified by:: getAllViews in interface IAGAnimationContainer

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

getViewController

public Object getViewController(Object pViewer)
                         throws IOException,
                                AutomationException

The controller object (Camera) of a viewer.

Product Availability

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

Specified by:: getViewController in interface IAGAnimationContainer

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

refreshViews

public void refreshViews(boolean bRefreshAllViewers)
                  throws IOException,
                         AutomationException

Refresh the active viewer or all viewers.

Product Availability

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

Specified by:: refreshViews in interface IAGAnimationContainer

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

refreshObject

public void refreshObject(Object pObject)
                   throws IOException,
                          AutomationException

Container-specific actions to refresh object.

Product Availability

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

Specified by:: refreshObject in interface IAGAnimationContainer

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

saveViewerStates

public void saveViewerStates()
                      throws IOException,
                             AutomationException

Save the current state of the viewers.

Product Availability

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

Specified by:: saveViewerStates in interface IAGAnimationContainer

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

restoreViewerStates

public void restoreViewerStates(boolean bApplyRestored)
                         throws IOException,
                                AutomationException

Restore the current state of the viewers.

Product Availability

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

Specified by:: restoreViewerStates in interface IAGAnimationContainer

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

putIsAnimating

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

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

Product Availability

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

Specified by:: putIsAnimating in interface IAGAnimationContainer

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

isGestureEnabled

public boolean isGestureEnabled()
                         throws IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Product Availability

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

Specified by:: isGestureEnabled in interface IAGAnimationContainer

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

setIsGestureEnabled

public void setIsGestureEnabled(boolean pbGestureEnabled)
                         throws IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Product Availability

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

Specified by:: setIsGestureEnabled in interface IAGAnimationContainer

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

getWindowHandle

public int getWindowHandle(Object pView)
                    throws IOException,
                           AutomationException

The window handle associated with the given view.

Product Availability

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

Specified by:: getWindowHandle in interface IAGAnimationContainer

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

getAnimationFileExtension

public String getAnimationFileExtension()
                                 throws IOException,
                                        AutomationException

The extension for the animation files.

Product Availability

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

Specified by:: getAnimationFileExtension in interface IAGAnimationContainer

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

getAnimationFileFilter

public String getAnimationFileFilter(boolean bAllVersions)
                              throws IOException,
                                     AutomationException

The filter for browing animation files.

Product Availability

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

Specified by:: getAnimationFileFilter in interface IAGAnimationContainer

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

getSpatialBookmarks

public IArray getSpatialBookmarks()
                           throws IOException,
                                  AutomationException

The spatial bookmarks that can be used to define animations.

Product Availability

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

Specified by:: getSpatialBookmarks in interface IAGAnimationContainer

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

removeAllAnimationTimeStrings

public void removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)
                                   throws IOException,
                                          AutomationException

Remove all animation time string from the display.

Product Availability

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

Specified by:: removeAllAnimationTimeStrings in interface IAGAnimationContainer

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

removeTrackTimeDisplay

public void removeTrackTimeDisplay(IAGAnimationTrack pTrack)
                            throws IOException,
                                   AutomationException

Remove a single animation track time string from the display.

Product Availability

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

Specified by:: removeTrackTimeDisplay in interface IAGAnimationContainer

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

setAnimationTime

public void setAnimationTime(IStringArray rhs1)
                      throws IOException,
                             AutomationException

Provides access to the animation time string.

Product Availability

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

Specified by:: setAnimationTime in interface IAGAnimationContainer

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

drawGraphsToDC

public void drawGraphsToDC(int hDC)
                    throws IOException,
                           AutomationException

Draw datagraphs to specified device context.

Product Availability

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

Specified by:: drawGraphsToDC in interface IAGAnimationContainer

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

drawPageLayoutToDC

public void drawPageLayoutToDC(int hDC)
                        throws IOException,
                               AutomationException

Draw the page layout to specified device context.

Product Availability

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

Specified by:: drawPageLayoutToDC in interface IAGAnimationContainer

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

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

enumConnectionPoints

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

enumConnectionPoints

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

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

findConnectionPoint

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

findConnectionPoint

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

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

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

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

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

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

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

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

getGeographicTransformations

public IGeoTransformationOperationSet getGeographicTransformations()
                                                            throws IOException,
                                                                   AutomationException

On-the-fly geographic transformations.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGeographicTransformations in interface IMapGeographicTransformations

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

hasTimeData

public boolean hasTimeData()
                    throws IOException,
                           AutomationException

Indicates whether the map has a time-enabled layer.

Product Availability

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

Specified by:: hasTimeData in interface IMapTimeDisplay

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

getDefaultTimeInterval

public double getDefaultTimeInterval()
                              throws IOException,
                                     AutomationException

The time interval to be used by the time slider to animate the map.

Product Availability

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

Specified by:: getDefaultTimeInterval in interface IMapTimeDisplay

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

setDefaultTimeInterval

public void setDefaultTimeInterval(double interval)
                            throws IOException,
                                   AutomationException

The time interval to be used by the time slider to animate the map.

Product Availability

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

Specified by:: setDefaultTimeInterval in interface IMapTimeDisplay

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

getDefaultTimeIntervalUnits

public int getDefaultTimeIntervalUnits()
                                throws IOException,
                                       AutomationException

The time interval units to be used to animate the map.

Product Availability

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

Specified by:: getDefaultTimeIntervalUnits in interface IMapTimeDisplay

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

setDefaultTimeIntervalUnits

public void setDefaultTimeIntervalUnits(int units)
                                 throws IOException,
                                        AutomationException

The time interval units to be used to animate the map.

Product Availability

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

Specified by:: setDefaultTimeIntervalUnits in interface IMapTimeDisplay

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

getDefaultTimeWindow

public double getDefaultTimeWindow()
                            throws IOException,
                                   AutomationException

The time window used to display the data in the map.

Product Availability

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

Specified by:: getDefaultTimeWindow in interface IMapTimeDisplay

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

setDefaultTimeWindow

public void setDefaultTimeWindow(double duration)
                          throws IOException,
                                 AutomationException

The time window used to display the data in the map.

Product Availability

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

Specified by:: setDefaultTimeWindow in interface IMapTimeDisplay

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

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

Returns the full time extent of the time-enabled layers in the map.

Product Availability

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

Specified by:: getFullTimeExtent in interface IMapTimeDisplay

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

setFullTimeExtentByRef

public void setFullTimeExtentByRef(ITimeExtent timeExtent)
                            throws IOException,
                                   AutomationException

Returns the full time extent of the time-enabled layers in the map.

Product Availability

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

Specified by:: setFullTimeExtentByRef in interface IMapTimeDisplay

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

getCurrentTimeExtent

public ITimeExtent getCurrentTimeExtent()
                                 throws IOException,
                                        AutomationException

The current time extent of the map.

Product Availability

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

Specified by:: getCurrentTimeExtent in interface IMapTimeDisplay

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

setCurrentTimeExtentByRef

public void setCurrentTimeExtentByRef(ITimeExtent timeExtent)
                               throws IOException,
                                      AutomationException

The current time extent of the map.

Product Availability

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

Specified by:: setCurrentTimeExtentByRef in interface IMapTimeDisplay

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

getTimeValue

public ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

The time extent for which the data is displayed in the map.

Product Availability

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

Specified by:: getTimeValue in interface IMapTimeDisplay

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

setTimeValueByRef

public void setTimeValueByRef(ITimeValue time)
                       throws IOException,
                              AutomationException

The time extent for which the data is displayed in the map.

Product Availability

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

Specified by:: setTimeValueByRef in interface IMapTimeDisplay

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

getTimeReference

public ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

The time reference (time zone information, daylight savings, etc.) associated with the map.

Product Availability

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

Specified by:: getTimeReference in interface IMapTimeDisplay

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

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference timeReference)
                           throws IOException,
                                  AutomationException

The time reference (time zone information, daylight savings, etc.) associated with the map.

Product Availability

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

Specified by:: setTimeReferenceByRef in interface IMapTimeDisplay

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

getDisplayDateFormat

public String getDisplayDateFormat()
                            throws IOException,
                                   AutomationException

The format of the date that is displayed on the time slider.

Product Availability

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

Specified by:: getDisplayDateFormat in interface IMapTimeDisplay

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

setDisplayDateFormat

public void setDisplayDateFormat(String dateFormat)
                          throws IOException,
                                 AutomationException

The format of the date that is displayed on the time slider.

Product Availability

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

Specified by:: setDisplayDateFormat in interface IMapTimeDisplay

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

getDisplayTimeFormat

public String getDisplayTimeFormat()
                            throws IOException,
                                   AutomationException

The format of the time that is displayed on the time slider.

Product Availability

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

Specified by:: getDisplayTimeFormat in interface IMapTimeDisplay

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

setDisplayTimeFormat

public void setDisplayTimeFormat(String timeFormat)
                          throws IOException,
                                 AutomationException

The format of the time that is displayed on the time slider.

Product Availability

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

Specified by:: setDisplayTimeFormat in interface IMapTimeDisplay

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

isDisplayEachTimestamp

public boolean isDisplayEachTimestamp()
                               throws IOException,
                                      AutomationException

Indicates whether data for each timestamp will be drawn when playing the time visualization.

Product Availability

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

Specified by:: isDisplayEachTimestamp in interface IMapTimeDisplay

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

setDisplayEachTimestamp

public void setDisplayEachTimestamp(boolean value)
                             throws IOException,
                                    AutomationException

Indicates whether data for each timestamp will be drawn when playing the time visualization.

Product Availability

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

Specified by:: setDisplayEachTimestamp in interface IMapTimeDisplay

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

getDisplaySpeed

public int getDisplaySpeed()
                    throws IOException,
                           AutomationException

The speed of the slider on a scale of 1 to 10 with 10 being the fastest.

Product Availability

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

Specified by:: getDisplaySpeed in interface IMapTimeDisplay

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

setDisplaySpeed

public void setDisplaySpeed(int speed)
                     throws IOException,
                            AutomationException

The speed of the slider on a scale of 1 to 10 with 10 being the fastest.

Product Availability

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

Specified by:: setDisplaySpeed in interface IMapTimeDisplay

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

getPlayOption

public int getPlayOption()
                  throws IOException,
                         AutomationException

The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.

Product Availability

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

Specified by:: getPlayOption in interface IMapTimeDisplay

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

setPlayOption

public void setPlayOption(int option)
                   throws IOException,
                          AutomationException

The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.

Product Availability

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

Specified by:: setPlayOption in interface IMapTimeDisplay

Parameters:: option - A com.esri.arcgis.carto.esriMapTimePlayOption constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeExtentOption

public int getTimeExtentOption()
                        throws IOException,
                               AutomationException

Indicates how the time extent of the map is defined.

Product Availability

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

Specified by:: getTimeExtentOption in interface IMapTimeDisplay

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

setTimeExtentOption

public void setTimeExtentOption(int option)
                         throws IOException,
                                AutomationException

Indicates how the time extent of the map is defined.

Product Availability

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

Specified by:: setTimeExtentOption in interface IMapTimeDisplay

Parameters:: option - A com.esri.arcgis.carto.esriMapTimeExtentOption constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeExtentDefinitionLayer

public ILayer getTimeExtentDefinitionLayer()
                                    throws IOException,
                                           AutomationException

The time-enabled layer that defines the time extent of the map.

Product Availability

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

Specified by:: getTimeExtentDefinitionLayer in interface IMapTimeDisplay

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

setTimeExtentDefinitionLayerByRef

public void setTimeExtentDefinitionLayerByRef(ILayer layer)
                                       throws IOException,
                                              AutomationException

The time-enabled layer that defines the time extent of the map.

Product Availability

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

Specified by:: setTimeExtentDefinitionLayerByRef in interface IMapTimeDisplay

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

isDynamicTimeRefresh

public boolean isDynamicTimeRefresh()
                             throws IOException,
                                    AutomationException

Indicates whether the data in the map refreshes when moving the time slider dynamically.

Product Availability

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

Specified by:: isDynamicTimeRefresh in interface IMapTimeDisplay

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

setDynamicTimeRefresh

public void setDynamicTimeRefresh(boolean flag)
                           throws IOException,
                                  AutomationException

Indicates whether the data in the map refreshes when moving the time slider dynamically.

Product Availability

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

Specified by:: setDynamicTimeRefresh in interface IMapTimeDisplay

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

isShowTime

public boolean isShowTime()
                   throws IOException,
                          AutomationException

Indicates whether time is enabled on the map.

Product Availability

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

Specified by:: isShowTime in interface IMapTimeDisplay

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

setShowTime

public void setShowTime(boolean flag)
                 throws IOException,
                        AutomationException

Indicates whether time is enabled on the map.

Product Availability

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

Specified by:: setShowTime in interface IMapTimeDisplay

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

computeFullTimeExtent

public ITimeExtent computeFullTimeExtent()
                                  throws IOException,
                                         AutomationException

Returns the full time extent of the time-enabled layers in the map.

Product Availability

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

Specified by:: computeFullTimeExtent in interface IMapTimeDisplay

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

isHasLiveData

public boolean isHasLiveData()
                      throws IOException,
                             AutomationException

Indicates whether the map has a time-enabled layer that is being updated frequently with new data.

Product Availability

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

Specified by:: isHasLiveData in interface IMapTimeDisplay2

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

setHasLiveData

public void setHasLiveData(boolean flag)
                    throws IOException,
                           AutomationException

Indicates whether the map has a time-enabled layer that is being updated frequently with new data.

Product Availability

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

Specified by:: setHasLiveData in interface IMapTimeDisplay2

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

getTimeRelation

public int getTimeRelation()
                    throws IOException,
                           AutomationException

Time relation used with the time window for the map.

Product Availability

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

Specified by:: getTimeRelation in interface IMapTimeDisplay2

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

setTimeRelation

public void setTimeRelation(int relation)
                     throws IOException,
                            AutomationException

Time relation used with the time window for the map.

Product Availability

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

Specified by:: setTimeRelation in interface IMapTimeDisplay2

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

isShowTimeOnDisplay

public boolean isShowTimeOnDisplay()
                            throws IOException,
                                   AutomationException

Indicates whether time is displayed on the map.

Product Availability

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

Specified by:: isShowTimeOnDisplay in interface IMapTimeDisplay2

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

setShowTimeOnDisplay

public void setShowTimeOnDisplay(boolean flag)
                          throws IOException,
                                 AutomationException

Indicates whether time is displayed on the map.

Product Availability

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

Specified by:: setShowTimeOnDisplay in interface IMapTimeDisplay2

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

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

Description

Product Availability

Supported Platforms

Globe

Globe

getClsid

equals

hashCode

addIActiveViewEventsListener

removeIActiveViewEventsListener

refreshGroupLayer

Product Availability

setReportLayersInDrawingOrder

Product Availability

isReportLayersInDrawingOrder

Product Availability

getDanglingCachesCount

Product Availability

getGlobeLayers

Product Availability

getGlobeDisplay

Product Availability

Supported Platforms

getDefaultGlobeBackgroundOption

Description

Product Availability

Supported Platforms

setDefaultGlobeBackgroundOption

Product Availability

Supported Platforms

setDefaultHighBackgroundColor

Description

Product Availability

Supported Platforms

getDefaultHighBackgroundColor

Description

Product Availability

Supported Platforms

setDefaultLowBackgroundColor

Description

Product Availability

Supported Platforms

getDefaultLowBackgroundColor

Description

Product Availability

Supported Platforms

setDefaultBackgTransitionDistances

Description

Product Availability

Supported Platforms

getDefaultBackgTransitionDistances

Description

Product Availability

Supported Platforms

setGlobeUnits

Product Availability

Supported Platforms

getGlobeUnits

Description

Product Availability

Supported Platforms

addLayerType

Description

Product Availability

Supported Platforms

setShowGlobeTips

Product Availability

Supported Platforms

getShowGlobeTips

Description

Product Availability

Supported Platforms

getExtent

Remarks

Product Availability

Supported Platforms

suggestExaggerationFactor

Product Availability

Supported Platforms

com.esri.arcgis.globecore
Class Globe