rcContext

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

Windows
MacOS
Linux

References

Module

Navmesh

Header

/Engine/Source/Runtime/Navmesh/Public/Recast/Recast.h

Include

#include "Recast/Recast.h"

Syntax

class rcContext

Remarks

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.

Variables

Name Description

Protected variable

bool

 

m_logEnabled

True if logging is enabled.

Protected variable

bool

 

m_timerEnabled

True if the performance timers are enabled.

Constructors

Name Description

Public function

rcContext

(
    bool state
)

Contructor.

Destructors

Name Description

Public function Virtual

~rcContext()

Functions

Name Description

Protected function Virtual Const

int

 

doGetAccumulatedTime

(
    const rcTimerLabel
)

Returns the total accumulated time of the specified performance timer.

Protected function Virtual

void

 

doLog

(
    const rcLogCategory,
    const char*,
    const int
)

Logs a message.

Protected function Virtual

void

 

doResetLog()

Clears all log entries.

Protected function Virtual

void

 

doResetTimers()

Clears all timers. (Resets all to unused.)

Protected function Virtual

void

 

doStartTimer

(
    const rcTimerLabel
)

Starts the specified performance timer.

Protected function Virtual

void

 

doStopTimer

(
    const rcTimerLabel
)

Stops the specified performance timer.

Public function

void

 

enableLog

(
    bool state
)

Enables or disables logging.

Public function

void

 

enableTimer

(
    bool state
)

Enables or disables the performance timers.

Public function Const

int

 

getAccumulatedTime

(
    const rcTimerLabel label
)

Returns the total accumulated time of the specified performance timer.

Public function

void

 

log

(
    const rcLogCategory category,
    const char* format,
    ...
)

Logs a message.

Public function

void

 

resetLog()

Clears all log entries.

Public function

void

 

resetTimers()

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

Public function

void

 

startTimer

(
    const rcTimerLabel label
)

Starts the specified performance timer.

Public function

void

 

stopTimer

(
    const rcTimerLabel label
)

Stops the specified performance timer.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss