com.esri.arcgis.controls
Class SceneControl

java.lang.Object
  java.awt.Component
      java.awt.Canvas
          com.esri.arcgis.interop.Ocx
              com.esri.arcgis.controls.SceneControl

All Implemented Interfaces:

ISceneControl, ISceneControlDefault, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, ImageObserver, MenuContainer, Serializable, Accessible

public class SceneControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, ISceneControlDefault, ISceneControl, ITOCBuddy, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

Esri SceneControl

Description

The SceneControl encapsulates the SceneViewer class and provides additional properties, methods and events for: managing the general appearance; loading scene documents into the control; managing the scene, scene graph and camera properties, and setting the current tool.

Remarks

There is no need to declare the SceneControl's outbound interface as described below in most development environments, because the interface is automaticlly implemented.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Canvas

Canvas.AccessibleAWTCanvas

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class com.esri.arcgis.interop.Ocx

rootParentContainers, rootWindows

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SceneControl()
Constructs a SceneControl using ArcGIS Engine.

SceneControl(Object o)
Constructs a SceneControl.

Method Summary

void	aboutBox() Displays a dialog of information about the SceneControl.
void	addISceneControlEventsListener(ISceneControlEvents theListener) addISceneControlEventsListener.
void	addITOCBuddyEventsListener(ITOCBuddyEvents theListener) addITOCBuddyEventsListener.
void	addNotify()
boolean	checkSxFile(String fileName) Checks if a filename is a scene document.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
boolean	esri_isEnabled() Indicates whether the SceneControl can respond to user generated events.
void	esri_setEnabled(boolean rhs1) Indicates whether the SceneControl can respond to user generated events.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
IActiveView	getActiveView() Returns the underlying object implementing basic map and ActiveView.
int	getAppearance() The appearance of the SceneControl.
int	getBackColor() Background color of the SceneControl.
int	getBorderStyle() The border style of the SceneControl.
ICamera	getCamera() The Camera object associated with the SceneControl.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ITool	getCurrentTool() Current active tool for the SceneControl.
Object	getCustomProperty() A property to associate data with a control.
String	getDocumentFilename() The filename of the last scene document loaded into the control.
int	getHWnd() Handle to the window associated with the SceneControl.
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the SceneControl.
Object	getObject() A property that returns the underlying control.
double	getScale(IBasicMap pBasicMap) Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.
IScene	getScene() The Scene object associated with the SceneControl.
ISceneGraph	getSceneGraph() The SceneGraph object associated with the SceneControl.
ISceneViewer	getSceneViewer() The SceneViewer associated with the SceneControl.
void	getSizeMax(_ULARGE_INTEGER[] pCbSize) getSizeMax
int	getTipDelay() The delay before scene tips are shown.
int	getTipStyle() The style of scene tips.
void	initNew() initNew
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isNavigate() Indicates if the SceneControl performs default scene navigation in response to mouse events.
boolean	isOverrideBackColor() Indicates whether to override the background color of the scene document.
boolean	isShowSceneTips() Indicates if scene tips are shown.
void	load(IStream pStm) load
void	loadSxFile(String sxPath) Loads a scene document into the SceneControl.
void	removeISceneControlEventsListener(ISceneControlEvents theListener) removeISceneControlEventsListener.
void	removeITOCBuddyEventsListener(ITOCBuddyEvents theListener) removeITOCBuddyEventsListener.
void	save(IStream pStm, int fClearDirty) save
void	setAppearance(int rhs1) The appearance of the SceneControl.
void	setBackColor(int rhs1) Background color of the SceneControl.
void	setBorderStyle(int rhs1) The border style of the SceneControl.
void	setCameraByRef(ICamera rhs1) The Camera object associated with the SceneControl.
void	setCurrentToolByRef(ITool rhs1) Current active tool for the SceneControl.
void	setCustomProperty(Object rhs1) A property to associate data with a control.
void	setDocumentFilename(String rhs1) The filename of the last scene document loaded into the control.
void	setKeyIntercept(int rhs1) A property that specifies interception of key strokes that are normally handled by the container.
void	setMouseIconByRef(Picture rhs1) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int rhs1) The mouse pointer displayed over the SceneControl.
void	setNavigate(boolean rhs1) Indicates if the SceneControl performs default scene navigation in response to mouse events.
void	setOverrideBackColor(boolean rhs1) Indicates whether to override the background color of the scene document.
void	setSceneGraphByRef(ISceneGraph rhs1) The SceneGraph object associated with the SceneControl.
void	setShowSceneTips(boolean rhs1) Indicates if scene tips are shown.
void	setTipDelay(int rhs1) The delay before scene tips are shown.
void	setTipStyle(int rhs1) The style of scene tips.

Methods inherited from class com.esri.arcgis.interop.Ocx

checkIfVisible, dispose, finalize, getCanvasWindowHandle, getControlWindowHandle, getMinimumSize, getObjRef, getPreferredSize, paint, removeNotify, setBounds, setBounds, setSize, setSize, zz_doQueuedSets, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SceneControl

public SceneControl()

Constructs a SceneControl using ArcGIS Engine.

SceneControl

public SceneControl(Object o)

Constructs a SceneControl.

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

addISceneControlEventsListener

public void addISceneControlEventsListener(ISceneControlEvents theListener)
                                    throws IOException

addISceneControlEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ISceneControlEvents interface.

Throws:

IOException - If there are communications problems.

removeISceneControlEventsListener

public void removeISceneControlEventsListener(ISceneControlEvents theListener)
                                       throws IOException

removeISceneControlEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ISceneControlEvents interface.

Throws:

IOException - If there are communications problems.

addITOCBuddyEventsListener

public void addITOCBuddyEventsListener(ITOCBuddyEvents theListener)
                                throws IOException

addITOCBuddyEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ITOCBuddyEvents interface.

Throws:

IOException - If there are communications problems.

removeITOCBuddyEventsListener

public void removeITOCBuddyEventsListener(ITOCBuddyEvents theListener)
                                   throws IOException

removeITOCBuddyEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ITOCBuddyEvents interface.

Throws:

IOException - If there are communications problems.

addNotify

public void addNotify()

Overrides:

addNotify in class com.esri.arcgis.interop.Ocx

setBackColor

public void setBackColor(int rhs1)
                  throws IOException,
                         AutomationException

Background color of the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setBackColor in interface ISceneControl

Specified by:

setBackColor in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackColor

public int getBackColor()
                 throws IOException,
                        AutomationException

Background color of the SceneControl.

Description

Returns or sets the Background Color of the SceneControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:

OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)

Where Red, Green and Blue are Long Integers within the range 0 - 255.

To ensure the BackColor property overrides any background color set in a scene document, set the OverrideBackColor to true.

Product Availability

Available with ArcGIS Engine.

Specified by:

getBackColor in interface ISceneControl

Specified by:

getBackColor in interface ISceneControlDefault

Returns:

The returnValue (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws IOException,
                           AutomationException

The border style of the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setBorderStyle in interface ISceneControl

Specified by:

setBorderStyle in interface ISceneControlDefault

Parameters:

rhs1 - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

public int getBorderStyle()
                   throws IOException,
                          AutomationException

The border style of the SceneControl.

Description

Returns or sets the border style of a SceneControl. By default a border is drawn.

Product Availability

Available with ArcGIS Engine.

Specified by:

getBorderStyle in interface ISceneControl

Specified by:

getBorderStyle in interface ISceneControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws IOException,
                            AutomationException

Indicates whether the SceneControl can respond to user generated events.

Product Availability

Available with ArcGIS Engine.

Specified by:

esri_setEnabled in interface ISceneControl

Specified by:

esri_setEnabled in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws IOException,
                              AutomationException

Indicates whether the SceneControl can respond to user generated events.

Product Availability

Available with ArcGIS Engine.

Specified by:

esri_isEnabled in interface ISceneControl

Specified by:

esri_isEnabled in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int rhs1)
                   throws IOException,
                          AutomationException

The appearance of the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setAppearance in interface ISceneControl

Specified by:

setAppearance in interface ISceneControlDefault

Parameters:

rhs1 - A com.esri.arcgis.controls.esriControlsAppearance constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAppearance

public int getAppearance()
                  throws IOException,
                         AutomationException

The appearance of the SceneControl.

Description

Returns or sets the paint style of a SceneControl to either Flat or 3D. By default the appearance is flat.

Product Availability

Available with ArcGIS Engine.

Specified by:

getAppearance in interface ISceneControl

Specified by:

getAppearance in interface ISceneControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int rhs1)
                     throws IOException,
                            AutomationException

The mouse pointer displayed over the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setMousePointer in interface ISceneControl

Specified by:

setMousePointer in interface ISceneControlDefault

Parameters:

rhs1 - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMousePointer

public int getMousePointer()
                    throws IOException,
                           AutomationException

The mouse pointer displayed over the SceneControl.

Description

Use this property when you want to indicate changes in functionality as the mouse pointer passes over the SceneControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.

Product Availability

Available with ArcGIS Engine.

Specified by:

getMousePointer in interface ISceneControl

Specified by:

getMousePointer in interface ISceneControlDefault

Returns:

A com.esri.arcgis.controls.esriControlsMousePointer constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture rhs1)
                       throws IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Product Availability

Available with ArcGIS Engine.

Specified by:

setMouseIconByRef in interface ISceneControl

Specified by:

setMouseIconByRef in interface ISceneControlDefault

Parameters:

rhs1 - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

Description

The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).

Remarks

In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.

To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment.

Product Availability

Available with ArcGIS Engine.

Specified by:

getMouseIcon in interface ISceneControl

Specified by:

getMouseIcon in interface ISceneControlDefault

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

Handle to the window associated with the SceneControl.

Description

The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.

Product Availability

Available with ArcGIS Engine.

Specified by:

getHWnd in interface ISceneControl

Specified by:

getHWnd in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

aboutBox

public void aboutBox()
              throws IOException,
                     AutomationException

Displays a dialog of information about the SceneControl.

Description

The AboutBox method causes a modal dialog box to display on top of the SceneControl, containing information about the version and creation date of the SceneControl as well as listing relevant legal and copyright information from ESRI.

Product Availability

Available with ArcGIS Engine.

Specified by:

aboutBox in interface ISceneControl

Specified by:

aboutBox in interface ISceneControlDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadSxFile

public void loadSxFile(String sxPath)
                throws IOException,
                       AutomationException

Loads a scene document into the SceneControl.

Description

Loads a Scene document (*.sxd) into the SceneControl. Use the CheckSxFile method to determine if the specified scene document is a valid scene document.

Product Availability

Available with ArcGIS Engine.

Specified by:

loadSxFile in interface ISceneControl

Specified by:

loadSxFile in interface ISceneControlDefault

Parameters:

sxPath - The sxPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScene

public IScene getScene()
                throws IOException,
                       AutomationException

The Scene object associated with the SceneControl.

Description

This is a shortcut to the ISceneGraph::Scene property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getScene in interface ISceneControl

Specified by:

getScene in interface ISceneControlDefault

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.

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws IOException,
                                 AutomationException

The SceneGraph object associated with the SceneControl.

Description

This is a shortcut to the ISceneViewer::SceneGraph property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getSceneGraph in interface ISceneControl

Specified by:

getSceneGraph in interface ISceneControlDefault

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

public void setSceneGraphByRef(ISceneGraph rhs1)
                        throws IOException,
                               AutomationException

The SceneGraph object associated with the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setSceneGraphByRef in interface ISceneControl

Specified by:

setSceneGraphByRef in interface ISceneControlDefault

Parameters:

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

getSceneViewer

public ISceneViewer getSceneViewer()
                            throws IOException,
                                   AutomationException

The SceneViewer associated with the SceneControl.

Description

This is the SceneViewer contained within the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

getSceneViewer in interface ISceneControl

Specified by:

getSceneViewer in interface ISceneControlDefault

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.

getCamera

public ICamera getCamera()
                  throws IOException,
                         AutomationException

The Camera object associated with the SceneControl.

Description

This is a shortcut to the ISceneViewer::Camera property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCamera in interface ISceneControl

Specified by:

getCamera in interface ISceneControlDefault

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

public void setCameraByRef(ICamera rhs1)
                    throws IOException,
                           AutomationException

The Camera object associated with the SceneControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setCameraByRef in interface ISceneControl

Specified by:

setCameraByRef in interface ISceneControlDefault

Parameters:

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

getCurrentTool

public ITool getCurrentTool()
                     throws IOException,
                            AutomationException

Current active tool for the SceneControl. Set to nothing to clear the tool.

Description

The CurrentTool is the tool used to interact will the SceneControl's display. Always check if a tool is enabled before setting it to the CurrentTool property, otherwise a user will be able to use a tool that is actually disabled.

Remarks

When the CurrentTool is set the following events occur:

1. The ITool::Deactivate event is triggered on the 'old' CurrentTool if one was set. If this event returns false a trappable error ocurrs. If this event returns true the 'old' CurrentTool is removed and replaced.
2. The ICommand::OnClick event is triggered on the 'new' CurrentTool and its cursor is picked up.

Within an ITool implementation it is recommended that the ITool::Deactivate event returns true. This allows a 'new' CurrentTool to be set, and allows the release of the CurrentTool when an application is shutting down.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCurrentTool in interface ISceneControl

