segment_view.qbk 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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_1segment__view.xml]
  12. [section:segment_view segment_view]
  13. '''<indexterm><primary>segment_view</primary></indexterm>'''
  14. Makes a segment behave like a linestring or a range.
  15. [heading Description]
  16. Adapts a segment to the Boost.Range concept, enabling the user to iterate the two segment points. The segment\u005fview is registered as a LineString Concept
  17. [heading Model of]
  18. [link geometry.reference.concepts.concept_linestring LineString Concept]
  19. [heading Synopsis]
  20. ``template<typename Segment>
  21. struct segment_view
  22. : public detail::points_view< geometry::point_type< Segment >::type, 2 >
  23. {
  24. // ...
  25. };
  26. ``
  27. [heading Template parameter(s)]
  28. [table
  29. [[Parameter] [Description]]
  30. [[typename Segment] [A type fulfilling the Segment Concept]]
  31. ]
  32. [heading Constructor(s)]
  33. [table
  34. [[Function] [Description] [Parameters] ]
  35. [[``segment_view(Segment const & segment)``
  36. ] [Constructor accepting the segment to adapt. ] [[* Segment const &]: ['segment]:
  37. ]]
  38. ]
  39. [heading Header]
  40. Either
  41. `#include <boost/geometry.hpp>`
  42. Or
  43. `#include <boost/geometry/views/segment_view.hpp>`
  44. [include reference/views/segment_view.qbk]
  45. [endsect]