com.esri.arcgis.controls
Class GlobeControl

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

All Implemented Interfaces:

IGlobeControl, IGlobeControlDefault, ITOCBuddy, ITOCBuddy2, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, ImageObserver, MenuContainer, Serializable, Accessible

public class GlobeControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeControlDefault, IGlobeControl, ITOCBuddy, ITOCBuddy2, IToolbarBuddy, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

Esri GlobeControl

Description

The GlobeControl encapsulates the GlobeViewer class and provides additional properties, methods and events for: managing the general appearance; loading globe documents into the control; managing the globe, globe display and globe camera properties, and setting the current tool.

Remarks

There is no need to declare the GlobeControl'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

GlobeControl()
Constructs a GlobeControl using ArcGIS Engine.

GlobeControl(Object o)
Constructs a GlobeControl.

Method Summary

void	aboutBox() Displays a dialog of information about the GlobeControl.
void	addIGlobeControlEventsListener(IGlobeControlEvents theListener) addIGlobeControlEventsListener.
void	addITOCBuddyEventsListener(ITOCBuddyEvents theListener) addITOCBuddyEventsListener.
void	addNotify()
boolean	check3dFile(String fileName) Checks if a filename is a Globe document.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
boolean	esri_isEnabled() Indicates whether the GlobeControl can respond to user generated events.
void	esri_setEnabled(boolean rhs1) Indicates whether the GlobeControl 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 GlobeControl.
int	getBackColor() Background color of the GlobeControl.
int	getBorderStyle() The border style of the GlobeControl.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ITool	getCurrentTool() Current active tool for the GlobeControl.
Object	getCustomProperty() A property to associate data with a control.
String	getDocumentFilename() The filename of the last globe document loaded into the control.
IGlobe	getGlobe() The Globe object associated with the GlobeControl.
IGlobeCamera	getGlobeCamera() The GlobeCamera object associated with the GlobeControl.
IGlobeDisplay	getGlobeDisplay() The GlobeDisplay object associated with the GlobeControl.
IGlobeViewer	getGlobeViewer() The GlobeViewer associated with the GlobeControl.
int	getHWnd() Handle to the window associated with the GlobeControl.
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 GlobeControl.
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.
int	getShowGlobeTips() Indicates the type of globe tips that are shown.
void	getSizeMax(_ULARGE_INTEGER[] pCbSize) getSizeMax
int	getTipDelay() The delay before globe tips are shown.
int	getTipStyle() The style of globe tips.
void	initNew() initNew
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isLayerValid(ILayer pLayer) The TOCControl calls this method to ask the buddy if a layer is fully cached and valid if it cannot determine this on its own.
boolean	isLayerVisibleAtScale(ILayer pLayer, double scale) The TOCControl calls this method to ask the buddy if a layer is visible at the specified scale.
boolean	isNavigate() Indicates if the GlobeControl performs default scene navigation in response to mouse events.
boolean	isOverrideBackColor() Indicates whether to override the background color of the globe document.
void	layerVisibilityChanged(IBasicMap pBasicMap, ILayer pLayer, boolean visibility) The TOCControl calls this method to instruct the buddy that layer visibility has changed.
void	load(IStream pStm) load
void	load3dFile(String fileName) Loads a Globe document into the GlobeControl.
void	removeIGlobeControlEventsListener(IGlobeControlEvents theListener) removeIGlobeControlEventsListener.
void	removeITOCBuddyEventsListener(ITOCBuddyEvents theListener) removeITOCBuddyEventsListener.
void	save(IStream pStm, int fClearDirty) save
void	setAppearance(int rhs1) The appearance of the GlobeControl.
void	setBackColor(int rhs1) Background color of the GlobeControl.
void	setBorderStyle(int rhs1) The border style of the GlobeControl.
void	setCurrentToolByRef(ITool rhs1) Current active tool for the GlobeControl.
void	setCustomProperty(Object rhs1) A property to associate data with a control.
void	setDocumentFilename(String rhs1) The filename of the last globe document loaded into the control.
void	setGlobeCameraByRef(IGlobeCamera rhs1) The GlobeCamera object associated with the GlobeControl.
void	setGlobeDisplayByRef(IGlobeDisplay rhs1) The GlobeDisplay object associated with the GlobeControl.
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 GlobeControl.
void	setNavigate(boolean rhs1) Indicates if the GlobeControl performs default scene navigation in response to mouse events.
void	setOverrideBackColor(boolean rhs1) Indicates whether to override the background color of the globe document.
void	setShowGlobeTips(int rhs1) Indicates the type of globe tips that are shown.
void	setTipDelay(int rhs1) The delay before globe tips are shown.
void	setTipStyle(int rhs1) The style of globe 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

GlobeControl

public GlobeControl()

Constructs a GlobeControl using ArcGIS Engine.

GlobeControl

public GlobeControl(Object o)

Constructs a GlobeControl.

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

addIGlobeControlEventsListener

public void addIGlobeControlEventsListener(IGlobeControlEvents theListener)
                                    throws IOException

addIGlobeControlEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

IOException - If there are communications problems.

removeIGlobeControlEventsListener

public void removeIGlobeControlEventsListener(IGlobeControlEvents theListener)
                                       throws IOException

removeIGlobeControlEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.IGlobeControlEvents 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 GlobeControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setBackColor in interface IGlobeControl

Specified by:

setBackColor in interface IGlobeControlDefault

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

Description

Returns or sets the Background Color of the GlobeControl. 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 globe document, set the OverrideBackColor to true.

Product Availability

Available with ArcGIS Engine.

Specified by:

getBackColor in interface IGlobeControl

Specified by:

getBackColor in interface IGlobeControlDefault

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

Product Availability

Available with ArcGIS Engine.

Specified by:

setBorderStyle in interface IGlobeControl

Specified by:

setBorderStyle in interface IGlobeControlDefault

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

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

getBorderStyle in interface IGlobeControl

Specified by:

getBorderStyle in interface IGlobeControlDefault

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 GlobeControl can respond to user generated events.

Product Availability

Available with ArcGIS Engine.

Specified by:

esri_setEnabled in interface IGlobeControl

Specified by:

esri_setEnabled in interface IGlobeControlDefault

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 GlobeControl can respond to user generated events.

Product Availability

Available with ArcGIS Engine.

Specified by:

esri_isEnabled in interface IGlobeControl

Specified by:

esri_isEnabled in interface IGlobeControlDefault

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

Product Availability

Available with ArcGIS Engine.

Specified by:

setAppearance in interface IGlobeControl

Specified by:

setAppearance in interface IGlobeControlDefault

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

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

getAppearance in interface IGlobeControl

Specified by:

getAppearance in interface IGlobeControlDefault

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

Product Availability

Available with ArcGIS Engine.

Specified by:

setMousePointer in interface IGlobeControl

Specified by:

setMousePointer in interface IGlobeControlDefault

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

Description

Use this property when you want to indicate changes in functionality as the mouse pointer passes over the GlobeControl. 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 IGlobeControl

Specified by:

getMousePointer in interface IGlobeControlDefault

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 IGlobeControl

Specified by:

setMouseIconByRef in interface IGlobeControlDefault

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 IGlobeControl

Specified by:

getMouseIcon in interface IGlobeControlDefault

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

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 IGlobeControl

Specified by:

getHWnd in interface IGlobeControlDefault

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

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

aboutBox in interface IGlobeControl

Specified by:

aboutBox in interface IGlobeControlDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load3dFile

public void load3dFile(String fileName)
                throws IOException,
                       AutomationException

Loads a Globe document into the GlobeControl.

Description

Loads a globe document (*.3dd) into the GlobeControl. Use the Check3dFile method to determine if the specified globe document is a valid globe document.

Product Availability

Available with ArcGIS Engine.

Specified by:

load3dFile in interface IGlobeControl

Specified by:

load3dFile in interface IGlobeControlDefault

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobe

public IGlobe getGlobe()
                throws IOException,
                       AutomationException

The Globe object associated with the GlobeControl.

Description

This is a shortcut to the IGlobeDisplay::Globe property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getGlobe in interface IGlobeControl

Specified by:

getGlobe in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws IOException,
                                     AutomationException

The GlobeDisplay object associated with the GlobeControl.

Description

This is a shortcut to the IGlobeViewer::GlobeDisplay property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getGlobeDisplay in interface IGlobeControl

Specified by:

getGlobeDisplay in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeDisplay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeDisplayByRef

public void setGlobeDisplayByRef(IGlobeDisplay rhs1)
                          throws IOException,
                                 AutomationException

The GlobeDisplay object associated with the GlobeControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setGlobeDisplayByRef in interface IGlobeControl

Specified by:

setGlobeDisplayByRef in interface IGlobeControlDefault

Parameters:

rhs1 - A reference to a com.esri.arcgis.globecore.IGlobeDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeViewer

public IGlobeViewer getGlobeViewer()
                            throws IOException,
                                   AutomationException

The GlobeViewer associated with the GlobeControl.

Description

This is the GlobeViewer contained within the GlobeControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

getGlobeViewer in interface IGlobeControl

Specified by:

getGlobeViewer in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeViewer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeCamera

public IGlobeCamera getGlobeCamera()
                            throws IOException,
                                   AutomationException

The GlobeCamera object associated with the GlobeControl.

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

getGlobeCamera in interface IGlobeControl

Specified by:

getGlobeCamera in interface IGlobeControlDefault

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeCamera

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeCameraByRef

public void setGlobeCameraByRef(IGlobeCamera rhs1)
                         throws IOException,
                                AutomationException

The GlobeCamera object associated with the GlobeControl.

Product Availability

Available with ArcGIS Engine.

Specified by:

setGlobeCameraByRef in interface IGlobeControl

Specified by:

setGlobeCameraByRef in interface IGlobeControlDefault

Parameters:

rhs1 - A reference to a com.esri.arcgis.globecore.IGlobeCamera (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 GlobeControl. Set to nothing to clear the tool.

Description

The CurrentTool is the tool used to interact will the GlobeControl'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 IGlobeControl

Specified by:

getCurrentTool in interface IGlobeControlDefault

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 GlobeControl. Set to nothing to clear the tool.

Product Availability

Available with ArcGIS Engine.

Specified by:

setCurrentToolByRef in interface IGlobeControl

Specified by:

setCurrentToolByRef in interface IGlobeControlDefault

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 GlobeControl performs default scene navigation in response to mouse events.

Description

The Navigate property determines whether the default GlobeControl 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 GlobeCamera.
• The GlobeControl 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 IGlobeControl

Specified by:

isNavigate in interface IGlobeControlDefault

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 GlobeControl performs default scene navigation in response to mouse events.

Product Availability

Available with ArcGIS Engine.

Specified by:

setNavigate in interface IGlobeControl

Specified by:

setNavigate in interface IGlobeControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

check3dFile

public boolean check3dFile(String fileName)
                    throws IOException,
                           AutomationException

Checks if a filename is a Globe document.

Description

Determines whether the specified Globe Document (*.3dd) is a valid globe document and can be loaded into the GlobeControl. 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 Load3dFile to do this.

Product Availability

Available with ArcGIS Engine.

Specified by:

check3dFile in interface IGlobeControl

Specified by:

check3dFile in interface IGlobeControlDefault

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

Specified by:

getCustomProperty in interface IGlobeControlDefault

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 IGlobeControl

Specified by:

setCustomProperty in interface IGlobeControlDefault

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 globe document loaded into the control.

Product Availability

Available with ArcGIS Engine.

Specified by:

setDocumentFilename in interface IGlobeControl

Specified by:

setDocumentFilename in interface IGlobeControlDefault

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 globe document loaded into the control.

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

getDocumentFilename in interface IGlobeControl

Specified by:

getDocumentFilename in interface IGlobeControlDefault

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 IGlobeControl

Specified by:

getObject in interface IGlobeControlDefault

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

Product Availability

Available with ArcGIS Engine.

Specified by:

setOverrideBackColor in interface IGlobeControl

Specified by:

setOverrideBackColor in interface IGlobeControlDefault

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

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

isOverrideBackColor in interface IGlobeControl

Specified by:

isOverrideBackColor in interface IGlobeControlDefault

Returns:

The returnValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowGlobeTips

public void setShowGlobeTips(int rhs1)
                      throws IOException,
                             AutomationException

Indicates the type of globe tips that are shown.

Product Availability

Available with ArcGIS Engine.

Specified by:

setShowGlobeTips in interface IGlobeControl

Specified by:

setShowGlobeTips in interface IGlobeControlDefault

Parameters:

rhs1 - A com.esri.arcgis.globecore.esriGlobeTipsType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShowGlobeTips

public int getShowGlobeTips()
                     throws IOException,
                            AutomationException

Indicates the type of globe tips that are shown.

Description

The type of globe tips that are displayed as the mouse moves over the globe. The globe tip can display decimal degree coordinates or elevation or a combination of both. By default the ShowGlobeTips property is set to esriGlobeTipsNone.

Product Availability

Available with ArcGIS Engine.

Specified by:

getShowGlobeTips in interface IGlobeControl

Specified by:

getShowGlobeTips in interface IGlobeControlDefault

Returns:

A com.esri.arcgis.globecore.esriGlobeTipsType constant

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

Product Availability

Available with ArcGIS Engine.

Specified by:

setTipStyle in interface IGlobeControl

Specified by:

setTipStyle in interface IGlobeControlDefault

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

Description

Returns or sets the TipStyle used by the globe tips. By default the TipStyle is solid.

Product Availability

Available with ArcGIS Engine.

Specified by:

getTipStyle in interface IGlobeControl

Specified by:

getTipStyle in interface IGlobeControlDefault

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 globe tips are shown.

Product Availability

Available with ArcGIS Engine.

Specified by:

setTipDelay in interface IGlobeControl

Specified by:

setTipDelay in interface IGlobeControlDefault

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 globe tips are shown.

Description

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

Product Availability

Available with ArcGIS Engine.

Specified by:

getTipDelay in interface IGlobeControl

Specified by:

getTipDelay in interface IGlobeControlDefault

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 GlobeControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the GlobeControl 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 IGlobeControl

Specified by:

getKeyIntercept in interface IGlobeControlDefault

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 IGlobeControl

Specified by:

setKeyIntercept in interface IGlobeControlDefault

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.

layerVisibilityChanged

public void layerVisibilityChanged(IBasicMap pBasicMap,
                                   ILayer pLayer,
                                   boolean visibility)
                            throws IOException,
                                   AutomationException

The TOCControl calls this method to instruct the buddy that layer visibility has changed.

Description

The LayerVisibilityChanged method is called when the visibility of a layer is changed interactively using the TOCControl.

If a layer (typically a raster layer) within a Globe is fully cached the original data source does not need to be present in order for the layer to display. To ensure that the TOCControl changes the visibility of a cached layer the LayerVisibilityChanged method ensures the Globe changes the GlobeLayerProperties.

Product Availability

Available with ArcGIS Engine.

Specified by:

layerVisibilityChanged in interface ITOCBuddy2

Parameters:

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

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

visibility - The visibility (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLayerValid

public boolean isLayerValid(ILayer pLayer)
                     throws IOException,
                            AutomationException

The TOCControl calls this method to ask the buddy if a layer is fully cached and valid if it cannot determine this on its own.

Description

The IsLayerValid method returns whether the specified layer is fullly cached and so valid, even if the connection to the layers data source is broken.

If a layer (typically a raster layer) within a GlobeControl is fully cached the original data source does not need to be present in order for the layer to display. To ensure that the TOCControl does not display this layer as broken (with a red exclamation symbol !), the IsLayerValid method additionally checks if layer is fully cached.

Product Availability

Available with ArcGIS Engine.

Specified by:

isLayerValid in interface ITOCBuddy2

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLayerVisibleAtScale

public boolean isLayerVisibleAtScale(ILayer pLayer,
                                     double scale)
                              throws IOException,
                                     AutomationException

The TOCControl calls this method to ask the buddy if a layer is visible at the specified scale.

Description

The IsLayerVisibleAtScale method, called by the TOCControl, returns whether the specified layer is visible at the specified scale.

A layer in a globe has IGlobeLayerProperties::MinimumDistance and IGlobeLayerProperties::MaximumDistance properties. The IsLayerVisibleAtScale method allows the GlobeControl to override the ILayer::MinimumScale and ILayer::MaximumScale properties with the MinimumDistance and MaximumDistance properties to correctly manage the visibility of the layer.

Product Availability

Available with ArcGIS Engine.

Specified by:

isLayerVisibleAtScale in interface ITOCBuddy2

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

scale - The scale (in)

Returns:

The visibility

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.