Specified by:

getCurrentTool in interface ISceneControlDefault

Specified by:

getCurrentTool in interface IToolbarBuddy

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ITool rhs1)
                         throws IOException,
                                AutomationException

Current active tool for the SceneControl. Set to nothing to clear the tool.

Product Availability

Available with ArcGIS Engine.

Specified by:

setCurrentToolByRef in interface ISceneControl

Specified by:

setCurrentToolByRef in interface ISceneControlDefault

Specified by:

setCurrentToolByRef in interface IToolbarBuddy

Parameters:

rhs1 - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNavigate

public boolean isNavigate()
                   throws IOException,
                          AutomationException

Indicates if the SceneControl performs default scene navigation in response to mouse events.

Description

The Navigate property determines whether the default SceneControl navigation functionality is enabled at run time. By default the Navigate property is set to false. When the Navigate property is set to true, the end user can use the left mouse button to navigate backwards and forwards and to the left and right of the display, and the right mouse button to zoom in and out on the display.

Remarks

When the Navigate property is set to true, the OnMouseDown, OnMouseMove, OnMouseUp events are being intercepted. As such, care must be taken by developers to avoid the display becoming confused when:

• The OnMouseDown, OnMouseMove, OnMouseUp events contain code that interacts with the Camera.
• The SceneControl is being used in conjunction with the ToolbarControl with Control Commands or custom commands hosted on it. When a command hosted on the ToolbarControl is selected by the end user to become the CurrentTool, both the Navigate functionality and the CurrentTool are catching the OnMouseDown, OnMouseMove, OnMouseUp events.

Product Availability

Available with ArcGIS Engine.

Specified by:

isNavigate in interface ISceneControl

Specified by:

isNavigate in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNavigate

public void setNavigate(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates if the SceneControl performs default scene navigation in response to mouse events.

Product Availability

Available with ArcGIS Engine.

Specified by:

setNavigate in interface ISceneControl

Specified by:

setNavigate in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkSxFile

public boolean checkSxFile(String fileName)
                    throws IOException,
                           AutomationException

Checks if a filename is a scene document.

Description

Determines whether the specified Scene Document (*.sxd) is a valid scene document and can be loaded into the SceneControl. The method verifies the file exists and verifies the file internals conform to an expected storage format. The method does not read and validate the entire contents of the file; use the LoadSxFile to do this.

Product Availability

Available with ArcGIS Engine.

Specified by:

checkSxFile in interface ISceneControl

Specified by:

checkSxFile in interface ISceneControlDefault

Parameters:

fileName - The fileName (in)

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with a control.

Description

Use the CustomProperty to associate any useful data with the SceneControl. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCustomProperty in interface ISceneControl

Specified by:

getCustomProperty in interface ISceneControlDefault

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object rhs1)
                       throws IOException,
                              AutomationException

A property to associate data with a control.

Product Availability

Available with ArcGIS Engine.

Specified by:

setCustomProperty in interface ISceneControl

Specified by:

setCustomProperty in interface ISceneControlDefault

Parameters:

rhs1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(String rhs1)
                         throws IOException,
                                AutomationException

The filename of the last scene document loaded into the control.

Product Availability

Available with ArcGIS Engine.

Specified by:

setDocumentFilename in interface ISceneControl

Specified by:

setDocumentFilename in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public String getDocumentFilename()
                           throws IOException,
                                  AutomationException

The filename of the last scene document loaded into the control.

Description

Returns the DocumentFilename of the last document loaded into the SceneControl with the LoadSxFile method. An empty string will be returned if no document is loaded.

Product Availability

Available with ArcGIS Engine.

Specified by:

getDocumentFilename in interface ISceneControl

Specified by:

getDocumentFilename in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException

A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Description

In some development environments it is not possible to query interface directly on the control to other COM interfaces, beacuse the control is contained within a wrapper object. To get the real control use the Object property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getObject in interface ISceneControl

Specified by:

getObject in interface ISceneControlDefault

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverrideBackColor

public void setOverrideBackColor(boolean rhs1)
                          throws IOException,
                                 AutomationException

Indicates whether to override the background color of the scene document.

Product Availability

Available with ArcGIS Engine.

Specified by:

setOverrideBackColor in interface ISceneControl

Specified by:

setOverrideBackColor in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverrideBackColor

public boolean isOverrideBackColor()
                            throws IOException,
                                   AutomationException

Indicates whether to override the background color of the scene document.

Description

The OverrideBackColor property determines whether the background color of any document loaded into the SceneControl is overriden and replaced with the SceneControl's BackColor. By default this property is false.

