TracksScreen Class Reference

screen where the user can select a track More...

#include <tracks_screen.hpp>

Inheritance diagram for TracksScreen:

Public Member Functions
void	addVote (uint32_t host_id, const PeerVote &vote)
	Selects in which part of the vote list the new host is being shown and stores this information in the m_index_to_hostid mapping.
void	removeVote (uint32_t host_id)
	Removes a vote, which is triggered when a client disconnects.
void	setResult (uint32_t winner_host, const PeerVote &winner_vote)
	Received the winning vote.
virtual void	loadedFromFile () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	eventCallback (GUIEngine::Widget *widget, const std::string &name, const int playerID) OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	init () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	beforeAddingWidget () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	tearDown () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual bool	onEscapePressed () OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	onUpdate (float dt) OVERRIDE
	implement callback from parent class GUIEngine::Screen
virtual void	unloaded () OVERRIDE
	implement callback from parent class GUIEngine::Screen
void	setFocusOnTrack (const std::string &trackName)
void	setNetworkTracks ()
void	setQuitServer ()
void	resetVote ()
	Called at the beginning of the voting process to reset any previous data fields.
void	updatePlayerVotes ()
virtual void	onTextUpdated () OVERRIDE
Public Member Functions inherited from GUIEngine::Screen
std::function< Screen *()>	getNewScreenPointer () const
	Save the function before GUIEngine::clearScreenCache, call it after to get the new screen instance pointer.
void	setScreenPointerFunction (const std::function< Screen *()> &f)
	Screen (bool pause_race=true)
	Creates a dummy incomplete object; only use to override behaviour in sub-class.
	Screen (const char *filename, bool pause_race=true)
	Creates a screen populated by the widgets described in a STK GUI file.
bool	operator== (const char *filename) const
void	loadFromFile ()
	loads this Screen from the file passed to the constructor
bool	isLoaded () const
void	addWidgets ()
	Adds the IrrLicht widgets corresponding to this screen to the IGUIEnvironment.
void	calculateLayout ()
	Called after all widgets have been added.
void	manualAddWidget (Widget *w)
	Can be used for custom purposes for which the load-screen-from-XML code won't make it.
void	manualRemoveWidget (Widget *w)
	Can be used for custom purposes for which the load-screen-from-XML code won't make it.
void	setUpdateInBackground (bool value)
	When set to true it updates the screen even if modal dialog is opened.
bool	getUpdateInBackground ()
const std::string &	getName () const
virtual void	unload ()
	Next time this menu needs to be shown, don't use cached values, re-calculate everything.
bool	needs3D ()
	Will be called to determine if the 3D scene must be rendered when at this screen.
void	setNeeds3D (bool needs3D)
	Invoke this method for screens that use a 3D scene as background.
virtual void	loadedFromFile ()=0
	Callback invoked when loading this menu.
virtual void	unloaded ()
	Callback invoked when this screen is being unloaded.
virtual void	beforeAddingWidget ()
	Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)
virtual void	init ()
	Callback invoked when entering this menu (after the widgets have been added).
void	push ()
	Displays this screen bu pushing it onto the stack of screen in the state manager.
virtual void	tearDown ()
	Callback invoked before leaving this menu.
virtual bool	onEscapePressed ()
	Called when escape is pressed.
virtual void	eventCallback (Widget *widget, const std::string &name, const int playerID)=0
	will be called everytime something happens.
virtual void	onUpdate (float dt)
	optional callback you can override to be notified at every frame.
virtual void	onDraw (float dt)
	optional callback you can override to be notified at every frame.
virtual MusicInformation *	getMusic () const
virtual MusicInformation *	getInGameMenuMusic () const
virtual int	getWidth ()
virtual int	getHeight ()
virtual bool	isResizable () const
virtual EventPropagation	filterActions (PlayerAction action, int deviceID, const unsigned int value, Input::InputType type, int playerId)
	Override this if you need to be notified of player actions in subclasses.
virtual void	onDisabledItemClicked (const std::string &item)
	Callback you can use if you want to know when the user pressed on a disabled ribbon item.
virtual void	filterInput (Input::InputType type, int deviceID, int btnID, int axisDir, int value)
	Override this if you need to be notified of raw input in subclasses.
virtual void	onDialogClose ()
	Callback that gets called when a dialog is closed.
virtual void	onFocusChanged (Widget *previous, Widget *focus, int playerID)
	Callback called when focus changes.
Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
virtual int	getWidth ()=0
virtual int	getHeight ()=0
Widget *	getWidget (const char *name)
	This function returns a widget by name if that widget is found.
Widget *	getWidget (const int id)
	This function returns a widget by irrlicht ID if that widget is found.
template<typename T >
T *	getWidget (const char *name)
	This function searches and returns a widget by name, cast as specified type, if that widget is found and the type is correct.
Widget *	getFirstWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the first widget found in within_vector.
Widget *	getLastWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the last widget found in within_vector.
void	elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
	This function is called when screen is removed.
