Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::geometry::box_view< Box, Clockwise > Struct Template Reference

Makes a box behave like a ring or a range. More...

#include <box_view.hpp>

Inheritance diagram for boost::geometry::box_view< Box, Clockwise >:
Collaboration diagram for boost::geometry::box_view< Box, Clockwise >:

Public Types

typedef geometry::point_type
< Box >::type 
point_type
 

Public Member Functions

 box_view (Box const &box)
 Constructor accepting the box to adapt. More...
 

Detailed Description

template<typename Box, bool Clockwise = true>
struct boost::geometry::box_view< Box, Clockwise >

Makes a box behave like a ring or a range.

Adapts a box to the Boost.Range concept, enabling the user to iterating box corners. The box_view is registered as a Ring Concept

Template Parameters
Box{Box}
ClockwiseIf true, walks in clockwise direction, otherwise it walks in counterclockwise direction

{before.synopsis, [heading Model of] [link geometry.reference.concepts.concept_ring Ring Concept] }

{[include reference/views/box_view.qbk]}

Member Typedef Documentation

template<typename Box , bool Clockwise = true>
typedef geometry::point_type<Box>::type boost::geometry::box_view< Box, Clockwise >::point_type

Constructor & Destructor Documentation

template<typename Box , bool Clockwise = true>
boost::geometry::box_view< Box, Clockwise >::box_view ( Box const &  box)
inlineexplicit

Constructor accepting the box to adapt.


The documentation for this struct was generated from the following file: