Class Proximity2DResult

java.lang.Object
com.esri.core.geometry.Proximity2DResult
public class Proximity2DResult extends Object
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.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    isRightSide()
    Returns true if the closest coordinate is to the right of the MultiPath.
    void
    setRightSide(boolean bRight)
    Sets the right_side info to true or false.

    Methods inherited from class Object

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

  • Method Details

    • setRightSide

      public void setRightSide(boolean bRight)
      Sets the right_side info to true or false.
      Parameters:
      bRight - Whether the nearest coordinate is to the right or left of the geometry.

    • isEmpty

      public boolean isEmpty()
      Returns TRUE if the Proximity2DResult is empty. This only happens if the Geometry passed to the Proximity operator is empty.

    • getCoordinate

      public Point getCoordinate()
      Returns the closest coordinate for OperatorProximity2D.getNearestCoordinate or the vertex coordinates for the OperatorProximity2D.getNearestVertex and OperatorProximity2D.getNearestVertices.

    • getVertexIndex

      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.

    • getDistance

      public double getDistance()
      Returns the distance to the closest vertex or coordinate.

    • isRightSide

      public boolean isRightSide()
      Returns true if the closest coordinate is to the right of the MultiPath.