Select an avatar from the avatar gallery. More...

#include <AvatarSelectScene.h>

Inheritance diagram for HoverRace::Client::AvatarSelectScene:

Public Types
using	confirmSignal_t = boost::signals2::signal< void(const std::string &)>

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 }

Public Member Functions
	AvatarSelectScene (Display::Display &display, GameDirector &director, const std::string &parentTitle, std::shared_ptr< Player::AvatarGallery > gallery, const std::string &avatarName={})
	Constructor. More...

virtual	~AvatarSelectScene ()

const std::string &	GetAvatarName () const

confirmSignal_t &	GetConfirmSignal ()

void	OnAvatarSelected (const std::string &name)

Public Member Functions inherited from HoverRace::Client::DialogScene
	DialogScene (Display::Display &display, GameDirector &director, const std::string &parentTitle, const std::string &title, const std::string &name)
	Constructor. More...

	DialogScene (Display::Display &display, GameDirector &director, const std::string &title="", const std::string &name="")

virtual	~DialogScene ()

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

void	OnPhaseTransition (double progress) override
	Fired during the starting and stopping phases, if SetPhaseTransitionDuration() 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...

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

Private Types
using	SUPER = DialogScene

Private Attributes
std::string	avatarName

confirmSignal_t	confirmSignal

std::list< boost::signals2::scoped_connection >	conns

std::shared_ptr< Player::AvatarGallery >	gallery

std::shared_ptr< Display::Picture >	previewPic

Additional Inherited Members
Static Public Attributes inherited from HoverRace::Client::DialogScene
static constexpr double	MARGIN_WIDTH = 40

Protected Member Functions inherited from HoverRace::Client::DialogScene
Display::Container *	GetContentRoot () const

const std::string &	GetFullTitle () const
	Retrieve the full combined title (including parent title). More...

Display::Container *	GetStatusRoot () const

const std::string &	GetTitle () const

virtual void	OnCancel ()
	Called when the "Cancel" action is fired. More...

virtual void	OnExtra ()
	Called when the scene-specific extra action is fired. More...

virtual void	OnOk ()
	Called when the "OK" action is fired. More...

void	SetBackground (Display::Background *fader)
	Set the background, replacing the currently set background. More...

void	SetStoppingTransitionEnabled (bool enabled)
	Enable or disable content visibility while scene is stopping. More...

void	SupportCancelAction (const std::string &label="")
	Enable the "Cancel" action for this scene. More...

void	SupportExtraAction (const std::string &label)
	Enable the "extra" action for this scene. More...

void	SupportOkAction (const std::string &label="")
	Enable the "OK" action for this scene. More...

Protected Member Functions inherited from HoverRace::Client::FormScene
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	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...

Static Protected Member Functions inherited from HoverRace::Client::DialogScene
static std::string	JoinTitles (const std::string &parent, const std::string &title)
	Combine a parent dialog title to the child dialog title. More...

Protected Attributes inherited from HoverRace::Client::DialogScene
GameDirector &	director

Protected Attributes inherited from HoverRace::Client::FormScene
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

Detailed Description

Select an avatar from the avatar gallery.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Client::AvatarSelectScene::confirmSignal_t = boost::signals2::signal<void(const std::string&)>

using HoverRace::Client::AvatarSelectScene::SUPER = DialogScene

private

Constructor & Destructor Documentation

HoverRace::Client::AvatarSelectScene::AvatarSelectScene	(	Display::Display &	display,
		GameDirector &	director,
		const std::string &	parentTitle,
		std::shared_ptr< Player::AvatarGallery >	gallery,
		const std::string &	avatarName = `{}`
	)

Constructor.

Parameters

display	The target display.
director	The current director.
parentTitle	The title of the parent dialog (may be blank).
gallery	The avatar gallery from which to pick an avatar.
avatarName	The initially-selected avatar.

virtual HoverRace::Client::AvatarSelectScene::~AvatarSelectScene ( )

inlinevirtual

Member Function Documentation

const std::string& HoverRace::Client::AvatarSelectScene::GetAvatarName ( ) const

inline

confirmSignal_t& HoverRace::Client::AvatarSelectScene::GetConfirmSignal ( )

inline

void HoverRace::Client::AvatarSelectScene::OnAvatarSelected ( const std::string & name )

Member Data Documentation

std::string HoverRace::Client::AvatarSelectScene::avatarName

private

confirmSignal_t HoverRace::Client::AvatarSelectScene::confirmSignal

private

std::list<boost::signals2::scoped_connection> HoverRace::Client::AvatarSelectScene::conns

private

std::shared_ptr<Player::AvatarGallery> HoverRace::Client::AvatarSelectScene::gallery

private

std::shared_ptr<Display::Picture> HoverRace::Client::AvatarSelectScene::previewPic

private

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

Public Types

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation