SceneGraph (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.analyst3d
Class SceneGraph

java.lang.Object
  com.esri.arcgis.analyst3d.SceneGraph

All Implemented Interfaces:: ISceneGraph, ISceneRendererEvents, IViewers3D, IActiveViewEvents, IConnectionPointContainer, IDisplay, IDisplay3D, IScreenDisplay, IScreenDisplay2, ITimeDisplay, ITimeDisplay2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable, EventListener

public class SceneGraph
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IActiveViewEvents, ISceneRendererEvents, ISceneGraph, IViewers3D, ISupportErrorInfo, IConnectionPointContainer, IScreenDisplay, IScreenDisplay2, IDisplay3D, ITimeDisplay, ITimeDisplay2
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IActiveViewEvents, ISceneRendererEvents, ISceneGraph, IViewers3D, ISupportErrorInfo, IConnectionPointContainer, IScreenDisplay, IScreenDisplay2, IDisplay3D, ITimeDisplay, ITimeDisplay2

A container for recording data and events that occur in a scene.

Remarks

SceneGraph is to Scene what MapDisplay is to Map. It's associated with a Scene object, either in ArcScene or in a scene viewer control (or a later version scene control). It handles most of the 3D rendering operations and makes the drawing more efficient.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

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

Method Summary
`short`	`addCache()` Creates a new cache and return its ID.
`void`	`addFlashFeature(IGeometry pGeometry)` Adds a feature shape to the flash list.
`void`	`addISceneGraphEventsDispListener(ISceneGraphEventsDisp theListener)` addISceneGraphEventsDispListener.
`void`	`addISceneGraphEventsListener(ISceneGraphEvents theListener)` addISceneGraphEventsListener.
`void`	`addISceneGraphLayerEventsDispListener(ISceneGraphLayerEventsDisp theListener)` addISceneGraphLayerEventsDispListener.
`void`	`addISceneGraphLayerEventsListener(ISceneGraphLayerEvents theListener)` addISceneGraphLayerEventsListener.
`void`	`addITimeDisplayEventsListener(ITimeDisplayEvents theListener)` addITimeDisplayEventsListener.
`void`	`addSimpleActor(ISceneRenderer pRecorder, IGeoDataset pGeoDataset)` Constructs a simple actor (layer visualization subgraph).
`void`	`addSimpleGraphics(ISceneRenderer pRecorder)` Constructs a simple graphics node.
`void`	`afterDraw(IActiveViewEventsAfterDrawEvent theEvent)` Fired after the specified phase is drawn.
`void`	`afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)` Fired after an individual view item is drawn.
`void`	`beginCompositeActor(ICompositeLayer pGroupLayer)` Creates a composite layer node and notifies the scene graph that subsequent actors must be added as children.
`void`	`clear(boolean bKeepBasicGraph)` Resets the scene graph.
`void`	`contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)` Fired when the contents of the view changes.
`void`	`contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)` Fired when the contents of the view is cleared.
`void`	`doScroll(int xDelta, int yDelta, boolean updateScreen)` Scrolls the screen by the specified amount.
`void`	`drawCache(int hDC, short index, tagRECT deviceRect, tagRECT cacheRect)` Draws the specified screen cache to the specified window device context.
`void`	`drawMultipoint(IGeometry multipoint)` Draws specified multipoint on the display.
`void`	`drawPoint(IGeometry point)` Draws specified point on the display.
`void`	`drawPolygon(IGeometry polygon)` Draws specified polygon on the display.
`void`	`drawPolyline(IGeometry polyline)` Draws specified line on the display.
`void`	`drawRectangle(IEnvelope rectangle)` Draws specified rectangle on the display.
`void`	`drawText(IGeometry shape, String text)` Draws specified text on the display.
`void`	`endCompositeActor()` Notifies the scene graph that the definition of a group layer has ended.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`ISceneViewer`	`findViewer(String caption)` Finds the Viewer.
`void`	`finishDrawing()` Completes drawing.
`void`	`finishFeedback()` Ends feedback drawing.
`void`	`flashFeatures()` Redraws viewers flashing the features in the flash list.
`void`	`flashGeometry(Object pOwner, Object feature)` Flashes a feature shape.
`void`	`flashLocation(IPoint pGeometry)` Redraws viewers flashing the given location.
`void`	`focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)` Fired when a new map is made active.
`void`	`frameScrolled(int x, int y)` Call on frame display when container is scrolled.
`short`	`getActiveCache()` Screen cache where drawing occurs.
`ISceneViewer`	`getActiveViewer()` The active viewer.
`IArray`	`getAllViewers()` Returns all registered Viewers.
`void`	`getBackgroundColor(float[] pRed, float[] pGreen, float[] pBlue)` Returns the background color.
`int`	`getBackgroundRGB()` The RGB value of the background color.
`short`	`getCacheCount()` Number of screen caches.
`int`	`getCacheMemDC(short index)` Memory device context for the specified screen cache.
`ITrackCancel`	`getCancelTracker()` Cancel tracker that is associated with the display.
`IEnvelope`	`getClipEnvelope()` The bounds of the invalid region.
`ISet`	`getClipEnvelopes()` The invalid region as a set of envelopes.
`IGeometry`	`getClipGeometry()` User-specified clip shape.
`static String`	`getClsid()` getClsid.
`int`	`getContrast()` The contrast coefficient.
`IDisplayTransformation`	`getDisplayTransformation()` The transformation used by the display.
`void`	`getDrawingOffset(int[] x, int[] y)` The offset between the device origin and the active cache origin.
`void`	`getDrawingTimeInfo(double[] pLastFrameDuration, double[] pMeanFrameRate)` Returns the duration in seconds of last redraw and the average number of frames per second.
`IEnvelope`	`getExtent()` The extent of the scene graph content.
`IDisplayFilter`	`getFilter()` Display filter.
`IEnvelope`	`getGeographySelectionExtent()` The volumetric bounding box of selected features.
`int`	`getHDC()` The device context that the display is currently drawing to.
`int`	`getHPalette()` Palette.
`int`	`getHWnd()` Associated window handle.
`IIlluminationProps`	`getIlluminationProps()` Illumination properties used by the display.
`void`	`getMaxTextureSize(int[] pMaxTextureWidth, int[] pMaxTextureHeight)` The limit for the size of a single texture.
`IEnvelope`	`getOwnerExtent(Object pOwner, boolean bSelectionOnly)` The full or selected extent of a layer.
`void`	`getOwnerSymbols(Object pOwner, IArray[] ppSymbols, ILongArray[] ppDisplayListIDs)` Returns an array containing all symbols used in a layer and their corresponding display list identifications.
`void`	`getOwnerTransparency(Object pObject, int[] pTranspPercent)` Get the transparency percentage of an owner as stored in the scene graph.
`IScene`	`getScene()` The scene.
`int`	`getScreenPickTolerance()` The tolerance in pixels used when picking.
`IColor`	`getSelectionColor()` The selection color.
`IVector3D`	`getSunVector()` The sun vector.
`float`	`getSymbolScale()` The scale for point size and line width of symbols.
`ITimeReference`	`getTimeReference()` Time reference using which the data has to be displayed.
`int`	`getTimeRelation()` Time relation for the time query.
`ITimeValue`	`getTimeValue()` Time Extent for which the data has to be displayed.
`double`	`getVerticalExaggeration()` The vertical exaggeration factor.
`int`	`getWindowDC()` Device context for the associated window.
`int`	`hashCode()` the hashcode for this object
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`void`	`invalidate(IEnvelope rect, boolean erase, short cacheIndex)` Cause the specified area of the specified cache to redraw.
`void`	`invalidate(Object pObject, boolean bInvalidateGeography, boolean bInvalidateSelection)` Invalidates acts representing an object.
`boolean`	`isCacheDirty(short cacheIndex)` Indicates if the specified cache needs refreshing.
`boolean`	`isEmpty()` Indicates if the content of the scene graph is empty.
`boolean`	`isFirstCacheTransparent()` Indicates if the bottom cache is transparent.
`boolean`	`isFramed()` Indicates if drawing occurs in a frame rather than on the whole window.
`boolean`	`isGestureEnabled()` Indicates if the mouse gestures are supported.
`boolean`	`isImmediateMode()` Indicates if immediate-mode rendering for the whole scene is being used.
`boolean`	`isNavigating()` Indicates if the scene graph is in navigation mode.
`boolean`	`isRecordingMessageEnabled()` Indicates if the scene graph provides visual feedback during recording.
`boolean`	`isScaleContents()` Indicates if the contents of the screen scale when a resize occurs.
`boolean`	`isSuppressEvents()` Indicates if display object suppresses events.
`boolean`	`isSuppressResize()` Indicates if display resizing is suppressed.
`boolean`	`isUseScrollbars()` Indicates if scrollbars should appear.
`void`	`itemAdded(IActiveViewEventsItemAddedEvent theEvent)` Fired when an item is added to the view.
`void`	`itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)` Fired when an item is deleted from the view.
`void`	`itemReordered(IActiveViewEventsItemReorderedEvent theEvent)` Fired when a view item is reordered.
`void`	`locate(ISceneViewer pViewer, int x, int y, int mode, boolean bGetTransformed, IPoint[] ppPt, Object[] ppOwner, Object[] ppObject)` Locates a single object.
`void`	`locateMultiple(ISceneViewer pViewer, int x, int y, int mode, boolean bGetTransformed, IHit3DSet[] ppHits)` Locates multiple objects.
`void`	`lockViewers(boolean lock)` Locks the viewer cameras in position.
`void`	`panMoveTo(IPoint mouseLocation)` Pans to a new point.
`void`	`panStart(IPoint mouseLocation)` Prepares display for panning.
`IEnvelope`	`panStop()` Stops panning and returns new visible bounds.
`void`	`progress(int vertexCount)` Call frequently during drawing process.
`void`	`putMaxTextureSize(int maxTextureWidth, int maxTextureHeight)` The limit for the size of a single texture.
`void`	`recordSymbol(ISymbol pSymbol, int glList, boolean bIsExtruded, boolean bLighting, int layerTransparencyPercent, boolean bOptimizeState)` Creates the display list with the given identification for the symbol and its extrusion state (for points and lines).
`void`	`refreshViewers()` Redraws all viewers.
`void`	`registerViewer(ISceneViewer pViewer)` Adds a viewer to the scene graph.
`void`	`remove(Object pObject, boolean bUpdateExtent)` Removes actors representing an object.
`void`	`removeAllCaches()` Removes all caches.
`void`	`removeCache(short cacheID)` Removes the specified cache.
`void`	`removeISceneGraphEventsDispListener(ISceneGraphEventsDisp theListener)` removeISceneGraphEventsDispListener.
`void`	`removeISceneGraphEventsListener(ISceneGraphEvents theListener)` removeISceneGraphEventsListener.
`void`	`removeISceneGraphLayerEventsDispListener(ISceneGraphLayerEventsDisp theListener)` removeISceneGraphLayerEventsDispListener.
`void`	`removeISceneGraphLayerEventsListener(ISceneGraphLayerEvents theListener)` removeISceneGraphLayerEventsListener.
`void`	`removeITimeDisplayEventsListener(ITimeDisplayEvents theListener)` removeITimeDisplayEventsListener.
`void`	`replayFrame(ICamera camera)` Uses the camera to redraw a frame.
`void`	`rotateMoveTo(IPoint pPoint)` Rotates to new point.
`void`	`rotateStart(IPoint mousePt, IPoint centerPt)` Prepares display for rotating.
`double`	`rotateStop()` Stops rotating and returns new angle.
`void`	`rotateTimer()` Draws the rotated display.
`void`	`selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)` Call this function to fire the selection changed event.
`void`	`selectionChanged(ISceneRendererEventsSelectionChangedEvent theEvent)` Fired when the selection is changed.
`void`	`setActiveCache(short index)` Screen cache where drawing occurs.
`void`	`setActiveViewerByRef(ISceneViewer ppViewer)` The active viewer.
`void`	`setBackgroundColor(float red, float green, float blue)` Sets the background color.
`void`	`setBackgroundRGB(int rGB)` The RGB value of the background color.
`void`	`setCancelTrackerByRef(ITrackCancel cancelTracker)` Cancel tracker that is associated with the display.
`void`	`setClipGeometry(IGeometry geometry)` User-specified clip shape.
`void`	`setContrast(int pContrast)` The contrast coefficient.
`void`	`setDisplayTransformation(IDisplayTransformation displayTransformation)` The transformation used by the display.
`void`	`setFilterByRef(IDisplayFilter filter)` Display filter.
`void`	`setGestureEnabled(boolean pbEnabled)` Indicates if the mouse gestures are supported.
`void`	`setHPalette(int hPalette)` Palette.
`void`	`setHWnd(int hWnd)` Associated window handle.
`void`	`setIlluminationProps(IIlluminationProps illuminationProps)` Illumination properties used by the display.
`void`	`setImmediateMode(boolean pbIsAllImmediate)` Indicates if immediate-mode rendering for the whole scene is being used.
`void`	`setIsFirstCacheTransparent(boolean flag)` Indicates if the bottom cache is transparent.
`void`	`setIsFramed(boolean flag)` Indicates if drawing occurs in a frame rather than on the whole window.
`void`	`setIsNavigating(boolean pbIsNavigating)` Indicates if the scene graph is in navigation mode.
`void`	`setIsRecordingMessageEnabled(boolean pbIsEnabled)` Indicates if the scene graph provides visual feedback during recording.
`void`	`setOwnerDepthPriority(Object pObject, short depthPriority)` Sets the depth offset of layers.
`void`	`setOwnerExtrusion(Object pObject, boolean rhs2)` The scene graph information about a layer extrusion.
`void`	`setOwnerFaceCulling(Object pObject, int cullingMode)` Sets retained or immediate mode for the owner.
`void`	`setOwnerImmediateMode(Object pObject, boolean bIsLayerImmediate)` Sets retained or immediate mode for the owner.
`void`	`setOwnerLightingOption(Object pObject, boolean lighting)` Sets the lighting state of layers.
`void`	`setOwnerNavigationVisibility(Object pObject, boolean visibleWhenNavigating, boolean visibleWhenStill)` Sets the visibility of layers depending on navigating state.
`void`	`setOwnerShadingMode(Object pObject, boolean bIsSmooth)` Sets the shading mode (smooth or flat) of layers.
`void`	`setOwnerTimeThreshold(Object pObject, double timeThreshold)` Sets the time threshold to use lowest level of detail in layers when navigating.
`void`	`setOwnerTransparencyState(Object pObject, boolean bIsTransparent)` Sets transparency enabling flag for the owner.
`void`	`setOwnerVisibility(Object pObject, boolean visible)` Sets the visibility of acts representing an object.
`void`	`setScaleContents(boolean flag)` Indicates if the contents of the screen scale when a resize occurs.
`void`	`setSceneByRef(IScene pVal)` The scene.
`void`	`setScreenPickTolerance(int pixels)` The tolerance in pixels used when picking.
`void`	`setScrollbarHandles(int hWndHorzScrollbar, int hWndVertScrollbar)` Optionally specify application supplied scrollbars.
`void`	`setSelectionColorByRef(IColor pSelectionColor)` The selection color.
`void`	`setSunVector(IVector3D ppSun)` The sun vector.
`void`	`setSuppressEvents(boolean suppressEvents)` Indicates if display object suppresses events.
`void`	`setSuppressResize(boolean suppressResize)` Indicates if display resizing is suppressed.
`void`	`setSymbol(ISymbol sym)` Sets the symbol used for drawing.
`void`	`setSymbolScale(float scale)` The scale for point size and line width of symbols.
`void`	`setTimeReference(ITimeReference timeReference)` Time reference using which the data has to be displayed.
`void`	`setTimeRelation(int relation)` Time relation for the time query.
`void`	`setTimeValue(ITimeValue timeExtent)` Time Extent for which the data has to be displayed.
`void`	`setUseScrollbars(boolean flag)` Indicates if scrollbars should appear.
`void`	`setVerticalExaggeration(double pZFactor)` The vertical exaggeration factor.
`void`	`spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)` Fired when the spatial reference is changed.
`void`	`startDrawing(int hDC, short cacheID)` Prepare the display for drawing.
`void`	`startFeedback()` Prepare the display for drawing selection/rubberbanding.
`void`	`startRecording()` Starts recording all output to the recording cache.
`void`	`stopRecording()` Stops recording to the recording cache.
`void`	`trackPan()` Interactively pans the screen.
`void`	`trackRotate()` Interactively rotates the screen.
`void`	`unregisterViewer(ISceneViewer pViewer)` Removes a viewer from the scene graph.
`void`	`updateWindow()` Forces a redraw.
`void`	`validate(short cacheIndex)` Clear dirty flag for specified cache.
`void`	`viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)` Fired when view is refreshed before draw happens.

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

SceneGraph

public SceneGraph()
           throws IOException,
                  UnknownHostException

Constructs a SceneGraph using ArcGIS Engine.

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

SceneGraph

public SceneGraph(Object obj)
           throws IOException

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

Construct a SceneGraph using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SceneGraph.

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

addISceneGraphEventsDispListener

public void addISceneGraphEventsDispListener(ISceneGraphEventsDisp theListener)
                                      throws IOException

addISceneGraphEventsDispListener. Listen to events generated by this class.

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

removeISceneGraphEventsDispListener

public void removeISceneGraphEventsDispListener(ISceneGraphEventsDisp theListener)
                                         throws IOException

removeISceneGraphEventsDispListener. Stop listening to events generated by this class.

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

addISceneGraphEventsListener

public void addISceneGraphEventsListener(ISceneGraphEvents theListener)
                                  throws IOException

addISceneGraphEventsListener. Listen to events generated by this class.

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

removeISceneGraphEventsListener

public void removeISceneGraphEventsListener(ISceneGraphEvents theListener)
                                     throws IOException

removeISceneGraphEventsListener. Stop listening to events generated by this class.

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

addITimeDisplayEventsListener

public void addITimeDisplayEventsListener(ITimeDisplayEvents theListener)
                                   throws IOException

addITimeDisplayEventsListener. Listen to events generated by this class.

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

removeITimeDisplayEventsListener

public void removeITimeDisplayEventsListener(ITimeDisplayEvents theListener)
                                      throws IOException

removeITimeDisplayEventsListener. Stop listening to events generated by this class.

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

addISceneGraphLayerEventsListener

public void addISceneGraphLayerEventsListener(ISceneGraphLayerEvents theListener)
                                       throws IOException

addISceneGraphLayerEventsListener. Listen to events generated by this class.

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

removeISceneGraphLayerEventsListener

public void removeISceneGraphLayerEventsListener(ISceneGraphLayerEvents theListener)
                                          throws IOException

removeISceneGraphLayerEventsListener. Stop listening to events generated by this class.

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

addISceneGraphLayerEventsDispListener

public void addISceneGraphLayerEventsDispListener(ISceneGraphLayerEventsDisp theListener)
                                           throws IOException

addISceneGraphLayerEventsDispListener. Listen to events generated by this class.

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

removeISceneGraphLayerEventsDispListener

public void removeISceneGraphLayerEventsDispListener(ISceneGraphLayerEventsDisp theListener)
                                              throws IOException

removeISceneGraphLayerEventsDispListener. Stop listening to events generated by this class.

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

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view changes.

Remarks

The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.

The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: contentsChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IActiveView.contentsChanged()

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: contentsCleared in interface IActiveViewEvents

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

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws IOException,
                      AutomationException

Fired when an item is added to the view.

Remarks

The Map fires the event every time a new layer is added.

The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: itemAdded in interface IActiveViewEvents

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

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an item is deleted from the view.

Remarks

The PageLayout object fires this event whenever elements are deleted from the layout.

The Map object fires this event when a layer is removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: itemDeleted in interface IActiveViewEvents

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

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a view item is reordered.

Remarks

The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.

The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: itemReordered in interface IActiveViewEvents

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

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent 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 IActiveViewEvents

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

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Description

Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.

Remarks

This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.

The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.

If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.

In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: viewRefreshed in interface IActiveViewEvents

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

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException

Fired after the specified phase is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: afterDraw in interface IActiveViewEvents

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

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Remarks

AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: afterItemDraw in interface IActiveViewEvents

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

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when a new map is made active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: focusMapChanged in interface IActiveViewEvents

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

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: spatialReferenceChanged in interface IActiveViewEvents

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

selectionChanged

public void selectionChanged(ISceneRendererEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Fired when the selection is changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectionChanged in interface ISceneRendererEvents

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

getScene

public IScene getScene()
                throws IOException,
                       AutomationException

The scene.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getScene in interface ISceneGraph
Specified by:: getScene in interface IViewers3D

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

setSceneByRef

public void setSceneByRef(IScene pVal)
                   throws IOException,
                          AutomationException

The scene.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSceneByRef in interface ISceneGraph
Specified by:: setSceneByRef in interface IViewers3D

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

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the content of the scene graph is empty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEmpty in interface ISceneGraph

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

addSimpleGraphics

public void addSimpleGraphics(ISceneRenderer pRecorder)
                       throws IOException,
                              AutomationException

Constructs a simple graphics node.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSimpleGraphics in interface ISceneGraph

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

addSimpleActor

public void addSimpleActor(ISceneRenderer pRecorder,
                           IGeoDataset pGeoDataset)
                    throws IOException,
                           AutomationException

Constructs a simple actor (layer visualization subgraph).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSimpleActor in interface ISceneGraph

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

beginCompositeActor

public void beginCompositeActor(ICompositeLayer pGroupLayer)
                         throws IOException,
                                AutomationException

Creates a composite layer node and notifies the scene graph that subsequent actors must be added as children.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: beginCompositeActor in interface ISceneGraph

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

endCompositeActor

public void endCompositeActor()
                       throws IOException,
                              AutomationException

Notifies the scene graph that the definition of a group layer has ended.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: endCompositeActor in interface ISceneGraph

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

remove

public void remove(Object pObject,
                   boolean bUpdateExtent)
            throws IOException,
                   AutomationException

Removes actors representing an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: remove in interface ISceneGraph

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

invalidate

public void invalidate(Object pObject,
                       boolean bInvalidateGeography,
                       boolean bInvalidateSelection)
                throws IOException,
                       AutomationException

Invalidates acts representing an object.

Remarks

The Invalidate method of the SceneGraph is used to ensure a full re-recording of the contents of the invalidated object, such as a viewer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: invalidate in interface ISceneGraph

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

setImmediateMode

public void setImmediateMode(boolean pbIsAllImmediate)
                      throws IOException,
                             AutomationException

Indicates if immediate-mode rendering for the whole scene is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setImmediateMode in interface ISceneGraph

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

isImmediateMode

public boolean isImmediateMode()
                        throws IOException,
                               AutomationException

Indicates if immediate-mode rendering for the whole scene is being used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isImmediateMode in interface ISceneGraph

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

setOwnerVisibility

public void setOwnerVisibility(Object pObject,
                               boolean visible)
                        throws IOException,
                               AutomationException

Sets the visibility of acts representing an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerVisibility in interface ISceneGraph

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

setOwnerNavigationVisibility

public void setOwnerNavigationVisibility(Object pObject,
                                         boolean visibleWhenNavigating,
                                         boolean visibleWhenStill)
                                  throws IOException,
                                         AutomationException

Sets the visibility of layers depending on navigating state.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerNavigationVisibility in interface ISceneGraph

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

setOwnerLightingOption

public void setOwnerLightingOption(Object pObject,
                                   boolean lighting)
                            throws IOException,
                                   AutomationException

Sets the lighting state of layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerLightingOption in interface ISceneGraph

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

setOwnerShadingMode

public void setOwnerShadingMode(Object pObject,
                                boolean bIsSmooth)
                         throws IOException,
                                AutomationException

Sets the shading mode (smooth or flat) of layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerShadingMode in interface ISceneGraph

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

setOwnerDepthPriority

public void setOwnerDepthPriority(Object pObject,
                                  short depthPriority)
                           throws IOException,
                                  AutomationException

Sets the depth offset of layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerDepthPriority in interface ISceneGraph

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

setOwnerTimeThreshold

public void setOwnerTimeThreshold(Object pObject,
                                  double timeThreshold)
                           throws IOException,
                                  AutomationException

Sets the time threshold to use lowest level of detail in layers when navigating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerTimeThreshold in interface ISceneGraph

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

setOwnerImmediateMode

public void setOwnerImmediateMode(Object pObject,
                                  boolean bIsLayerImmediate)
                           throws IOException,
                                  AutomationException

Sets retained or immediate mode for the owner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerImmediateMode in interface ISceneGraph

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

setOwnerFaceCulling

public void setOwnerFaceCulling(Object pObject,
                                int cullingMode)
                         throws IOException,
                                AutomationException

Sets retained or immediate mode for the owner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerFaceCulling in interface ISceneGraph

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

setOwnerTransparencyState

public void setOwnerTransparencyState(Object pObject,
                                      boolean bIsTransparent)
                               throws IOException,
                                      AutomationException

Sets transparency enabling flag for the owner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOwnerTransparencyState in interface ISceneGraph

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

getOwnerTransparency

public void getOwnerTransparency(Object pObject,
                                 int[] pTranspPercent)
                          throws IOException,
                                 AutomationException

Get the transparency percentage of an owner as stored in the scene graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOwnerTransparency in interface ISceneGraph

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

setOwnerExtrusion

public void setOwnerExtrusion(Object pObject,
                              boolean rhs2)
                       throws IOException,
                              AutomationException

The scene graph information about a layer extrusion.

Product Availability

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

Specified by:: setOwnerExtrusion in interface ISceneGraph

Parameters:: pObject - A reference to another Object (IUnknown) (in); rhs2 - The rhs2 (in)
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 graph content.

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 ISceneGraph

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.

getGeographySelectionExtent

public IEnvelope getGeographySelectionExtent()
                                      throws IOException,
                                             AutomationException

The volumetric bounding box 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:: getGeographySelectionExtent in interface ISceneGraph

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.

getOwnerExtent

public IEnvelope getOwnerExtent(Object pOwner,
                                boolean bSelectionOnly)
                         throws IOException,
                                AutomationException

The full or selected extent of a layer.

Product Availability

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

Specified by:: getOwnerExtent in interface ISceneGraph

Parameters:: pOwner - A reference to another Object (IUnknown) (in); bSelectionOnly - The bSelectionOnly (in)
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.

registerViewer

public void registerViewer(ISceneViewer pViewer)
                    throws IOException,
                           AutomationException

Adds a viewer to the scene graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: registerViewer in interface ISceneGraph
Specified by:: registerViewer in interface IViewers3D

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

unregisterViewer

public void unregisterViewer(ISceneViewer pViewer)
                      throws IOException,
                             AutomationException

Removes a viewer from the scene graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: unregisterViewer in interface ISceneGraph
Specified by:: unregisterViewer in interface IViewers3D

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

findViewer

public ISceneViewer findViewer(String caption)
                        throws IOException,
                               AutomationException

Finds the Viewer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findViewer in interface ISceneGraph
Specified by:: findViewer in interface IViewers3D

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

getAllViewers

public IArray getAllViewers()
                     throws IOException,
                            AutomationException

Returns all registered Viewers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAllViewers in interface ISceneGraph
Specified by:: getAllViewers in interface IViewers3D

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.

setActiveViewerByRef

public void setActiveViewerByRef(ISceneViewer ppViewer)
                          throws IOException,
                                 AutomationException

The active viewer.

Product Availability

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

Specified by:: setActiveViewerByRef in interface ISceneGraph
Specified by:: setActiveViewerByRef in interface IViewers3D

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

getActiveViewer

public ISceneViewer getActiveViewer()
                             throws IOException,
                                    AutomationException

The active viewer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getActiveViewer in interface ISceneGraph
Specified by:: getActiveViewer in interface IViewers3D

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

replayFrame

public void replayFrame(ICamera camera)
                 throws IOException,
                        AutomationException

Uses the camera to redraw a frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: replayFrame in interface ISceneGraph
Specified by:: replayFrame in interface IViewers3D

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

refreshViewers

public void refreshViewers()
                    throws IOException,
                           AutomationException

Redraws all viewers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: refreshViewers in interface ISceneGraph
Specified by:: refreshViewers in interface IViewers3D

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

setBackgroundColor

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

Sets the background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBackgroundColor in interface ISceneGraph
Specified by:: setBackgroundColor in interface IViewers3D

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.

getBackgroundColor

public void getBackgroundColor(float[] pRed,
                               float[] pGreen,
                               float[] pBlue)
                        throws IOException,
                               AutomationException

Returns the background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBackgroundColor in interface ISceneGraph
Specified by:: getBackgroundColor in interface IViewers3D

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

setSelectionColorByRef

public void setSelectionColorByRef(IColor pSelectionColor)
                            throws IOException,
                                   AutomationException

The selection color.

Product Availability

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

Specified by:: setSelectionColorByRef in interface ISceneGraph

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

getSelectionColor

public IColor getSelectionColor()
                         throws IOException,
                                AutomationException

The selection color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectionColor in interface ISceneGraph

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

isNavigating

public boolean isNavigating()
                     throws IOException,
                            AutomationException

Indicates if the scene graph is in navigation mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isNavigating in interface ISceneGraph
Specified by:: isNavigating in interface IViewers3D

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

setIsNavigating

public void setIsNavigating(boolean pbIsNavigating)
                     throws IOException,
                            AutomationException

Indicates if the scene graph is in navigation mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIsNavigating in interface ISceneGraph
Specified by:: setIsNavigating in interface IViewers3D

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

setGestureEnabled

public void setGestureEnabled(boolean pbEnabled)
                       throws IOException,
                              AutomationException

Indicates if the mouse gestures are supported.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setGestureEnabled in interface ISceneGraph
Specified by:: setGestureEnabled in interface IViewers3D

Parameters:: pbEnabled - The pbEnabled (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 the mouse gestures are supported.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isGestureEnabled in interface ISceneGraph
Specified by:: isGestureEnabled in interface IViewers3D

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

locate

public void locate(ISceneViewer pViewer,
                   int x,
                   int y,
                   int mode,
                   boolean bGetTransformed,
                   IPoint[] ppPt,
                   Object[] ppOwner,
                   Object[] ppObject)
            throws IOException,
                   AutomationException

Locates a single object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: locate in interface ISceneGraph

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

locateMultiple

public void locateMultiple(ISceneViewer pViewer,
                           int x,
                           int y,
                           int mode,
                           boolean bGetTransformed,
                           IHit3DSet[] ppHits)
                    throws IOException,
                           AutomationException

Locates multiple objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: locateMultiple in interface ISceneGraph

Parameters:: pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in); x - The x (in); y - The y (in); mode - A com.esri.arcgis.analyst3d.esriScenePickMode constant (in); bGetTransformed - The bGetTransformed (in); ppHits - A reference to a com.esri.arcgis.analyst3d.IHit3DSet (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getVerticalExaggeration

public double getVerticalExaggeration()
                               throws IOException,
                                      AutomationException

The vertical exaggeration factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getVerticalExaggeration in interface ISceneGraph

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

setVerticalExaggeration

public void setVerticalExaggeration(double pZFactor)
                             throws IOException,
                                    AutomationException

The vertical exaggeration factor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setVerticalExaggeration in interface ISceneGraph

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

getSunVector

public IVector3D getSunVector()
                       throws IOException,
                              AutomationException

The sun vector.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSunVector in interface ISceneGraph

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

setSunVector

public void setSunVector(IVector3D ppSun)
                  throws IOException,
                         AutomationException

The sun vector.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSunVector in interface ISceneGraph

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

getContrast

public int getContrast()
                throws IOException,
                       AutomationException

The contrast coefficient.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getContrast in interface ISceneGraph

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

setContrast

public void setContrast(int pContrast)
                 throws IOException,
                        AutomationException

The contrast coefficient.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setContrast in interface ISceneGraph

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

clear

public void clear(boolean bKeepBasicGraph)
           throws IOException,
                  AutomationException

Resets the scene graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clear in interface ISceneGraph

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

lockViewers

public void lockViewers(boolean lock)
                 throws IOException,
                        AutomationException

Locks the viewer cameras in position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: lockViewers in interface ISceneGraph

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

getDrawingTimeInfo

public void getDrawingTimeInfo(double[] pLastFrameDuration,
                               double[] pMeanFrameRate)
                        throws IOException,
                               AutomationException

Returns the duration in seconds of last redraw and the average number of frames per second.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDrawingTimeInfo in interface ISceneGraph

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

getOwnerSymbols

public void getOwnerSymbols(Object pOwner,
                            IArray[] ppSymbols,
                            ILongArray[] ppDisplayListIDs)
                     throws IOException,
                            AutomationException

Returns an array containing all symbols used in a layer and their corresponding display list identifications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOwnerSymbols in interface ISceneGraph

Parameters:: pOwner - A reference to another Object (IUnknown) (in); ppSymbols - A reference to a com.esri.arcgis.system.IArray (out: use single element array); ppDisplayListIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

recordSymbol

public void recordSymbol(ISymbol pSymbol,
                         int glList,
                         boolean bIsExtruded,
                         boolean bLighting,
                         int layerTransparencyPercent,
                         boolean bOptimizeState)
                  throws IOException,
                         AutomationException

Creates the display list with the given identification for the symbol and its extrusion state (for points and lines).

Remarks

This method provides a mechnism for a quick update on the display of system symbols in the SceneGraph. The purpose of this method is to capture a changed symbol state of a layer for a possible redraw to reflect the change.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: recordSymbol in interface ISceneGraph

Parameters:: pSymbol - A reference to a com.esri.arcgis.display.ISymbol (in); glList - The glList (in); bIsExtruded - The bIsExtruded (in); bLighting - The bLighting (in); layerTransparencyPercent - The layerTransparencyPercent (in); bOptimizeState - The bOptimizeState (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isRecordingMessageEnabled

public boolean isRecordingMessageEnabled()
                                  throws IOException,
                                         AutomationException

Indicates if the scene graph provides visual feedback during recording.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isRecordingMessageEnabled in interface ISceneGraph

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

setIsRecordingMessageEnabled

public void setIsRecordingMessageEnabled(boolean pbIsEnabled)
                                  throws IOException,
                                         AutomationException

Indicates if the scene graph provides visual feedback during recording.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIsRecordingMessageEnabled in interface ISceneGraph

Parameters:: pbIsEnabled - The pbIsEnabled (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.

setHWnd

public void setHWnd(int hWnd)
             throws IOException,
                    AutomationException

Associated window handle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHWnd in interface IScreenDisplay
Specified by:: setHWnd in interface IScreenDisplay2

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

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

Associated window handle.

Remarks

The hWnd property tells ScreenDisplay objects which window to draw in. When a new view (a Map or PageLayout) is created and activated (IActiveView::Activate), a related ScreenDisplay is created and its hWnd is set to that of the main application. Data windows, such as the MapInsetWindow, also have a related ScreenDisplay object and in this case the ScreenDisplay's hWnd property is set so that all drawing will occur in the data window and not the main application window.

Several Windows API calls require an hWnd in order to perform their operation; this property provides the hWnd for the ScreenDisplay object you are currently working with. For example, several of ArcMap's zoom commands use the Windows API function 'GetClientRect' to get the coordinates of the main window's client area. GetClientRect requires the hWnd of the window of interest and in ArcMap's case, IScreenDisplay::hWnd holds this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHWnd in interface IScreenDisplay
Specified by:: getHWnd in interface IScreenDisplay2

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

getWindowDC

public int getWindowDC()
                throws IOException,
                       AutomationException

Device context for the associated window. Only use this between calls to StartDrawing and FinishDrawing.

Remarks

This property is a Windows operating environment device context handle. The Windows operating environment manages the system display by assigning a device context for each window in the application. You can use the WindowDC property to refer to the handle for an object's device context.

This property does not provide a value to pass to IDisplay::StartDrawing. Instead, call IDisplay::StartDrawing with a value of 0 for the hDC as this will automatically use the Windows API function GetDC to populate IScreenDisplay::WindowDC with the hDC of the main display and drawing will occur there.

The value of the WindowDC property can change while an application runs, so do not store the value in a variable; instead, use the WindowDC property each time you need it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWindowDC in interface IScreenDisplay
Specified by:: getWindowDC in interface IScreenDisplay2

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

addCache

public short addCache()
               throws IOException,
                      AutomationException

Creates a new cache and return its ID. The ID can be specified to StartDrawing to direct output to the cache. It can also be used with a number of other methods such as DrawCache and Invalidate.

Remarks

ScreenDisplay objects make 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 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, a Map object 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.

The AppDisplay object has no implementation for this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addCache in interface IScreenDisplay
Specified by:: addCache in interface IScreenDisplay2

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

removeCache

public void removeCache(short cacheID)
                 throws IOException,
                        AutomationException

Removes the specified cache.

Remarks

Use this method to remove a cache that is no longer needed. For example, calling the IActiveView::PartialRefresh method on a Map object will delete the Map's selection cache if one exists and there are no features selected.

The AppDisplay object has no implementation for this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeCache in interface IScreenDisplay
Specified by:: removeCache in interface IScreenDisplay2

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

getCacheCount

public short getCacheCount()
                    throws IOException,
                           AutomationException

Number of screen caches.

Remarks

Use this property to loop through all of the available screen caches. For example, if you Invalidate using esriAllScreenCaches, this property is used to loop through all of the caches to invalidate each one.

The AppDisplay object has no implementation for this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCacheCount in interface IScreenDisplay
Specified by:: getCacheCount in interface IScreenDisplay2

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

removeAllCaches

public void removeAllCaches()
                     throws IOException,
                            AutomationException

Removes all caches.

Remarks

Use this property to clear all of the screen caches the current object has. For example, when a Map is deactivated (IActiveView::Deactivate) it uses this property to remove all of its caches.

The AppDisplay object has no implementation for this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeAllCaches in interface IScreenDisplay
Specified by:: removeAllCaches in interface IScreenDisplay2

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

getCacheMemDC

public int getCacheMemDC(short index)
                  throws IOException,
                         AutomationException

Memory device context for the specified screen cache.

Product Availability

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

Specified by:: getCacheMemDC in interface IScreenDisplay
Specified by:: getCacheMemDC in interface IScreenDisplay2

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

setActiveCache

public void setActiveCache(short index)
                    throws IOException,
                           AutomationException

Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setActiveCache in interface IScreenDisplay
Specified by:: setActiveCache in interface IScreenDisplay2

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

getActiveCache

public short getActiveCache()
                     throws IOException,
                            AutomationException

Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getActiveCache in interface IScreenDisplay
Specified by:: getActiveCache in interface IScreenDisplay2

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

setIsFirstCacheTransparent

public void setIsFirstCacheTransparent(boolean flag)
                                throws IOException,
                                       AutomationException

Indicates if the bottom cache is transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIsFirstCacheTransparent in interface IScreenDisplay
Specified by:: setIsFirstCacheTransparent in interface IScreenDisplay2

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

isFirstCacheTransparent

public boolean isFirstCacheTransparent()
                                throws IOException,
                                       AutomationException

Indicates if the bottom cache is transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isFirstCacheTransparent in interface IScreenDisplay
Specified by:: isFirstCacheTransparent in interface IScreenDisplay2

Returns:: The flag
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.isFramed()

startRecording

public void startRecording()
                    throws IOException,
                           AutomationException

Starts recording all output to the recording cache.

Remarks

In addition to the caches clients create, the ScreenDisplay object also provides a recording cache that accumulates all drawing that happens on the display. This recording cache is used to redraw the application when the application is moved or exposed or when drawing rubber banding.

Note, StartRecording and StopRecording are exposed for developers creating custom applications that draw from multiple caches and need to refresh quickly. If you are working with ArcMap or even the Map object, leave all cache management up to the Map.

Use StartRecording to let the display know exactly what to record. Use DrawCache(esriScreenRecording) to display the recording cache. Use CacheMemDC(esriScreenRecording) to get a handle to the memory device context for the recording bitmap.

The following C++ code excerpt is a drawing sequence example that uses StartRecording.

VARIANT_BOOL isCacheDirty;

m_ipScreen->IsCacheDirty(esriScreenRecording, &isCacheDirty);



if (isCacheDirty) // draw from scratch

{

  m_ipScreen->StartRecording();

  m_ipScreen->StartDrawing((OLE_HANDLE)hPaintDC, esriNoScreenCache);

  DrawContents();

  m_ipScreen->FinishDrawing();

  m_ipScreen->StopRecording();

}

  else // draw from offscreen bitmap

{

  m_ipScreen->DrawCache((OLE_HANDLE)hPaintDC, esriScreenRecording, 0, 0);

}

Example:

The following java code gives you an example drawing sequence.        
IScreenDisplay pScreen;

        boolean isCacheDirty = pScreen.isCacheDirty(esriScreenRecording);

        if (isCacheDirty) // draw from scratch

        {

          IDisplay pIDisplay = new IDisplayProxy(pScreen); 

          pScreen.startRecording();

          pIDisplay.startDrawing((int)hPaintDC, esriNoScreenCache);

          DrawContents();

          pScreen.finishDrawing();

          pScreen.stopRecording();

        } else // draw from offscreen bitmap

        {

          pScreen.drawCache((int)hPaintDC, esriScreenRecording, 0, 0);

        }

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: startRecording in interface IScreenDisplay
Specified by:: startRecording in interface IScreenDisplay2

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

stopRecording

public void stopRecording()
                   throws IOException,
                          AutomationException

Stops recording to the recording cache.

Remarks

The following C++ code excerpt is a drawing sequence example that uses StartRecording.

VARIANT_BOOL isCacheDirty;

m_ipScreen->IsCacheDirty(esriScreenRecording, &isCacheDirty);



if (isCacheDirty) // draw from scratch

{

  m_ipScreen->StartRecording();

  m_ipScreen->StartDrawing((OLE_HANDLE)hPaintDC, esriNoScreenCache);

  DrawContents();

  m_ipScreen->FinishDrawing();

  m_ipScreen->StopRecording();

}

  else // draw from offscreen bitmap

{

  m_ipScreen->DrawCache((OLE_HANDLE)hPaintDC, esriScreenRecording, 0, 0);

}

Example:

The following java code gives you an example drawing sequence.        
IScreenDisplay pScreen;

        boolean isCacheDirty = pScreen.isCacheDirty(esriScreenRecording);

        if (isCacheDirty) // draw from scratch

        {

          IDisplay pIDisplay = new IDisplayProxy(pScreen); 

          pScreen.startRecording();

          pIDisplay.startDrawing((int)hPaintDC, esriNoScreenCache);

          DrawContents();

          pScreen.finishDrawing();

          pScreen.stopRecording();

        } else // draw from offscreen bitmap

        {

          pScreen.drawCache((int)hPaintDC, esriScreenRecording, 0, 0);

        }

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: stopRecording in interface IScreenDisplay
Specified by:: stopRecording in interface IScreenDisplay2

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

setUseScrollbars

public void setUseScrollbars(boolean flag)
                      throws IOException,
                             AutomationException

Indicates if scrollbars should appear.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseScrollbars in interface IScreenDisplay
Specified by:: setUseScrollbars in interface IScreenDisplay2

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

isUseScrollbars

public boolean isUseScrollbars()
                        throws IOException,
                               AutomationException

Indicates if scrollbars should appear.

Remarks

IActiveView::ShowScrollBars redirects all its calls to this property.

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 scrollbars 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 the 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 Map's 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:: isUseScrollbars in interface IScreenDisplay
Specified by:: isUseScrollbars in interface IScreenDisplay2

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

setScrollbarHandles

public void setScrollbarHandles(int hWndHorzScrollbar,
                                int hWndVertScrollbar)
                         throws IOException,
                                AutomationException

Optionally specify application supplied scrollbars.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScrollbarHandles in interface IScreenDisplay
Specified by:: setScrollbarHandles in interface IScreenDisplay2

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

setScaleContents

public void setScaleContents(boolean flag)
                      throws IOException,
                             AutomationException

Indicates if the contents of the screen scale when a resize occurs. True means scale contents to fit new window size. False means contents stays the same with more or less of it showing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScaleContents in interface IScreenDisplay
Specified by:: setScaleContents in interface IScreenDisplay2

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

isScaleContents

public boolean isScaleContents()
                        throws IOException,
                               AutomationException

Indicates if the contents of the screen scale when a resize occurs. True means scale contents to fit new window size. False means contents stays the same with more or less of it showing.

Remarks

If a Map's ScaleContents property is set to TRUE, when its display is resized, the area shown stays the same and the scale changes. When set to FALSE, the scale of the Map stays the same and the area shown changes.

The PageLayout object works similarly. If set to TRUE, the contents are stretched when the display is resized. The scale of all maps changes. When set to FALSE, the page remains the same size.

In ArcMap, on the Tools/Options menu, there are check boxes for controlling this property for the data and layout view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isScaleContents in interface IScreenDisplay
Specified by:: isScaleContents in interface IScreenDisplay2

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

setSuppressResize

public void setSuppressResize(boolean suppressResize)
                       throws IOException,
                              AutomationException

Indicates if display resizing is suppressed. True means the display doesn't resize with the window. False ensures that the display is the same size as the window.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSuppressResize in interface IScreenDisplay
Specified by:: setSuppressResize in interface IScreenDisplay2

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

isSuppressResize

public boolean isSuppressResize()
                         throws IOException,
                                AutomationException

Indicates if display resizing is suppressed. True means the display doesn't resize with the window. False ensures that the display is the same size as the window.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSuppressResize in interface IScreenDisplay
Specified by:: isSuppressResize in interface IScreenDisplay2

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

isFramed

public boolean isFramed()
                 throws IOException,
                        AutomationException

Indicates if drawing occurs 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.

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 application 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 IScreenDisplay
Specified by:: isFramed in interface IScreenDisplay2

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

setIsFramed

public void setIsFramed(boolean flag)
                 throws IOException,
                        AutomationException

Indicates if drawing occurs 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 IScreenDisplay
Specified by:: setIsFramed in interface IScreenDisplay2

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

getCancelTracker

public ITrackCancel getCancelTracker()
                              throws IOException,
                                     AutomationException

Cancel tracker that is associated with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCancelTracker in interface IScreenDisplay
Specified by:: getCancelTracker in interface IScreenDisplay2

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

setCancelTrackerByRef

public void setCancelTrackerByRef(ITrackCancel cancelTracker)
                           throws IOException,
                                  AutomationException

Cancel tracker that is associated with the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCancelTrackerByRef in interface IScreenDisplay
Specified by:: setCancelTrackerByRef in interface IScreenDisplay2

Parameters:: cancelTracker - 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.

invalidate

public void invalidate(IEnvelope rect,
                       boolean erase,
                       short cacheIndex)
                throws IOException,
                       AutomationException

Cause the specified area of the specified cache to redraw.

Remarks

Use Invalidate to refresh a specific region on the display. For example, if you add a new feature, only the extent of the new feature requires refreshing; the remainder of the display can redraw from cache.

The rect parameter specifies the region to update. Use 'Nothing' in Visual Basic or a zero in C++ to invalidate the entire display.

Erase specifies whether or not the background within the update region is erased when the update region is processed. Usually this is set to TRUE.

CacheIndex controls which cache to update. Use IActiveView::ScreenCacheID to get the cache index for a specific draw phase. The valid draw phases are held in the esriViewDrawPhase enumeration and are as follows:

0 - esriViewNone
1 - esriViewBackground
2 - esriViewGeography
4 - esriViewGeoSelection
8 - esriViewGraphics
16 - esriViewGraphicSelection
32 - esriviewForeground

You can also specify esriAllScreenCaches, esriNoScreenCache, and esriScreenRecording.

Invalidate sets the cache(s) as dirty. Use IsCacheDirty to check the state of a particular cache.

After completion, Invalidate fires the IDisplayEvents::DisplayInvalidated event.

IActiveView::PartialRefresh has similar parameters and itself calls Invalidate. Use this method instead as much as possible as it automatically determines the cache index based on the phase provided.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: invalidate in interface IScreenDisplay
Specified by:: invalidate in interface IScreenDisplay2

Parameters:: rect - A reference to a com.esri.arcgis.geometry.IEnvelope (in); erase - The erase (in); cacheIndex - The cacheIndex (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()

isCacheDirty

public boolean isCacheDirty(short cacheIndex)
                     throws IOException,
                            AutomationException

Indicates if the specified cache needs refreshing.

Remarks

When drawing, use this property to check if a particular cache is dirty. If a cache is not dirty (FALSE), redraw the cache; if the cache is dirty (TRUE), redraw from scratch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCacheDirty in interface IScreenDisplay
Specified by:: isCacheDirty in interface IScreenDisplay2

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

drawCache

public void drawCache(int hDC,
                      short index,
                      tagRECT deviceRect,
                      tagRECT cacheRect)
               throws IOException,
                      AutomationException

Draws the specified screen cache to the specified window device context. Pass an empty rectangle to copy the full bitmap to the DC origin.

Remarks

Redrawing data from scratch is time consuming compared to drawing data that has been cached in an off-screen bitmap. If a particular cache return FALSE for IsCacheDirty, use DrawCache to instantly redraw the bitmap.

Use the CacheMemDC property to get the desired cache's hDC.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawCache in interface IScreenDisplay
Specified by:: drawCache in interface IScreenDisplay2

Parameters:: hDC - The hDC (A COM typedef) (in); index - The index (in); deviceRect - A Structure: com.esri.arcgis.system.tagRECT (in); cacheRect - A Structure: com.esri.arcgis.system.tagRECT (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

doScroll

public void doScroll(int xDelta,
                     int yDelta,
                     boolean updateScreen)
              throws IOException,
                     AutomationException

Scrolls the screen by the specified amount.

Remarks

ArcMap's scroll bars call this method to scroll the current display. The updateScreen parameter specifies whether or not the display will be refreshed after the scroll.

Example:

The following example shows how this method can be used.

 
MapControl mapControl; 
IActiveView pActiveView = mapControl.getActiveView(); 
IDisplayTransformation pDisplayTransform =      
   pActiveView.getScreenDisplay().getDisplayTransformation()  
IScreenDisplay pScreenDisplay = pActiveView.getScreenDisplay();  
pScreenDisplay.doScroll( 100, 100, true );

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: doScroll in interface IScreenDisplay
Specified by:: doScroll in interface IScreenDisplay2

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

trackPan

public void trackPan()
              throws IOException,
                     AutomationException

Interactively pans the screen.

Remarks

There are two approaches to panning - this method, and the group PanStart, PanMoveTo, and PanStop. This method is the easiest to use as it takes care of all the mouse events and refreshing the display when pan is complete.

Call this method in the mouse down event and make certain you have a reference to the correct ScreenDisplay object. For example, if you are in layout view and you want to pan just the focus map, do not use the ScreenDisplay object associated with IMxDocument::ActiveView. Instead, get the focus Map via IMxDocument::FocusMap, and then get its ScreenDisplay.

Example:

MapControl mapControl; 
IActiveView pActiveView = mapControl.getActiveView();        
IScreenDisplay pScreenDisplay = pActiveView.getScreenDisplay();        
pScreenDisplay.trackPan();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: trackPan in interface IScreenDisplay
Specified by:: trackPan in interface IScreenDisplay2

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.panMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStart(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStop()

panStart

public void panStart(IPoint mouseLocation)
              throws IOException,
                     AutomationException

Prepares display for panning.

Remarks

Call PanStart to initiate panning. The required point parameter specifies the pan's starting point. Call PanMoveTo next to specify a destination point.

The typical sequence for using the pan methods is as follows:

OnMouseDown - PanStart
OnMouseMove - PanMoveTo
OnMouseUp - PanStop

See TrackPan for an alternative panning approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: panStart in interface IScreenDisplay
Specified by:: panStart in interface IScreenDisplay2

Parameters:: mouseLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.panMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStart(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStop(), IScreenDisplay.trackPan()

panMoveTo

public void panMoveTo(IPoint mouseLocation)
               throws IOException,
                      AutomationException

Pans to a new point.

Remarks

PanMoveTo pans the display by calculating an offset distance between the start point supplied to PanStart and the destination point provided to this method. The recording cache is automatically redrawn each time PanMoveTo is called. Use the envelope PanStop returns to truly refresh the display.

The typical sequence for using the pan methods is as follows:

OnMouseDown - PanStart
OnMouseMove - PanMoveTo
OnMouseUp - PanStop

See TrackPan for an alternative panning approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: panMoveTo in interface IScreenDisplay
Specified by:: panMoveTo in interface IScreenDisplay2

Parameters:: mouseLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.panMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStart(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStop(), IScreenDisplay.trackPan()

panStop

public IEnvelope panStop()
                  throws IOException,
                         AutomationException

Stops panning and returns new visible bounds.

Remarks

PanStop creates an Envelope that should be used to reset the extent of the active view. Because PanMoveTo redraws only the recording cache (bitmap), there are typically blank areas in the display. Call IActiveView::Refresh after calling PanStop to invalidate the entire display.

The typical sequence for using the pan methods is as follows:

OnMouseDown - PanStart
OnMouseMove - PanMoveTo
OnMouseUp - PanStop

See TrackPan for an alternative panning approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: panStop in interface IScreenDisplay
Specified by:: panStop in interface IScreenDisplay2

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:: IScreenDisplay.panMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.panStart(com.esri.arcgis.geometry.IPoint), com.esri.arcgis.display.IActiveView, IScreenDisplay.panStop(), IScreenDisplay.trackPan()

trackRotate

public void trackRotate()
                 throws IOException,
                        AutomationException

Interactively rotates the screen.

Remarks

There are two approaches to rotating the display - this method and the group RotateStart, RotateMoveTo, RotateTimer, and RotateStop. This method is the easiest to use as it takes care of all the mouse events automatically, performs the final display rotation, and invalidates the display.

Example:

The following java code excerpt shows this.
 
MapControl mapControl; 
IActiveView pActiveView = mapControl.getActiveView();        
IScreenDisplay pScreenDisplay = pActiveView.getScreenDisplay();       
pScreenDisplay.trackRotate();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: trackRotate in interface IScreenDisplay
Specified by:: trackRotate in interface IScreenDisplay2

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

rotateStart

public void rotateStart(IPoint mousePt,
                        IPoint centerPt)
                 throws IOException,
                        AutomationException

Prepares display for rotating. If centerPt is NULL, the center of the visible bounds is used.

Remarks

Call RotateStart to initiate rotating the display. The required point parameter specifies the starting point of the rotation. Call RotateMoveTo next to specify the rotation destination point, a rotation angle is calculated based on these two points.

The typical sequence for using the rotate methods is as follows:

OnMouseDown - RotateStart
OnMouseMove - RotateMoveTo
OnMouseMove - RotateTimer
OnMouseUp - RotateStop

See TrackRotate for an alternative rotating approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotateStart in interface IScreenDisplay
Specified by:: rotateStart in interface IScreenDisplay2

Parameters:: mousePt - A reference to a com.esri.arcgis.geometry.IPoint (in); centerPt - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.rotateTimer(), IDisplayTransformation.getRotation(), IScreenDisplay.rotateMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.rotateStop(), IScreenDisplay.rotateStart(com.esri.arcgis.geometry.IPoint, com.esri.arcgis.geometry.IPoint)

rotateMoveTo

public void rotateMoveTo(IPoint pPoint)
                  throws IOException,
                         AutomationException

Rotates to new point.

Remarks

RotateMoveTo rotates the display based on the calculated angle between the start point supplied to RotateStart and the destination point provided to this method. Next call RotateTimer to show the rotation degree readout and repaint the display from cache.

The typical sequence for using the rotate methods is as follows:

OnMouseDown - RotateStart
OnMouseMove - RotateMoveTo
OnMouseMove - RotateTimer
OnMouseUp - RotateStop

See TrackRotate for an alternative rotating approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotateMoveTo in interface IScreenDisplay
Specified by:: rotateMoveTo in interface IScreenDisplay2

Parameters:: pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.rotateTimer(), IDisplayTransformation.getRotation(), IScreenDisplay.rotateMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.rotateStop(), IScreenDisplay.rotateStart(com.esri.arcgis.geometry.IPoint, com.esri.arcgis.geometry.IPoint)

rotateTimer

public void rotateTimer()
                 throws IOException,
                        AutomationException

Draws the rotated display. Call in response to WM_TIMER.

Remarks

RotateTimer shows the rotation degree readout and repaints the display from cache.

The typical sequence for using the rotate methods is as follows:

OnMouseDown - RotateStart
OnMouseMove - RotateMoveTo
OnMouseMove - RotateTimer
OnMouseUp - RotateStop

See TrackRotate for an alternative rotating approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotateTimer in interface IScreenDisplay
Specified by:: rotateTimer in interface IScreenDisplay2

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.rotateTimer(), IDisplayTransformation.getRotation(), IScreenDisplay.rotateMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.rotateStop(), IScreenDisplay.rotateStart(com.esri.arcgis.geometry.IPoint, com.esri.arcgis.geometry.IPoint)

rotateStop

public double rotateStop()
                  throws IOException,
                         AutomationException

Stops rotating and returns new angle.

Remarks

RotateStop returns the final rotation angle. You must call IDisplayTransformation::Rotation with the final rotation angle to actually rotate the display.

The typical sequence for using the rotate methods is as follows:

OnMouseDown - RotateStart
OnMouseMove - RotateMoveTo
OnMouseMove - RotateTimer
OnMouseUp - RotateStop

See TrackRotate for an alternative rotating approach.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotateStop in interface IScreenDisplay
Specified by:: rotateStop in interface IScreenDisplay2

Returns:: The degrees
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IScreenDisplay.rotateTimer(), IDisplayTransformation.getRotation(), IScreenDisplay.rotateMoveTo(com.esri.arcgis.geometry.IPoint), IScreenDisplay.rotateStop(), IScreenDisplay.rotateStart(com.esri.arcgis.geometry.IPoint, com.esri.arcgis.geometry.IPoint)

updateWindow

public void updateWindow()
                  throws IOException,
                         AutomationException

Forces a redraw.

Remarks

Use UpdateWindow to process pending Windows WM_PAINT messages immediately. This may be the case if you have a routine that takes a long time to execute and you need the window to refresh while the code executes. Typically, no drawing will occur until all your code has been executed and control returns to the ArcMap's message loop and the WM_PAINT message is handled. UpdateWindow forces the window to invalidate by sending a WM_PAINT message directly to the window; the normal ArcMap message queue is bypassed.

See UpdateWindow in MSDN for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: updateWindow in interface IScreenDisplay
Specified by:: updateWindow in interface IScreenDisplay2

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

getDisplayTransformation

public IDisplayTransformation getDisplayTransformation()
                                                throws IOException,
                                                       AutomationException

The transformation used by the display.

Remarks

Each display object, like ScreenDisplay for example, manages (CoCreates) a DisplayTransformation object to convert coordinates between map units and device units. Use this property to get a reference to the DisplayTransformation object associated with this display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDisplayTransformation in interface IDisplay

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

setDisplayTransformation

public void setDisplayTransformation(IDisplayTransformation displayTransformation)
                              throws IOException,
                                     AutomationException

The transformation used by the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setDisplayTransformation in interface IDisplay

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

getClipEnvelope

public IEnvelope getClipEnvelope()
                          throws IOException,
                                 AutomationException

The bounds of the invalid region. Use after StartDrawing and before FinishDrawing.

Remarks

The ClipEnvelope is the is the display transformation's fitted bounds (IDisplayTransformation::FittedBounds) intersected with the ClipGeometry if one exists.

This property is mostly used during drawing operations, for example, IDisplay's drawing functions clip (ITopologicalOperator::Clip) the object they are drawing against the ClipEnvelope to ensure that only the visible parts of the object are drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClipEnvelope in interface IDisplay

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.

getClipEnvelopes

public ISet getClipEnvelopes()
                      throws IOException,
                             AutomationException

The invalid region as a set of envelopes. Use after StartDrawing and before FinishDrawing.

Remarks

Use ISet::Reset and ISet::Next methods to iterate through the returned set of objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClipEnvelopes in interface IDisplay

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

getClipGeometry

public IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException

User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

Remarks

Use the ClipGeometry property to shape the area data is drawn in. For example, if you had a map of the United States that contained many layers, you could set the ClipGeometry property on the focus Map's ScreenDisplay object equal to the geometry of a particular state thereby telling the map to only draw the data falling within the particular state's area. The ClipGeometry is used to cookie-cut all data before it is drawn.

See IMap::ClipGeometry for a more information and a sample.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClipGeometry in interface IDisplay

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.

setClipGeometry

public void setClipGeometry(IGeometry geometry)
                     throws IOException,
                            AutomationException

User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setClipGeometry in interface IDisplay

Parameters:: geometry - 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.

isSuppressEvents

public boolean isSuppressEvents()
                         throws IOException,
                                AutomationException

Indicates if display object suppresses events.

Remarks

Use SuppressEvents to prevent the following events from being fired.

IDisplayEvents - DisplayStarted, DisplayFinished, DisplayScrolled, DisplayInvalidated
ITransformEvents - BoundsUpdated, VisibleBoundsUpdated, DeviceFrameUpdated, ResolutionUpdated, UnitsUpdated

For example, IScreenDisplay::StartDrawing sets SuppressEvents to TRUE and FinishDrawing sets it back to FALSE, this prevents all transform events from firing during the drawing.

SuppressEvents is set to FALSE by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSuppressEvents in interface IDisplay

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

setSuppressEvents

public void setSuppressEvents(boolean suppressEvents)
                       throws IOException,
                              AutomationException

Indicates if display object suppresses events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSuppressEvents in interface IDisplay

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

getFilter

public IDisplayFilter getFilter()
                         throws IOException,
                                AutomationException

Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFilter in interface IDisplay

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

setFilterByRef

public void setFilterByRef(IDisplayFilter filter)
                    throws IOException,
                           AutomationException

Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFilterByRef in interface IDisplay

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

getHPalette

public int getHPalette()
                throws IOException,
                       AutomationException

Palette.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHPalette in interface IDisplay

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

setHPalette

public void setHPalette(int hPalette)
                 throws IOException,
                        AutomationException

Palette.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHPalette in interface IDisplay

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

startDrawing

public void startDrawing(int hDC,
                         short cacheID)
                  throws IOException,
                         AutomationException

Prepare the display for drawing. Specify the device context and the cache to draw to (normally esriNoScreenCache). The ScreenDisplay coclass will automatically create a window device context if you specify hdc = 0.

Remarks

StartDrawing and FinishDrawing are used to manage clipping, symbols, and caching. Call StartDrawing and FinishDrawing anytime you want to draw to a device such as a display, printer, or cache (bitmap). However, if you are drawing in response to IActiveViewEvents::AfterDraw, the Map object automatically makes these calls for you.

StartDrawing has two parameters: hDc and cacheID. The hDc parameter specifies the target device where drawing will occur, usually a display, printer, or bitmap. The cacheID parameter activates a specific cache. In most cases, esriNoScreenCache should be used.

Specifying a cache sets it as the screen's active cache. When esriNoScreenCache is used, it sets the display's active cache to zero and drawing occurs directly in the device. Specify a cache when you don't want to draw to a screen directly and you instead want to draw to a cache (bitmap) that may ultimately be copied to the screen. For example, when ArcMap draws geography, it draws it to a specific cache and then the cache is copied to the screen. When the screen repaints, instead of drawing all the data from scratch again, the software checks if the cache is dirty or not and simply redraws the bitmap to save time if it can. When drawing to a cache, the hDc parameter should be the device context of the bitmap, use the IScreenDisplay::CacheMemDC property to get a particular cache's hDC.

Each time you need to change the cache you are drawing to, you must do so inside a new StartDrawing / FinishDrawing block. For example, ArcMap usually creates three caches: one for geography layers, one for graphics and annotation, and one for selections. ArcMap draws each of these phases within a separate StartDrawing / FinishDrawing block.

There are times when may need to draw shapes directly to screen without having them become part of a display cache. For example, drawing moving objects. In these cases, use IScreenDisplay::WindowDC to get the device context of the display and esriNoScreenCache as the cacheID.

If a zero is specified for the hDc parameter, the Windows API function GetDC is used to populate IScreenDisplay::WindowDC with the hDC of the main display and drawing is sent here.

As mentioned above, if you drawing in response to the IActiveView::AfterDraw event, the Map object calls StartDrawing and StopDrawing for you. Also, if the draw phase you are drawing after is cached, your drawings will be cached as well.

StartDrawing fires the IDisplayEvents::DisplayStarted event.

Example:

The following java code gives you an example drawing sequence.

<font face=�Courier New� size=2>
<pre>
        IScreenDisplay pScreen;
        boolean isCacheDirty = pScreen.isCacheDirty(esriScreenRecording);
        if (isCacheDirty) // draw from scratch
        {
          IDisplay pIDisplay = new IDisplayProxy(pScreen); 
          pScreen.startRecording();
          pIDisplay.startDrawing((int)hPaintDC, esriNoScreenCache);
          DrawContents();
          pScreen.finishDrawing();
          pScreen.stopRecording();
        } else // draw from offscreen bitmap
        {
          pScreen.drawCache((int)hPaintDC, esriScreenRecording, 0, 0);
        }
</pre>
</font>

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: startDrawing in interface IDisplay

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

getHDC

public int getHDC()
           throws IOException,
                  AutomationException

The device context that the display is currently drawing to. Only valid between calls to StartDrawing and FinishDrawing.

Remarks

Returns the device context specified to StartDrawing. This may be the device context of a display, cache (bitmap), or some other device such as a printer. As StartDrawing is called frequently throughout the drawing pipeline, the hDc property continually changes and is therefore safe to use only within a single StartDrawing / FinishDrawing block.

This property does not provide a value to pass to IDisplay::StartDrawing. Instead, call IDisplay::StartDrawing with a value of 0 for the hDC as this will automatically use the Windows API function GetDC to populate IScreenDisplay::WindowDC with the hDC of the main display and drawing will occur there.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHDC in interface IDisplay

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

finishDrawing

public void finishDrawing()
                   throws IOException,
                          AutomationException

Completes drawing.

Remarks

When FinishDrawing is called, all the caches get flushed to the screen.

FinishDrawing must be called before StartDrawing can be called again.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: finishDrawing in interface IDisplay

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IDisplay.startDrawing(int, short)

progress

public void progress(int vertexCount)
              throws IOException,
                     AutomationException

Call frequently during drawing process.

Remarks

Progress is called from the draw methods.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: progress in interface IDisplay

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

drawPoint

public void drawPoint(IGeometry point)
               throws IOException,
                      AutomationException

Draws specified point on the display.

Remarks

DrawPoint draws a Point object with the symbol that must be specified before hand with the SetSymbol method. All draw methods must be enclosed between the calls to StartDrawing and FinishDrawing unless you are drawing in response to the IActiveViewEvents::AfterDraw event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawPoint in interface IDisplay

Parameters:: point - 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.
See Also:: IDisplay.startDrawing(int, short)

drawMultipoint

public void drawMultipoint(IGeometry multipoint)
                    throws IOException,
                           AutomationException

Draws specified multipoint on the display.

Remarks

DrawMultipoint draws a Multipoint object with the symbol that must be specified before hand with the SetSymbol method. All draw methods must be enclosed between the calls to StartDrawing and FinishDrawing unless you are drawing in response to the IActiveViewEvents::AfterDraw event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawMultipoint in interface IDisplay

Parameters:: multipoint - 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.
See Also:: IDisplay.startDrawing(int, short)

drawRectangle

public void drawRectangle(IEnvelope rectangle)
                   throws IOException,
                          AutomationException

Draws specified rectangle on the display.

Remarks

DrawRectangle draws a Envelope object with the symbol that must be specified before hand with the SetSymbol method. All draw methods must be enclosed between the calls to StartDrawing and FinishDrawing unless you are drawing in response to the IActiveViewEvents::AfterDraw event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawRectangle in interface IDisplay

Parameters:: rectangle - 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:: IDisplay.startDrawing(int, short)

drawPolyline

public void drawPolyline(IGeometry polyline)
                  throws IOException,
                         AutomationException

Draws specified line on the display.

Remarks

DrawPolyline draws a Polyline object with the symbol that must be specified before hand with the SetSymbol method. All draw methods must be enclosed between the calls to StartDrawing and FinishDrawing unless you are drawing in response to the IActiveViewEvents::AfterDraw event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawPolyline in interface IDisplay

Parameters:: polyline - 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.
See Also:: IDisplay.startDrawing(int, short)

drawPolygon

public void drawPolygon(IGeometry polygon)
                 throws IOException,
                        AutomationException

Draws specified polygon on the display.

Remarks

DrawPolygon draws a Polygon object with the symbol that must be specified before hand with the SetSymbol method. All draw methods must be enclosed between the calls to StartDrawing and FinishDrawing unless you are drawing in response to the IActiveViewEvents::AfterDraw event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawPolygon in interface IDisplay

Parameters:: polygon - 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.
See Also:: IDisplay.startDrawing(int, short)

drawText

public void drawText(IGeometry shape,
                     String text)
              throws IOException,
                     AutomationException

Draws specified text on the display.

Remarks

DrawText draws a text string with the symbol that must be specified before hand with the SetSymbol method. All draw methods must be enclosed between the calls to StartDrawing and FinishDrawing unless you are drawing in response to the IActiveViewEvents::AfterDraw event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawText in interface IDisplay

Parameters:: shape - A reference to a com.esri.arcgis.geometry.IGeometry (in); text - The text (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IDisplay.startDrawing(int, short)

setSymbol

public void setSymbol(ISymbol sym)
               throws IOException,
                      AutomationException

Sets the symbol used for drawing. Four different symbols can be specified simultaneously: Marker, Line, Fill, Text.

Remarks

Call this method before calling one of the Draw methods to set the symbol for the object about to be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSymbol in interface IDisplay

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

getIlluminationProps

public IIlluminationProps getIlluminationProps()
                                        throws IOException,
                                               AutomationException

Illumination properties used by the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getIlluminationProps in interface IDisplay

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

setIlluminationProps

public void setIlluminationProps(IIlluminationProps illuminationProps)
                          throws IOException,
                                 AutomationException

Illumination properties used by the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setIlluminationProps in interface IDisplay

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

setBackgroundRGB

public void setBackgroundRGB(int rGB)
                      throws IOException,
                             AutomationException

The RGB value of the background color. This color only appears on the screen, not on output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBackgroundRGB in interface IScreenDisplay2

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

getBackgroundRGB

public int getBackgroundRGB()
                     throws IOException,
                            AutomationException

The RGB value of the background color. This color only appears on the screen, not on output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBackgroundRGB in interface IScreenDisplay2

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

getDrawingOffset

public void getDrawingOffset(int[] x,
                             int[] y)
                      throws IOException,
                             AutomationException

The offset between the device origin and the active cache origin.

Product Availability

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

Specified by:: getDrawingOffset in interface IScreenDisplay2

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

validate

public void validate(short cacheIndex)
              throws IOException,
                     AutomationException

Clear dirty flag for specified cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: validate in interface IScreenDisplay2

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

startFeedback

public void startFeedback()
                   throws IOException,
                          AutomationException

Prepare the display for drawing selection/rubberbanding. Drawing isn't clipped or zoomed with page. Must match with a call to FinishFeedback.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: startFeedback in interface IScreenDisplay2

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

finishFeedback

public void finishFeedback()
                    throws IOException,
                           AutomationException

Ends feedback drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: finishFeedback in interface IScreenDisplay2

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

frameScrolled

public void frameScrolled(int x,
                          int y)
                   throws IOException,
                          AutomationException

Call on frame display when container is scrolled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: frameScrolled in interface IScreenDisplay2

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

setScreenPickTolerance

public void setScreenPickTolerance(int pixels)
                            throws IOException,
                                   AutomationException

The tolerance in pixels used when picking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScreenPickTolerance in interface IDisplay3D

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

getScreenPickTolerance

public int getScreenPickTolerance()
                           throws IOException,
                                  AutomationException

The tolerance in pixels used when picking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getScreenPickTolerance in interface IDisplay3D

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

setSymbolScale

public void setSymbolScale(float scale)
                    throws IOException,
                           AutomationException

The scale for point size and line width of symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSymbolScale in interface IDisplay3D

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

getSymbolScale

public float getSymbolScale()
                     throws IOException,
                            AutomationException

The scale for point size and line width of symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSymbolScale in interface IDisplay3D

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

putMaxTextureSize

public void putMaxTextureSize(int maxTextureWidth,
                              int maxTextureHeight)
                       throws IOException,
                              AutomationException

The limit for the size of a single texture.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: putMaxTextureSize in interface IDisplay3D

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

getMaxTextureSize

public void getMaxTextureSize(int[] pMaxTextureWidth,
                              int[] pMaxTextureHeight)
                       throws IOException,
                              AutomationException

The limit for the size of a single texture.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMaxTextureSize in interface IDisplay3D

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

addFlashFeature

public void addFlashFeature(IGeometry pGeometry)
                     throws IOException,
                            AutomationException

Adds a feature shape to the flash list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addFlashFeature in interface IDisplay3D

Parameters:: pGeometry - 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.

flashFeatures

public void flashFeatures()
                   throws IOException,
                          AutomationException

Redraws viewers flashing the features in the flash list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: flashFeatures in interface IDisplay3D

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

flashLocation

public void flashLocation(IPoint pGeometry)
                   throws IOException,
                          AutomationException

Redraws viewers flashing the given location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: flashLocation in interface IDisplay3D

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

flashGeometry

public void flashGeometry(Object pOwner,
                          Object feature)
                   throws IOException,
                          AutomationException

Flashes a feature shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: flashGeometry in interface IDisplay3D

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

getTimeValue

public ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

Time Extent for which the data has to be displayed.

Product Availability

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

Specified by:: getTimeValue in interface ITimeDisplay

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.

setTimeValue

public void setTimeValue(ITimeValue timeExtent)
                  throws IOException,
                         AutomationException

Time Extent for which the data has to be displayed.

Product Availability

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

Specified by:: setTimeValue in interface ITimeDisplay

Parameters:: timeExtent - 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

Time reference using which the data has to be displayed.

Product Availability

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

Specified by:: getTimeReference in interface ITimeDisplay

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.

setTimeReference

public void setTimeReference(ITimeReference timeReference)
                      throws IOException,
                             AutomationException

Time reference using which the data has to be displayed.

Product Availability

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

Specified by:: setTimeReference in interface ITimeDisplay

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.

getTimeRelation

public int getTimeRelation()
                    throws IOException,
                           AutomationException

Time relation for the time query.

Product Availability

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

Specified by:: getTimeRelation in interface ITimeDisplay2

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 for the time query.

Product Availability

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

Specified by:: setTimeRelation in interface ITimeDisplay2

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.

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.analyst3d Class SceneGraph

Remarks

Product Availability

Supported Platforms

SceneGraph

SceneGraph

getClsid

equals

hashCode

addISceneGraphEventsDispListener

removeISceneGraphEventsDispListener

addISceneGraphEventsListener

removeISceneGraphEventsListener

addITimeDisplayEventsListener

removeITimeDisplayEventsListener

addISceneGraphLayerEventsListener

removeISceneGraphLayerEventsListener

addISceneGraphLayerEventsDispListener

removeISceneGraphLayerEventsDispListener

contentsChanged

Remarks

Product Availability

Supported Platforms

contentsCleared

Product Availability

Supported Platforms

itemAdded

Remarks

Product Availability

Supported Platforms

itemDeleted

Remarks

Product Availability

Supported Platforms

itemReordered

Remarks

Product Availability

Supported Platforms

selectionChanged

Product Availability

Supported Platforms

viewRefreshed

Description

Remarks

Product Availability

Supported Platforms

afterDraw

Product Availability

Supported Platforms

afterItemDraw

Remarks

Product Availability

Supported Platforms

focusMapChanged

Product Availability

Supported Platforms

spatialReferenceChanged

Product Availability

Supported Platforms

selectionChanged

Product Availability

Supported Platforms

getScene

Product Availability

Supported Platforms

setSceneByRef

Product Availability

Supported Platforms

isEmpty

Product Availability

Supported Platforms

addSimpleGraphics

Product Availability

Supported Platforms

addSimpleActor

Product Availability

Supported Platforms

beginCompositeActor

Product Availability

Supported Platforms

com.esri.arcgis.analyst3d
Class SceneGraph