The editor_controller class contains the mouse and keyboard event handling routines for the editor. More...

#include <editor_controller.hpp>

Inheritance diagram for editor::editor_controller:

Collaboration diagram for editor::editor_controller:

Public Member Functions
	editor_controller (const config &game_config, CVideo &video)
	The constructor.
	~editor_controller ()
EXIT_STATUS	main_loop ()
	Editor main loop.
void	do_screenshot (const std::string &screenshot_filename="map_screenshot.bmp")
	Takes a screenshot.
void	hotkey_quit ()
	Process a hotkey quit command.
void	quit_confirm (EXIT_STATUS status)
	Show a quit confirmation dialog and if confirmed quit with the given exit status.
void	editor_settings_dialog ()
	Display the settings dialog, used to control e.g.
void	save_map ()
	Save the map, open dialog if not named yet.
bool	can_execute_command (hotkey::HOTKEY_COMMAND, int index=-1) const
	command_executor override
hotkey::ACTION_STATE	get_action_state (hotkey::HOTKEY_COMMAND command, int index) const
	command_executor override
bool	execute_command (hotkey::HOTKEY_COMMAND command, int index=-1)
	command_executor override
void	show_menu (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu)
	controller_base override
void	preferences ()
	Show the preferences dialog.
void	toggle_grid ()
	Grid toggle.
void	copy_selection ()
	Copy the selection on the current map to the clipboard.
void	cut_selection ()
	Cut the selection from the current map to the clipboard.
void	export_selection_coords ()
	Export the WML-compatible list of selected tiles to the system clipboard.
void	update_mouse_action_highlights ()
void	mouse_motion (int x, int y, const bool browse, bool update, map_location new_loc=map_location::null_location)
	Called when a mouse motion event takes place.
editor_display &	gui ()
	Reference to the used display objects.
const editor_display &	gui () const
	Const version.
bool	allow_mouse_wheel_scroll (int x, int y)
	Derived classes can overrid this to disable mousewheel scrolling under some circumstances, e.g.
bool	right_click_show_menu (int x, int y, const bool browse)
	Called in the default right_click when the context menu is about to be shown, can be used for preprocessing and preventing the menu from being displayed without rewriting the right click function.
bool	left_click (int x, int y, const bool browse)
	Overridden in derived classes, called on a left click (mousedown).
void	left_drag_end (int x, int y, const bool browse)
	Called whenever the left mouse drag has "ended".
void	left_mouse_up (int x, int y, const bool browse)
	Called when the left mouse button is up.
bool	right_click (int x, int y, const bool browse)
	Overridden in derived classes, called on a right click (mousedown).
void	right_drag_end (int x, int y, const bool browse)
	Called whenever the right mouse drag has "ended".
void	right_mouse_up (int x, int y, const bool browse)
	Called when the right mouse button is up.
Public Attributes
boost::scoped_ptr < context_manager >	context_manager_
Protected Member Functions
void	process_keyup_event (const SDL_Event &event)
mouse_handler_base &	get_mouse_handler_base ()
editor_display &	get_display ()
mouse_action *	get_mouse_action ()
	Get the current mouse action.
void	perform_delete (editor_action *action)
	Perform an action, then delete the action object.
void	perform_refresh_delete (editor_action *action, bool drag_part=false)
	Peform an action on the current map_context, then refresh the display and delete the pointer.
void	editor_settings_dialog_redraw_callback (int r, int g, int b)
	Callback for the editor settings dialog to allow on-the-fly updating of the lighting display on the game map behing the dialog.
Private Member Functions
void	init_gui ()
	init the display object and general set-up
void	init_tods (const config &game_config)
	init the available time-of-day settings
void	init_music (const config &game_config)
	init background music for the editor
void	load_tooltips ()
	Load editor-specific tooltips.
void	refresh_image_cache ()
	Reload images.
void	display_redraw_callback (display &)
	Callback function passed to display to be called on each redraw_everything run.
void	undo ()
	Undos an action in the current map context.
void	redo ()
	Redos an action in the current map context.
Private Attributes
editor::menu_type	active_menu_
boost::scoped_ptr< rand_rng::rng >	rng_
boost::scoped_ptr < rand_rng::set_random_generator >	rng_setter_
unit_map	units_
boost::scoped_ptr< editor_display >	gui_
	The display object used and owned by the editor.
std::vector< team >	teams_
std::vector< time_of_day >	tods_
	Pre-defined time of day lighting settings for the settings dialog.
