TrackInfoScreen Class Reference

Dialog that shows the information about a given track. More...

#include <track_info_screen.hpp>

Inheritance diagram for TrackInfoScreen:

Public Member Functions
	TrackInfoScreen ()
	Constructor, which loads the corresponding track_info.stkgui file.
virtual void	init () OVERRIDE
	Initialised the display.
virtual void	beforeAddingWidget () OVERRIDE
	Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)
virtual void	loadedFromFile () OVERRIDE
	Callback invoked when loading this menu.
virtual void	tearDown () OVERRIDE
	Callback invoked before leaving this menu.
virtual void	unloaded () OVERRIDE
	Callback invoked when this screen is being unloaded.
virtual void	eventCallback (GUIEngine::Widget *, const std::string &name, const int player_id) OVERRIDE
	will be called everytime something happens.
void	onEnterPressedInternal ()
void	setTrack (Track *track)
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

Private Member Functions
void	updateHighScores ()
void	setSoccerWidgets (bool has_AI)
void	setSoccerTarget (bool time_limit)
void	soccerSpinnerUpdate (bool blue_spinner)

Private Attributes
Track *	m_track
	A pointer to the track of which the info is shown.
bool	m_record_this_race
bool	m_is_soccer
bool	m_is_lap_trial
bool	m_show_ffa_spinner
GUIEngine::SpinnerWidget *	m_target_type_spinner
	Spinner for target types.
GUIEngine::LabelWidget *	m_target_type_label
	The label besides the target types spinner.
GUIEngine::SpinnerWidget *	m_ai_blue_spinner
	Spinner for number of blue AI karts.
GUIEngine::LabelWidget *	m_ai_blue_label
	The label besides the blue AI karts spinner.
GUIEngine::Widget *	m_ai_blue_div
GUIEngine::Widget *	m_target_type_div
GUIEngine::SpinnerWidget *	m_target_value_spinner
	Spinner for target value e.g.
GUIEngine::LabelWidget *	m_target_value_label
	The label besides the target value spinner.
GUIEngine::SpinnerWidget *	m_ai_kart_spinner
	Spinner for number of AI karts.
GUIEngine::LabelWidget *	m_ai_kart_label
	The label besides the AI karts spinner.
GUIEngine::CheckBoxWidget *	m_option
	Check box for reverse mode or random item in arena.
GUIEngine::CheckBoxWidget *	m_record_race
	Check box for record race.
GUIEngine::LabelWidget *	m_highscore_label
	The label of the highscore list.
GUIEngine::ListWidget *	m_highscore_entries
	The actual highscore text values shown.
irr::gui::STKModifiedSpriteBank *	m_icon_bank
int	m_icon_unknown_kart

Static Private Attributes
static const int	HIGHSCORE_COUNT = 5

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< TrackInfoScreen >
static TrackInfoScreen *	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< TrackInfoScreen >
static TrackInfoScreen *	singleton

Detailed Description

Dialog that shows the information about a given track.

Member Function Documentation

beforeAddingWidget()

void TrackInfoScreen::beforeAddingWidget ( )

virtual

Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)

Reimplemented from GUIEngine::Screen.

eventCallback()

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

virtual

will be called everytime something happens.

Events are generally a widget state change. In this case, a pointer to the said widget is passed along its name, so you get its new state and/or act. There are two special events, passed with a NULL widget, and which bear the names "init" and "tearDown", called respectively when a screen is being made visible and when it's being left, allowing for setup/clean-up.

Implements GUIEngine::Screen.

init()

void TrackInfoScreen::init ( )

virtual

Initialised the display.

The previous screen has to setup m_track before pushing this screen using TrackInfoScreen::getInstance()->setTrack().

Reimplemented from GUIEngine::Screen.

loadedFromFile()

void TrackInfoScreen::loadedFromFile ( )

virtual

Callback invoked when loading this menu.

Precondition

Children widgets of this menu have been created by the time this callback is invoked.

Note

This method is not called everytime the screen is shown. Screen::init is. Use this method for persistent setup code (namely, that deals with setting up children widget objects and needs not be done everytime we visit the screen).

A Screen object instance may be unloaded then loaded back. This method might thus be called more than once in the lifetime of a Screen object, however there will always be an 'unload' event in-between calls to this method.

Implements GUIEngine::Screen.

tearDown()

void TrackInfoScreen::tearDown ( )

virtual

Callback invoked before leaving this menu.

Prepares removal of this screen.

Note

The same instance of your object may be entered/left more than once, so make sure that one instance of your object can be used several times if the same screen is visited several times.

If necessary this will unpause the race (so this means that if you have several consecutive screens while the race is running the race will be unpaused and paused when switching from one screen to the next.

Reimplemented from GUIEngine::Screen.

unloaded()

void TrackInfoScreen::unloaded ( )

virtual

Callback invoked when this screen is being unloaded.

Override this method in children classes if you need to be notified of this.

Note

A Screen object instance may be unloaded then loaded back at will.

An unloaded Screen object does not have its children widgets anymore, it only retains its members (most importantly the path to its GUI file) so that it can be loaded back later.

Reimplemented from GUIEngine::Screen.

Member Data Documentation

m_target_value_spinner

GUIEngine::SpinnerWidget* TrackInfoScreen::m_target_value_spinner

private

Spinner for target value e.g.

number of laps or goals to score.

---

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

• states_screens/track_info_screen.hpp
• states_screens/track_info_screen.cpp