buffer_join_miter.qbk 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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/classboost_1_1geometry_1_1strategy_1_1buffer_1_1join__miter.xml]
  12. [section:strategy_buffer_join_miter strategy::buffer::join_miter]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>buffer</primary></indexterm><indexterm><primary>join_miter</primary></indexterm>'''
  14. Let the buffer create sharp corners.
  15. [heading Description]
  16. This strategy can be used as JoinStrategy for the buffer algorithm. It creates a sharp corners around each convex vertex. It can be applied for (multi)linestrings and (multi)polygons. If corners are sharp by themselves, the miters might become very long. Therefore there is a limit (miter\u005flimit), in terms of the used distance, which limits their length. The miter is not changed to a bevel form (as done in some other software), it is just adapted to the specified miter\u005flimit but keeps its miter form. If the buffer distance is 5.0, and the miter limit is 2.0, generated points will be located at a distance of at most 10.0 (2*5) units. This strategy is only applicable for Cartesian coordinate systems.
  17. [heading Synopsis]
  18. ``class strategy::buffer::join_miter
  19. {
  20. // ...
  21. };
  22. ``
  23. [heading Constructor(s)]
  24. [table
  25. [[Function] [Description] [Parameters] ]
  26. [[``join_miter(double miter_limit = 5.0)``
  27. ] [Constructs the strategy. ] [[* double]: ['miter_limit]: The miter limit, to avoid excessively long miters around sharp corners
  28. ]]
  29. ]
  30. [heading Header]
  31. `#include <boost/geometry/strategies/cartesian/buffer_join_miter.hpp>`
  32. [heading Example]
  33. [buffer_join_miter]
  34. [heading Output]
  35. [$img/strategies/buffer_join_miter.png]
  36. [heading See also]
  37. * [link geometry.reference.algorithms.buffer.buffer_7_with_strategies buffer (with strategies)]
  38. * [link geometry.reference.strategies.strategy_buffer_join_round join_round]
  39. [endsect]