com.esri.arcgis.controls
Class SceneHookHelper

java.lang.Object
  extended by com.esri.arcgis.controls.SceneHookHelper
All Implemented Interfaces:
ISceneHookHelper, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class SceneHookHelper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISceneHookHelper, IConnectionPointContainer, ISupportErrorInfo

COM Class 'SceneHookHelper'. Generated 3/19/2015 1:20:48 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Helps commands work with the SceneControl, ArcScene, and custom controls and applications.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.controls.ISceneHookHelper
IID, IID142dce00_0dd2_4761_b639_5fc7af74fa1b, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
SceneHookHelper()
          Constructs a SceneHookHelper using ArcGIS Engine.
SceneHookHelper(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SceneHookHelper theSceneHookHelper = (SceneHookHelper) obj;
 
Method Summary
 void addIHookHelperEventsListener(IHookHelperEvents theListener)
          addIHookHelperEventsListener.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 ISceneViewer getActiveViewer()
          Active scene viewer of hooked control or application.
 ICamera getCamera()
          Camera of hooked control or application.
static java.lang.String getClsid()
          getClsid.
 java.lang.Object getHook()
          Hook object that should be the same as the hook object passed in ICommand::OnCreate.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IScene getScene()
          Scene of hooked control or application.
 ISceneGraph getSceneGraph()
          SceneGraph of hooked control or application.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void release()
          Release a SceneHookHelper.
 void removeIHookHelperEventsListener(IHookHelperEvents theListener)
          removeIHookHelperEventsListener.
 void setHookByRef(java.lang.Object ppHook)
          Hook object that should be the same as the hook object passed in ICommand::OnCreate.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SceneHookHelper

public SceneHookHelper()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a SceneHookHelper using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SceneHookHelper

public SceneHookHelper(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SceneHookHelper theSceneHookHelper = (SceneHookHelper) obj;

Construct a SceneHookHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SceneHookHelper.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIHookHelperEventsListener

public void addIHookHelperEventsListener(IHookHelperEvents theListener)
                                  throws java.io.IOException
addIHookHelperEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.IHookHelperEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIHookHelperEventsListener

public void removeIHookHelperEventsListener(IHookHelperEvents theListener)
                                     throws java.io.IOException
removeIHookHelperEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.controls.IHookHelperEvents interface.
Throws:
java.io.IOException - If there are communications problems.

release

public void release()
Release a SceneHookHelper.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setHookByRef

public void setHookByRef(java.lang.Object ppHook)
                  throws java.io.IOException,
                         AutomationException
Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Specified by:
setHookByRef in interface ISceneHookHelper
Parameters:
ppHook - A reference to another Automation Object (IDispatch) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHook

public java.lang.Object getHook()
                         throws java.io.IOException,
                                AutomationException
Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Specified by:
getHook in interface ISceneHookHelper
Returns:
A reference to another Automation Object (IDispatch)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScene

public IScene getScene()
                throws java.io.IOException,
                       AutomationException
Scene of hooked control or application.

Specified by:
getScene in interface ISceneHookHelper
Returns:
A reference to a com.esri.arcgis.analyst3d.IScene
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException
SceneGraph of hooked control or application.

Specified by:
getSceneGraph in interface ISceneHookHelper
Returns:
A reference to a com.esri.arcgis.analyst3d.ISceneGraph
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveViewer

public ISceneViewer getActiveViewer()
                             throws java.io.IOException,
                                    AutomationException
Active scene viewer of hooked control or application.

Specified by:
getActiveViewer in interface ISceneHookHelper
Returns:
A reference to a com.esri.arcgis.analyst3d.ISceneViewer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCamera

public ICamera getCamera()
                  throws java.io.IOException,
                         AutomationException
Camera of hooked control or application.

Specified by:
getCamera in interface ISceneHookHelper
Returns:
A reference to a com.esri.arcgis.analyst3d.ICamera
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.