convert.qbk 1.8 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/group__convert.xml]
  12. [section:convert convert]
  13. '''<indexterm><primary>convert</primary></indexterm>'''
  14. Converts one geometry to another geometry.
  15. [heading Description]
  16. The convert algorithm converts one geometry, e.g. a BOX, to another geometry, e.g. a RING. This only works if it is possible and applicable. If the point-order is different, or the closure is different between two geometry types, it will be converted correctly by explicitly reversing the points or closing or opening the polygon rings.
  17. [heading Synopsis]
  18. ``template<typename Geometry1, typename Geometry2>
  19. void convert(Geometry1 const & geometry1, Geometry2 & geometry2)``
  20. [heading Parameters]
  21. [table
  22. [[Type] [Concept] [Name] [Description] ]
  23. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept (source) ]]
  24. [[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept (target)]]
  25. ]
  26. [heading Header]
  27. Either
  28. `#include <boost/geometry.hpp>`
  29. Or
  30. `#include <boost/geometry/algorithms/convert.hpp>`
  31. [include reference/algorithms/convert.qbk]
  32. [endsect]