application Class Reference

#include <application.hpp>

Inheritance diagram for application:

[legend]

Collaboration diagram for application:

[legend]

List of all members.

Detailed Description

Base class for applications.

Definition at line 84 of file application.hpp.


Public Member Functions
	application (const string &title, const int &argc, const char **argv)
	Creates the global application object.
virtual	~application ()
Virtual Functions
virtual void	cleanup ()
	This function when the application ends. Do not call it yourself.
virtual bool	draw ()
	This function is called for every frame. Do not call it yourself. If it returns false and the sim pointer is valid, the sim's draw function is called.
virtual bool	handle_event (const SDL_Event &e)
	Handles SDL events.
virtual void	init ()
	This function is called by the constructor. Do not call it yourself.
virtual void	update ()
	This function is called after every frame. Do not call it yourself.
Accessors
platform::display *	get_console ()
widget *	get_focus_widget ()
	Return the widget with the current keyboard focus.
platform::budget *	get_global_budget ()
scenegraph::node *	get_global_scenery ()
void	get_mousedown_info (int &button, int &x, int &y)
scenegraph::simulation *	get_simulation ()
string &	get_title ()
data::simple_stack< widget * > &	get_widgets ()
Game Lifecycle Functions
const gsgl::data::list < package * > &	get_loaded_packages () const
void	load_and_run_simulation (const string &fname, gsgl::scenegraph::context *c)
	Loads and runs a simulation. This will set the top widget to be invisible.
void	load_package (const string &fname)
	Load a game package containing specifications for shared libraries, scenery, and vehicles.
void	load_scenery (platform::synchronized< string > &status_string)
void	quit_application ()
	Quits the application. Unloads and quits any simulation loaded.
void	run ()
void	unload_and_quit_simulation ()
	Unloads and quits a simulation. This will set the top widget to be visible, so make sure that any extra widgets have been popped off the stack.
void	unload_scenery ()
Static Public Member Functions
static T *	global_instance ()
Static Public Attributes
System Configuration Variables
static data::config_variable < gsgl::string >	EVENT_MAP_PATH
	The program's event map.
static data::config_variable < gsgl::string >	PROGRAM_PATH
	The path that the program is running in.
static data::config_variable < gsgl::string >	SYS_DATA_PATH
	The directory of the system data.
static data::config_variable < gsgl::string >	USER_CONFIG_PATH
	The program's user config file.
static data::config_variable < gsgl::string >	USER_DATA_PATH
	The user's data directory.
Protected Types
enum	app_state { APP_NO_STATE = 0, APP_INITIALIZING, APP_UI_RUNNING, APP_SIM_LOADING, APP_SIM_RUNNING, APP_QUITTING, APP_DEAD }
Protected Attributes
widget *	focus_widget
platform::budget *	global_budget
platform::display *	global_console
scenegraph::context *	global_context
scenegraph::event_map *	global_mapper
scenegraph::node *	global_scenery
scenegraph::simulation *	global_simulation
data::list< package * >	loaded_packages
platform::texture *	splash_screen
app_state	state
gsgl::string	title
data::simple_stack< widget * >	widgets
Private Member Functions
void	draw_budget (unsigned int ticks)
void	draw_splash_screen ()
void	draw_ui (framework::widget *)
bool	get_cmdline_dir (const int &argc, const char **argv, const int &pos, const gsgl::string &arg_key, gsgl::data::config_record &conf, const gsgl::string &conf_key)
void	get_config_overrides (const int &argc, const char **argv)
gsgl::string	get_program_dir (const gsgl::string &arg)
gsgl::string	get_user_dir ()
bool	handle_ui_event (const SDL_Event &e, widget *w, int mouse_x, int mouse_y)
bool	handle_ui_event (const SDL_Event &e, widget *w)
scenegraph::node *	load_objects (const data::config_record &obj_config, platform::synchronized< string > &status_string)
void	remove_viewpoint_nodes (scenegraph::node *)
Private Attributes
data::list< gsgl::data_object * >	global_caches
int	mouse_button_pressed
int	mouse_button_x
int	mouse_button_y

Member Enumeration Documentation

enum app_state [protected]

Enumerator:

APP_NO_STATE
APP_INITIALIZING
APP_UI_RUNNING
APP_SIM_LOADING
APP_SIM_RUNNING
APP_QUITTING
APP_DEAD

Definition at line 90 of file application.hpp.

Constructor & Destructor Documentation

application	(	const string &	title,
		const int &	argc,
		const char **	argv
	)

Creates the global application object.

This will also create the global application broker, event map and console objects. It will parse the command line to determine the correct system and user data directories.

Definition at line 98 of file application.cpp.

References list::append(), string::c_string(), font::create_global_font_cache(), material::create_global_material_cache(), model::create_global_model_cache(), texture::create_global_texture_cache(), display::DISPLAY_HEIGHT, display::DISPLAY_WIDTH, application::EVENT_MAP_PATH, file::exists(), config_record::get_children(), global_config::get_config(), application::get_config_overrides(), exception::get_message(), application::global_budget, application::global_caches, application::global_console, application::global_mapper, countable::is_empty(), application::load_package(), application::splash_screen, application::SYS_DATA_PATH, and gsgl::platform::TEXTURE_ENV_REPLACE.

