boost/libs/geometry/doc/generated/exterior_ring.qbk
2018-01-12 21:47:58 +01:00

82 lines
2.0 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__exterior__ring.xml]
[section:exterior_ring_1 exterior_ring]
'''<indexterm><primary>exterior_ring</primary></indexterm>'''
Function to get the exterior\u005fring ring of a polygon.
[heading Synopsis]
``template<typename Polygon>
ring_return_type<Polygon>::type exterior_ring(Polygon & polygon)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Polygon &] [polygon type ] [polygon] [the polygon to get the exterior ring from ]]
]
[heading Returns]
a reference to the exterior ring
[heading Header]
Either
`#include <boost/geometry.hpp>`
Or
`#include <boost/geometry/core/exterior_ring.hpp>`
[endsect]
[section:exterior_ring_1_const_version exterior_ring (const version)]
'''<indexterm><primary>exterior_ring</primary></indexterm>'''
Function to get the exterior ring of a polygon (const version)
[heading Synopsis]
``template<typename Polygon>
ring_return_type<Polygon const>::type exterior_ring(Polygon const & polygon)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Polygon const &] [polygon type ] [polygon] [the polygon to get the exterior ring from ]]
]
[heading Returns]
a const reference to the exterior ring
[heading Header]
Either
`#include <boost/geometry.hpp>`
Or
`#include <boost/geometry/core/exterior_ring.hpp>`
[endsect]