com.esri.arcgis.geometry
Interface IProximityOperator3D

All Superinterfaces:

Serializable

All Known Implementing Classes:

Envelope, Line, MultiPatch, Multipoint, Point, Polygon, Polyline

public interface IProximityOperator3D
extends Serializable

Provides access to members that find the 3D distance between two geometries with Zs.

Description

This interface is new at ArcGIS 9.3.

Returns the point on the input geometry that is closest to the input point, and returns the 3D distance between these two points. In contrast to IProximityOperator, Z values are taken into account when determining whether the given relationship exists.

Remarks

These methods are intended to be called against top-level geometries only (Point, Multipoint, Polyline, Polygon, Envelope, MultiPatch). To call a method against a Segment/Path or Ring, first add the part to a Polyline or Polygon container, respectively, and then call the appropriate method against the container.

These methods treat MultiPatch geometries as shell representations, where the interior is not considered part of the geometry. Consequently, a point situated inside a MultiPatch that does not touch one of its surfaces will be classified as disjoint from that MultiPatch.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	queryNearestPoint3D(IPoint pInP, int extension, IPoint pNearest) Copies into 'nearest' a point on this geometry nearest to the input point.
double	returnDistance3D(IGeometry pOther) Returns the minimal distance between two geometries.
IPoint	returnNearestPoint3D(IPoint pInP, int extension) Creates and returns a point on this geometry nearest to the input point.

Method Detail

queryNearestPoint3D

void queryNearestPoint3D(IPoint pInP,
                         int extension,
                         IPoint pNearest)
                         throws IOException,
                                AutomationException

Copies into 'nearest' a point on this geometry nearest to the input point.

Description

Queries the nearest point on a z aware geometry to the input point in 3D space. Depending on the method of segment extension, the nearest point can also be found on an extension of the geometry.

Remarks

If the geometry is an Envelope and the input point is located within the bounds of the Envelope, QueryNearestPoint3D will return a point on the exterior of the Envelope nearest the input point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

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

returnNearestPoint3D

IPoint returnNearestPoint3D(IPoint pInP,
                            int extension)
                            throws IOException,
                                   AutomationException

Creates and returns a point on this geometry nearest to the input point.

Description

Finds and returns the nearest point, in 3D space, on a z aware geometry to the input point. Depending on the method of segment extension, the nearest point can also be found on an extension of the geometry.

Remarks

If the geometry is an Envelope and the input point is located within the bounds of the Envelope, QueryNearestPoint3D will return a point on the exterior of the Envelope nearest the input point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)

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.

returnDistance3D

double returnDistance3D(IGeometry pOther)
                        throws IOException,
                               AutomationException

Returns the minimal distance between two geometries.

Description

Returns the minimum distance between two z aware geometries in 3D space. If the geometries intersect, the minimum distance is 0. Only returns the distance, and not the nearest points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pOther - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The pDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.