A base class for PreparedGeometry subclasses. More...

#include <BasicPreparedGeometry.h>

Inheritance diagram for geos::geom::prep::BasicPreparedGeometry:

Public Member Functions
	BasicPreparedGeometry (const Geometry *geom)

const geom::Geometry &	getGeometry () const override
	Gets the original `Geometry` which has been prepared. More...

const std::vector< const CoordinateXY * > *	getRepresentativePoints () const

bool	isAnyTargetComponentInTest (const geom::Geometry *testGeom) const

bool	within (const geom::Geometry *g) const override

bool	contains (const geom::Geometry *g) const override

bool	containsProperly (const geom::Geometry *g) const override

bool	coveredBy (const geom::Geometry *g) const override

bool	covers (const geom::Geometry *g) const override

bool	crosses (const geom::Geometry *g) const override

bool	disjoint (const geom::Geometry *g) const override

bool	intersects (const geom::Geometry *g) const override

bool	overlaps (const geom::Geometry *g) const override

bool	touches (const geom::Geometry *g) const override

std::unique_ptr< IntersectionMatrix >	relate (const geom::Geometry *g) const override

bool	relate (const geom::Geometry *g, const std::string &pat) const override

std::unique_ptr< geom::CoordinateSequence >	nearestPoints (const geom::Geometry *g) const override

double	distance (const geom::Geometry *g) const override

bool	isWithinDistance (const geom::Geometry *geom, double dist) const override

std::string	toString ()

virtual const geom::Geometry &	getGeometry () const =0
	Gets the original `Geometry` which has been prepared. More...

virtual bool	contains (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` contains a given geometry. More...

virtual bool	containsProperly (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` properly contains a given geometry. More...

virtual bool	coveredBy (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` is covered by a given geometry. More...

virtual bool	covers (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` covers a given geometry. More...

virtual bool	crosses (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` crosses a given geometry. More...

virtual bool	disjoint (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` is disjoint from a given geometry. More...

virtual bool	intersects (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` intersects a given geometry. More...

virtual bool	overlaps (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` overlaps a given geometry. More...

virtual bool	touches (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` touches a given geometry. More...

virtual bool	within (const geom::Geometry *geom) const =0
	Tests whether the base `Geometry` is within a given geometry. More...

virtual std::unique_ptr< geom::CoordinateSequence >	nearestPoints (const geom::Geometry *geom) const =0
	Compute the nearest locations on the base `Geometry` and the given geometry. More...

virtual double	distance (const geom::Geometry *geom) const =0
	Compute the minimum distance between the base `Geometry` and the given geometry. More...

virtual bool	isWithinDistance (const geom::Geometry *geom, double dist) const =0
	Tests whether the base `Geometry` is within a given distance from the given geometry. More...

virtual std::unique_ptr< IntersectionMatrix >	relate (const geom::Geometry *geom) const =0
	Compares the prepared geometry to the given geometry and returns the DE9IM intersection matrix as a string. More...

virtual bool	relate (const geom::Geometry *geom, const std::string &pat) const =0
	Compares the prepared geometry to the given geometry and the provided DE9IM pattern, and returns true if the pattern is consistent with the relationship between the prepared and provided geometries. More...

Protected Member Functions
void	setGeometry (const geom::Geometry *geom)

bool	envelopesIntersect (const geom::Geometry *g) const

bool	envelopeCovers (const geom::Geometry *g) const

Detailed Description

A base class for PreparedGeometry subclasses.

Contains default implementations for methods, which simply delegate to the equivalent Geometry methods. This class may be used as a "no-op" class for Geometry types which do not have a corresponding PreparedGeometry implementation.

Author: Martin Davis

Member Function Documentation

◆ contains()

bool geos::geom::prep::BasicPreparedGeometry::contains ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedPolygon.

◆ containsProperly()

bool geos::geom::prep::BasicPreparedGeometry::containsProperly ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedPolygon.

◆ coveredBy()

bool geos::geom::prep::BasicPreparedGeometry::coveredBy ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

◆ covers()

bool geos::geom::prep::BasicPreparedGeometry::covers ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedPolygon.

◆ crosses()

bool geos::geom::prep::BasicPreparedGeometry::crosses ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

◆ disjoint()

bool geos::geom::prep::BasicPreparedGeometry::disjoint ( const geom::Geometry * g ) const

overridevirtual

Standard implementation for all geometries. Supports GeometryCollections as input.

Implements geos::geom::prep::PreparedGeometry.

◆ distance()

double geos::geom::prep::BasicPreparedGeometry::distance ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedLineString, and geos::geom::prep::PreparedPolygon.

◆ envelopeCovers()

bool geos::geom::prep::BasicPreparedGeometry::envelopeCovers ( const geom::Geometry * g ) const

protected

Determines whether the envelope of this geometry covers the Geometry g.

Parameters

g	a Geometry

Returns: true if g is contained in this envelope

◆ envelopesIntersect()

bool geos::geom::prep::BasicPreparedGeometry::envelopesIntersect ( const geom::Geometry * g ) const

protected

Determines whether a Geometry g interacts with this geometry by testing the geometry envelopes.

Parameters

g	a Geometry

Returns: true if the envelopes intersect

◆ getGeometry()

const geom::Geometry & geos::geom::prep::BasicPreparedGeometry::getGeometry ( ) const

inlineoverridevirtual

Gets the original Geometry which has been prepared.

Returns: the base geometry

Implements geos::geom::prep::PreparedGeometry.

◆ getRepresentativePoints()

const std::vector< const CoordinateXY * > * geos::geom::prep::BasicPreparedGeometry::getRepresentativePoints ( ) const

inline

Gets the list of representative points for this geometry. One vertex is included for every component of the geometry (i.e. including one for every ring of polygonal geometries)

Returns: a List of Coordinate

◆ intersects()

bool geos::geom::prep::BasicPreparedGeometry::intersects ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedLineString, geos::geom::prep::PreparedPoint, and geos::geom::prep::PreparedPolygon.

◆ isAnyTargetComponentInTest()

bool geos::geom::prep::BasicPreparedGeometry::isAnyTargetComponentInTest ( const geom::Geometry * testGeom ) const

Tests whether any representative of the target geometry intersects the test geometry. This is useful in A/A, A/L, A/P, L/P, and P/P cases.

Parameters

testGeom the test geometry

Returns: true if any component intersects the areal test geometry

◆ isWithinDistance()

bool geos::geom::prep::BasicPreparedGeometry::isWithinDistance	(	const geom::Geometry *	geom,
		double	dist
	)		const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedLineString, and geos::geom::prep::PreparedPolygon.

◆ nearestPoints()

std::unique_ptr< geom::CoordinateSequence > geos::geom::prep::BasicPreparedGeometry::nearestPoints ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

Reimplemented in geos::geom::prep::PreparedLineString.

◆ overlaps()

bool geos::geom::prep::BasicPreparedGeometry::overlaps ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

◆ relate() [1/2]

std::unique_ptr< IntersectionMatrix > geos::geom::prep::BasicPreparedGeometry::relate ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

◆ relate() [2/2]

bool geos::geom::prep::BasicPreparedGeometry::relate	(	const geom::Geometry *	g,
		const std::string &	pat
	)		const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

◆ setGeometry()

void geos::geom::prep::BasicPreparedGeometry::setGeometry ( const geom::Geometry * geom )

protected

Sets the original Geometry which will be prepared.

◆ touches()

bool geos::geom::prep::BasicPreparedGeometry::touches ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

◆ within()

bool geos::geom::prep::BasicPreparedGeometry::within ( const geom::Geometry * g ) const

overridevirtual

Default implementation.

Implements geos::geom::prep::PreparedGeometry.

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

BasicPreparedGeometry.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ contains()

◆ containsProperly()

◆ coveredBy()

◆ covers()

◆ crosses()

◆ disjoint()

◆ distance()

◆ envelopeCovers()

◆ envelopesIntersect()

◆ getGeometry()

◆ getRepresentativePoints()

◆ intersects()

◆ isAnyTargetComponentInTest()

◆ isWithinDistance()

◆ nearestPoints()

◆ overlaps()

◆ relate() [1/2]

◆ relate() [2/2]

◆ setGeometry()

◆ touches()

◆ within()