com.esri.arcgis.analyst3d
Interface ISceneViewer

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISceneViewerProxy

public interface ISceneViewer
extends 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.

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 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 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.
 

Method Detail

getCaption

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

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 scene 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.

getSceneGraph

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

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

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

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

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

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 scene 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 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

Parameters:
cameraMoved - The cameraMoved (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 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:
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 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

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.