Public API Reference

                 

---

csSubRectangles Class Reference
[Geometry utilities]

A class managing allocations of sub-rectangles. More...

#include <subrec.h>

List of all members.

Public Methods
	csSubRectangles (const csRect &region)
	Allocate a new empty region with the given size. More...
	~csSubRectangles ()
	Remove this region and sub-regions. More...
const csRect &	GetRectangle () const
	Get the rectangle for this region. More...
void	Clear ()
	Free all rectangles in this region. More...
bool	Alloc (int w, int h, csRect &rect)
	Allocate a new rectangle. More...
void	Dump ()
	For debugging: dump all free rectangles. More...
Protected Attributes
csRect	region
	Dimensions of this region. More...
csSubRect *	first
	First empty region. More...

---

Detailed Description

A class managing allocations of sub-rectangles.

i.e. this class represents a rectangular region from which a client can allocate smaller rectangles until the region is full.

Definition at line 51 of file subrec.h.

---

Constructor & Destructor Documentation

csSubRectangles::csSubRectangles (  const csRect &    region )

Allocate a new empty region with the given size.

csSubRectangles::~csSubRectangles (    )

Remove this region and sub-regions.

---

Member Function Documentation

bool csSubRectangles::Alloc (  int    w, int    h, csRect &    rect )

Allocate a new rectangle. Return false if there is no room

void csSubRectangles::Clear (    )

Free all rectangles in this region.

void csSubRectangles::Dump (    )

For debugging: dump all free rectangles.

const csRect& csSubRectangles::GetRectangle (    )  const [inline]

Get the rectangle for this region. Definition at line 67 of file subrec.h.

---

Member Data Documentation

csSubRect* csSubRectangles::first [protected]

First empty region. Definition at line 57 of file subrec.h.

csRect csSubRectangles::region [protected]

Dimensions of this region. Definition at line 55 of file subrec.h.

---

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

• subrec.h

---