1. Epic GamesDeveloper
  3. rcContext

rcContext

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

Unreal Engine C++ API Reference > Runtime > Navmesh > Recast

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

  Type 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

  Type Name Description
Public function  

rcContext ( bool state
)

 Contructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type 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 Clears all log entries.
Protected function Virtual void 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 Clears all log entries.
Public function void 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page