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_1ring.xml] 16[section:model_ring model::ring] 17 18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>ring</primary></indexterm>''' 19A ring (aka linear ring) is a closed line which should not be selfintersecting. 20 21[heading Model of] 22[link geometry.reference.concepts.concept_ring Ring Concept] 23 24[heading Synopsis] 25``template<typename Point, bool ClockWise, bool Closed, template< typename, typename > class Container, 26 template< typename > class Allocator> 27class model::ring 28 : public Container< Point, Allocator< Point > > 29{ 30 // ... 31}; 32`` 33 34[heading Template parameter(s)] 35[table 36[[Parameter] [Default] [Description]] 37[[typename Point] [] [point type ]] 38[[bool ClockWise] [true] [true for clockwise direction, false for CounterClockWise direction ]] 39[[bool Closed] [true] [true for closed polygons (last point == first point), false open points ]] 40[[template< typename, typename > class Container] [std::vector] [container type, for example std::vector, std::deque ]] 41[[template< typename > class Allocator] [std::allocator] [container-allocator-type]] 42] 43 44[heading Constructor(s)] 45[table 46[[Function] [Description] [Parameters] ] 47[[``ring()`` 48 49] [Default constructor, creating an empty ring. ] [ 50 51]] 52[[``template<typename Iterator> 53ring(Iterator begin, Iterator end)`` 54 55] [Constructor with begin and end, filling the ring. ] [[* Iterator]: ['begin]: 56 57[* Iterator]: ['end]: 58 59 60 61]] 62[[``ring(std::initializer_list< Point > l)`` 63 64] [Constructor taking std::initializer_list, filling the ring. ] [[* std::initializer_list< Point >]: ['l]: 65 66 67 68]] 69] 70 71[heading Header] 72Either 73 74`#include <boost/geometry/geometries/geometries.hpp>` 75 76 77Or 78 79`#include <boost/geometry/geometries/ring.hpp>` 80 81[include reference/geometries/ring.qbk] 82 83[endsect] 84 85