com.esri.arcgis.analyst3d
Class I3DViewerProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.analyst3d.I3DViewerProxy
All Implemented Interfaces:
java.io.Externalizable, I3DViewer, java.io.Serializable

public class I3DViewerProxy
extends Dispatch
implements I3DViewer, java.io.Serializable

Provides access to members that conrtrol the 3D viewer.

Product Availability

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

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  I3DViewerProxy()
          For internal use only
  I3DViewerProxy(java.lang.Object obj)
           
protected I3DViewerProxy(java.lang.Object obj, java.lang.String iid)
           
  I3DViewerProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected I3DViewerProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 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 viewer's camera.
 java.lang.String getCaption()
          The 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.
 void getScreenShot(int type, java.lang.String fileName)
          Saves the content of the viewer and any windows superimposed on the scene viewer as an image.
 void getSnapshot(int width, int height, int type, java.lang.String fileName)
          Saves the content of the viewer as an image.
 boolean isFullScreen()
          Indicates if full screen is the current drawing mode.
 boolean isFullScreenEnabled()
          Indicates if key [F11] is enabled to toggle full screen drawing.
 boolean isGestureEnabled()
          Indicates if gesturing is enabled.
 void overrideDefaultHandler()
          Supersedes the default event handler.
 void redraw(boolean bCameraMoved)
          Redraws the viewer.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 void setCameraByRef(ICamera ppCamera)
          The viewer's camera.
 void setCaption(java.lang.String pCaption)
          The viewer's caption.
 void setFullScreen(boolean bFullScreen)
          Full screen drawing if the argument is TRUE, otherwise normal window drawing.
 void setFullScreenEnabled(boolean pbEnabled)
          Indicates if key [F11] is enabled to toggle full screen drawing.
 void setGestureEnabled(boolean pbEnabled)
          Indicates if gesturing is enabled.
 void setGestureSensitivity(int pcPixels)
          The gesture sensitivity as indicated by number of pixels.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Constructor Detail

I3DViewerProxy

public I3DViewerProxy(java.lang.String CLSID,
                      java.lang.String host,
                      AuthInfo authInfo)
               throws java.net.UnknownHostException,
                      java.io.IOException

I3DViewerProxy

public I3DViewerProxy()
For internal use only


I3DViewerProxy

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

I3DViewerProxy

protected I3DViewerProxy(java.lang.Object obj,
                         java.lang.String iid)
                  throws java.io.IOException

I3DViewerProxy

protected I3DViewerProxy(java.lang.String CLSID,
                         java.lang.String iid,
                         java.lang.String host,
                         AuthInfo authInfo)
                  throws java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object to be informed of the events
theSource - the proxy class that represents the COM class that is the source of the events
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object that no longer wishes to be informed of the events
Throws:
java.io.IOException

getCaption

public java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: I3DViewer
The viewer's caption.

Supported Platforms

Windows, Solaris, Linux

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

setCaption

public void setCaption(java.lang.String pCaption)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: I3DViewer
The viewer's caption.

Supported Platforms

Windows, Solaris, Linux

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

getCamera

public ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: I3DViewer
The viewer's camera.

Supported Platforms

Windows, Solaris, Linux

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

setCameraByRef

public void setCameraByRef(ICamera ppCamera)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: I3DViewer
The viewer's camera.

Specified by:
setCameraByRef in interface I3DViewer
Parameters:
ppCamera - A reference to a com.esri.arcgis.analyst3d.ICamera (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redraw

public void redraw(boolean bCameraMoved)
            throws java.io.IOException,
                   AutomationException
Description copied from interface: I3DViewer
Redraws the viewer.

Supported Platforms

Windows, Solaris, Linux

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

drawToMetafile

public void drawToMetafile(int hDC,
                           float resolutionFactor,
                           int left,
                           int top,
                           int right,
                           int bottom,
                           boolean bOffScreen)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: I3DViewer
Draws the contents of the viewer to a device.

Supported Platforms

Windows, Solaris, Linux

Specified by:
drawToMetafile in interface I3DViewer
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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSnapshot

public void getSnapshot(int width,
                        int height,
                        int type,
                        java.lang.String fileName)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: I3DViewer
Saves the content of the viewer as an image.

Supported Platforms

Windows, Solaris, Linux

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

getScreenShot

public void getScreenShot(int type,
                          java.lang.String fileName)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: I3DViewer
Saves the content of the viewer and any windows superimposed on the scene viewer as an image.

Supported Platforms

Windows, Solaris, Linux

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

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: I3DViewer
The associated window handle.

Supported Platforms

Windows, Solaris, Linux

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

getHDC

public int getHDC()
           throws java.io.IOException,
                  AutomationException
Description copied from interface: I3DViewer
The associated device context.

Supported Platforms

Windows, Solaris, Linux

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

setGestureSensitivity

public void setGestureSensitivity(int pcPixels)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: I3DViewer
The gesture sensitivity as indicated by number of pixels.

Supported Platforms

Windows, Solaris, Linux

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

getGestureSensitivity

public int getGestureSensitivity()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: I3DViewer
The gesture sensitivity as indicated by number of pixels.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGestureSensitivity in interface I3DViewer
Returns:
The pcPixels
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setGestureEnabled

public void setGestureEnabled(boolean pbEnabled)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: I3DViewer
Indicates if gesturing is enabled.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGestureEnabled in interface I3DViewer
Parameters:
pbEnabled - The pbEnabled (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isGestureEnabled

public boolean isGestureEnabled()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: I3DViewer
Indicates if gesturing is enabled.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isGestureEnabled in interface I3DViewer
Returns:
The pbEnabled
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

clearGesture

public void clearGesture()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: I3DViewer
Clears the last gesture.

Supported Platforms

Windows, Solaris, Linux

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

overrideDefaultHandler

public void overrideDefaultHandler()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: I3DViewer
Supersedes the default event handler.

Supported Platforms

Windows, Solaris, Linux

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

setFullScreenEnabled

public void setFullScreenEnabled(boolean pbEnabled)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: I3DViewer
Indicates if key [F11] is enabled to toggle full screen drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFullScreenEnabled in interface I3DViewer
Parameters:
pbEnabled - The pbEnabled (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFullScreenEnabled

public boolean isFullScreenEnabled()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: I3DViewer
Indicates if key [F11] is enabled to toggle full screen drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFullScreenEnabled in interface I3DViewer
Returns:
The pbEnabled
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isFullScreen

public boolean isFullScreen()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: I3DViewer
Indicates if full screen is the current drawing mode.

Specified by:
isFullScreen in interface I3DViewer
Returns:
The pbIsFullScreen
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setFullScreen

public void setFullScreen(boolean bFullScreen)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: I3DViewer
Full screen drawing if the argument is TRUE, otherwise normal window drawing.

Specified by:
setFullScreen in interface I3DViewer
Parameters:
bFullScreen - The bFullScreen (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.