boost::scoped_ptr< editor_toolkit >	toolkit_
boost::scoped_ptr < preferences::display_manager >	prefs_disp_manager_
tooltips::manager	tooltip_manager_
boost::scoped_ptr < font::floating_label_context >	floating_label_manager_
boost::scoped_ptr< halo::manager >	halo_manager_
bool	do_quit_
	Quit main loop flag.
EXIT_STATUS	quit_mode_

Detailed Description

The editor_controller class contains the mouse and keyboard event handling routines for the editor.

It also serves as the main editor class with the general logic.

Definition at line 73 of file editor_controller.hpp.

Constructor & Destructor Documentation

editor::editor_controller::editor_controller	(	const config &	game_config,
		CVideo &	video
	)

The constructor.

A initial map context can be specified here, the controller will assume ownership and delete the pointer during destruction, but changes to the map can be retrieved between the main loop's end and the controller's destruction.

Definition at line 53 of file editor_controller.cpp.

References _, context_manager_, controller_base::game_config_, hotkey::get_hotkey(), gui(), gui_, hotkey::HOTKEY_QUIT_GAME, init_gui(), init_music(), init_tods(), controller_base::key_, cursor::NORMAL, events::raise_draw_event(), display::redraw_everything(), rng_, rng_setter_, cursor::set(), image::set_color_adjustment(), preferences::editor::tod_b(), preferences::editor::tod_g(), preferences::editor::tod_r(), and toolkit_.

Here is the call graph for this function:

editor::editor_controller::~editor_controller ( )

Definition at line 142 of file editor_controller.cpp.

Member Function Documentation

bool editor::editor_controller::allow_mouse_wheel_scroll	(	int	x,
		int	y
	)			`[virtual]`

Derived classes can overrid this to disable mousewheel scrolling under some circumstances, e.g.

when the mouse wheel controls something else, but the event is also received by this class

Reimplemented from events::mouse_handler_base.

Definition at line 702 of file editor_controller.cpp.

References context_manager_, and gui().

Here is the call graph for this function:

bool editor::editor_controller::can_execute_command	(	hotkey::HOTKEY_COMMAND	command,
		int	index = `-1`
	)			const

command_executor override

Definition at line 216 of file editor_controller.cpp.

Referenced by show_menu().

Here is the call graph for this function:

Here is the caller graph for this function:

void editor::editor_controller::copy_selection ( )

Copy the selection on the current map to the clipboard.

Definition at line 595 of file editor_controller.cpp.

References context_manager_.

Referenced by cut_selection(), and execute_command().

Here is the caller graph for this function:

void editor::editor_controller::cut_selection ( )

Cut the selection from the current map to the clipboard.

Definition at line 603 of file editor_controller.cpp.

References context_manager_, copy_selection(), and editor::get_selected_bg_terrain().

Referenced by execute_command().

Here is the call graph for this function:

Here is the caller graph for this function:

void editor::editor_controller::display_redraw_callback ( display & ) [private]

Callback function passed to display to be called on each redraw_everything run.

Redraws toolbar, brush bar and related items.

Definition at line 649 of file editor_controller.cpp.

References toolkit_.

Referenced by init_gui().

Here is the caller graph for this function:

void editor::editor_controller::do_screenshot ( const std::string & screenshot_filename = "map_screenshot.bmp" )

Takes a screenshot.

Definition at line 164 of file editor_controller.cpp.

References gui(), display::screenshot(), and twml_exception::show().

Here is the call graph for this function:

void editor::editor_controller::editor_settings_dialog ( )

Display the settings dialog, used to control e.g.

the lighting settings

Definition at line 194 of file editor_controller.cpp.

References _, context_manager_, gui2::teditor_settings::execute(), gui(), image::color_adjustment_resetter::reset(), gui2::show_error_message(), and tods_.

Referenced by execute_command().

Here is the call graph for this function:

Here is the caller graph for this function:

void editor::editor_controller::editor_settings_dialog_redraw_callback	(	int	r,
		int	g,
		int	b
	)			`[protected]`

Callback for the editor settings dialog to allow on-the-fly updating of the lighting display on the game map behing the dialog.

Definition at line 209 of file editor_controller.cpp.

References gui(), display::redraw_everything(), and image::set_color_adjustment().

Here is the call graph for this function:

bool editor::editor_controller::execute_command	(	hotkey::HOTKEY_COMMAND	command,
		int	index = `-1`
	)

command_executor override

Definition at line 355 of file editor_controller.cpp.

Here is the call graph for this function:

void editor::editor_controller::export_selection_coords ( )

Export the WML-compatible list of selected tiles to the system clipboard.

Definition at line 609 of file editor_controller.cpp.

References context_manager_, and copy_to_clipboard().

Referenced by execute_command().