bool	isMyChild (Widget *widget) const
	This function checks if a widget is a child of the container.
virtual bool	enableScreenPadding () const
Public Member Functions inherited from GUIEngine::ITextBoxWidgetListener
virtual void	onTextUpdated ()=0
virtual bool	onEnterPressed (const irr::core::stringw &text)

Private Member Functions
void	buildTrackList ()
	adds the tracks from the current track group into the tracks ribbon
void	voteForPlayer ()
void	updateProgressBarText ()

Private Attributes
Track *	m_selected_track = NULL
GUIEngine::CheckBoxWidget *	m_reversed
GUIEngine::SpinnerWidget *	m_laps
GUIEngine::ListWidget *	m_vote_list
GUIEngine::TextBoxWidget *	m_search_track
GUIEngine::ProgressBarWidget *	m_timer
	Pointer to progress bar widget which is used as a timer (going backwards).
irr::gui::STKModifiedSpriteBank *	m_track_icons
bool	m_network_tracks
bool	m_quit_server
int	m_bottom_box_height
uint32_t	m_winning_index
	Id of the winning peer.
std::vector< uint32_t >	m_index_to_hostid
	This stores which vote (hostid) is shown at which index in the vote overview list.
std::deque< std::string >	m_random_track_list

Friends
class	GUIEngine::ScreenSingleton< TracksScreen >

Additional Inherited Members
Static Public Member Functions inherited from GUIEngine::Screen
static void	parseScreenFileDiv (irr::io::IXMLReader *xml, PtrVector< Widget > &append_to, irr::gui::IGUIElement *parent=NULL)
	Loads a GUI screen from its XML file.
Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
static Widget *	getWidget (const char *name, PtrVector< Widget > *within_vector)
	This function returns a widget by name if that widget is found in within_vector.
static Widget *	getWidget (const int id, PtrVector< Widget > *within_vector)
	This function returns a widget by irrlicht ID if that widget is found.
Static Public Member Functions inherited from GUIEngine::ScreenSingleton< TracksScreen >
static TracksScreen *	getInstance ()
Protected Member Functions inherited from GUIEngine::AbstractTopLevelContainer
void	addWidgetsRecursively (PtrVector< Widget > &widgets, Widget *parent=NULL)
	This function adds a list of widgets recursively, effectively creating the hierarchy of widgets.
Protected Attributes inherited from GUIEngine::Screen
bool	m_resizable
	True if this screen is resizable.
Protected Attributes inherited from GUIEngine::AbstractTopLevelContainer
PtrVector< Widget, HOLD >	m_widgets
	the widgets in this screen
Widget *	m_first_widget
	AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g.
Widget *	m_last_widget
	AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g.
Static Protected Attributes inherited from GUIEngine::ScreenSingleton< TracksScreen >
static TracksScreen *	singleton

Detailed Description

screen where the user can select a track

Member Function Documentation

addVote()

void TracksScreen::addVote	(	uint32_t	host_id,
		const PeerVote &	vote
	)

Selects in which part of the vote list the new host is being shown and stores this information in the m_index_to_hostid mapping.

If the host_id is already mapped, this is ignored (this can happen in case one host changes its vote.

Parameters

host_id	Index of the host that is voting.
vote	Vote information.

beforeAddingWidget()

void TracksScreen::beforeAddingWidget ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

buildTrackList()

void TracksScreen::buildTrackList ( )

private

adds the tracks from the current track group into the tracks ribbon

Rebuild the list of tracks.

This need to be recomputed e.g. to take unlocked tracks into account.

eventCallback()

void TracksScreen::eventCallback ( GUIEngine::Widget *  widget, const std::string &  name, const int  playerID  )

virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

init()

void TracksScreen::init ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

loadedFromFile()

void TracksScreen::loadedFromFile ( )

virtual

implement callback from parent class GUIEngine::Screen

Implements GUIEngine::Screen.

onEscapePressed()

bool TracksScreen::onEscapePressed ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

onTextUpdated()

virtual void TracksScreen::onTextUpdated ( )

inlinevirtual

Implements GUIEngine::ITextBoxWidgetListener.

onUpdate()

void TracksScreen::onUpdate ( float  dt )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

removeVote()

void TracksScreen::removeVote

(

uint32_t

host_id

)

Removes a vote, which is triggered when a client disconnects.

Parameters

host_id

Host id of the disconnected client.

setResult()

void TracksScreen::setResult	(	uint32_t	winner_host,
		const PeerVote &	winner_vote
	)

Received the winning vote.

i.e. the data about the track to play (including #laps etc).

tearDown()

void TracksScreen::tearDown ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

unloaded()

void TracksScreen::unloaded ( )

virtual

implement callback from parent class GUIEngine::Screen

Reimplemented from GUIEngine::Screen.

---

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

• states_screens/online/tracks_screen.hpp
• states_screens/online/tracks_screen.cpp