com.esri.arcgis.analyst3d
Interface ISceneGraph

All Superinterfaces:
Serializable
All Known Subinterfaces:
ISceneGraph2
All Known Implementing Classes:
ISceneGraph2Proxy, ISceneGraphProxy, SceneGraph

public interface ISceneGraph
extends Serializable

Provides access to members that control and manipulate the scene graph.

Superseded By

ISceneGraph2

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addSimpleActor(ISceneRenderer pRecorder, IGeoDataset pGeoDataset)
          Constructs a simple actor (layer visualization subgraph).
 void addSimpleGraphics(ISceneRenderer pRecorder)
          Constructs a simple graphics node.
 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 endCompositeActor()
          Notifies the scene graph that the definition of a group layer has ended.
 ISceneViewer findViewer(String caption)
          Finds the Viewer.
 ISceneViewer getActiveViewer()
          The active viewer.
 IArray getAllViewers()
          Returns all registered Viewers.
 void getBackgroundColor(float[] pRed, float[] pGreen, float[] pBlue)
          Returns the background color.
 int getContrast()
          The contrast coefficient.
 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.
 IEnvelope getGeographySelectionExtent()
          The volumetric bounding box of selected features.
 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.
 IColor getSelectionColor()
          The selection color.
 IVector3D getSunVector()
          The sun vector.
 double getVerticalExaggeration()
          The vertical exaggeration factor.
 void invalidate(Object pObject, boolean bInvalidateGeography, boolean bInvalidateSelection)
          Invalidates acts representing an object.
 boolean isEmpty()
          Indicates if the content of the scene graph is empty.
 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.
 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 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 replayFrame(ICamera camera)
          Uses the camera to redraw a frame.
 void setActiveViewerByRef(ISceneViewer ppViewer)
          The active viewer.
 void setBackgroundColor(float red, float green, float blue)
          Sets the background color.
 void setContrast(int pContrast)
          The contrast coefficient.
 void setGestureEnabled(boolean pbEnabled)
          Indicates if the mouse gestures are supported.
 void setImmediateMode(boolean pbIsAllImmediate)
          Indicates if immediate-mode rendering for the whole scene is being used.
 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 setSceneByRef(IScene pVal)
          The scene.
 void setSelectionColorByRef(IColor pSelectionColor)
          The selection color.
 void setSunVector(IVector3D ppSun)
          The sun vector.
 void setVerticalExaggeration(double pZFactor)
          The vertical exaggeration factor.
 void unregisterViewer(ISceneViewer pViewer)
          Removes a viewer from the scene graph.
 

Method Detail

getScene

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

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

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

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

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

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

addSimpleGraphics

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

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

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

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

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

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

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

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

remove

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

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

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

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

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

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

isImmediateMode

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

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

setOwnerVisibility

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

setBackgroundColor

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

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

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

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

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.

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

getSelectionColor

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isNavigating

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

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

setIsNavigating

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

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

setGestureEnabled

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

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

isGestureEnabled

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

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

locate

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

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

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

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

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

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

setVerticalExaggeration

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

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

getSunVector

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

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

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

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

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

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

setContrast

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

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

clear

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

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

lockViewers

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

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

getDrawingTimeInfo

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

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

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

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

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

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

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

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

setIsRecordingMessageEnabled

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

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