com.esri.arcgis.analyst3d
Interface I3DViewer

All Superinterfaces:
Serializable
All Known Implementing Classes:
I3DViewerProxy

public interface I3DViewer
extends 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


Method Summary
 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 redraw(boolean bCameraMoved)
          Redraws the viewer.
 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.
 

Method Detail

getCaption

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

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

setCaption

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

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

getCamera

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

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

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

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

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

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

drawToMetafile

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

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

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

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

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

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

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

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

getHDC

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

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

setGestureSensitivity

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

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

getGestureSensitivity

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

Returns:
The pcPixels
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 gesturing is enabled.

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

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.

clearGesture

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

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

overrideDefaultHandler

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

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

setFullScreenEnabled

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

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

isFullScreenEnabled

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

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

isFullScreen

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

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

setFullScreen

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

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