Here is the call graph for this function:

Here is the caller graph for this function:

hotkey::ACTION_STATE editor::editor_controller::get_action_state	(	hotkey::HOTKEY_COMMAND	command,
		int	index
	)			const

command_executor override

Definition at line 325 of file editor_controller.cpp.

References hotkey::ACTION_ON, active_menu_, editor::AREA, context_manager_, gui_, gui2::hotkey(), hotkey::HOTKEY_EDITOR_DRAW_COORDINATES, hotkey::HOTKEY_EDITOR_DRAW_TERRAIN_CODES, hotkey::HOTKEY_EDITOR_TOOL_FILL, hotkey::HOTKEY_EDITOR_TOOL_LABEL, hotkey::HOTKEY_EDITOR_TOOL_PAINT, hotkey::HOTKEY_EDITOR_TOOL_SELECT, hotkey::HOTKEY_EDITOR_TOOL_STARTING_POSITION, hotkey::HOTKEY_EDITOR_TOOL_UNIT, hotkey::HOTKEY_NULL, editor::MAP, editor::PALETTE, editor::SIDE, and toolkit_.

Here is the call graph for this function:

editor_display& editor::editor_controller::get_display ( ) [inline, protected]

Definition at line 153 of file editor_controller.hpp.

References gui_.

mouse_action* editor::editor_controller::get_mouse_action ( ) [protected]

Get the current mouse action.

mouse_handler_base& editor::editor_controller::get_mouse_handler_base ( ) [inline, protected]

Definition at line 152 of file editor_controller.hpp.

editor_display& editor::editor_controller::gui ( ) [inline, virtual]

Reference to the used display objects.

Derived classes should ensure this is always valid. Note the constructor of this class cannot use this.

Implements events::mouse_handler_base.

Definition at line 137 of file editor_controller.hpp.

References gui_.

Referenced by allow_mouse_wheel_scroll(), do_screenshot(), editor_controller(), editor_settings_dialog(), editor_settings_dialog_redraw_callback(), execute_command(), init_gui(), left_click(), main_loop(), mouse_motion(), process_keyup_event(), quit_confirm(), right_click(), and show_menu().

Here is the caller graph for this function:

const editor_display& editor::editor_controller::gui ( ) const [inline, virtual]

Const version.

Implements events::mouse_handler_base.

Definition at line 138 of file editor_controller.hpp.

References gui_.

void editor::editor_controller::hotkey_quit ( )

Process a hotkey quit command.

void editor::editor_controller::init_gui ( ) [private]

init the display object and general set-up

Definition at line 103 of file editor_controller.cpp.

References context_manager_, display_redraw_callback(), preferences::editor::draw_hex_coordinates(), preferences::editor::draw_terrain_codes(), floating_label_manager_, preferences::grid(), gui(), gui_, halo_manager_, prefs_disp_manager_, display::set_draw_coordinates(), and display::set_draw_terrain_codes().

Referenced by editor_controller().

Here is the call graph for this function:

Here is the caller graph for this function:

void editor::editor_controller::init_music ( const config & game_config ) [private]

init background music for the editor

Definition at line 129 of file editor_controller.cpp.

References config::child(), config::child_range(), sound::commit_music_changes(), ERR_ED, and sound::play_music_config().

Referenced by editor_controller().

Here is the call graph for this function:

Here is the caller graph for this function:

void editor::editor_controller::init_tods ( const config & game_config ) [private]

init the available time-of-day settings

Definition at line 117 of file editor_controller.cpp.

References config::child(), config::child_range(), ERR_ED, and tods_.

Referenced by editor_controller().

Here is the call graph for this function:

Here is the caller graph for this function:

bool editor::editor_controller::left_click	(	int	x,
		int	y,
		const bool	browse
	)			`[virtual]`

Overridden in derived classes, called on a left click (mousedown).

Defaults to process (initiate) minimap scrolling.

Returns:: true when the click should not process the event further. This means do not treat the call as a start of drag movement. FIXME: This return value is currently ignored

Reimplemented from events::mouse_handler_base.

Definition at line 712 of file editor_controller.cpp.

References context_manager_, gui(), gui_, display::hex_clicked_on(), LOG_ED, perform_refresh_delete(), toolkit_, map_location::x, and map_location::y.

Here is the call graph for this function:

void editor::editor_controller::left_drag_end	(	int	x,
		int	y,
		const bool	browse
	)			`[virtual]`

Called whenever the left mouse drag has "ended".

Reimplemented from events::mouse_handler_base.

Definition at line 726 of file editor_controller.cpp.

References gui_, perform_delete(), and toolkit_.

Here is the call graph for this function:

void editor::editor_controller::left_mouse_up	(	int	x,
		int	y,
		const bool	browse
	)			`[virtual]`

Called when the left mouse button is up.

Reimplemented from events::mouse_handler_base.

Definition at line 732 of file editor_controller.cpp.

References context_manager_, gui_, perform_delete(), and toolkit_.

Here is the call graph for this function:

void editor::editor_controller::load_tooltips ( ) [private]

Load editor-specific tooltips.

EXIT_STATUS editor::editor_controller::main_loop ( )

Editor main loop.

Definition at line 149 of file editor_controller.cpp.

References _, do_quit_, gui(), controller_base::play_slice(), quit_mode_, twml_exception::show(), gui2::show_transient_message(), and game::error::what().

Here is the call graph for this function:

void editor::editor_controller::mouse_motion	(	int	x,
		int	y,
		const bool	browse,
		bool	update,
		map_location	new_loc = `map_location::null_location`
	)			`[virtual]`

Called when a mouse motion event takes place.

Derived classes mustprovide an implementation, possibly using mouse_motion_default().

Implements events::mouse_handler_base.

Definition at line 668 of file editor_controller.cpp.

References context_manager_, events::mouse_handler_base::drag_from_hex_, events::mouse_handler_base::dragging_left_, events::mouse_handler_base::dragging_right_, gui(), gui_, display::hex_clicked_on(), display::highlight_hex(), events::mouse_handler_base::is_dragging(), preferences::editor::TransitionUpdateMode::partial, and toolkit_.

Here is the call graph for this function:

void editor::editor_controller::perform_delete ( editor_action * action ) [protected]

Perform an action, then delete the action object.

The pointer can be NULL, in which case nothing will happen.

Definition at line 627 of file editor_controller.cpp.

References context_manager_.

Referenced by left_drag_end(), left_mouse_up(), right_drag_end(), and right_mouse_up().

Here is the caller graph for this function:

void editor::editor_controller::perform_refresh_delete	(	editor_action *	action,
		bool	drag_part = `false`
	)			`[protected]`

Peform an action on the current map_context, then refresh the display and delete the pointer.

The pointer can be NULL, in which case nothing will happen.

Definition at line 635 of file editor_controller.cpp.

References context_manager_.

Referenced by left_click(), process_keyup_event(), and right_click().

Here is the caller graph for this function:

void editor::editor_controller::preferences ( )

Show the preferences dialog.

Definition at line 583 of file editor_controller.cpp.

References controller_base::game_config_, gui_, and preferences::show_preferences_dialog().

Here is the call graph for this function:

void editor::editor_controller::process_keyup_event ( const SDL_Event & event ) [protected]

Definition at line 768 of file editor_controller.cpp.

References gui(), perform_refresh_delete(), and toolkit_.

Here is the call graph for this function:

void editor::editor_controller::quit_confirm ( EXIT_STATUS status )

Show a quit confirmation dialog and if confirmed quit with the given exit status.

Definition at line 173 of file editor_controller.cpp.

References _, gui2::twindow::CANCEL, context_manager_, do_quit_, gui(), quit_mode_, gui2::show_message(), and gui2::tmessage::yes_no_buttons.

Referenced by execute_command().

Here is the call graph for this function:

Here is the caller graph for this function:

void editor::editor_controller::redo ( ) [private]

Redos an action in the current map context.

Definition at line 662 of file editor_controller.cpp.

References context_manager_.

void editor::editor_controller::refresh_image_cache ( ) [private]

Reload images.

Definition at line 643 of file editor_controller.cpp.

References context_manager_, and image::flush_cache().

Referenced by execute_command().

Here is the call graph for this function:

Here is the caller graph for this function:

bool editor::editor_controller::right_click	(	int	x,
		int	y,
		const bool	browse
	)			`[virtual]`

Overridden in derived classes, called on a right click (mousedown).

Defaults to displaying the menu (by setting the appropriate flag) if right_click_show_menu returns true.

Returns:: true when the click should not process the event further. This means do not treat the call as a start of drag movement.

Reimplemented from events::mouse_handler_base.

Definition at line 740 of file editor_controller.cpp.

References context_manager_, gui(), gui_, display::hex_clicked_on(), LOG_ED, perform_refresh_delete(), toolkit_, map_location::x, and map_location::y.

Here is the call graph for this function:

bool editor::editor_controller::right_click_show_menu	(	int	x,
		int	y,
		const bool	browse
	)			`[virtual]`

Called in the default right_click when the context menu is about to be shown, can be used for preprocessing and preventing the menu from being displayed without rewriting the right click function.