com.esri.arcgis.analyst3d
Class ISceneViewerProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.analyst3d.ISceneViewerProxy
All Implemented Interfaces:
ISceneViewer, Externalizable, Serializable

public class ISceneViewerProxy
extends com.esri.arcgis.interop.Dispatch
implements ISceneViewer, Serializable

Provides access to members that conrtrol the scene viewer.

Product Availability

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

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  ISceneViewerProxy()
           
  ISceneViewerProxy(Object obj)
           
protected ISceneViewerProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void clearGesture()
          Clears the last gesture.
 void drawToMetafile(int hDC, float resolutionFactor, int left, int top, int right, int bottom, boolean bOffScreen)
          Draws the contents of the viewer to a device.
 ICamera getCamera()
          The scene viewer's camera.
 String getCaption()
          The scene viewer's caption.
 int getGestureSensitivity()
          The gesture sensitivity as indicated by number of pixels.
 int getHDC()
          The associated device context.
 int getHWnd()
          The associated window handle.
 ISceneGraph getSceneGraph()
          The scene viewer's scene graph.
 void getScreenShot(int type, String fileName)
          Saves the content of the scene viewer and any windows superimposed on the scene viewer as an image.
 void getSnapshot(int width, int height, int type, String fileName)
          Saves the content of the scene viewer as an image.
 boolean isGestureEnabled()
          Indicates if gesturing is enabled.
 void overrideDefaultHandler()
          Supersedes the default event handler.
 void redraw(boolean cameraMoved)
          Redraws the scene viewer.
 void removeListener(String iidStr, Object theListener)
           
 void setCameraByRef(ICamera ppCamera)
          The scene viewer's camera.
 void setCaption(String pCaption)
          The scene viewer's caption.
 void setGestureEnabled(boolean pbEnabled)
          Indicates if gesturing is enabled.
 void setGestureSensitivity(int pcPixels)
          The gesture sensitivity as indicated by number of pixels.
 void setSceneGraphByRef(ISceneGraph ppSceneGraph)
          The scene viewer's scene graph.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

ISceneViewerProxy

public ISceneViewerProxy()

ISceneViewerProxy

public ISceneViewerProxy(Object obj)
                  throws IOException
Throws:
IOException

ISceneViewerProxy

protected ISceneViewerProxy(Object obj,
                            String iid)
                     throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException
The scene viewer's caption.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCaption in interface ISceneViewer
Returns:
The pCaption
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCaption

public void setCaption(String pCaption)
                throws IOException,
                       AutomationException
The scene viewer's caption.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCaption in interface ISceneViewer
Parameters:
pCaption - The pCaption (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws IOException,
                                 AutomationException
The scene viewer's scene graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSceneGraph in interface ISceneViewer
Returns:
A reference to a com.esri.arcgis.analyst3d.ISceneGraph
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSceneGraphByRef

public void setSceneGraphByRef(ISceneGraph ppSceneGraph)
                        throws IOException,
                               AutomationException
The scene viewer's scene graph.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSceneGraphByRef in interface ISceneViewer
Parameters:
ppSceneGraph - A reference to a com.esri.arcgis.analyst3d.ISceneGraph (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCamera

public ICamera getCamera()
                  throws IOException,
                         AutomationException
The scene viewer's camera.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCamera in interface ISceneViewer
Returns:
A reference to a com.esri.arcgis.analyst3d.ICamera
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCameraByRef

public void setCameraByRef(ICamera ppCamera)
                    throws IOException,
                           AutomationException
The scene viewer's camera.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCameraByRef in interface ISceneViewer
Parameters:
ppCamera - 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.

redraw

public void redraw(boolean cameraMoved)
            throws IOException,
                   AutomationException
Redraws the scene viewer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
redraw in interface ISceneViewer
Parameters:
cameraMoved - The cameraMoved (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawToMetafile

public void drawToMetafile(int hDC,
                           float resolutionFactor,
                           int left,
                           int top,
                           int right,
                           int bottom,
                           boolean bOffScreen)
                    throws IOException,
                           AutomationException
Draws the contents of the viewer to a device.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
drawToMetafile in interface ISceneViewer
Parameters:
hDC - The hDC (A COM typedef) (in)
resolutionFactor - The resolutionFactor (in)
left - The left (in)
top - The top (in)
right - The right (in)
bottom - The bottom (in)
bOffScreen - The bOffScreen (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSnapshot

public void getSnapshot(int width,
                        int height,
                        int type,
                        String fileName)
                 throws IOException,
                        AutomationException
Saves the content of the scene viewer as an image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSnapshot in interface ISceneViewer
Parameters:
width - The width (in)
height - The height (in)
type - A com.esri.arcgis.analyst3d.esri3DOutputImageType constant (in)
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScreenShot

public void getScreenShot(int type,
                          String fileName)
                   throws IOException,
                          AutomationException
Saves the content of the scene viewer and any windows superimposed on the scene viewer as an image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getScreenShot in interface ISceneViewer
Parameters:
type - A com.esri.arcgis.analyst3d.esri3DOutputImageType constant (in)
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException
The associated window handle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHWnd in interface ISceneViewer
Returns:
The pHwnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHDC

public int getHDC()
           throws IOException,
                  AutomationException
The associated device context.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHDC in interface ISceneViewer
Returns:
The pHDC (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGestureSensitivity

public void setGestureSensitivity(int pcPixels)
                           throws IOException,
                                  AutomationException
The gesture sensitivity as indicated by number of pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGestureSensitivity in interface ISceneViewer
Parameters:
pcPixels - The pcPixels (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGestureSensitivity

public int getGestureSensitivity()
                          throws IOException,
                                 AutomationException
The gesture sensitivity as indicated by number of pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGestureSensitivity in interface ISceneViewer
Returns:
The pcPixels
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 gesturing is enabled.

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 ISceneViewer
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 gesturing is enabled.

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 ISceneViewer
Returns:
The pbEnabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearGesture

public void clearGesture()
                  throws IOException,
                         AutomationException
Clears the last gesture.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
clearGesture in interface ISceneViewer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

overrideDefaultHandler

public void overrideDefaultHandler()
                            throws IOException,
                                   AutomationException
Supersedes the default event handler.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
overrideDefaultHandler in interface ISceneViewer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.