box.hpp File Reference

Macros
#define	BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS(Box, Point, MinCorner, MaxCorner)
#define	BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS_TEMPLATED(Box, MinCorner, MaxCorner)
#define	BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS_4VALUES(Box, Point, Left, Bottom, Right, Top)
#define	BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS(Box, PointType)
#define	BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS_TEMPLATED(Box)
#define	BOOST_GEOMETRY_REGISTER_BOX(Box, Point, MinCorner, MaxCorner)
	{box} More...
#define	BOOST_GEOMETRY_REGISTER_BOX_TEMPLATED(Box, MinCorner, MaxCorner)
	{box} More...
#define	BOOST_GEOMETRY_REGISTER_BOX_2D_4VALUES(Box, Point, Left, Bottom, Right, Top)
	{box} More...

Macro Definition Documentation

#define BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS	(		Box,
			Point,
			MinCorner,
			MaxCorner
	)

Value:

template <size_t D> \
struct indexed_access<Box, min_corner, D> \
{ \
    typedef typename coordinate_type<Point>::type ct; \
    static inline ct get(Box const& b) \
    { return geometry::get<D>(b. MinCorner);  } \
    static inline void set(Box& b, ct const& value) \
    { geometry::set<D>(b. MinCorner, value);  } \
}; \
template <size_t D> \
struct indexed_access<Box, max_corner, D> \
{ \
    typedef typename coordinate_type<Point>::type ct; \
    static inline ct get(Box const& b) \
    { return geometry::get<D>(b. MaxCorner);  } \
    static inline void set(Box& b, ct const& value) \
    { geometry::set<D>(b. MaxCorner, value);  } \
};

#define BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS_4VALUES	(		Box,
			Point,
			Left,
			Bottom,
			Right,
			Top
	)

Value:

template <> struct indexed_access<Box, min_corner, 0> \
{ \
    typedef coordinate_type<Point>::type ct; \
    static inline ct get(Box const& b) { return b. Left;  } \
    static inline void set(Box& b, ct const& value) { b. Left = value; } \
}; \
template <> struct indexed_access<Box, min_corner, 1> \
{ \
    typedef coordinate_type<Point>::type ct; \
    static inline ct get(Box const& b) { return b. Bottom;  } \
    static inline void set(Box& b, ct const& value) { b. Bottom = value; } \
}; \
template <> struct indexed_access<Box, max_corner, 0> \
{ \
    typedef coordinate_type<Point>::type ct; \
    static inline ct get(Box const& b) { return b. Right;  } \
    static inline void set(Box& b, ct const& value) { b. Right = value; } \
}; \
template <> struct indexed_access<Box, max_corner, 1> \
{ \
    typedef coordinate_type<Point>::type ct; \
    static inline ct get(Box const& b) { return b. Top; } \
    static inline void set(Box& b, ct const& value) { b. Top = value; } \
};

#define BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS_TEMPLATED	(		Box,
			MinCorner,
			MaxCorner
	)

Value:

template <typename P, size_t D> \
struct indexed_access<Box<P>, min_corner, D> \
{ \
    typedef typename coordinate_type<P>::type ct; \
    static inline ct get(Box<P> const& b) \
    { return geometry::get<D>(b. MinCorner);  } \
    static inline void set(Box<P>& b, ct const& value) \
    { geometry::set<D>(b. MinCorner, value);  } \
}; \
template <typename P, size_t D> \
struct indexed_access<Box<P>, max_corner, D> \
{ \
    typedef typename coordinate_type<P>::type ct; \
    static inline ct get(Box<P> const& b) \
    { return geometry::get<D>(b. MaxCorner);  } \
    static inline void set(Box<P>& b, ct const& value) \
    { geometry::set<D>(b. MaxCorner, value);  } \
};

#define BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS	(		Box,
			PointType
	)

Value:

template<> struct tag<Box > { typedef box_tag type; }; \
    template<> struct point_type<Box > { typedef PointType type; };

#define BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS_TEMPLATED

(

Box

)

Value:

template<typename P> struct tag<Box<P> > { typedef box_tag type; }; \
    template<typename P> struct point_type<Box<P> > { typedef P type; };

#define BOOST_GEOMETRY_REGISTER_BOX	(		Box,
			Point,
			MinCorner,
			MaxCorner
	)

Value:

namespace boost { namespace geometry { namespace traits {  \
    BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS(Box, Point) \
    BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS(Box, Point, MinCorner, MaxCorner) \
}}}

{box}

{BOOST_GEOMETRY_REGISTER_BOX, box} The box may contain template parameters, which must be specified then.

Parameters

Box	{Box}
Point	Point type on which box is based. Might be two or three-dimensional
MinCorner	minimum corner (should be public member or method)
MaxCorner	maximum corner (should be public member or method)

{ [heading Example] [register_box] [register_box_output] }

#define BOOST_GEOMETRY_REGISTER_BOX_2D_4VALUES	(		Box,
			Point,
			Left,
			Bottom,
			Right,
			Top
	)

Value:

namespace boost { namespace geometry { namespace traits {  \
    BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS(Box, Point) \
    BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS_4VALUES(Box, Point, Left, Bottom, Right, Top) \
}}}

{box}

{BOOST_GEOMETRY_REGISTER_BOX_2D_4VALUES, box}

Parameters

Box	{Box}
Point	Point type reported as point_type by box. Must be two dimensional. Note that these box tyeps do not contain points, but they must have a related point_type
Left	Left side (must be public member or method)
Bottom	Bottom side (must be public member or method)
Right	Right side (must be public member or method)
Top	Top side (must be public member or method)

{ [heading Example] [register_box_2d_4values] [register_box_2d_4values_output] }

#define BOOST_GEOMETRY_REGISTER_BOX_TEMPLATED	(		Box,
			MinCorner,
			MaxCorner
	)

Value:

namespace boost { namespace geometry { namespace traits {  \
    BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_TRAITS_TEMPLATED(Box) \
    BOOST_GEOMETRY_DETAIL_SPECIALIZE_BOX_ACCESS_TEMPLATED(Box, MinCorner, MaxCorner) \
}}}

{box}

{BOOST_GEOMETRY_REGISTER_BOX_TEMPLATED, box} {box, point}

Parameters

Box	{Box}
MinCorner	minimum corner (should be public member or method)
MaxCorner	maximum corner (should be public member or method)

{ [heading Example] [register_box_templated] [register_box_templated_output] }