com.esri.arcgis.analyst3d
Class IHit3DProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.analyst3d.IHit3DProxy
All Implemented Interfaces:
IHit3D, Externalizable, Serializable

public class IHit3DProxy
extends com.esri.arcgis.interop.Dispatch
implements IHit3D, Serializable

Provides access to members that control information about a hit in 3D picking.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IHit3DProxy()
           
  IHit3DProxy(Object obj)
           
protected IHit3DProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void getDepthRange(double[] pDMin, double[] pDMax)
          Returns the depth range of the hit as reported by OpenGL.
 double getDistanceToObserver()
          The 3D distance from the observer to the hit point.
 double getDistanceToRay()
          The 3D distance between the hit point and the picking ray.
 Object getObject()
          The object (feature) that is hit.
 Object getOwner()
          The owner (layer) that is hit.
 IPoint getPoint()
          The location of the hit.
 boolean isExactHit()
          Indicates whether an exact hit.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setDepthRange(double dMin, double dMax)
          Sets the depth range of the hit as reported by OpenGL.
 void setDistanceToObserver(double pDistanceToObs)
          The 3D distance from the observer to the hit point.
 void setDistanceToRay(double pDistanceToRay)
          The 3D distance between the hit point and the picking ray.
 void setExactHit(boolean hit)
          Indicates whether an exact hit.
 void setObjectByRef(Object ppObject)
          The object (feature) that is hit.
 void setOwnerByRef(Object ppOwner)
          The owner (layer) that is hit.
 void setPointByRef(IPoint ppPoint)
          The location of the hit.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IHit3DProxy

public IHit3DProxy()

IHit3DProxy

public IHit3DProxy(Object obj)
            throws IOException
Throws:
IOException

IHit3DProxy

protected IHit3DProxy(Object obj,
                      String iid)
               throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

setPointByRef

public void setPointByRef(IPoint ppPoint)
                   throws IOException,
                          AutomationException
The location of the hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:
setPointByRef in interface IHit3D
Parameters:
ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPoint

public IPoint getPoint()
                throws IOException,
                       AutomationException
The location of the hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPoint in interface IHit3D
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOwnerByRef

public void setOwnerByRef(Object ppOwner)
                   throws IOException,
                          AutomationException
The owner (layer) that is hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:
setOwnerByRef in interface IHit3D
Parameters:
ppOwner - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOwner

public Object getOwner()
                throws IOException,
                       AutomationException
The owner (layer) that is hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOwner in interface IHit3D
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectByRef

public void setObjectByRef(Object ppObject)
                    throws IOException,
                           AutomationException
The object (feature) that is hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:
setObjectByRef in interface IHit3D
Parameters:
ppObject - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject()
                 throws IOException,
                        AutomationException
The object (feature) that is hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getObject in interface IHit3D
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceToObserver

public void setDistanceToObserver(double pDistanceToObs)
                           throws IOException,
                                  AutomationException
The 3D distance from the observer to the hit point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDistanceToObserver in interface IHit3D
Parameters:
pDistanceToObs - The pDistanceToObs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceToObserver

public double getDistanceToObserver()
                             throws IOException,
                                    AutomationException
The 3D distance from the observer to the hit point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDistanceToObserver in interface IHit3D
Returns:
The pDistanceToObs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceToRay

public void setDistanceToRay(double pDistanceToRay)
                      throws IOException,
                             AutomationException
The 3D distance between the hit point and the picking ray.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDistanceToRay in interface IHit3D
Parameters:
pDistanceToRay - The pDistanceToRay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceToRay

public double getDistanceToRay()
                        throws IOException,
                               AutomationException
The 3D distance between the hit point and the picking ray.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDistanceToRay in interface IHit3D
Returns:
The pDistanceToRay
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDepthRange

public void setDepthRange(double dMin,
                          double dMax)
                   throws IOException,
                          AutomationException
Sets the depth range of the hit as reported by OpenGL.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDepthRange in interface IHit3D
Parameters:
dMin - The dMin (in)
dMax - The dMax (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDepthRange

public void getDepthRange(double[] pDMin,
                          double[] pDMax)
                   throws IOException,
                          AutomationException
Returns the depth range of the hit as reported by OpenGL.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDepthRange in interface IHit3D
Parameters:
pDMin - The pDMin (out: use single element array)
pDMax - The pDMax (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExactHit

public void setExactHit(boolean hit)
                 throws IOException,
                        AutomationException
Indicates whether an exact hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExactHit in interface IHit3D
Parameters:
hit - The hit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExactHit

public boolean isExactHit()
                   throws IOException,
                          AutomationException
Indicates whether an exact hit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isExactHit in interface IHit3D
Returns:
The hit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException