Boost.Geometry    Boost C++ Libraries
Classes | Functions
covered_by: detect if a geometry is inside or on the border of another geometry, a.o. point-in-polygon (border included)

Classes

struct  boost::geometry::strategy::covered_by::services::default_strategy< TagContained, TagContaining, CastedTagContained, CastedTagContaining, CsTagContained, CsTagContaining, GeometryContained, GeometryContaining >
 Traits class binding a covered_by determination strategy to a coordinate system. More...
 

Functions

template<typename Geometry1 , typename Geometry2 >
bool boost::geometry::covered_by (Geometry1 const &geometry1, Geometry2 const &geometry2)
 Checks if the first geometry is inside or on border the second geometry. More...
 
template<typename Geometry1 , typename Geometry2 , typename Strategy >
bool boost::geometry::covered_by (Geometry1 const &geometry1, Geometry2 const &geometry2, Strategy const &strategy)
 Checks if the first geometry is inside or on border the second geometry using the specified strategy. More...
 

Detailed Description

Function Documentation

template<typename Geometry1 , typename Geometry2 >
bool boost::geometry::covered_by ( Geometry1 const &  geometry1,
Geometry2 const &  geometry2 
)

Checks if the first geometry is inside or on border the second geometry.

The free function covered_by checks if the first geometry is inside or on border the second geometry.

Template Parameters
Geometry1Any type fulfilling a Geometry Concept
Geometry2Any type fulfilling a Geometry Concept
Parameters
geometry1A model of the specified concept which might be inside or on the border of the second geometry
geometry2A model of the specified concept which might cover the first geometry
Returns
true if geometry1 is inside of or on the border of geometry2, else false
Note
The default strategy is used for covered_by detection
template<typename Geometry1 , typename Geometry2 , typename Strategy >
bool boost::geometry::covered_by ( Geometry1 const &  geometry1,
Geometry2 const &  geometry2,
Strategy const &  strategy 
)

Checks if the first geometry is inside or on border the second geometry using the specified strategy.

The free function covered_by checks if the first geometry is inside or on border the second geometry, using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation.

Template Parameters
Geometry1Any type fulfilling a Geometry Concept
Geometry2Any type fulfilling a Geometry Concept
Parameters
geometry1A model of the specified concept which might be inside or on the border of the second geometry
geometry2A model of the specified concept which might cover the first geometry
strategystrategy to be used
Returns
true if geometry1 is inside of or on the border of geometry2, else false

April 2, 2011

Copyright © 2007-2011 Barend Gehrels, Amsterdam, the Netherlands
Copyright © 2008-2011 Bruno Lalande, Paris, France
Copyright © 2009-2010 Mateusz Loskot, London, UK
Documentation is generated by Doxygen