com.esri.core.geometry.OperatorProximity2D Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of esri-geometry-api Show documentation
The Esri Geometry API for Java enables developers to write custom applications for analysis of spatial data.
There is a newer version: 2.2.4
/*
 Copyright 1995-2015 Esri

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts Dept
 380 New York Street
 Redlands, California, USA 92373

 email: [email protected]
 */

package com.esri.core.geometry;

import com.esri.core.geometry.Operator.Type;

/**
 * Finds closest vertices of the Geometry.
 */
public abstract class OperatorProximity2D extends Operator {
	@Override
	public Type getType() {
		return Type.Proximity2D;
	}

	/**
	 *Returns the nearest coordinate on the Geometry to the given input point.
	 *@param geom The input Geometry.
	 *@param inputPoint The query point.
	 *@param 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.
	 *@param 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.
	 */
	public abstract Proximity2DResult getNearestCoordinate(Geometry geom,
			Point inputPoint, boolean bTestPolygonInterior,
			boolean bCalculateLeftRightSide);

	/**
	 *Returns the nearest coordinate on the Geometry to the given input point.
	 *@param geom The input Geometry.
	 *@param inputPoint The query point.
	 *@param 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.
	 */
	public abstract Proximity2DResult getNearestCoordinate(Geometry geom,
			Point inputPoint, boolean bTestPolygonInterior);

	/**
	 * Returns the nearest vertex of the Geometry to the given input point.
	 */
	public abstract Proximity2DResult getNearestVertex(Geometry geom,
			Point inputPoint);

	/**
	 * Returns vertices of the Geometry that are closer to the given point than
	 * the given radius.
	 * 
	 * @param geom
	 *            The input Geometry.
	 * @param inputPoint
	 *            The query point.
	 * @param searchRadius
	 *            The maximum distance to the query point of the vertices.
	 * @param maxVertexCountToReturn
	 *            The maximum vertex count to return. The function returns no
	 *            more than this number of vertices.
	 * @return 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.
	 */
	public abstract Proximity2DResult[] getNearestVertices(Geometry geom,
			Point inputPoint, double searchRadius, int maxVertexCountToReturn);

	public static OperatorProximity2D local() {
		return (OperatorProximity2D) OperatorFactoryLocal.getInstance()
				.getOperator(Type.Proximity2D);
	}

	interface ProxResultInfo {
		static final int rightSide = 0x1;
	}

}