com.esri.core.geometry

Class OperatorProximity2D

java.lang.Object

com.esri.core.geometry.Operator

com.esri.core.geometry.OperatorProximity2D

public abstract class OperatorProximity2D
extends Operator

Finds closest vertices of the Geometry.

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.core.geometry.Operator

Operator.Type

Constructor Summary

Constructors

Constructor and Description
OperatorProximity2D()

Method Summary

Modifier and Type	Method and Description
abstract Proximity2DResult	getNearestCoordinate(Geometry geom, Point inputPoint, boolean bTestPolygonInterior) Returns the nearest coordinate on the Geometry to the given input point.
abstract Proximity2DResult	getNearestCoordinate(Geometry geom, Point inputPoint, boolean bTestPolygonInterior, boolean bCalculateLeftRightSide) Returns the nearest coordinate on the Geometry to the given input point.
abstract Proximity2DResult	getNearestVertex(Geometry geom, Point inputPoint) Returns the nearest vertex of the Geometry to the given input point.
abstract Proximity2DResult[]	getNearestVertices(Geometry geom, Point inputPoint, double searchRadius, int maxVertexCountToReturn) Returns vertices of the Geometry that are closer to the given point than the given radius.
Operator.Type	getType()
static OperatorProximity2D	local()

Methods inherited from class com.esri.core.geometry.Operator

accelerateGeometry, canAccelerateGeometry, deaccelerateGeometry

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorProximity2D

public OperatorProximity2D()

Method Detail

getType

public Operator.Type getType()

Specified by:

getType in class Operator

getNearestCoordinate

public abstract Proximity2DResult getNearestCoordinate(Geometry geom,
                                                       Point inputPoint,
                                                       boolean bTestPolygonInterior,
                                                       boolean bCalculateLeftRightSide)

Returns the nearest coordinate on the Geometry to the given input point.

Parameters:

geom - The input Geometry.

inputPoint - The query point.

bTestPolygonInterior - When true and geom is a polygon, the function will test if the input_point is inside of the polygon. Points that are inside of the polygon have zero distance to the polygon. When false, the function will not check if the point is inside of the polygon, but only determine proximity to the boundary.

bCalculateLeftRightSide - The function will calculate left/right side of polylines or polygons when the parameter is True. \return Returns the result of proximity calculation. See Proximity_2D_result.

getNearestCoordinate

public abstract Proximity2DResult getNearestCoordinate(Geometry geom,
                                                       Point inputPoint,
                                                       boolean bTestPolygonInterior)

Returns the nearest coordinate on the Geometry to the given input point.

Parameters:

geom - The input Geometry.

inputPoint - The query point.

bTestPolygonInterior - When true and geom is a polygon, the function will test if the input_point is inside of the polygon. Points that are inside of the polygon have zero distance to the polygon. When false, the function will not check if the point is inside of the polygon, but only determine proximity to the boundary. \return Returns the result of proximity calculation. See Proximity_2D_result.

getNearestVertex

public abstract Proximity2DResult getNearestVertex(Geometry geom,
                                                   Point inputPoint)

Returns the nearest vertex of the Geometry to the given input point.

getNearestVertices

public abstract Proximity2DResult[] getNearestVertices(Geometry geom,
                                                       Point inputPoint,
                                                       double searchRadius,
                                                       int maxVertexCountToReturn)

Returns vertices of the Geometry that are closer to the given point than the given radius.

Parameters:

geom - The input Geometry.

inputPoint - The query point.

searchRadius - The maximum distance to the query point of the vertices.

maxVertexCountToReturn - The maximum vertex count to return. The function returns no more than this number of vertices.

Returns:

The array of vertices that are in the given search radius to the point. The array is sorted by distance to the queryPoint with the closest point first. When there are more than the maxVertexCountToReturn vertices to return, it returns the closest vertices. The array will be empty when geom is empty.

local

public static OperatorProximity2D local()