Base class for UI-centric scenes. More...

#include <UiScene.h>

Inheritance diagram for HoverRace::Client::UiScene:

Public Member Functions
	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...

Protected Member Functions
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
virtual void	Advance (Util::OS::timestamp_t tick)

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...

Private Types
using	SUPER = Scene

Private Member Functions
void	OnAction ()

void	OnNav (Control::Nav &nav)

Private Attributes
boost::signals2::scoped_connection	focusRelConn

boost::signals2::scoped_connection	focusReqConn

std::shared_ptr< Display::UiViewModel >	focusRoot

bool	needsLayout

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 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

Base class for UI-centric scenes.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Client::UiScene::SUPER = Scene

private

Constructor & Destructor Documentation

HoverRace::Client::UiScene::UiScene ( const std::string & name = "" )

inline

virtual HoverRace::Client::UiScene::~UiScene ( )

inlinevirtual

Member Function Documentation

void HoverRace::Client::UiScene::AttachController	(	Control::InputEventController &	controller,
		ConnList &	conns
	)

overridevirtual

Configure the controller mappings.

This is called whenever the scene becomes the foreground scene or the controller config needs to be rebuilt.

Parameters

controller	The current controller being used. It can be assumed that the controller's action mappings have been cleared.
conns	The list to manage connections while the input is attached. Any connections added to this list will be automatically disconnected when then the input is detached.

Implements HoverRace::Client::Scene.

Reimplemented in HoverRace::Client::HoverScript::ConsoleScene.

void HoverRace::Client::UiScene::DetachController	(	Control::InputEventController &	controller,
		ConnList &	conns
	)

inlineoverridevirtual

Remove the controller mappings.

Parameters

controller	The current controller being used. It can be assumed that the controller's action mappings have been cleared.
conns	The same connection list passed to AttachController.

Implements HoverRace::Client::Scene.

Reimplemented in HoverRace::Client::HoverScript::ConsoleScene.

bool HoverRace::Client::UiScene::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.

virtual void HoverRace::Client::UiScene::Layout ( )

inlineprotectedvirtual

Adjust the size and position of any child elements.

Subclasses with child elements that are relative to each other should override this function.

This is called automatically during the PrepareRender() phase if RequestLayout() has been called. It is also called the first time PrepareRender() is invoked. After this function is called, it will not be called again until another call to RequestLayout().

Reimplemented in HoverRace::Client::Module::FlexGridModule, HoverRace::Client::GameScene, HoverRace::Client::StatusOverlayScene, HoverRace::Client::HoverScript::ConsoleScene, HoverRace::Client::MessageScene, and HoverRace::Client::MainMenuScene.

void HoverRace::Client::UiScene::OnAction ( )

private

void HoverRace::Client::UiScene::OnNav ( Control::Nav & nav )

private

void HoverRace::Client::UiScene::PrepareRender ( )

inlineoverridevirtual

Reimplemented from HoverRace::Client::Scene.

Reimplemented in HoverRace::Client::HoverScript::ConsoleScene.

void HoverRace::Client::UiScene::Render ( )

inlineoverridevirtual

Implements HoverRace::Client::Scene.

Reimplemented in HoverRace::Client::HoverScript::ConsoleScene.

void HoverRace::Client::UiScene::RequestLayout ( )

inlineprotected

Indicate that the current layout is out-of-date and needs to be adjusted.

Subclasses should call this when a property changes that affects the layout (such as the size).

void HoverRace::Client::UiScene::SetFocusRoot ( std::shared_ptr< Display::UiViewModel > root )

protected

Set the widget used as the root for all focus management.

Widgets which are not under this widget will not be able to receive input focus.

Parameters

root	The root widget.

Member Data Documentation

boost::signals2::scoped_connection HoverRace::Client::UiScene::focusRelConn

private

boost::signals2::scoped_connection HoverRace::Client::UiScene::focusReqConn

private

std::shared_ptr<Display::UiViewModel> HoverRace::Client::UiScene::focusRoot

private

bool HoverRace::Client::UiScene::needsLayout

private

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation