rcContext Class Reference

#include <Recast.h>

Public Member Functions
	rcContext (bool state=true)
virtual	~rcContext ()
void	enableLog (bool state)
void	resetLog ()
	Clears all log entries. More...
void	log (const rcLogCategory category, const char *format,...)
void	enableTimer (bool state)
void	resetTimers ()
	Clears all peformance timers. (Resets all to unused.) More...
void	startTimer (const rcTimerLabel label)
void	stopTimer (const rcTimerLabel label)
int	getAccumulatedTime (const rcTimerLabel label) const

Protected Member Functions
virtual void	doResetLog ()
	Clears all log entries. More...
virtual void	doLog (const rcLogCategory, const char *, const int)
virtual void	doResetTimers ()
	Clears all timers. (Resets all to unused.) More...
virtual void	doStartTimer (const rcTimerLabel)
virtual void	doStopTimer (const rcTimerLabel)
virtual int	doGetAccumulatedTime (const rcTimerLabel) const

Protected Attributes
bool	m_logEnabled
	True if logging is enabled. More...
bool	m_timerEnabled
	True if the performance timers are enabled. More...

Detailed Description

Provides an interface for optional logging and performance tracking of the Recast build process.

This class does not provide logging or timer functionality on its own. Both must be provided by a concrete implementation by overriding the protected member functions. Also, this class does not provide an interface for extracting log messages. (Only adding them.) So concrete implementations must provide one.

If no logging or timers are required, just pass an instance of this class through the Recast build process.

Constructor & Destructor Documentation

rcContext::rcContext ( bool  state = true )

inline

Contructor.

Parameters

[in]

state

TRUE if the logging and performance timers should be enabled. [Default: true]

: m_logEnabled(state), m_timerEnabled(state) {}

virtual rcContext::~rcContext ( )

inlinevirtual

{}

Member Function Documentation

virtual int rcContext::doGetAccumulatedTime ( const rcTimerLabel  ) const

inlineprotectedvirtual

Returns the total accumulated time of the specified performance timer.

Parameters

[in]

label

The category of the timer.

Returns

The accumulated time of the timer, or -1 if timers are disabled or the timer has never been started.

{ return -1; }

Here is the caller graph for this function:

virtual void rcContext::doLog ( const rcLogCategory  , const char *  , const int    )

inlineprotectedvirtual

Logs a message.

Parameters

[in]	category	The category of the message.
[in]	msg	The formatted message.
[in]	len	The length of the formatted message.

{}

Here is the caller graph for this function:

virtual void rcContext::doResetLog ( )

inlineprotectedvirtual

Clears all log entries.

{}

Here is the caller graph for this function:

virtual void rcContext::doResetTimers ( )

inlineprotectedvirtual

Clears all timers. (Resets all to unused.)

{}

Here is the caller graph for this function:

virtual void rcContext::doStartTimer ( const rcTimerLabel  )

inlineprotectedvirtual

Starts the specified performance timer.

Parameters

[in]

label

The category of timer.

{}

Here is the caller graph for this function:

virtual void rcContext::doStopTimer ( const rcTimerLabel  )

inlineprotectedvirtual

Stops the specified performance timer.

Parameters

[in]

label

The category of the timer.

{}

Here is the caller graph for this function:

void rcContext::enableLog ( bool  state )

inline

Enables or disables logging.

Parameters

[in]

state

TRUE if logging should be enabled.

{ m_logEnabled = state; }

void rcContext::enableTimer ( bool  state )

inline

Enables or disables the performance timers.

Parameters

[in]

state

TRUE if timers should be enabled.

{ m_timerEnabled = state; }

int rcContext::getAccumulatedTime ( const rcTimerLabel  label ) const

inline

Returns the total accumulated time of the specified performance timer.

Parameters

label

The category of the timer.

Returns

The accumulated time of the timer, or -1 if timers are disabled or the timer has never been started.

{ return m_timerEnabled ? doGetAccumulatedTime(label) : -1; }

Here is the call graph for this function:

void rcContext::log	(	const rcLogCategory	category,
		const char *	format,
			...
	)

Logs a message.

Parameters

[in]	category	The category of the message.
[in]	format	The message.

Example:

// Where ctx is an instance of rcContext and filepath is a char array.
ctx->log(RC_LOG_ERROR, "buildTiledNavigation: Could not load '%s'", filepath);

{
 if (!m_logEnabled)
 return;
 static const int MSG_SIZE = 512;
 char msg[MSG_SIZE];
 va_list ap;
 va_start(ap, format);
 int len = vsnprintf(msg, MSG_SIZE, format, ap);
 if (len >= MSG_SIZE)
 {
 len = MSG_SIZE-1;
 msg[MSG_SIZE-1] = '\0';
 }
 va_end(ap);
 doLog(category, msg, len);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void rcContext::resetLog ( )

inline

Clears all log entries.

{ if (m_logEnabled) doResetLog(); }

Here is the call graph for this function:

void rcContext::resetTimers ( )

inline

Clears all peformance timers. (Resets all to unused.)

{ if (m_timerEnabled) doResetTimers(); }

Here is the call graph for this function:

void rcContext::startTimer ( const rcTimerLabel  label )

inline

Starts the specified performance timer.

Parameters

label

The category of timer.

{ if (m_timerEnabled) doStartTimer(label); }

Here is the call graph for this function:

Here is the caller graph for this function:

void rcContext::stopTimer ( const rcTimerLabel  label )

inline

Stops the specified performance timer.

Parameters

label

The category of the timer.

{ if (m_timerEnabled) doStopTimer(label); }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool rcContext::m_logEnabled

protected

True if logging is enabled.

bool rcContext::m_timerEnabled

protected

True if the performance timers are enabled.

---

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

• dep/recastnavigation/Recast/Include/Recast.h
• dep/recastnavigation/Recast/Source/Recast.cpp