com.esri.arcgis.analyst3d
Class Hit3D

java.lang.Object
  com.esri.arcgis.analyst3d.Hit3D

All Implemented Interfaces:

IHit3D, java.io.Serializable

public class Hit3D

extends java.lang.Object

implements IHit3D

A container for information regarding 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

Constructor Summary

Hit3D(java.lang.Object obj)
Construct a Hit3D using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IHit3D	getAsIHit3D() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
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.
java.lang.Object	getObject() The object (feature) that is hit.
java.lang.Object	getOwner() The owner (layer) that is hit.
IPoint	getPoint() The location of the hit.
int	hashCode() the hashcode for this object
boolean	isExactHit() Indicates whether an exact hit.
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(java.lang.Object ppObject) The object (feature) that is hit.
void	setOwnerByRef(java.lang.Object ppOwner) The owner (layer) that is hit.
void	setPointByRef(IPoint ppPoint) The location of the hit.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Hit3D

public Hit3D(java.lang.Object obj)
      throws java.io.IOException

Construct a Hit3D using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Hit3D.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
Hit3D o = (Hit3D)obj; // will not work

Hit3D o = new Hit3D(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server Hit3D theHit3D = (Hit3D) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIHit3D

public IHit3D getAsIHit3D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setPointByRef

public void setPointByRef(IPoint ppPoint)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IHit3D

The location of the hit.

Specified by:

setPointByRef in interface IHit3D

Parameters:

ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getPoint

public IPoint getPoint()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IHit3D

The location of the hit.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPoint in interface IHit3D

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setOwnerByRef

public void setOwnerByRef(java.lang.Object ppOwner)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IHit3D

The owner (layer) that is hit.

Specified by:

setOwnerByRef in interface IHit3D

Parameters:

ppOwner - A reference to another Object (IUnknown) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOwner

public java.lang.Object getOwner()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IHit3D

The owner (layer) that is hit.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOwner in interface IHit3D

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setObjectByRef

public void setObjectByRef(java.lang.Object ppObject)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IHit3D

The object (feature) that is hit.

Specified by:

setObjectByRef in interface IHit3D

Parameters:

ppObject - A reference to another Object (IUnknown) (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IHit3D

The object (feature) that is hit.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getObject in interface IHit3D

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceToObserver

public void setDistanceToObserver(double pDistanceToObs)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IHit3D

The 3D distance from the observer to the hit point.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDistanceToObserver in interface IHit3D

Parameters:

pDistanceToObs - The pDistanceToObs (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceToObserver

public double getDistanceToObserver()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IHit3D

The 3D distance from the observer to the hit point.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDistanceToObserver in interface IHit3D

Returns:

The pDistanceToObs

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceToRay

public void setDistanceToRay(double pDistanceToRay)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IHit3D

The 3D distance between the hit point and the picking ray.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDistanceToRay in interface IHit3D

Parameters:

pDistanceToRay - The pDistanceToRay (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceToRay

public double getDistanceToRay()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IHit3D

The 3D distance between the hit point and the picking ray.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDistanceToRay in interface IHit3D

Returns:

The pDistanceToRay

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setDepthRange

public void setDepthRange(double dMin,
                          double dMax)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IHit3D

Sets the depth range of the hit as reported by OpenGL.

Specified by:

setDepthRange in interface IHit3D

Parameters:

dMin - The dMin (in)

dMax - The dMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepthRange

public void getDepthRange(double[] pDMin,
                          double[] pDMax)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IHit3D

Returns the depth range of the hit as reported by OpenGL.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExactHit

public void setExactHit(boolean hit)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IHit3D

Indicates whether an exact hit.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExactHit in interface IHit3D

Parameters:

hit - The hit (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExactHit

public boolean isExactHit()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IHit3D

Indicates whether an exact hit.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isExactHit in interface IHit3D

Returns:

The hit

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.