87 lines
2.6 KiB
Plaintext
87 lines
2.6 KiB
Plaintext
[/============================================================================
|
|
Boost.Geometry (aka GGL, Generic Geometry Library)
|
|
|
|
Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
|
|
Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
|
|
Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
|
|
|
|
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 1.1.1, don't change, will be overwritten automatically]
|
|
[/ Generated from doxy/doxygen_output/xml/group__correct.xml]
|
|
[section:correct_1 correct]
|
|
|
|
'''<indexterm><primary>correct</primary></indexterm>'''
|
|
Corrects a geometry.
|
|
|
|
[heading Description]
|
|
Corrects a geometry: all rings which are wrongly oriented with respect to their expected orientation are reversed. To all rings which do not have a closing point and are typed as they should have one, the first point is appended. Also boxes can be corrected.
|
|
|
|
[heading Synopsis]
|
|
``template<typename Geometry>
|
|
void correct(Geometry & geometry)``
|
|
|
|
[heading Parameters]
|
|
|
|
[table
|
|
[[Type] [Concept] [Name] [Description] ]
|
|
[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept which will be corrected if necessary]]
|
|
]
|
|
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry.hpp>`
|
|
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/algorithms/correct.hpp>`
|
|
|
|
[include reference/algorithms/correct.qbk]
|
|
|
|
|
|
[endsect]
|
|
|
|
[section:correct_2_with_strategy correct (with strategy)]
|
|
|
|
'''<indexterm><primary>correct</primary></indexterm>'''
|
|
Corrects a geometry.
|
|
|
|
[heading Description]
|
|
Corrects a geometry: all rings which are wrongly oriented with respect to their expected orientation are reversed. To all rings which do not have a closing point and are typed as they should have one, the first point is appended. Also boxes can be corrected.
|
|
|
|
[heading Synopsis]
|
|
``template<typename Geometry, typename Strategy>
|
|
void correct(Geometry & geometry, Strategy const & strategy)``
|
|
|
|
[heading Parameters]
|
|
|
|
[table
|
|
[[Type] [Concept] [Name] [Description] ]
|
|
[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept which will be corrected if necessary ]]
|
|
[[Strategy const &] [Any type fulfilling a Area Strategy Concept ] [strategy] [The strategy which will be used for area calculations]]
|
|
]
|
|
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry.hpp>`
|
|
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/algorithms/correct.hpp>`
|
|
|
|
[include reference/algorithms/correct.qbk]
|
|
|
|
|
|
[endsect]
|
|
|