HoverRace  2.0
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
HoverRace::Client::Module::TransitionModule Class Reference
+ Inheritance diagram for HoverRace::Client::Module::TransitionModule:

Public Member Functions

 TransitionModule (Display::Display &display, GameDirector &director)
 
virtual ~TransitionModule ()
 
- Public Member Functions inherited from HoverRace::Client::TestLabScene::LabModule
 LabModule (Display::Display &display, GameDirector &director, const std::string &title)
 
virtual ~LabModule ()
 
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::FormScene
 FormScene (Display::Display &display, const std::string &name="")
 
virtual ~FormScene ()
 
- 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...
 

Protected Member Functions

void OnPhaseChanged (Phase oldPhase) override
 Fired immediately after entering a new phase. More...
 
void OnPhaseTransition (double progress) override
 Fired during the starting and stopping phases, if SetPhaseTransitionDuration() was set. More...
 
void OnStateChanged (State oldState) override
 Fired immediately after entering a new state. More...
 
void OnStateTransition (double progress) override
 Fired during the raising and lowering states, if SetStateTransitionDuration() was set. More...
 
- Protected Member Functions inherited from HoverRace::Client::FormScene
Display::ContainerGetRoot () 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...
 
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 = TestLabScene::LabModule
 

Private Attributes

std::shared_ptr< Display::FillBoxphaseBox
 
std::shared_ptr< Display::LabelphaseLbl
 
std::shared_ptr< Display::FillBoxstateBox
 
std::shared_ptr< Display::LabelstateLbl
 

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::TestLabScene::LabModule
GameDirectordirector
 
Display::Displaydisplay
 
const std::string title
 
- 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
 

Member Typedef Documentation

Constructor & Destructor Documentation

HoverRace::Client::Module::TransitionModule::TransitionModule ( Display::Display display,
GameDirector director 
)
virtual HoverRace::Client::Module::TransitionModule::~TransitionModule ( )
inlinevirtual

Member Function Documentation

void HoverRace::Client::Module::TransitionModule::OnPhaseChanged ( Phase  oldPhase)
overrideprotectedvirtual

Fired immediately after entering a new phase.

Parameters
oldPhaseThe previous phase.
See also
GetPhase()

Reimplemented from HoverRace::Client::Scene.

void HoverRace::Client::Module::TransitionModule::OnPhaseTransition ( double  progress)
overrideprotectedvirtual

Fired during the starting and stopping phases, if SetPhaseTransitionDuration() was set.

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

Reimplemented from HoverRace::Client::Scene.

void HoverRace::Client::Module::TransitionModule::OnStateChanged ( State  oldState)
overrideprotectedvirtual

Fired immediately after entering a new state.

Parameters
oldStateThe previous state.
See also
GetState()

Reimplemented from HoverRace::Client::Scene.

void HoverRace::Client::Module::TransitionModule::OnStateTransition ( double  progress)
overrideprotectedvirtual

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.

Member Data Documentation

std::shared_ptr<Display::FillBox> HoverRace::Client::Module::TransitionModule::phaseBox
private
std::shared_ptr<Display::Label> HoverRace::Client::Module::TransitionModule::phaseLbl
private
std::shared_ptr<Display::FillBox> HoverRace::Client::Module::TransitionModule::stateBox
private
std::shared_ptr<Display::Label> HoverRace::Client::Module::TransitionModule::stateLbl
private

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