org.locationtech.jts.algorithm

Class PointLocation

java.lang.Object

org.locationtech.jts.algorithm.PointLocation

public class PointLocation
extends Object

Functions for locating points within basic geometric structures such as line segments, lines and rings.

Author:

Martin Davis

Constructor Summary

Constructors

Constructor and Description
PointLocation()

Method Summary

Modifier and Type	Method and Description
static boolean	isInRing(Coordinate p, Coordinate[] ring) Tests whether a point lies inside or on a ring.
static boolean	isOnLine(Coordinate p, Coordinate[] line) Tests whether a point lies on the line defined by a list of coordinates.
static boolean	isOnLine(Coordinate p, CoordinateSequence line) Tests whether a point lies on the line defined by a CoordinateSequence.
static boolean	isOnSegment(Coordinate p, Coordinate p0, Coordinate p1) Tests whether a point lies on a line segment.
static int	locateInRing(Coordinate p, Coordinate[] ring) Determines whether a point lies in the interior, on the boundary, or in the exterior of a ring.

Methods inherited from class java.lang.Object

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

Constructor Detail

PointLocation

public PointLocation()

Method Detail

isOnSegment

public static boolean isOnSegment(Coordinate p,
                                  Coordinate p0,
                                  Coordinate p1)

Tests whether a point lies on a line segment.

Parameters:

p - the point to test

p0 - a point of the line segment

p1 - a point of the line segment

Returns:

true if the point lies on the line segment

isOnLine

public static boolean isOnLine(Coordinate p,
                               Coordinate[] line)

Tests whether a point lies on the line defined by a list of coordinates.

Parameters:

p - the point to test

line - the line coordinates

Returns:

true if the point is a vertex of the line or lies in the interior of a line segment in the line

isOnLine

public static boolean isOnLine(Coordinate p,
                               CoordinateSequence line)

Tests whether a point lies on the line defined by a CoordinateSequence.

Parameters:

p - the point to test

line - the line coordinates

Returns:

true if the point is a vertex of the line or lies in the interior of a line segment in the line

isInRing

public static boolean isInRing(Coordinate p,
                               Coordinate[] ring)

Tests whether a point lies inside or on a ring. The ring may be oriented in either direction. A point lying exactly on the ring boundary is considered to be inside the ring.

This method does not first check the point against the envelope of the ring.

Parameters:

p - point to check for ring inclusion

ring - an array of coordinates representing the ring (which must have first point identical to last point)

Returns:

true if p is inside ring

See Also:

locateInRing(Coordinate, Coordinate[])

locateInRing

public static int locateInRing(Coordinate p,
                               Coordinate[] ring)

Determines whether a point lies in the interior, on the boundary, or in the exterior of a ring. The ring may be oriented in either direction.

This method does not first check the point against the envelope of the ring.

Parameters:

p - point to check for ring inclusion

ring - an array of coordinates representing the ring (which must have first point identical to last point)

Returns:

the Location of p relative to the ring