com.esri.arcgis.analyst3d
Class I3DViewerProxy

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

public class I3DViewerProxy
extends com.esri.arcgis.interop.Dispatch
implements I3DViewer, Serializable

Provides access to members that conrtrol the 3D viewer.

Remarks

This interface could be seen as a newer version or replacement of ISceneViewer interface. It keeps the basic members of the ISceneViewer interface and added some new members, with the most notable ones being those for full screen control.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  I3DViewerProxy()
           
  I3DViewerProxy(Object obj)
           
protected I3DViewerProxy(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 viewer's camera.
 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, 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, 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 readExternal(ObjectInput in)
           
 void redraw(boolean bCameraMoved)
          Redraws the viewer.
 void removeListener(String iidStr, Object theListener)
           
 void setCameraByRef(ICamera ppCamera)
          The viewer's camera.
 void setCaption(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.
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

I3DViewerProxy

public I3DViewerProxy()

I3DViewerProxy

public I3DViewerProxy(Object obj)
               throws IOException
Throws:
IOException

I3DViewerProxy

protected I3DViewerProxy(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 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 I3DViewer
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 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 I3DViewer
Parameters:
pCaption - The pCaption (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCamera

public ICamera getCamera()
                  throws IOException,
                         AutomationException
The 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 I3DViewer
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 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 I3DViewer
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 bCameraMoved)
            throws IOException,
                   AutomationException
Redraws the 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 I3DViewer
Parameters:
bCameraMoved - The bCameraMoved (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 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:
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 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 I3DViewer
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 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 I3DViewer
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 I3DViewer
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 I3DViewer
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 I3DViewer
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 I3DViewer
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 I3DViewer
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 I3DViewer
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 I3DViewer
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 I3DViewer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFullScreenEnabled

public void setFullScreenEnabled(boolean pbEnabled)
                          throws IOException,
                                 AutomationException
Indicates if key [F11] is enabled to toggle full screen drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isFullScreenEnabled

public boolean isFullScreenEnabled()
                            throws IOException,
                                   AutomationException
Indicates if key [F11] is enabled to toggle full screen drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isFullScreen

public boolean isFullScreen()
                     throws IOException,
                            AutomationException
Indicates if full screen is the current drawing mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFullScreen

public void setFullScreen(boolean bFullScreen)
                   throws IOException,
                          AutomationException
Full screen drawing if the argument is TRUE, otherwise normal window drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException