com.esri.arcgis.analyst3d
Interface IViewers3D

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGlobeDisplay, IGlobeDisplay2, IGlobeDisplay3

All Known Implementing Classes:

GlobeDisplay, SceneGraph

public interface IViewers3D
extends Serializable

Provides access to members that control 3D displays.

Product Availability

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

Method Summary

ISceneViewer	findViewer(String caption) Finds the Viewer.
ISceneViewer	getActiveViewer() The active viewer.
IArray	getAllViewers() Returns all registered Viewers.
void	getBackgroundColor(float[] pRed, float[] pGreen, float[] pBlue) Returns the background color.
IScene	getScene() The scene.
boolean	isGestureEnabled() Indicates if the mouse gestures are supported.
boolean	isNavigating() Indicates if the 3D Display is in navigation mode.
void	refreshViewers() Redraws all viewers.
void	registerViewer(ISceneViewer pViewer) Adds a viewer to the 3D Display.
void	replayFrame(ICamera camera) Uses the camera to redraw a frame.
void	setActiveViewerByRef(ISceneViewer ppViewer) The active viewer.
void	setBackgroundColor(float red, float green, float blue) Sets the background color.
void	setGestureEnabled(boolean pbEnabled) Indicates if the mouse gestures are supported.
void	setIsNavigating(boolean pbIsNavigating) Indicates if the 3D Display is in navigation mode.
void	setSceneByRef(IScene pVal) The scene.
void	unregisterViewer(ISceneViewer pViewer) Removes a viewer from the 3D Display.

Method Detail

getScene

IScene getScene()
                throws IOException,
                       AutomationException

The scene.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSceneByRef

void setSceneByRef(IScene pVal)
                   throws IOException,
                          AutomationException

The scene.

Product Availability

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

Parameters:

pVal - A reference to a com.esri.arcgis.analyst3d.IScene (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

registerViewer

void registerViewer(ISceneViewer pViewer)
                    throws IOException,
                           AutomationException

Adds a viewer to the 3D Display.

Product Availability

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

Parameters:

pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unregisterViewer

void unregisterViewer(ISceneViewer pViewer)
                      throws IOException,
                             AutomationException

Removes a viewer from the 3D Display.

Product Availability

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

Parameters:

pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViewer

ISceneViewer findViewer(String caption)
                        throws IOException,
                               AutomationException

Finds the Viewer.

Product Availability

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

Parameters:

caption - The caption (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllViewers

IArray getAllViewers()
                     throws IOException,
                            AutomationException

Returns all registered Viewers.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveViewerByRef

void setActiveViewerByRef(ISceneViewer ppViewer)
                          throws IOException,
                                 AutomationException

The active viewer.

Product Availability

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

Parameters:

ppViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveViewer

ISceneViewer getActiveViewer()
                             throws IOException,
                                    AutomationException

The active viewer.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshViewers

void refreshViewers()
                    throws IOException,
                           AutomationException

Redraws all viewers.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNavigating

boolean isNavigating()
                     throws IOException,
                            AutomationException

Indicates if the 3D Display is in navigation mode.

Product Availability

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

Returns:

The pbIsNavigating

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsNavigating

void setIsNavigating(boolean pbIsNavigating)
                     throws IOException,
                            AutomationException

Indicates if the 3D Display is in navigation mode.

Product Availability

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

Parameters:

pbIsNavigating - The pbIsNavigating (in)

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 the mouse gestures are supported.

Product Availability

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

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 the mouse gestures are supported.

Product Availability

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

Returns:

The pbEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

void setBackgroundColor(float red,
                        float green,
                        float blue)
                        throws IOException,
                               AutomationException

Sets the background color.

Product Availability

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

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

void getBackgroundColor(float[] pRed,
                        float[] pGreen,
                        float[] pBlue)
                        throws IOException,
                               AutomationException

Returns the background color.

Product Availability

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

Parameters:

pRed - The pRed (out: use single element array)

pGreen - The pGreen (out: use single element array)

pBlue - The pBlue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replayFrame

void replayFrame(ICamera camera)
                 throws IOException,
                        AutomationException

Uses the camera to redraw a frame.

Product Availability

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

Parameters:

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