Interface PointOnGeometryLocator

 1 /*
 2  * Copyright (c) 2016 Vivid Solutions.
 3  *
 4  * All rights reserved. This program and the accompanying materials
 5  * are made available under the terms of the Eclipse Public License 2.0
 6  * and Eclipse Distribution License v. 1.0 which accompanies this distribution.
 7  * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v20.html
 8  * and the Eclipse Distribution License is available at
 9  *
10  * http://www.eclipse.org/org/documents/edl-v10.php.
11  */
12 package org.locationtech.jts.algorithm.locate;
13  
14 import org.locationtech.jts.geom.Coordinate;
15 import org.locationtech.jts.geom.Geometry;
16 import org.locationtech.jts.geom.Location;
17  
18 /**
19  * An interface for classes which determine the {@link Location} of
20  * points in a {@link Geometry}.
21  * 
22  * @author Martin Davis
23  */
24 public interface PointOnGeometryLocator 
25 {
26   /**
27    * Determines the {@link Location} of a point in the {@link Geometry}.
28    * 
29    * @param p the point to test
30    * @return the location of the point in the geometry  
31    */
32     int locate(Coordinate p);
33 }
34