com.esri.arcgis.geometry
Interface IProximityOperator

All Superinterfaces:

Serializable

All Known Implementing Classes:

BezierCurve, CircularArc, EllipticArc, Envelope, Line, MultiPatch, Multipoint, Point, Polygon, Polyline

public interface IProximityOperator
extends Serializable

Provides access to members that find the 2D distance between two geometries.

Description

Proximity operators are used to find the distance between two geometries or the distance from a given point to the nearest point on another geometry.

Product Availability

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

Method Summary

void	queryNearestPoint(IPoint p, int extension, IPoint nearest) Copies into 'nearest' a point on this geometry nearest to the input point.
double	returnDistance(IGeometry other) Returns the minimum distance between two geometries.
IPoint	returnNearestPoint(IPoint p, int extension) Creates and returns a point on this geometry nearest to the input point.

Method Detail

queryNearestPoint

void queryNearestPoint(IPoint p,
                       int extension,
                       IPoint nearest)
                       throws IOException,
                              AutomationException

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

Description

Queries the nearest point on a 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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

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

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

See Also:

esriSegmentExtension, IProximityOperator.returnNearestPoint(com.esri.arcgis.geometry.IPoint, int)

returnNearestPoint

IPoint returnNearestPoint(IPoint p,
                          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 on a 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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

See Also:

esriSegmentExtension, IProximityOperator.queryNearestPoint(com.esri.arcgis.geometry.IPoint, int, com.esri.arcgis.geometry.IPoint)

returnDistance

double returnDistance(IGeometry other)
                      throws IOException,
                             AutomationException

Returns the minimum distance between two geometries.

Description

Returns the minimum distance between two geometries. If the geometries intersect, the minimum distance is 0. Only returns the distance, and not the nearest points.

Remarks

The geometry combinations which can be used with ReturnDistance are:

Point: Point, MultiPoint, Envelope, Polyline, Polygon, Line, CircularArc, EllipticArc, BezierCurve.
Multipoint: Point, MultiPoint, Envelope, Polyline, Polygon.
Envelope: Point, MultiPoint, Envelope, Line, CircularArc, EllipticArc, BezierCurve, PolyLine, Polygon.
PolyLine: Point, Multipoint, Envelope, PolyLine, Polygon.
Polygon: Point, Multipoint, Envelope, PolyLine, Polygon.
Line: Point, Envelope, Line, CircularArc, EllipticArc, BezierCurve.
CircularArc: Point, Envelope, Line, CircularArc, EllipticArc (not implemented yet), BezierCurve.
EllipticArc: Point, Envelope, Line, CircularArc (not implemented yet), EllipticArc (not implemented yet), BezierCurve (not implemented yet).
BezierCurve: Point, Envelope, Line, CircularArc, EllipticArc (not implemented yet), BezierCurve.

Note: To get the distance between a segment (Line, CircularArc, EllipticArc, BezierCurve) and a MultiPoint, PolyLine or Polygon, add that segment to a PolyLine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.