GEOS  3.8.0dev
geos::algorithm::PointLocation Class Reference

Functions for locating points within basic geometric structures such as lines and rings. More...

`#include <PointLocation.h>`

## Static Public Member Functions

static bool isOnLine (const geom::Coordinate &p, const geom::CoordinateSequence *line)
Tests whether a point lies on the line defined by a CoordinateSequence. More...

static bool isInRing (const geom::Coordinate &p, const std::vector< const geom::Coordinate * > &ring)
Tests whether a point lies inside or on a ring. More...

static bool isInRing (const geom::Coordinate &p, const geom::CoordinateSequence *ring)

static geom::Location locateInRing (const geom::Coordinate &p, const std::vector< const geom::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. More...

static geom::Location locateInRing (const geom::Coordinate &p, const geom::CoordinateSequence &ring)

## Detailed Description

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

## Member Function Documentation

 static bool geos::algorithm::PointLocation::isInRing ( const geom::Coordinate & p, const std::vector< const geom::Coordinate * > & ring )
static

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
RayCrossingCounter::locatePointInRing()
 static bool geos::algorithm::PointLocation::isOnLine ( const geom::Coordinate & p, const geom::CoordinateSequence * line )
static

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
 static geom::Location geos::algorithm::PointLocation::locateInRing ( const geom::Coordinate & p, const std::vector< const geom::Coordinate * > & ring )
static

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

The documentation for this class was generated from the following file: