com.esri.arcgis.controls
Interface ISceneHookHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

SceneHookHelper

public interface ISceneHookHelper
extends Serializable

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

Description

Use the ISceneHookHelper interface to return the Scene, SceneGraph, SceneViewer and Camera of the hook passed to the ICommand::OnCreate event regardless of whether the hook is a SceneControl, ToolbarControl (with a 'buddy' SceneControl) or ArcScene.

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.
Object	getHook() Hook object that should be the same as the hook object passed in ICommand::OnCreate.
IScene	getScene() Scene of hooked control or application.
ISceneGraph	getSceneGraph() SceneGraph of hooked control or application.
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 SceneControl, ToolbarControl or ArcScene.

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.

getScene

IScene getScene()
                throws IOException,
                       AutomationException

Scene of hooked control or application.

Description

The IScene object of the hook passed to the ICommand::OnCreate event. The Scene is returned regardless of whether the hook is a SceneControl, ToolbarControl (with a 'buddy' SceneControl) or ArcScene.

Product Availability

Available with ArcGIS Engine.

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

ISceneGraph getSceneGraph()
                          throws IOException,
                                 AutomationException

SceneGraph of hooked control or application.

Description

The ISceneGraph object of the hook passed to the ICommand::OnCreate event. The SceneGraph is returned regardless of whether the hook is a SceneControl, ToolbarControl (with a 'buddy' SceneControl) or ArcScene.

Product Availability

Available with ArcGIS Engine.

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.

getActiveViewer

ISceneViewer getActiveViewer()
                             throws IOException,
                                    AutomationException

Active scene viewer of hooked control or application.

Description

The ISceneViewer object of the hook passed to the ICommand::OnCreate event. The ActiveViewer is returned regardless of whether the hook is a SceneControl, ToolbarControl (with a 'buddy' SceneControl) or ArcScene.

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 ActiveViewer is returned regardless of whether the hook is a SceneControl, ToolbarControl (with a 'buddy' SceneControl) or ArcScene.

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.