HoverRace::Client::DebugScene Class Reference

Overlay for displaying debug information. More...

#include <DebugScene.h>

Inheritance diagram for HoverRace::Client::DebugScene:

Public Member Functions
	DebugScene (Display::Display &display, GameDirector &director)
virtual	~DebugScene ()
void	Advance (Util::OS::timestamp_t tick) override
bool	IsMouseCursorEnabled () const override
	Determine if the mouse cursor is enabled for this scene. More...
void	PrepareRender () override
void	Render () override
Public Member Functions inherited from HoverRace::Client::UiScene
	UiScene (const std::string &name="")
virtual	~UiScene ()
void	AttachController (Control::InputEventController &controller, ConnList &conns) override
	Configure the controller mappings. More...
void	DetachController (Control::InputEventController &, ConnList &) override
	Remove the controller mappings. More...
bool	IsMouseCursorEnabled () const override
	Determine if the mouse cursor is enabled for this scene. More...
void	PrepareRender () override
void	Render () override
Public Member Functions inherited from HoverRace::Client::Scene
	Scene (const std::string &name="Unnamed Scene")
	Constructor. More...
virtual	~Scene ()
void	AdvanceScene (Util::OS::timestamp_t tick)
void	AttachInput (Control::InputEventController &controller)
	Attach the user input to the scene. More...
void	DetachInput (Control::InputEventController &controller)
	Detach the user input from the scene. More...
const std::string &	GetName () const
	Retrieve the name of the scene. More...
Phase	GetPhase () const
State	GetState () const
bool	MoveToBackground ()
	Signal that the scene is moving into the background. More...
bool	MoveToForeground ()
	Signal that the scene is moving into the foreground. More...
virtual void	OnScenePushed ()
	Called when the scene is actually pushed to the stage. More...
Scene &	operator= (const Scene &)=delete
virtual std::ostream &	OutputDebugText (std::ostream &oss) const
	Output a stream of debug information describing this scene. More...
void	PrepareScene ()
void	RenderScene ()
bool	SetPhase (Phase phase)
	Switch to another phase. More...

Private Types
using	SUPER = UiScene

Private Attributes
std::unique_ptr< Display::FillBox >	debugBox
std::unique_ptr< Display::ActiveText >	debugLbl
GameDirector &	director
Util::OS::timestamp_t	prevUpdateTick

Additional Inherited Members
Public Types inherited from HoverRace::Client::Scene
enum	Phase {   Phase::INITIALIZING, Phase::STARTING, Phase::RUNNING, Phase::STOPPING,   Phase::STOPPED }
enum	State {   State::INITIALIZING, State::BACKGROUND, State::RAISING, State::FOREGROUND,   State::LOWERING }
Protected Member Functions inherited from HoverRace::Client::UiScene
virtual void	Layout ()
	Adjust the size and position of any child elements. More...
void	RequestLayout ()
	Indicate that the current layout is out-of-date and needs to be adjusted. More...
void	SetFocusRoot (std::shared_ptr< Display::UiViewModel > root)
	Set the widget used as the root for all focus management. More...
Protected Member Functions inherited from HoverRace::Client::Scene
Util::OS::timestamp_t	GetPhaseDuration (Util::OS::timestamp_t curTime=Util::OS::Time())
	Calculate how much time we've spent in the current phase. More...
Util::OS::timestamp_t	GetStartingPhaseTime ()
	Return how long the starting phase lasted. More...
Util::OS::timestamp_t	GetStateDuration (Util::OS::timestamp_t curTime=Util::OS::Time())
	Calculate how much time we've spent in the current state. More...
virtual void	OnPhaseChanged (Phase oldPhase)
	Fired immediately after entering a new phase. More...
virtual void	OnPhaseTransition (double progress)
	Fired during the starting and stopping phases, if SetPhaseTransitionDuration() was set. More...
virtual void	OnStateChanged (State oldState)
	Fired immediately after entering a new state. More...
virtual void	OnStateTransition (double progress)
	Fired during the raising and lowering states, if SetStateTransitionDuration() was set. More...
void	SetPhaseTransitionDuration (Util::OS::timestamp_t ms)
	Set the maximum duration of the starting or stopping phases. More...
void	SetStateTransitionDuration (Util::OS::timestamp_t ms)
	Set the maximum duration of the raising or lowering state. More...
Protected Attributes inherited from HoverRace::Client::Scene
std::shared_ptr< Util::Profiler >	advanceProfiler
std::shared_ptr< Util::Profiler >	prepareProfiler
std::shared_ptr< Util::Profiler >	renderProfiler
std::shared_ptr< Util::Profiler >	rootProfiler

Detailed Description

Overlay for displaying debug information.

Author

Michael Imamura

Member Typedef Documentation

using HoverRace::Client::DebugScene::SUPER = UiScene

private

Constructor & Destructor Documentation

HoverRace::Client::DebugScene::DebugScene	(	Display::Display &	display,
		GameDirector &	director
	)

HoverRace::Client::DebugScene::~DebugScene ( )

virtual

Member Function Documentation

void HoverRace::Client::DebugScene::Advance ( Util::OS::timestamp_t  tick )

overridevirtual

Reimplemented from HoverRace::Client::Scene.

bool HoverRace::Client::DebugScene::IsMouseCursorEnabled ( ) const

inlineoverridevirtual

Determine if the mouse cursor is enabled for this scene.

Returns

true if the cursor should be shown, false if it should be hidden.

Implements HoverRace::Client::Scene.

void HoverRace::Client::DebugScene::PrepareRender ( )

overridevirtual

Reimplemented from HoverRace::Client::Scene.

void HoverRace::Client::DebugScene::Render ( )

overridevirtual

Implements HoverRace::Client::Scene.

Member Data Documentation

std::unique_ptr<Display::FillBox> HoverRace::Client::DebugScene::debugBox

private

std::unique_ptr<Display::ActiveText> HoverRace::Client::DebugScene::debugLbl

private

GameDirector& HoverRace::Client::DebugScene::director

private

Util::OS::timestamp_t HoverRace::Client::DebugScene::prevUpdateTick

private

---

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

• DebugScene.h
• DebugScene.cpp