123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 |
- [/============================================================================
- Boost.Geometry (aka GGL, Generic Geometry Library)
- Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
- Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
- Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
- Use, modification and distribution is subject to the Boost Software License,
- Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
- http://www.boost.org/LICENSE_1_0.txt)
- =============================================================================/]
- [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
- [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1referring__segment.xml]
- [section:model_referring_segment model::referring_segment]
- '''<indexterm><primary>model</primary></indexterm><indexterm><primary>referring_segment</primary></indexterm>'''
- Class segment: small class containing two (templatized) point references.
- [heading Description]
- From Wikipedia: In geometry, a line segment is a part of a line that is bounded by two distinct end points, and contains every point on the line between its end points.
- [heading Synopsis]
- ``template<typename ConstOrNonConstPoint>
- class model::referring_segment
- {
- // ...
- };
- ``
- [heading Template parameter(s)]
- [table
- [[Parameter] [Description]]
- [[typename ConstOrNonConstPoint] [point type of the segment, maybe a point or a const point ]]
- ]
- [heading Constructor(s)]
- [table
- [[Function] [Description] [Parameters] ]
- [[``referring_segment(point_type & p1, point_type & p2)``
- ] [Constructor taking the first and the second point. ] [[* point_type &]: ['p1]:
- [* point_type &]: ['p2]:
- ]]
- ]
- [heading Header]
- Either
- `#include <boost/geometry/geometries/geometries.hpp>`
- Or
- `#include <boost/geometry/geometries/segment.hpp>`
- [endsect]
|