• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7
8  Use, modification and distribution is subject to the Boost Software License,
9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13
14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1ring__type.xml]
16[section:ring_type ring_type]
17
18'''<indexterm><primary>ring_type</primary></indexterm>'''
19Metafunction defining [*type] as the ring_type of the specified geometry type.
20
21[heading Description]
22A polygon contains one exterior ring and zero or more interior rings (holes). This metafunction retrieves the type of the rings. Exterior ring and each of the interior rings all have the same ring\u005ftype.
23
24[heading Synopsis]
25``template<typename Geometry>
26struct ring_type
27{
28  // ...
29};
30``
31
32[heading Template parameter(s)]
33[table
34[[Parameter] [Description]]
35[[typename Geometry] [A type fullfilling the Ring, Polygon or MultiPolygon concept.]]
36]
37
38[heading Header]
39Either
40
41`#include <boost/geometry.hpp>`
42
43
44Or
45
46`#include <boost/geometry/core/ring_type.hpp>`
47
48[include reference/core/ring_type.qbk]
49
50[endsect]
51
52