transform.qbk 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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__transform.xml]
  12. [section:transform_3_with_strategy transform (with strategy)]
  13. '''<indexterm><primary>transform</primary></indexterm>'''
  14. Transforms from one geometry to another geometry using the specified strategy.
  15. [heading Synopsis]
  16. ``template<typename Geometry1, typename Geometry2, typename Strategy>
  17. bool transform(Geometry1 const & geometry1, Geometry2 & geometry2, Strategy const & strategy)``
  18. [heading Parameters]
  19. [table
  20. [[Type] [Concept] [Name] [Description] ]
  21. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  22. [[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  23. [[Strategy const &] [strategy ] [strategy] [The strategy to be used for transformation ]]
  24. ]
  25. [heading Returns]
  26. True if the transformation could be done
  27. [heading Header]
  28. Either
  29. `#include <boost/geometry.hpp>`
  30. Or
  31. `#include <boost/geometry/algorithms/transform.hpp>`
  32. [include reference/algorithms/transform_with_strategy.qbk]
  33. [endsect]
  34. [section:transform_2 transform]
  35. '''<indexterm><primary>transform</primary></indexterm>'''
  36. Transforms from one geometry to another geometry using a strategy.
  37. [heading Synopsis]
  38. ``template<typename Geometry1, typename Geometry2>
  39. bool transform(Geometry1 const & geometry1, Geometry2 & geometry2)``
  40. [heading Parameters]
  41. [table
  42. [[Type] [Concept] [Name] [Description] ]
  43. [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  44. [[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  45. ]
  46. [heading Returns]
  47. True if the transformation could be done
  48. [heading Header]
  49. Either
  50. `#include <boost/geometry.hpp>`
  51. Or
  52. `#include <boost/geometry/algorithms/transform.hpp>`
  53. [include reference/algorithms/transform.qbk]
  54. [endsect]