mx::Rect Struct Reference

#include <mxtype.h>

List of all members.

Public Member Functions
	Rect ()
	Rect (SDL_Rect &rc)
	Rect (SDL_Rect *rc)
	Rect (int x, int y, int width, int height)
	Rect (const Rect &r)
	Rect (const Point &p, const Size &s)
const int	width () const
const int	height () const
const int	x () const
const int	y () const
const bool	pointInRect (Point p) const
	operator SDL_Rect ()
Public Attributes
Point	point
Size	rsize

---

Detailed Description

Rectangle structure, holds a Point and a Size, for x,y,width,height

Definition at line 63 of file mxtype.h.

---

Constructor & Destructor Documentation

mx::Rect::Rect

(

)

[inline]

default constructor

Definition at line 69 of file mxtype.h.

{ }

mx::Rect::Rect

(

SDL_Rect &

rc

)

[inline]

Constructor

Parameters:

rc

takes a SDL_Rect and fills in point and rsize

Definition at line 73 of file mxtype.h.

: point(rc.x, rc.y) , rsize(rc.w, rc.h) {}

mx::Rect::Rect

(

SDL_Rect *

rc

)

[inline]

Constructor

Parameters:

rc

takes a Pointer to a SDL_Rect and sets point and rsize

Definition at line 77 of file mxtype.h.

References point, and rsize.

                {
                        if(rc == 0) return;
                        point = mx::Point(rc->x, rc->y);
                        rsize = mx::Size(rc->w, rc->h);
                }

mx::Rect::Rect	(	int	x,
		int	y,
		int	width,
		int	height
	)			[inline]

Constructor sets the rect from four integer's.

Parameters:

	x	x coordinate
	y	y coordinate
	width	width size
	height	height size

Definition at line 90 of file mxtype.h.

: point(x,y), rsize(width, height) {}

mx::Rect::Rect

(

const Rect &

r

)

[inline]

Copy constructor sets this Rect's values from another Rect

Parameters:

r

Rectangle to set from

Definition at line 94 of file mxtype.h.

: point(r.point), rsize(r.rsize)  {}

mx::Rect::Rect	(	const Point &	p,
		const Size &	s
	)			[inline]

Constructor taking a Point and a Size

Parameters:

	p	Point for X,Y
	s	for Size width,height

Definition at line 99 of file mxtype.h.

: point(p), rsize(s) {}

---

Member Function Documentation

const int mx::Rect::height

(

)

const [inline]

height of the Rect

Returns:

returns height

Definition at line 108 of file mxtype.h.

References mx::Size::height, and rsize.

Referenced by mx::mxSurface::copySurface().

{ return rsize.height; }

mx::Rect::operator SDL_Rect

(

)

[inline]

operator SDL_Rect so Rect can be used as a SDL_Rect in expressions

Returns:

returns SDL_Rect

Definition at line 130 of file mxtype.h.

References mx::Size::height, point, rsize, mx::Size::width, mx::Point::x, and mx::Point::y.

                                     {
                        SDL_Rect rc = { point.x, point.y, rsize.width, rsize.height };
                        return rc;
                }

const bool mx::Rect::pointInRect

(

Point

p

)

const [inline]

is this Point inside this Rect ?

Parameters:

p

the Point

Returns:

true if it is, false if is not

Definition at line 122 of file mxtype.h.

References mx::Size::height, point, rsize, mx::Size::width, mx::Point::x, and mx::Point::y.

                {
                        if(p.x >= point.x && p.x <= point.x+rsize.width && p.y >= point.y && p.y <= point.y+rsize.height) return true;
                        return false;
                }

const int mx::Rect::width

(

)

const [inline]

width of the Rect

Returns:

returns width

Definition at line 104 of file mxtype.h.

References rsize, and mx::Size::width.

Referenced by mx::mxSurface::copySurface().

{ return rsize.width; }

const int mx::Rect::x

(

)

const [inline]

x of the Rect

Returns:

returns the x coordinate

Definition at line 112 of file mxtype.h.

References point, and mx::Point::x.

Referenced by mx::mxSurface::copySurface().

{ return point.x; }

const int mx::Rect::y

(

)

const [inline]

y of the Rect

Returns:

returns the y coordinate

Definition at line 116 of file mxtype.h.

References point, and mx::Point::y.

Referenced by mx::mxSurface::copySurface().

{ return point.y; }

---

Member Data Documentation

Point mx::Rect::point

Point variable for X,Y

Definition at line 65 of file mxtype.h.

Referenced by operator SDL_Rect(), pointInRect(), Rect(), x(), and y().

Size mx::Rect::rsize

Size variable for size width,height

Definition at line 67 of file mxtype.h.

Referenced by height(), operator SDL_Rect(), pointInRect(), Rect(), and width().

---

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

• mxtype.h