This document is archived and information here might be outdated.  Recommended version.


SceneHookHelper Class (ArcObjects .NET 10.7 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Classes > S > SceneHookHelper Class
ArcGIS Developer Help

SceneHookHelperClass Class

Helps commands work with the SceneControl, ArcScene, and custom controls and applications.

Product Availability

Available with ArcGIS Engine.

Description

The SceneHookHelper is designed to help developers write custom commands that will work with some ArcGIS Engine Controls and applications.

When creating a custom command the ICommand::OnCreate event is passed a hook to the control or application that the command will work with. The command needs to determine the type of hook that is passed so it knows how to handle itself. Rather than adding code into the ICommand::OnCreate event to determine the type of hook a SceneHookHelper object can do this. The SceneHookHelper is used to hold the hook and return the IScene, ISceneGraph, ISceneViewer and ICamera objects regardless of whether the hook is a SceneControl, ToolbarControl (with a 'buddy' SceneControl), the ArcScene application or a custom control or application implementing ISceneCommandHook.

When using the SceneHookHelper in the ICommand::OnCreate event of custom commands the following must be considered:

Extended Error Information

Use the ISupportErrorInfo method InterfaceSupportsErrorInfo to determine if the object supports extended error information. If the object supports extended error info, VC++ developers should use the OLE/COM IErrorInfo interface to access the ErrorInfo object. Visual Basic developers should use the global error object Err to retrieve this extended error information.

Interfaces

Interfaces Description
IConnectionPointContainer (esriDisplay)
IHookHelperEvents Provides access to events that occur when the state of a hook changes.
ISceneHookHelper Provides access to members needed when developing commands to work with the SceneControl, ArcScene, and custom controls and applications.
ISupportErrorInfo (esriSystem)