MityDSP::tcFrameBench Class Reference

Inheritance diagram for MityDSP::tcFrameBench:

List of all members.

Public Member Functions
	tcFrameBench (void)
	~tcFrameBench (void)
void	print (const char *fmt,...)
void	invalidate (tcRect &rect, tcRect *bckgrnd_redraw=NULL)
int	GetInvalidRegion (tcRect &rect)
tcView *	GetView (const char *apViewName)
Protected Attributes
LCK_Handle	mhLock
	MityDSP Lock Handle for thread safe invalidation.
tcRect	mcInvalidRect [5]
	the effecitive invalide region requiring painting.
int	mnNumActiveRects

---

Detailed Description

The tcFrameBench class provides an implementation of the ggui tcBench framwork class, which is responsible for managing all GUI objects and views in a ggui based system. The tcFrameBench implementation primarily is responsible for managing invalidation requests and provides hooks for debug print information.

This class is used internally by the tcGuiFramework class instantiations.

---

Constructor & Destructor Documentation

tcFrameBench::tcFrameBench

(

void

)

Constructor.

tcFrameBench::~tcFrameBench

(

void

)

Destructor (typically not reached)

---

Member Function Documentation

void tcFrameBench::print	(	const char *	fmt,
			...
	)			[virtual]

Debug method used to route error messages generated by the GGUI library (primariy during parsing of the skin.xml file) to the tcDspError::report() method provided by the MityDSP core library. See tcDspError for further information.

Parameters:

[in]

fmt

printf style format for following arguments.

Implements MityDSP::tcBench.

void tcFrameBench::invalidate	(	tcRect &	rect,
		tcRect *	bckgrnd_redraw = NULL
	)			[virtual]

Main screen invalidation routine.

In it's current implementation, the main Framework manages a single invalidation rectangle. For GUI events that generate multiple invalidation areas within on paint event, the rectangles are effectively or'ed together.

Parameters:

[in]	rect	rectangular area (in screen coordinates) to be invalidated
[in]	bckgrnd_redraw	currently not used.

Note:

this routine is thread safe.

Implements MityDSP::tcBench.

int tcFrameBench::GetInvalidRegion

(

tcRect &

rect

)

Acquires the final invalid rectangle that has been invalidated for the given refresh period. This routine clears the working invalid rectangle update return, so subsequent invalidations start from an empty (0 width/hieght) rectangle.

Parameters:

[out]

rect

final rectangle structure to be filled in.

Note:

this routine is thread safe.

tcView* MityDSP::tcFrameBench::GetView

(

const char *

apViewName

)

[inline]

Utility method to get a named XML view (or screen).

Parameters:

apViewName

name of the view to acquire

Returns:

valid view or NULL if no view with specified name is found.

---

Member Data Documentation

LCK_Handle MityDSP::tcFrameBench::mhLock [protected]

MityDSP Lock Handle for thread safe invalidation.

tcRect MityDSP::tcFrameBench::mcInvalidRect[5] [protected]

the effecitive invalide region requiring painting.

int MityDSP::tcFrameBench::mnNumActiveRects [protected]