com.esri.arcgis.controls
Interface IGlobeHookHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeHookHelper

public interface IGlobeHookHelper
extends Serializable

Provides access to members needed when developing commands to work with the GlobeControl, ArcGlobe, and custom controls and applications.

Description

Use the IGlobeHookHelper interface to return the Globe, GlobeDisplay, SceneViewer and Camera of the hook passed to the ICommand::OnCreate event regardless of whether the hook is a GlobeControl, ToolbarControl (with a 'buddy' GlobeControl) or ArcGlobe.

Product Availability

Available with ArcGIS Engine.

Method Summary

ISceneViewer	getActiveViewer() Active scene viewer of hooked control or application.
ICamera	getCamera() Camera of hooked control or application.
IGlobe	getGlobe() Globe of hooked control or application.
IGlobeDisplay	getGlobeDisplay() GlobeDisplay of hooked control or application.
Object	getHook() Hook object that should be the same as the hook object passed in ICommand::OnCreate.
void	setHookByRef(Object ppHook) Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Method Detail

setHookByRef

void setHookByRef(Object ppHook)
                  throws IOException,
                         AutomationException

Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Product Availability

Available with ArcGIS Engine.

Parameters:

ppHook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHook

Object getHook()
               throws IOException,
                      AutomationException

Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Description

The hook that is passed to the ICommand::OnCreate event. The hook is a GlobeControl or ArcGlobe.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobe

IGlobe getGlobe()
                throws IOException,
                       AutomationException

Globe of hooked control or application.

Description

The IGlobe object of the hook passed to the ICommand::OnCreate event. The Globe is returned regardless of whether the hook is a GlobeControl, ToolbarControl (with a 'buddy' GlobeControl) or ArcGlobe.

Remarks

This property can return Nothing if the GlobeControl has not been initialized to share a GlobeDisplay with another GlobeControl.

Product Availability

Available with ArcGIS Engine.

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

IGlobeDisplay getGlobeDisplay()
                              throws IOException,
                                     AutomationException

GlobeDisplay of hooked control or application.

Description

The IGlobeDisplay object of the hook passed to the ICommand::OnCreate event. The GlobeDisplay is returned regardless of whether the hook is a GlobeControl, ToolbarControl (with a 'buddy' GlobeControl) or ArcGlobe.

Remarks

This property can return Nothing if the GlobeControl has not been initialized to share a GlobeDisplay with another GlobeControl.

Product Availability

Available with ArcGIS Engine.

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.

getActiveViewer

ISceneViewer getActiveViewer()
                             throws IOException,
                                    AutomationException

Active scene viewer of hooked control or application.

Description

The ISceneViewer interface of the IGlobeViewer object of the hook passed to the ICommand::OnCreate event. The SceneViewer is returned regardless of whether the hook is a GlobeControl, ToolbarControl (with a 'buddy' GlobeControl) or ArcGlobe.

Product Availability

Available with ArcGIS Engine.

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

ICamera getCamera()
                  throws IOException,
                         AutomationException

Camera of hooked control or application.

Description

The ICamera object of the hook passed to the ICommand::OnCreate event. The Camera is returned regardless of whether the hook is a GlobeControl, ToolbarControl (with a 'buddy' GlobeControl) or ArcGlobe.

Product Availability

Available with ArcGIS Engine.

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.