within_winding.qbk 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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_1within_1_1winding.xml]
  12. [section:strategy_within_winding strategy::within::winding]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>within</primary></indexterm><indexterm><primary>winding</primary></indexterm>'''
  14. Within detection using winding rule. Side strategy used internally is choosen based on Point's coordinate system.
  15. [heading Synopsis]
  16. ``template<typename Point, typename PointOfSegment, typename CalculationType>
  17. class strategy::within::winding
  18. : public within::detail::winding_base_type::type< Point, PointOfSegment, CalculationType >
  19. {
  20. // ...
  21. };
  22. ``
  23. [heading Template parameter(s)]
  24. [table
  25. [[Parameter] [Default] [Description]]
  26. [[typename Point] [] [Any type fulfilling a Point Concept ]]
  27. [[typename PointOfSegment] [Point] [segment point type ]]
  28. [[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point]]
  29. ]
  30. [heading Constructor(s)]
  31. [table
  32. [[Function] [Description] [Parameters] ]
  33. [[``winding()``
  34. ] [] [
  35. ]]
  36. [[``template<typename Model>
  37. winding(Model const & model)``
  38. ] [] [[* Model const &]: ['model]:
  39. ]]
  40. ]
  41. [heading Header]
  42. `#include <boost/geometry/strategies/agnostic/point_in_poly_winding.hpp>`
  43. [heading See also]
  44. [link geometry.reference.algorithms.within.within_3_with_strategy within (with strategy)]
  45. [endsect]