public class

Proximity2DResult

extends Object
java.lang.Object
   ↳ com.esri.core.geometry.Proximity2DResult

Class Overview

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.

Summary

Public Methods
Point getCoordinate()
Returns the closest coordinate for OperatorProximity2D.getNearestCoordinate or the vertex coordinates for the OperatorProximity2D.getNearestVertex and OperatorProximity2D.getNearestVertices.
double getDistance()
Returns the distance to the closest vertex or coordinate.
int getVertexIndex()
Returns the vertex index.
boolean isEmpty()
Returns TRUE if the Proximity2DResult is empty.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public Point getCoordinate ()

Returns the closest coordinate for OperatorProximity2D.getNearestCoordinate or the vertex coordinates for the OperatorProximity2D.getNearestVertex and OperatorProximity2D.getNearestVertices.

Returns
Point

public double getDistance ()

Returns the distance to the closest vertex or coordinate.

Returns
double

public int getVertexIndex ()

Returns the vertex index. For OperatorProximity2D.getNearestCoordinate the behavior is: When the input is a polygon or an envelope and the bTestPolygonInterior is true, the value is zero. When the input is a polygon or an Envelope and the bTestPolygonInterior is false, the value is the start vertex index of a segment with the closest coordinate. When the input is a polyline, the value is the start vertex index of a segment with the closest coordinate. When the input is a point, the value is 0. When the input is a multipoint, the value is the closest vertex.

Returns
int

public boolean isEmpty ()

Returns TRUE if the Proximity2DResult is empty. This only happens if the Geometry passed to the Proximity operator is empty.

Returns
boolean