org.locationtech.jts.algorithm.locate

Class SimplePointInAreaLocator

java.lang.Object

org.locationtech.jts.algorithm.locate.SimplePointInAreaLocator

All Implemented Interfaces:

PointOnGeometryLocator

public class SimplePointInAreaLocator
extends Object
implements PointOnGeometryLocator

Computes the location of points relative to a Polygonal Geometry, using a simple O(n) algorithm. This algorithm is suitable for use in cases where only one or a few points will be tested against a given area.

The algorithm used is only guaranteed to return correct results for points which are not on the boundary of the Geometry.

Version:

1.7

Constructor Summary

Constructors

Constructor and Description
SimplePointInAreaLocator(Geometry geom)

Method Summary

Modifier and Type	Method and Description
static boolean	containsPointInPolygon(Coordinate p, Polygon poly) Determines whether a point lies in a Polygon.
int	locate(Coordinate p) Determines the Location of a point in the Geometry.
static int	locate(Coordinate p, Geometry geom) Determines the Location of a point in an areal Geometry.
static int	locatePointInPolygon(Coordinate p, Polygon poly) Determines the Location of a point in a Polygon.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplePointInAreaLocator

public SimplePointInAreaLocator(Geometry geom)

Method Detail

locate

public static int locate(Coordinate p,
                         Geometry geom)

Determines the Location of a point in an areal Geometry. Computes Location.BOUNDARY if the point lies exactly on a geometry line segment.

Parameters:

p - the point to test

geom - the areal geometry to test

Returns:

the Location of the point in the geometry

locatePointInPolygon

public static int locatePointInPolygon(Coordinate p,
                                       Polygon poly)

Determines the Location of a point in a Polygon. Computes Location.BOUNDARY if the point lies exactly on the polygon boundary.

Parameters:

p - the point to test

poly - the geometry to test

Returns:

the Location of the point in the polygon

containsPointInPolygon

public static boolean containsPointInPolygon(Coordinate p,
                                             Polygon poly)

Determines whether a point lies in a Polygon. If the point lies on the polygon boundary it is considered to be inside.

Parameters:

p - the point to test

poly - the geometry to test

Returns:

true if the point lies in or on the polygon

locate

public int locate(Coordinate p)

Description copied from interface: PointOnGeometryLocator

Determines the Location of a point in the Geometry.

Specified by:

locate in interface PointOnGeometryLocator

Parameters:

p - the point to test

Returns:

the location of the point in the geometry