~application ( ) [virtual]

Definition at line 171 of file application.cpp.

References list::clear(), application::focus_widget, application::global_budget, application::global_caches, application::global_console, application::global_context, application::global_mapper, application::global_scenery, application::global_simulation, iterable::iter(), application::splash_screen, and application::widgets.

Member Function Documentation

void cleanup ( ) [virtual]

This function when the application ends. Do not call it yourself.

Implement this if cleanup is needed after the main loop terminates.

Definition at line 613 of file application.cpp.

Referenced by application::quit_application().

bool draw ( ) [virtual]

This function is called for every frame. Do not call it yourself. If it returns false and the sim pointer is valid, the sim's draw function is called.

Implement this to draw the simulation in a custom manner.

If this is not implemented or returns false, the sim will be updated and drawn automatically.

Definition at line 601 of file application.cpp.

Referenced by application::run().

void draw_budget ( unsigned int ticks ) [private]

Definition at line 485 of file application.cpp.

References font::calc_width(), display::draw_2d_text(), display::draw_text_start(), display::draw_text_stop(), string::format(), budget::get_data(), application::global_budget, application::global_console, and color::set().

Referenced by application::run().

void draw_splash_screen ( ) [private]

Definition at line 454 of file application.cpp.

References texture::bind(), CHECK_GL_ERRORS, display::draw_rectangle(), display::get_height(), display::get_width(), application::global_console, and application::splash_screen.

Referenced by application::run().

void draw_ui ( framework::widget * w ) [private]

Definition at line 557 of file application.cpp.

References assert, widget::draw(), widget::get_children(), widget::get_flags(), widget::get_x(), widget::get_y(), and widget::WIDGET_INVISIBLE.

Referenced by application::run().

bool get_cmdline_dir	(	const int &	argc,
		const char **	argv,
		const int &	pos,
		const gsgl::string &	arg_key,
		gsgl::data::config_record &	conf,
		const gsgl::string &	conf_key
	)			`[private]`

Definition at line 652 of file application.cpp.

References config_record::get_child(), directory::get_full_path(), config_record::get_text(), and string::w_string().

Referenced by application::get_config_overrides().

void get_config_overrides	(	const int &	argc,
		const char **	argv
	)			`[private]`

platform::display* get_console ( ) [inline]

Definition at line 145 of file application.hpp.

Referenced by periapsis_app::init().

widget* get_focus_widget ( ) [inline]

Return the widget with the current keyboard focus.

Definition at line 150 of file application.hpp.

platform::budget* get_global_budget ( ) [inline]

Definition at line 147 of file application.hpp.

scenegraph::node* get_global_scenery ( ) [inline]

Definition at line 144 of file application.hpp.

const gsgl::data::list<package *>& get_loaded_packages ( ) const [inline]

Definition at line 160 of file application.hpp.

void get_mousedown_info	(	int &	button,
		int &	x,
		int &	y
	)

Definition at line 945 of file application.cpp.

References application::mouse_button_pressed, application::mouse_button_x, and application::mouse_button_y.

string get_program_dir ( const gsgl::string & arg ) [private]

Definition at line 973 of file application.cpp.

References string::find_reverse(), directory::get_full_path(), and string::substring().

Referenced by application::get_config_overrides().

scenegraph::simulation* get_simulation ( ) [inline]

Definition at line 146 of file application.hpp.

string& get_title ( ) [inline]

Definition at line 142 of file application.hpp.

Referenced by periapsis_app::init().

string get_user_dir ( ) [private]

Definition at line 993 of file application.cpp.

References directory::get_full_path(), directory::SEPARATOR, and application::title.

Referenced by application::get_config_overrides().

data::simple_stack<widget *>& get_widgets ( ) [inline]

Definition at line 149 of file application.hpp.

static T* global_instance ( ) [inline, static, inherited]

Reimplemented in broker, global_register, logger, global_register< gsgl::data::broker_creator, gsgl::data::dictionary< gsgl::data::broker_creator *, gsgl::string > >, global_register< gsgl::data::log_target, gsgl::data::list< gsgl::data::log_target * > >, and global_register< gsgl::data::log_target >.

Definition at line 70 of file singleton.hpp.

Referenced by widget::button_down_here(), font::font(), tabbox::handle_event(), material::material(), model_part::model_part(), and texture::texture().

bool handle_event ( const SDL_Event & e ) [virtual]

Handles SDL events.

Implement this to handle SDL events other than through the default scene graph event handler.

Does not normally need to be reimplemented, as UI elements and scenegraph events will propagate by default.

If it returns true, the scene graph event handler will NOT be called. If it returns false, and the current simulation pointer is valid, then the event mapper will be called with the simulation's set event targets.

Definition at line 587 of file application.cpp.

Referenced by application::run().