com.esri.arcgis.analyst3d
Interface IHit3D

All Superinterfaces:

Serializable

All Known Implementing Classes:

Hit3D, IHit3DProxy

public interface IHit3D
extends 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.

Method Summary

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	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.

Method Detail

setPointByRef

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.

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

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

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

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.

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

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectByRef

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.

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

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceToObserver

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

Parameters:

pDistanceToObs - The pDistanceToObs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceToObserver

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

Returns:

The pDistanceToObs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceToRay

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

Parameters:

pDistanceToRay - The pDistanceToRay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceToRay

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

Returns:

The pDistanceToRay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDepthRange

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

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

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

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

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

Parameters:

hit - The hit (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExactHit

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

Returns:

The hit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.