com.esri.arcgis.analyst3d
Interface I3DViewer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
I3DViewerProxy

public interface I3DViewer
extends java.io.Serializable

COM Interface 'I3DViewer'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esri3DAnalyst.olb'

Description: 'Provides access to members that conrtrol the 3D viewer.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDea6581ec_082d_435c_8f73_b4161ca06f20
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 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 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.
 

Field Detail

IIDea6581ec_082d_435c_8f73_b4161ca06f20

static final int IIDea6581ec_082d_435c_8f73_b4161ca06f20
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getCaption

java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException
The viewer's caption.

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

setCaption

void setCaption(java.lang.String pCaption)
                throws java.io.IOException,
                       AutomationException
The viewer's caption.

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

getCamera

ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException
The viewer's camera.

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

void setCameraByRef(ICamera ppCamera)
                    throws java.io.IOException,
                           AutomationException
The 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

void redraw(boolean bCameraMoved)
            throws java.io.IOException,
                   AutomationException
Redraws the viewer.

Parameters:
bCameraMoved - The bCameraMoved (in)
Throws:
java.io.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 java.io.IOException,
                           AutomationException
Draws the contents of the viewer to a device.

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

void getSnapshot(int width,
                 int height,
                 int type,
                 java.lang.String fileName)
                 throws java.io.IOException,
                        AutomationException
Saves the content of the viewer as an image.

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

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

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

int getHWnd()
            throws java.io.IOException,
                   AutomationException
The associated window handle.

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

getHDC

int getHDC()
           throws java.io.IOException,
                  AutomationException
The associated device context.

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

setGestureSensitivity

void setGestureSensitivity(int pcPixels)
                           throws java.io.IOException,
                                  AutomationException
The gesture sensitivity as indicated by number of pixels.

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

getGestureSensitivity

int getGestureSensitivity()
                          throws java.io.IOException,
                                 AutomationException
The gesture sensitivity as indicated by number of pixels.

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

setGestureEnabled

void setGestureEnabled(boolean pbEnabled)
                       throws java.io.IOException,
                              AutomationException
Indicates if gesturing is enabled.

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

isGestureEnabled

boolean isGestureEnabled()
                         throws java.io.IOException,
                                AutomationException
Indicates if gesturing is enabled.

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

clearGesture

void clearGesture()
                  throws java.io.IOException,
                         AutomationException
Clears the last gesture.

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

overrideDefaultHandler

void overrideDefaultHandler()
                            throws java.io.IOException,
                                   AutomationException
Supersedes the default event handler.

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

setFullScreenEnabled

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

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

isFullScreenEnabled

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

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

isFullScreen

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

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

setFullScreen

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

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