mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-10 07:34:03 +00:00
92 lines
3.3 KiB
Plaintext
92 lines
3.3 KiB
Plaintext
[/============================================================================
|
|
Boost.Geometry (aka GGL, Generic Geometry Library)
|
|
|
|
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
|
|
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
|
|
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
|
|
|
|
Use, modification and distribution is subject to the Boost Software License,
|
|
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
|
http://www.boost.org/LICENSE_1_0.txt)
|
|
=============================================================================/]
|
|
|
|
|
|
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
|
|
[/ Generated from doxy/doxygen_output/xml/group__within.xml]
|
|
[section:within_3_with_strategy within (with strategy)]
|
|
|
|
Checks if the first geometry is completely inside the second geometry using the specified strategy.
|
|
|
|
[heading Description]
|
|
The free function within checks if the first geometry is completely inside 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.
|
|
|
|
[heading Synopsis]
|
|
``template<typename Geometry1, typename Geometry2, typename Strategy>
|
|
bool within(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
|
|
|
|
[heading Parameters]
|
|
|
|
[table
|
|
[[Type] [Concept] [Name] [Description] ]
|
|
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept geometry which might be within the second geometry ]]
|
|
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept which might contain the first geometry ]]
|
|
[[Strategy const &] [] [strategy] [strategy to be used ]]
|
|
]
|
|
|
|
|
|
[heading Returns]
|
|
true if geometry1 is completely contained within geometry2, else false
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry/geometry.hpp>`
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/algorithms/within.hpp>`
|
|
|
|
[heading Available Strategies]
|
|
* [link geometry.reference.strategies.strategy_within_winding Winding (coordinate system agnostic)]
|
|
* [link geometry.reference.strategies.strategy_within_franklin Franklin (cartesian)]
|
|
* [link geometry.reference.strategies.strategy_within_crossings_multiply Crossings Multiply (cartesian)]
|
|
|
|
|
|
[endsect]
|
|
|
|
[section:within_2 within]
|
|
|
|
Checks if the first geometry is completely inside the second geometry.
|
|
|
|
[heading Description]
|
|
The free function within checks if the first geometry is completely inside the second geometry.
|
|
|
|
[heading Synopsis]
|
|
``template<typename Geometry1, typename Geometry2>
|
|
bool within(Geometry1 const & geometry1, Geometry2 const & geometry2)``
|
|
|
|
[heading Parameters]
|
|
|
|
[table
|
|
[[Type] [Concept] [Name] [Description] ]
|
|
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [geometry which might be within the second geometry ]]
|
|
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [geometry which might contain the first geometry ]]
|
|
]
|
|
|
|
|
|
[heading Returns]
|
|
true if geometry1 is completely contained within geometry2, else false
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry/geometry.hpp>`
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/algorithms/within.hpp>`
|
|
|
|
|
|
[endsect]
|
|
|