com.esri.arcgis.analyst3d
Interface ISceneViewer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISceneViewerProxy

public interface ISceneViewer

extends java.io.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.
java.lang.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, java.lang.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, java.lang.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(java.lang.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

public java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException

The scene viewer's caption.

Supported Platforms

Windows, Solaris, Linux

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

The scene viewer's caption.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pCaption - The pCaption (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException

The scene viewer's scene graph.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.analyst3d.ISceneGraph

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSceneGraphByRef

public void setSceneGraphByRef(ISceneGraph ppSceneGraph)
                        throws java.io.IOException,
                               AutomationException

The scene viewer's scene graph.

Parameters:

ppSceneGraph - A reference to a com.esri.arcgis.analyst3d.ISceneGraph (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCamera

public ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException

The scene viewer's camera.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.analyst3d.ICamera

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCameraByRef

public void setCameraByRef(ICamera ppCamera)
                    throws java.io.IOException,
                           AutomationException

The scene viewer's camera.

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 cameraMoved)
            throws java.io.IOException,
                   AutomationException

Redraws the scene viewer.

Supported Platforms

Windows, Solaris, Linux

Parameters:

cameraMoved - The cameraMoved (in)

Throws:

java.io.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 java.io.IOException,
                           AutomationException

Draws the contents of the viewer to a device.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapshot

public void getSnapshot(int width,
                        int height,
                        int type,
                        java.lang.String fileName)
                 throws java.io.IOException,
                        AutomationException

Saves the content of the scene viewer as an image.

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:

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

Saves the content of the scene viewer and any windows superimposed on the scene viewer as an image.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException

The associated window handle.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pHwnd (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHDC

public int getHDC()
           throws java.io.IOException,
                  AutomationException

The associated device context.

Supported Platforms

Windows, Solaris, Linux

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

The gesture sensitivity as indicated by number of pixels.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pcPixels - The pcPixels (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGestureSensitivity

public int getGestureSensitivity()
                          throws java.io.IOException,
                                 AutomationException

The gesture sensitivity as indicated by number of pixels.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pcPixels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGestureEnabled

public void setGestureEnabled(boolean pbEnabled)
                       throws java.io.IOException,
                              AutomationException

Indicates if gesturing is enabled.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pbEnabled - The pbEnabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGestureEnabled

public boolean isGestureEnabled()
                         throws java.io.IOException,
                                AutomationException

Indicates if gesturing is enabled.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pbEnabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearGesture

public void clearGesture()
                  throws java.io.IOException,
                         AutomationException

Clears the last gesture.

Supported Platforms

Windows, Solaris, Linux

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

overrideDefaultHandler

public void overrideDefaultHandler()
                            throws java.io.IOException,
                                   AutomationException

Supersedes the default event handler.

Supported Platforms

Windows, Solaris, Linux

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.