Product Availability

Available with ArcGIS Engine.

Specified by:

isOverrideBackColor in interface ISceneControl

Specified by:

isOverrideBackColor in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowSceneTips

public void setShowSceneTips(boolean rhs1)
                      throws IOException,
                             AutomationException

Indicates if scene tips are shown.

Product Availability

Available with ArcGIS Engine.

Specified by:

setShowSceneTips in interface ISceneControl

Specified by:

setShowSceneTips in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowSceneTips

public boolean isShowSceneTips()
                        throws IOException,
                               AutomationException

Indicates if scene tips are shown.

Description

Determines whether scene tips are displayed (if they exist) as the mouse moves over layer features. By default the ShowSceneTips property is set to false.

Product Availability

Available with ArcGIS Engine.

Specified by:

isShowSceneTips in interface ISceneControl

Specified by:

isShowSceneTips in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTipStyle

public void setTipStyle(int rhs1)
                 throws IOException,
                        AutomationException

The style of scene tips.

Product Availability

Available with ArcGIS Engine.

Specified by:

setTipStyle in interface ISceneControl

Specified by:

setTipStyle in interface ISceneControlDefault

Parameters:

rhs1 - A com.esri.arcgis.systemUI.esriTipStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipStyle

public int getTipStyle()
                throws IOException,
                       AutomationException

The style of scene tips.

Description

Returns or sets the TipStyle used by the scene tips when ShowSceneTips is set to true to either solid or transparent. By default the TipStyle is solid.

Product Availability

Available with ArcGIS Engine.

Specified by:

getTipStyle in interface ISceneControl

Specified by:

getTipStyle in interface ISceneControlDefault

Returns:

A com.esri.arcgis.systemUI.esriTipStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTipDelay

public void setTipDelay(int rhs1)
                 throws IOException,
                        AutomationException

The delay before scene tips are shown.

Product Availability

Available with ArcGIS Engine.

Specified by:

setTipDelay in interface ISceneControl

Specified by:

setTipDelay in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipDelay

public int getTipDelay()
                throws IOException,
                       AutomationException

The delay before scene tips are shown.

Description

Returns or sets the time delay in milliseconds before scene tips are displayed. By default TipDelay is 500 milliseconds.

Product Availability

Available with ArcGIS Engine.

Specified by:

getTipDelay in interface ISceneControl

Specified by:

getTipDelay in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws IOException,
                           AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Description

Returns or sets keys on the keyboard that will be intercepted by the SceneControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the SceneControl by the development environment container. By default the KeyIntercept is set to esriKeyInterceptNone.

Many development environment containers use the up, down, left and right arrow keys to change control focus on a form. These keys can also be useful for navigating around the display. To intercept the arrow keys and the Tab key combine the enum values using a logical OR operation (esriKeyInterceptArrowKeys OR esriKeyInterceptTabKey, which is 1 OR 4 = 5).

Product Availability

Available with ArcGIS Engine.

Specified by:

getKeyIntercept in interface ISceneControl

Specified by:

getKeyIntercept in interface ISceneControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int rhs1)
                     throws IOException,
                            AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Product Availability

Available with ArcGIS Engine.

Specified by:

setKeyIntercept in interface ISceneControl

Specified by:

setKeyIntercept in interface ISceneControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

Returns the underlying object implementing basic map and ActiveView. This is used to populate the TOC.

Description

The GetActiveView method returns the IActiveView interface of the ITOCControl::Buddy. This will either be a Map, PageLayout, Scene or Globe.

Product Availability

Available with ArcGIS Engine.

Specified by:

getActiveView in interface ITOCBuddy

Returns:

A reference to a com.esri.arcgis.carto.IActiveView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

public double getScale(IBasicMap pBasicMap)
                throws IOException,
                       AutomationException

Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Description

The GetScale method returns scale of the supplied Map or Scene. If the scale is unknown the GetScale method returns 0.0.

Product Availability

Available with ArcGIS Engine.

Specified by:

getScale in interface ITOCBuddy

Parameters:

pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Returns:

The dScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStreamInit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pStm)
          throws IOException,
                 AutomationException

load

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStreamInit

Parameters:

pStm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pStm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStreamInit

Parameters:

pStm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pCbSize)
                throws IOException,
                       AutomationException

getSizeMax

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStreamInit

Parameters:

pCbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initNew

public void initNew()
             throws IOException,
                    AutomationException

initNew

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

initNew in interface IPersistStreamInit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.