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

The actual, genuine gameplay scene. More...

#include <PlayGameScene.h>

+ Inheritance diagram for HoverRace::Client::PlayGameScene:

Public Member Functions

 PlayGameScene (Display::Display &display, GameDirector &director, Script::Core &scripting, std::shared_ptr< Rules > rules, std::shared_ptr< Util::Loader > loader)
 
virtual ~PlayGameScene ()
 
void AttachController (Control::InputEventController &controller, ConnList &conns) override
 Configure the controller mappings. More...
 
void DetachController (Control::InputEventController &controller, ConnList &conns) override
 Remove the controller mappings. More...
 
- Public Member Functions inherited from HoverRace::Client::GameScene
 GameScene (const std::string &name, Display::Display &display, GameDirector &director, Script::Core &scripting, std::shared_ptr< Rules > rules, std::shared_ptr< Util::Loader > loader)
 
virtual ~GameScene ()
 
void Advance (Util::OS::timestamp_t tick) override
 
bool IsMouseCursorEnabled () const override
 Determine if the mouse cursor is enabled for this scene. More...
 
void Layout () override
 Adjust the size and position of any child elements. More...
 
std::ostream & OutputDebugText (std::ostream &oss) const override
 Output a stream of debug information describing 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...
 
Sceneoperator= (const Scene &)=delete
 
void PrepareScene ()
 
void RenderScene ()
 
bool SetPhase (Phase phase)
 Switch to another phase. More...
 

Private Types

typedef GameScene SUPER
 

Private Member Functions

void OnCameraPan (int increment)
 
void OnCameraReset ()
 
void OnCameraZoom (int increment)
 
void OnPause ()
 Fired when the pause button (e.g. ESC) is pressed. More...
 

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::GameScene
virtual void OnFinishedLoading ()
 
void SetHudVisible (bool visible)
 
void SetMuted (bool muted)
 
- 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
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::GameScene
GameDirectordirector
 
Display::Displaydisplay
 
std::shared_ptr< Rulesrules
 
Script::Corescripting
 
ClientSessionsession
 
std::vector< Viewportviewports
 
- 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 actual, genuine gameplay scene.

Accept no imitations.

This scene manages the lifetime of a single session, from start to finish. Pushing this scene onto the stage starts a new game session, and likewise popping this scene from the stage aborts the game session.

Author
Michael Imamura

Member Typedef Documentation

Constructor & Destructor Documentation

HoverRace::Client::PlayGameScene::PlayGameScene ( Display::Display display,
GameDirector director,
Script::Core scripting,
std::shared_ptr< Rules rules,
std::shared_ptr< Util::Loader loader 
)
HoverRace::Client::PlayGameScene::~PlayGameScene ( )
virtual

Member Function Documentation

void HoverRace::Client::PlayGameScene::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
controllerThe current controller being used. It can be assumed that the controller's action mappings have been cleared.
connsThe 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.

void HoverRace::Client::PlayGameScene::DetachController ( Control::InputEventController controller,
ConnList conns 
)
overridevirtual

Remove the controller mappings.

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

Implements HoverRace::Client::Scene.

void HoverRace::Client::PlayGameScene::OnCameraPan ( int  increment)
private
void HoverRace::Client::PlayGameScene::OnCameraReset ( )
private
void HoverRace::Client::PlayGameScene::OnCameraZoom ( int  increment)
private
void HoverRace::Client::PlayGameScene::OnPause ( )
private

Fired when the pause button (e.g. ESC) is pressed.


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