SuperTuxKart
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TrackInfoScreen Class Reference

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

#include <track_info_screen.hpp>

Inheritance diagram for TrackInfoScreen:
Inheritance graph
[legend]

Public Member Functions

 TrackInfoScreen ()
 Constructor, which loads the corresponding track_info.stkgui file. More...
 
virtual void init () OVERRIDE
 Initialised the display. More...
 
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. More...
 
virtual void tearDown () OVERRIDE
 Callback invoked before leaving this menu. More...
 
virtual void unloaded () OVERRIDE
 Callback invoked when this screen is being unloaded. More...
 
virtual void eventCallback (GUIEngine::Widget *, const std::string &name, const int player_id) OVERRIDE
 will be called everytime something happens. More...
 
void onEnterPressedInternal ()
 
void setTrack (Track *track)
 
- Public Member Functions inherited from GUIEngine::Screen
 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. More...
 
bool operator== (const char *filename) const
 
void loadFromFile ()
 loads this Screen from the file passed to the constructor
 
bool isLoaded () const
 
bool throttleFPS () const
 
void addWidgets ()
 Adds the IrrLicht widgets corresponding to this screen to the IGUIEnvironment.
 
void calculateLayout ()
 Called after all widgets have been added. More...
 
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. More...
 
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. More...
 
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. More...
 
void push ()
 Displays this screen bu pushing it onto the stack of screen in the state manager. More...
 
virtual bool onEscapePressed ()
 Called when escape is pressed. More...
 
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 MusicInformationgetMusic () const
 
virtual MusicInformationgetInGameMenuMusic () const
 
virtual int getWidth ()
 Implementing method from AbstractTopLevelContainer.
 
virtual int getHeight ()
 Implementing method from AbstractTopLevelContainer.
 
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. More...
 
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. More...
 
virtual void onFocusChanged (Widget *previous, Widget *focus, int playerID)
 Callback called when focus changes.
 
- Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
WidgetgetWidget (const char *name)
 This function returns a widget by name if that widget is found. More...
 
WidgetgetWidget (const int id)
 This function returns a widget by irrlicht ID if that widget is found. More...
 
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. More...
 
WidgetgetFirstWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the first widget found in within_vector. More...
 
WidgetgetLastWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the last widget found in within_vector. More...
 
void elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
 This function is called when screen is removed. More...
 
bool isMyChild (Widget *widget) const
 This function checks if a widget is a child of the container. More...
 

Private Member Functions

void updateHighScores ()
 
void setSoccerWidgets (bool has_AI)
 
void setSoccerTarget (bool time_limit)
 
void soccerSpinnerUpdate (bool blue_spinner)
 

Private Attributes

Trackm_track
 A pointer to the track of which the info is shown. More...
 
bool m_record_this_race
 
bool m_is_soccer
 
bool m_show_ffa_spinner
 
GUIEngine::SpinnerWidgetm_target_type_spinner
 Spinner for target types. More...
 
GUIEngine::LabelWidgetm_target_type_label
 The label besides the target types spinner. More...
 
GUIEngine::SpinnerWidgetm_ai_blue_spinner
 Spinner for number of blue AI karts. More...
 
GUIEngine::LabelWidgetm_ai_blue_label
 The label besides the blue AI karts spinner. More...
 
GUIEngine::Widgetm_ai_blue_div
 
GUIEngine::Widgetm_target_type_div
 
GUIEngine::SpinnerWidgetm_target_value_spinner
 Spinner for target value e.g. More...
 
GUIEngine::LabelWidgetm_target_value_label
 The label besides the target value spinner. More...
 
GUIEngine::SpinnerWidgetm_ai_kart_spinner
 Spinner for number of AI karts. More...
 
GUIEngine::LabelWidgetm_ai_kart_label
 The label besides the AI karts spinner. More...
 
GUIEngine::CheckBoxWidgetm_option
 Check box for reverse mode or random item in arena. More...
 
GUIEngine::CheckBoxWidgetm_record_race
 Check box for record race. More...
 
GUIEngine::LabelWidgetm_highscore_label
 The label of the highscore list. More...
 
GUIEngine::ListWidgetm_highscore_entries
 The actual highscore text values shown. More...
 
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. More...
 
- Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
static WidgetgetWidget (const char *name, PtrVector< Widget > *within_vector)
 This function returns a widget by name if that widget is found in within_vector. More...
 
static WidgetgetWidget (const int id, PtrVector< Widget > *within_vector)
 This function returns a widget by irrlicht ID if that widget is found. More...
 
- Static Public Member Functions inherited from GUIEngine::ScreenSingleton< TrackInfoScreen >
static TrackInfoScreengetInstance ()
 
- 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. More...
 
- Protected Attributes inherited from GUIEngine::Screen
bool m_throttle_FPS
 
- Protected Attributes inherited from GUIEngine::AbstractTopLevelContainer
PtrVector< Widget, HOLD > m_widgets
 the widgets in this screen
 
Widgetm_first_widget
 AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g. More...
 
Widgetm_last_widget
 AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g. More...
 
- Static Protected Attributes inherited from GUIEngine::ScreenSingleton< TrackInfoScreen >
static TrackInfoScreensingleton
 

Detailed Description

Dialog that shows the information about a given track.

Constructor & Destructor Documentation

◆ TrackInfoScreen()

TrackInfoScreen::TrackInfoScreen ( )

Constructor, which loads the corresponding track_info.stkgui file.

Member Function Documentation

◆ 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_ai_blue_label

GUIEngine::LabelWidget* TrackInfoScreen::m_ai_blue_label
private

The label besides the blue AI karts spinner.

◆ m_ai_blue_spinner

GUIEngine::SpinnerWidget* TrackInfoScreen::m_ai_blue_spinner
private

Spinner for number of blue AI karts.

◆ m_ai_kart_label

GUIEngine::LabelWidget* TrackInfoScreen::m_ai_kart_label
private

The label besides the AI karts spinner.

◆ m_ai_kart_spinner

GUIEngine::SpinnerWidget* TrackInfoScreen::m_ai_kart_spinner
private

Spinner for number of AI karts.

◆ m_highscore_entries

GUIEngine::ListWidget* TrackInfoScreen::m_highscore_entries
private

The actual highscore text values shown.

◆ m_highscore_label

GUIEngine::LabelWidget* TrackInfoScreen::m_highscore_label
private

The label of the highscore list.

◆ m_option

GUIEngine::CheckBoxWidget* TrackInfoScreen::m_option
private

Check box for reverse mode or random item in arena.

◆ m_record_race

GUIEngine::CheckBoxWidget* TrackInfoScreen::m_record_race
private

Check box for record race.

◆ m_target_type_label

GUIEngine::LabelWidget* TrackInfoScreen::m_target_type_label
private

The label besides the target types spinner.

◆ m_target_type_spinner

GUIEngine::SpinnerWidget* TrackInfoScreen::m_target_type_spinner
private

Spinner for target types.

◆ m_target_value_label

GUIEngine::LabelWidget* TrackInfoScreen::m_target_value_label
private

The label besides the target value spinner.

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

◆ m_track

Track* TrackInfoScreen::m_track
private

A pointer to the track of which the info is shown.


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