GHOST_Rect Class Reference

#include <GHOST_Rect.h>

List of all members.

Public Member Functions
	GHOST_Rect (GHOST_TInt32 l=0, GHOST_TInt32 t=0, GHOST_TInt32 r=0, GHOST_TInt32 b=0)
	GHOST_Rect (const GHOST_Rect &r)
virtual	~GHOST_Rect ()
virtual GHOST_TInt32	getWidth () const
virtual GHOST_TInt32	getHeight () const
virtual void	set (GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b)
virtual bool	isEmpty () const
virtual bool	isValid () const
virtual void	inset (GHOST_TInt32 i)
virtual void	unionRect (const GHOST_Rect &r)
virtual void	unionPoint (GHOST_TInt32 x, GHOST_TInt32 y)
virtual void	wrapPoint (GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs)
virtual bool	isInside (GHOST_TInt32 x, GHOST_TInt32 y) const
virtual GHOST_TVisibility	getVisibility (GHOST_Rect &r) const
virtual void	setCenter (GHOST_TInt32 cx, GHOST_TInt32 cy)
virtual void	setCenter (GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h)
virtual bool	clip (GHOST_Rect &r) const
Public Attributes
GHOST_TInt32	m_l
GHOST_TInt32	m_t
GHOST_TInt32	m_r
GHOST_TInt32	m_b

---

Detailed Description

Implements rectangle functionality. The four extreme coordinates are stored as left, top, right and bottom. To be valid, a rectangle should have a left coordinate smaller than or equal to right. To be valid, a rectangle should have a top coordinate smaller than or equal to bottom.

Author:

Maarten Gribnau

Date:

May 10, 2001

Definition at line 48 of file GHOST_Rect.h.

---

Constructor & Destructor Documentation

GHOST_Rect::GHOST_Rect	(	GHOST_TInt32	l = 0,
		GHOST_TInt32	t = 0,
		GHOST_TInt32	r = 0,
		GHOST_TInt32	b = 0
	)		[inline]

Constructs a rectangle with the given values.

Parameters:

l	requested left coordinate of the rectangle
t	requested top coordinate of the rectangle
r	requested right coordinate of the rectangle
b	requested bottom coordinate of the rectangle

Definition at line 58 of file GHOST_Rect.h.

GHOST_Rect::GHOST_Rect

(

const GHOST_Rect &

r

)

[inline]

Copy constructor.

Parameters:

r	rectangle to copy

Definition at line 65 of file GHOST_Rect.h.

virtual GHOST_Rect::~GHOST_Rect

(

)

[inline, virtual]

Destructor.

Definition at line 71 of file GHOST_Rect.h.

---

Member Function Documentation

bool GHOST_Rect::clip

(

GHOST_Rect &

r

)

const [virtual]

Clips a rectangle. Updates the rectangle given such that it will fit within this one. This can result in an empty rectangle.

Parameters:

r	the rectangle to clip

Returns:

whether clipping has occurred

Definition at line 120 of file GHOST_Rect.cpp.

References m_b, m_l, m_r, and m_t.

GHOST_TInt32 GHOST_Rect::getHeight

(

)

const [inline, virtual]

Access to rectangle height.

Returns:

height of the rectangle

Definition at line 202 of file GHOST_Rect.h.

References m_b, and m_t.

Referenced by GHOST_SetCursorGrab(), GPG_Canvas::GPG_Canvas(), inset(), isEmpty(), GPG_Application::processEvent(), GHOST_WindowWin32::setClientHeight(), GHOST_WindowCarbon::setClientHeight(), GHOST_WindowCarbon::setClientSize(), GHOST_WindowWin32::setClientSize(), GHOST_WindowWin32::setClientWidth(), GHOST_WindowCarbon::setClientWidth(), View(), and wrapPoint().

GHOST_TVisibility GHOST_Rect::getVisibility

(

GHOST_Rect &

r

)

const [virtual]

Returns whether the rectangle is inside this rectangle.

Parameters:

r	rectangle to test.

Returns:

visibility (not, partially or fully visible).

Definition at line 69 of file GHOST_Rect.cpp.

References GHOST_kFullyVisible, GHOST_kNotVisible, GHOST_kPartiallyVisible, isInside(), m_b, m_l, m_r, and m_t.

GHOST_TInt32 GHOST_Rect::getWidth

(

)

const [inline, virtual]

Access to rectangle width.

Returns:

width of the rectangle

Definition at line 197 of file GHOST_Rect.h.

References m_l, and m_r.

Referenced by GPG_Canvas::GPG_Canvas(), inset(), isEmpty(), GPG_Application::processEvent(), GHOST_WindowWin32::setClientHeight(), GHOST_WindowCarbon::setClientHeight(), GHOST_WindowCarbon::setClientSize(), GHOST_WindowWin32::setClientSize(), GHOST_WindowWin32::setClientWidth(), GHOST_WindowCarbon::setClientWidth(), View(), and wrapPoint().

void GHOST_Rect::inset

(

GHOST_TInt32

i

)

[virtual]

Grows (or shrinks the rectangle). The method avoids negative insets making the rectangle invalid

Parameters:

i	The amount of offset given to each extreme (negative values shrink the rectangle).

Definition at line 37 of file GHOST_Rect.cpp.

References getHeight(), getWidth(), i, m_b, m_l, m_r, and m_t.

bool GHOST_Rect::isEmpty

(

)

const [inline, virtual]

Returns whether this rectangle is empty. Empty rectangles are rectangles that have width==0 and/or height==0.

Returns:

boolean value (true==empty rectangle)

Definition at line 212 of file GHOST_Rect.h.

References getHeight(), and getWidth().

bool GHOST_Rect::isInside	(	GHOST_TInt32	x,
		GHOST_TInt32	y
	)		const [inline, virtual]

Returns whether the point is inside this rectangle. Point on the boundary is considered inside.

Parameters:

x	x-coordinate of point to test.
y	y-coordinate of point to test.

Returns:

boolean value (true if point is inside).

Definition at line 252 of file GHOST_Rect.h.

References m_b, m_l, and m_t.

Referenced by getVisibility().

bool GHOST_Rect::isValid

(

)

const [inline, virtual]

Returns whether this rectangle is valid. Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.

Returns:

boolean value (true==valid rectangle)

Definition at line 217 of file GHOST_Rect.h.

References m_b, m_l, m_r, and m_t.

void GHOST_Rect::set	(	GHOST_TInt32	l,
		GHOST_TInt32	t,
		GHOST_TInt32	r,
		GHOST_TInt32	b
	)		[inline, virtual]

Sets all members of the rectangle.

Parameters:

l	requested left coordinate of the rectangle
t	requested top coordinate of the rectangle
r	requested right coordinate of the rectangle
b	requested bottom coordinate of the rectangle

Definition at line 207 of file GHOST_Rect.h.

References m_b, m_l, m_r, and m_t.

void GHOST_Rect::setCenter	(	GHOST_TInt32	cx,
		GHOST_TInt32	cy
	)		[virtual]

Sets rectangle members. Sets rectangle members such that it is centered at the given location.

Parameters:

cx	requested center x-coordinate of the rectangle
cy	requested center y-coordinate of the rectangle

Definition at line 98 of file GHOST_Rect.cpp.

References m_b, m_l, m_r, and m_t.

void GHOST_Rect::setCenter	(	GHOST_TInt32	cx,
		GHOST_TInt32	cy,
		GHOST_TInt32	w,
		GHOST_TInt32	h
	)		[virtual]

Sets rectangle members. Sets rectangle members such that it is centered at the given location, with the width requested.

Parameters:

cx	requested center x-coordinate of the rectangle
cy	requested center y-coordinate of the rectangle
w	requested width of the rectangle
h	requested height of the rectangle

Definition at line 108 of file GHOST_Rect.cpp.

References m_b, m_l, m_r, m_t, and simple_enum_gen::w.

void GHOST_Rect::unionPoint	(	GHOST_TInt32	x,
		GHOST_TInt32	y
	)		[inline, virtual]

Grows the rectangle to included a point.

Parameters:

x	The x-coordinate of the point.
y	The y-coordinate of the point.

Definition at line 230 of file GHOST_Rect.h.

References m_b, m_l, m_r, and m_t.

void GHOST_Rect::unionRect

(

const GHOST_Rect &

r

)

[inline, virtual]

Does a union of the rectangle given and this rectangle. The result is stored in this rectangle.

Parameters:

r	The rectangle that is input for the union operation.

Definition at line 222 of file GHOST_Rect.h.

