GrandPrixLose Class Reference

Screen shown at the end of a Grand Prix. More...

#include <grand_prix_lose.hpp>

Inheritance diagram for GrandPrixLose:

Public Member Functions
void	init () OVERRIDE
	Callback invoked when entering this menu (after the widgets have been added).
void	loadedFromFile () OVERRIDE
	Callback invoked when loading this menu.
void	onCutsceneEnd () OVERRIDE
void	onUpdate (float dt) OVERRIDE
	optional callback you can override to be notified at every frame.
void	setKarts (std::vector< std::pair< std::string, float > > ident)
	set which karts lost this GP
MusicInformation *	getInGameMenuMusic () const OVERRIDE
Public Member Functions inherited from GrandPrixCutscene
	GrandPrixCutscene (const char *filename)
Public Member Functions inherited from GUIEngine::CutsceneScreen
	CutsceneScreen (const char *name)
virtual void	onCutsceneEnd ()=0
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 Attributes
float	m_global_time
	Global evolution of time.
TrackObject *	m_kart_node [4]
std::vector< KartModel * >	m_all_kart_models
	A copy of the kart model for each kart used.
int	m_phase
float	m_kart_x
float	m_kart_y
float	m_kart_z

Friends
class	GUIEngine::ScreenSingleton< GrandPrixLose >

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< GrandPrixLose >
static GrandPrixLose *	getInstance ()
Protected Member Functions inherited from GrandPrixCutscene
void	saveGPButton ()
	A Button to save the GP if it was a random GP.
void	setNewGPWithName (const irr::core::stringw &name)
	Creates a new GP with the same content as the current and saves it The GP that the race_manager provides can't be used because we need some functions and settings that the GP manager only gives us through createNewGP().
void	eventCallback (GUIEngine::Widget *widget, const std::string &name, const int playerID) OVERRIDE
	will be called everytime something happens.
bool	onEscapePressed () OVERRIDE
	Called when escape is pressed.
void	tearDown () OVERRIDE
	Callback invoked before leaving this menu.
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< GrandPrixLose >
static GrandPrixLose *	singleton

Detailed Description

Screen shown at the end of a Grand Prix.

Member Function Documentation

getInGameMenuMusic()

MusicInformation * GrandPrixLose::getInGameMenuMusic ( ) const

virtual

Returns

which music to play at this screen, if accessed in "in-game-menu" mode

Reimplemented from GUIEngine::Screen.

init()

void GrandPrixLose::init ( )

virtual

Callback invoked when entering this menu (after the widgets have been added).

Initialisation before the object is displayed.

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 function will pause the race if it is running (i.e. world exists). While only some of the screen can be shown during the race (via the in-game menu you can get the options screen and the help screens only). This is used by the RaceResultGUI to leave the race running (for the end animation) while the results are being shown.

Reimplemented from GUIEngine::Screen.

loadedFromFile()

void GrandPrixLose::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.

onCutsceneEnd()

void GrandPrixLose::onCutsceneEnd ( )

virtual

Implements GUIEngine::CutsceneScreen.

onUpdate()

void GrandPrixLose::onUpdate ( float  dt )

virtual

optional callback you can override to be notified at every frame.

Reimplemented from GUIEngine::Screen.

---

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

• states_screens/grand_prix_lose.hpp
• states_screens/grand_prix_lose.cpp