Base class for full-scene menus and the like. More...

#include <FormScene.h>

Inheritance diagram for HoverRace::Client::FormScene:

Public Member Functions
	FormScene (Display::Display &display, const std::string &name="")

virtual	~FormScene ()

void	AttachController (Control::InputEventController &controller, ConnList &conns) override
	Configure the controller mappings. 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...

Protected Member Functions
Display::Container *	GetRoot () const

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

Protected Attributes
Display::Display &	display

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

Private Types
using	SUPER = UiScene

Private Member Functions
void	OnMouseMoved (const Vec2 &pos)

bool	OnMousePressed (const Control::Mouse::Click &click)

bool	OnMouseReleased (const Control::Mouse::Click &click)

bool	OnMouseScrolled (const Control::Mouse::Scroll &scroll)

Private Attributes
std::shared_ptr< Display::Container >	root

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 }

Detailed Description

Base class for full-scene menus and the like.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Client::FormScene::SUPER = UiScene

private

Constructor & Destructor Documentation

HoverRace::Client::FormScene::FormScene	(	Display::Display &	display,
		const std::string &	name = `""`
	)

HoverRace::Client::FormScene::~FormScene ( )

virtual

Member Function Documentation

void HoverRace::Client::FormScene::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::TextEditScene, HoverRace::Client::TestLabScene::LabModule, HoverRace::Client::MessageScene, and HoverRace::Client::PauseMenuScene.

Display::Container* HoverRace::Client::FormScene::GetRoot ( ) const

inlineprotected

void HoverRace::Client::FormScene::OnMouseMoved ( const Vec2 & pos )

private

bool HoverRace::Client::FormScene::OnMousePressed ( const Control::Mouse::Click & click )

private

bool HoverRace::Client::FormScene::OnMouseReleased ( const Control::Mouse::Click & click )

private

bool HoverRace::Client::FormScene::OnMouseScrolled ( const Control::Mouse::Scroll & scroll )

private