References m_b, m_l, m_r, and m_t.

void GHOST_Rect::wrapPoint	(	GHOST_TInt32 &	x,
		GHOST_TInt32 &	y,
		GHOST_TInt32	ofs
	)		[inline, virtual]

Grows the rectangle to included a point.

Parameters:

x	The x-coordinate of the point.
y	The y-coordinate of the point.

Definition at line 238 of file GHOST_Rect.h.

References getHeight(), getWidth(), m_b, m_l, m_r, m_t, and simple_enum_gen::w.

Referenced by GHOST_SystemCocoa::handleMouseEvent(), and GHOST_SystemWin32::processCursorEvent().

---

Member Data Documentation

GHOST_TInt32 GHOST_Rect::m_b

Bottom coordinate of the rectangle

Definition at line 187 of file GHOST_Rect.h.

Referenced by GHOST_WindowCarbon::activateDrawingContext(), clip(), GHOST_WindowSDL::getClientBounds(), GHOST_WindowWin32::getClientBounds(), GHOST_WindowX11::getClientBounds(), GHOST_WindowCarbon::getClientBounds(), getHeight(), getVisibility(), GHOST_WindowCarbon::getWindowBounds(), GHOST_WindowWin32::getWindowBounds(), GHOST_GetRectangle(), GHOST_SetCursorGrab(), GHOST_SystemCocoa::handleMouseEvent(), inset(), isInside(), isValid(), set(), setCenter(), unionPoint(), unionRect(), and wrapPoint().

GHOST_TInt32 GHOST_Rect::m_l

Left coordinate of the rectangle

Definition at line 181 of file GHOST_Rect.h.

Referenced by GHOST_WindowCarbon::activateDrawingContext(), clip(), GHOST_WindowSDL::getClientBounds(), GHOST_WindowWin32::getClientBounds(), GHOST_WindowX11::getClientBounds(), GHOST_WindowCarbon::getClientBounds(), GHOST_Window::getCursorGrabBounds(), getVisibility(), getWidth(), GHOST_WindowCarbon::getWindowBounds(), GHOST_WindowWin32::getWindowBounds(), GHOST_GetRectangle(), GHOST_SetCursorGrab(), GHOST_SystemCocoa::handleMouseEvent(), inset(), isInside(), isValid(), set(), setCenter(), GHOST_Window::setCursorGrab(), GHOST_WindowWin32::setWindowCursorGrab(), unionPoint(), unionRect(), and wrapPoint().

GHOST_TInt32 GHOST_Rect::m_r

Right coordinate of the rectangle

Definition at line 185 of file GHOST_Rect.h.

Referenced by GHOST_WindowCarbon::activateDrawingContext(), clip(), GHOST_WindowSDL::getClientBounds(), GHOST_WindowWin32::getClientBounds(), GHOST_WindowX11::getClientBounds(), GHOST_WindowCarbon::getClientBounds(), GHOST_Window::getCursorGrabBounds(), getVisibility(), getWidth(), GHOST_WindowCarbon::getWindowBounds(), GHOST_WindowWin32::getWindowBounds(), GHOST_GetRectangle(), GHOST_SetCursorGrab(), GHOST_SystemCocoa::handleMouseEvent(), inset(), isValid(), set(), setCenter(), GHOST_Window::setCursorGrab(), GHOST_WindowWin32::setWindowCursorGrab(), unionPoint(), unionRect(), and wrapPoint().

GHOST_TInt32 GHOST_Rect::m_t

Top coordinate of the rectangle

Definition at line 183 of file GHOST_Rect.h.

Referenced by GHOST_WindowCarbon::activateDrawingContext(), clip(), GHOST_WindowSDL::getClientBounds(), GHOST_WindowWin32::getClientBounds(), GHOST_WindowX11::getClientBounds(), GHOST_WindowCarbon::getClientBounds(), getHeight(), getVisibility(), GHOST_WindowCarbon::getWindowBounds(), GHOST_WindowWin32::getWindowBounds(), GHOST_GetRectangle(), GHOST_SetCursorGrab(), GHOST_SystemCocoa::handleMouseEvent(), inset(), isInside(), isValid(), set(), setCenter(), unionPoint(), unionRect(), and wrapPoint().

---

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

• GHOST_Rect.h
• GHOST_Rect.cpp