Audio settings dialog. More...

#include <AudioSettingsScene.h>

Inheritance diagram for HoverRace::Client::AudioSettingsScene:

Public Member Functions
	AudioSettingsScene (Display::Display &display, GameDirector &director, const std::string &parentTitle)

virtual	~AudioSettingsScene ()

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

virtual	~SettingsScene ()

void	PrepareRender () override

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	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	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
void	LoadFromConfig () override
	Refresh the form widgets with values from the config. More...

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

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

void	ResetToDefaults () override
	Reset the config values to their defaults (if possible). More...

Protected Member Functions inherited from HoverRace::Client::SettingsScene
Display::FlexGrid::CellProxy	AddSetting (const std::string &label)
	Add a new setting row. More...

Display::FlexGrid *	GetSettingsGrid ()

std::shared_ptr< MessageScene >	NewMainMenuConfirmScene () const
	Generate a new confirmation scene for when a return to the main menu is required. More...

std::shared_ptr< MessageScene >	NewSoftRestartConfirmScene () const
	Generate a new confirmation scene for when a soft restart is required. More...

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

void	RequestLoadFromConfig ()
	Indicate that the form needs to be refreshed from the config. More...

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

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

Private Types
using	SUPER = SettingsScene

Static Private Member Functions
static VideoServices::ShortSound *	LoadSound (int id)
	Loads a sound from the resources. More...

Private Attributes
Util::Config::audio_t &	audioCfg

Util::Config::audio_t	origAudioCfg

boost::signals2::scoped_connection	sfxVolumeConn

std::shared_ptr< Display::Slider >	sfxVolumeSlider

bool	skipSoundTest

VideoServices::ShortSound *	testSound

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 }

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

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

Static Protected Attributes inherited from HoverRace::Client::SettingsScene
static Vec2	SLIDER_SIZE = Vec2(300, 20)
	Default size for settings sliders. More...

Detailed Description

Audio settings dialog.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Client::AudioSettingsScene::SUPER = SettingsScene

private

Constructor & Destructor Documentation

HoverRace::Client::AudioSettingsScene::AudioSettingsScene	(	Display::Display &	display,
		GameDirector &	director,
		const std::string &	parentTitle
	)

virtual HoverRace::Client::AudioSettingsScene::~AudioSettingsScene ( )

inlinevirtual

Member Function Documentation

void HoverRace::Client::AudioSettingsScene::LoadFromConfig ( )

overrideprotectedvirtual

Refresh the form widgets with values from the config.

Implements HoverRace::Client::SettingsScene.

VideoServices::ShortSound * HoverRace::Client::AudioSettingsScene::LoadSound ( int id )

staticprivate

Loads a sound from the resources.

Parameters

id	The resource ID.

Returns: The sound effect, or nullptr if it fails to load.

void HoverRace::Client::AudioSettingsScene::OnCancel ( )

overrideprotectedvirtual

Called when the "Cancel" action is fired.

Reimplemented from HoverRace::Client::DialogScene.

void HoverRace::Client::AudioSettingsScene::OnOk ( )

overrideprotectedvirtual

Called when the "OK" action is fired.

Reimplemented from HoverRace::Client::DialogScene.

void HoverRace::Client::AudioSettingsScene::ResetToDefaults ( )

overrideprotectedvirtual

Reset the config values to their defaults (if possible).

Implements HoverRace::Client::SettingsScene.

Member Data Documentation

Util::Config::audio_t& HoverRace::Client::AudioSettingsScene::audioCfg

private

Util::Config::audio_t HoverRace::Client::AudioSettingsScene::origAudioCfg

private

boost::signals2::scoped_connection HoverRace::Client::AudioSettingsScene::sfxVolumeConn

private

std::shared_ptr<Display::Slider> HoverRace::Client::AudioSettingsScene::sfxVolumeSlider

private

bool HoverRace::Client::AudioSettingsScene::skipSoundTest

private

VideoServices::ShortSound* HoverRace::Client::AudioSettingsScene::testSound

private

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

Public Member Functions

Protected Member Functions

Private Types

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation