ring_type.qbk 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1ring__type.xml]
  12. [section:ring_type ring_type]
  13. '''<indexterm><primary>ring_type</primary></indexterm>'''
  14. Metafunction defining [*type] as the ring_type of the specified geometry type.
  15. [heading Description]
  16. A 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.
  17. [heading Synopsis]
  18. ``template<typename Geometry>
  19. struct ring_type
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Description]]
  27. [[typename Geometry] [A type fullfilling the Ring, Polygon or MultiPolygon concept.]]
  28. ]
  29. [heading Header]
  30. Either
  31. `#include <boost/geometry.hpp>`
  32. Or
  33. `#include <boost/geometry/core/ring_type.hpp>`
  34. [include reference/core/ring_type.qbk]
  35. [endsect]