Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext

model::ring

A ring (aka linear ring) is a closed line which should not be selfintersecting.

Model of

Ring Concept

Synopsis

template<typename Point, bool ClockWise, bool Closed, template< typename, typename > class Container,
         template< typename > class Allocator>
class model::ring
      : public Container< Point, Allocator< Point > >
{
  // ...
};

Template parameter(s)

Parameter

Default

Description

typename Point

point type

bool ClockWise

true

true for clockwise direction, false for CounterClockWise direction

bool Closed

true

true for closed polygons (last point == first point), false open points

template< typename, typename > class Container

std::vector

container type, for example std::vector, std::deque

template< typename > class Allocator

std::allocator

container-allocator-type

Constructor(s)

Function

Description

Parameters

ring()

Default constructor, creating an empty ring.

template<typename Iterator>
ring(Iterator begin, Iterator end)

Constructor with begin and end, filling the ring.

Iterator: begin:

Iterator: end:

Header

Either

#include <boost/geometry/geometries/geometries.hpp>

Or

#include <boost/geometry/geometries/ring.hpp>


PrevUpHomeNext