HoverRace  2.0
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
HoverRace::Client::MainMenuScene Class Reference

The title scene. More...

#include <MainMenuScene.h>

+ Inheritance diagram for HoverRace::Client::MainMenuScene:

Public Member Functions

 MainMenuScene (Display::Display &display, GameDirector &director, RulebookLibrary &rulebookLibrary)
 
virtual ~MainMenuScene ()
 
void Layout () override
 Adjust the size and position of any child elements. More...
 
void OnStateChanged (State oldState) override
 Fired immediately after entering a new state. More...
 
void OnStateTransition (double interval) override
 Fired during the raising and lowering states, if SetStateTransitionDuration() was set. More...
 
void PrepareRender () override
 
void Render () override
 
- Public Member Functions inherited from HoverRace::Client::FormScene
 FormScene (Display::Display &display, const std::string &name="")
 
virtual ~FormScene ()
 
void AttachController (Control::InputEventController &controller, ConnList &conns) override
 Configure the controller mappings. More...
 
- 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...
 
Sceneoperator= (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 = FormScene
 

Private Member Functions

std::shared_ptr< Display::ButtonAddButton (const std::string &text, bool enabled=true, bool focused=false)
 
void OnMultiplayerClicked ()
 
void OnMutedClicked ()
 
void OnPracticeClicked ()
 
void OnSettingsClicked ()
 

Private Attributes

GameDirectordirector
 
Display::Displaydisplay
 
boost::signals2::scoped_connection displayConfigChangedConn
 
std::unique_ptr< Display::FillBoxletterDownBox
 
std::unique_ptr< Display::FillBoxletterUpBox
 
std::vector< std::shared_ptr< Display::Button > > menuButtons
 
std::shared_ptr< Display::ContainermenuContainer
 
RulebookLibraryrulebookLibrary
 
std::shared_ptr< Display::ContainertitleContainer
 

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::FormScene
Display::ContainerGetRoot () const
 
- Protected Member Functions inherited from HoverRace::Client::UiScene
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...
 
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::FormScene
Display::Displaydisplay
 
- Protected Attributes inherited from HoverRace::Client::Scene
std::shared_ptr< Util::ProfileradvanceProfiler
 
std::shared_ptr< Util::ProfilerprepareProfiler
 
std::shared_ptr< Util::ProfilerrenderProfiler
 
std::shared_ptr< Util::ProfilerrootProfiler
 

Detailed Description

The title scene.

Author
Michael Imamura

Member Typedef Documentation

Constructor & Destructor Documentation

HoverRace::Client::MainMenuScene::MainMenuScene ( Display::Display display,
GameDirector director,
RulebookLibrary rulebookLibrary 
)
HoverRace::Client::MainMenuScene::~MainMenuScene ( )
virtual

Member Function Documentation

std::shared_ptr< Display::Button > HoverRace::Client::MainMenuScene::AddButton ( const std::string &  text,
bool  enabled = true,
bool  focused = false 
)
private
void HoverRace::Client::MainMenuScene::Layout ( )
overridevirtual

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

void HoverRace::Client::MainMenuScene::OnMultiplayerClicked ( )
private
void HoverRace::Client::MainMenuScene::OnMutedClicked ( )
private
void HoverRace::Client::MainMenuScene::OnPracticeClicked ( )
private
void HoverRace::Client::MainMenuScene::OnSettingsClicked ( )
private
void HoverRace::Client::MainMenuScene::OnStateChanged ( State  oldState)
overridevirtual

Fired immediately after entering a new state.

Parameters
oldStateThe previous state.
See also
GetState()

Reimplemented from HoverRace::Client::Scene.

void HoverRace::Client::MainMenuScene::OnStateTransition ( double  progress)
overridevirtual

Fired during the raising and lowering states, if SetStateTransitionDuration() was set.

Parameters
progressThe animation progress (during the RAISING phase this goes from 0.0 to 1.0, and in reverse for the LOWERING phase).

Reimplemented from HoverRace::Client::Scene.

void HoverRace::Client::MainMenuScene::PrepareRender ( )
overridevirtual

Reimplemented from HoverRace::Client::FormScene.

void HoverRace::Client::MainMenuScene::Render ( )
overridevirtual

Reimplemented from HoverRace::Client::FormScene.

Member Data Documentation

GameDirector& HoverRace::Client::MainMenuScene::director
private
Display::Display& HoverRace::Client::MainMenuScene::display
private
boost::signals2::scoped_connection HoverRace::Client::MainMenuScene::displayConfigChangedConn
private
std::unique_ptr<Display::FillBox> HoverRace::Client::MainMenuScene::letterDownBox
private
std::unique_ptr<Display::FillBox> HoverRace::Client::MainMenuScene::letterUpBox
private
std::vector<std::shared_ptr<Display::Button> > HoverRace::Client::MainMenuScene::menuButtons
private
std::shared_ptr<Display::Container> HoverRace::Client::MainMenuScene::menuContainer
private
RulebookLibrary& HoverRace::Client::MainMenuScene::rulebookLibrary
private
std::shared_ptr<Display::Container> HoverRace::Client::MainMenuScene::titleContainer
private

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