sge::math::basic_rect< T > Class Template Reference

#include <rect.hpp>

List of all members.

Public Types
typedef T	value_type
typedef std::size_t	size_type
typedef T &	reference
typedef const T &	const_reference
typedef math::basic_vector< T, 2 >	point_type
typedef math::basic_dim< T, 2 >	dim_type
Public Member Functions
	basic_rect (value_type const &left=value_type(), value_type const &top=value_type(), value_type const &right=value_type(), value_type const &bottom=value_type())
	basic_rect (point_type const &pos, dim_type const &sz)
	basic_rect (dim_type const &sz)
value_type	w () const
value_type	h () const
point_type const	pos () const
dim_type const	dim () const
size_type	area () const
const_reference	left () const
const_reference	top () const
const_reference	right () const
const_reference	bottom () const
reference	left ()
reference	top ()
reference	right ()
reference	bottom ()

---

Detailed Description

template<typename T>
class sge::math::basic_rect< T >

Attention:

To use basic_rect's functions you have to include <sge/math/rect_impl.hpp>!

---

Member Typedef Documentation

template<typename T>

typedef T sge::math::basic_rect< T >::value_type

template<typename T>

typedef std::size_t sge::math::basic_rect< T >::size_type

template<typename T>

typedef T& sge::math::basic_rect< T >::reference

template<typename T>

typedef const T& sge::math::basic_rect< T >::const_reference

template<typename T>

typedef math::basic_vector<T,2> sge::math::basic_rect< T >::point_type

template<typename T>

typedef math::basic_dim<T,2> sge::math::basic_rect< T >::dim_type

---

Constructor & Destructor Documentation

template<typename T>

sge::math::basic_rect< T >::basic_rect	(	value_type const &	left = value_type(),
		value_type const &	top = value_type(),
		value_type const &	right = value_type(),
		value_type const &	bottom = value_type()
	)			[inline, explicit]

Default constructs all parameters which are not given(sets them to zero for arithmetic built-in types)

Exceptions:

sge::exception

If right is smaller than left or bottom is smaller than top

template<typename T>

sge::math::basic_rect< T >::basic_rect	(	point_type const &	pos,
		dim_type const &	sz
	)			[inline]

Exceptions:

sge::exception

If right is smaller than left or bottom is smaller than top

template<typename T>

sge::math::basic_rect< T >::basic_rect

(

dim_type const &

sz

)

[inline, explicit]

Same as basic_rect(point_type(0,0),sz)

---

Member Function Documentation

template<typename T>

sge::math::basic_rect< T >::value_type sge::math::basic_rect< T >::w

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::value_type sge::math::basic_rect< T >::h

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::point_type const sge::math::basic_rect< T >::pos

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::dim_type const sge::math::basic_rect< T >::dim

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::size_type sge::math::basic_rect< T >::area

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::const_reference sge::math::basic_rect< T >::left

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::const_reference sge::math::basic_rect< T >::top

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::const_reference sge::math::basic_rect< T >::right

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::const_reference sge::math::basic_rect< T >::bottom

(

)

const [inline]

template<typename T>

sge::math::basic_rect< T >::reference sge::math::basic_rect< T >::left

(

)

[inline]

template<typename T>

sge::math::basic_rect< T >::reference sge::math::basic_rect< T >::top

(

)

[inline]

template<typename T>

sge::math::basic_rect< T >::reference sge::math::basic_rect< T >::right

(

)

[inline]

template<typename T>

sge::math::basic_rect< T >::reference sge::math::basic_rect< T >::bottom

(

)

[inline]

---

The documentation for this class was generated from the following files:

• include/sge/math/rect.hpp
• include/sge/math/rect_impl.hpp