1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1referring__segment.xml] 16[section:model_referring_segment model::referring_segment] 17 18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>referring_segment</primary></indexterm>''' 19Class segment: small class containing two (templatized) point references. 20 21[heading Description] 22From 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. 23 24[heading Synopsis] 25``template<typename ConstOrNonConstPoint> 26class model::referring_segment 27{ 28 // ... 29}; 30`` 31 32[heading Template parameter(s)] 33[table 34[[Parameter] [Description]] 35[[typename ConstOrNonConstPoint] [point type of the segment, maybe a point or a const point ]] 36] 37 38[heading Constructor(s)] 39[table 40[[Function] [Description] [Parameters] ] 41[[``referring_segment(point_type & p1, point_type & p2)`` 42 43] [Constructor taking the first and the second point. ] [[* point_type &]: ['p1]: 44 45[* point_type &]: ['p2]: 46 47 48 49]] 50] 51 52[heading Header] 53Either 54 55`#include <boost/geometry/geometries/geometries.hpp>` 56 57 58Or 59 60`#include <boost/geometry/geometries/segment.hpp>` 61 62[endsect] 63 64