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:

Public Member Functions
	editor_controller (const editor_controller &)=delete

editor_controller &	operator= (const editor_controller &)=delete

	editor_controller (bool clear_id)
	The constructor. More...

	~editor_controller ()

EXIT_STATUS	main_loop ()
	Editor main loop. More...

void	do_screenshot (const std::string &screenshot_filename="map_screenshot.png")
	Takes a screenshot. More...

bool	quit_confirm ()
	Show a quit confirmation dialog and returns true if the user pressed 'yes'. More...

void	unit_editor_dialog ()
	Show Unit Editor dialog. More...

void	custom_tods_dialog ()
	Display the settings dialog, used to control e.g. More...

void	update_map_schedule (std::vector< time_of_day > schedule)
	Updates schedule and the map display. More...

void	save_map () override
	Save the map, open dialog if not named yet. More...

bool	can_execute_command (const hotkey::ui_command &command) const override
	command_executor override More...

hotkey::ACTION_STATE	get_action_state (const hotkey::ui_command &command) const override
	command_executor override More...

bool	do_execute_command (const hotkey::ui_command &command, bool press=true, bool release=false) override
	command_executor override More...

void	show_menu (const std::vector< config > &items_arg, int xloc, int yloc, bool context_menu, display &disp) override
	controller_base override More...

void	show_help () override

void	status_table () override

void	preferences () override
	Show the preferences dialog. More...

void	scroll_up (bool on) override
	Handle hotkeys to scroll map. More...

void	scroll_down (bool on) override

void	scroll_left (bool on) override

void	scroll_right (bool on) override

void	toggle_grid () override
	Grid toggle. More...

void	terrain_description () override

void	unit_description () override

void	change_unit_id ()

void	rename_unit () override

void	unit_list () override

void	copy_selection ()
	Copy the selection on the current map to the clipboard. More...

void	cut_selection ()
	Cut the selection from the current map to the clipboard. More...

void	export_selection_coords ()
	Export the WML-compatible list of selected tiles to the system clipboard. More...

void	save_area ()
	Save the current selection to the active area. More...

void	add_area ()
	Add a new area to the current context, filled with the selection if any. More...

void	mouse_motion (int x, int y, const bool browse, bool update, map_location new_loc=map_location::null_location()) override
	Called when a mouse motion event takes place. More...

void	touch_motion (int x, int y, const bool browse, bool update=false, map_location new_loc=map_location::null_location()) override

editor_display &	gui () override
	Reference to the used display objects. More...

const editor_display &	gui () const override
	Const version of gui. More...

bool	allow_mouse_wheel_scroll (int x, int y) override
	Derived classes can override this to disable mousewheel scrolling under some circumstances, e.g. More...

bool	right_click_show_menu (int x, int y, const bool browse) override
	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. More...

bool	left_click (int x, int y, const bool browse) override
	Overridden in derived classes, called on a left click (mousedown). More...

void	left_drag_end (int x, int y, const bool browse) override
	Called whenever the left mouse drag has "ended". More...

void	left_mouse_up (int x, int y, const bool browse) override
	Called when the left mouse button is up. More...

bool	right_click (int x, int y, const bool browse) override
	Overridden in derived classes, called on a right click (mousedown). More...

void	right_drag_end (int x, int y, const bool browse) override
	Called whenever the right mouse drag has "ended". More...

void	right_mouse_up (int x, int y, const bool browse) override
	Called when the right mouse button is up. More...

virtual hotkey::command_executor *	get_hotkey_command_executor () override
	Optionally get a command executor to handle context menu events. More...

map_context &	get_current_map_context () const

bool	initialize_addon ()
	Initialize an addon if the addon id is empty. More...

Public Member Functions inherited from controller_base
	controller_base ()

virtual	~controller_base ()

virtual void	play_slice ()

void	apply_keyboard_scroll (int x, int y)

void	set_scroll_up (bool on)

void	set_scroll_down (bool on)

void	set_scroll_left (bool on)

void	set_scroll_right (bool on)

Public Member Functions inherited from events::sdl_handler
virtual void	handle_window_event (const SDL_Event &)

virtual void	process_event ()

virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	process_tooltip_string (int, int)

virtual void	join ()

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	leave ()

virtual void	join_global ()

virtual void	leave_global ()

virtual bool	has_joined ()

virtual bool	has_joined_global ()

sdl_handler &	operator= (sdl_handler &&)=delete
	Moving would require two instances' context membership to be handled, it's simpler to delete these and require the two instances to be separately constructed / destructed. More...

	sdl_handler (sdl_handler &&)=delete

Public Member Functions inherited from events::pump_monitor
	pump_monitor ()

virtual	~pump_monitor ()

Public Member Functions inherited from hotkey::command_executor_default
void	set_button_state ()

void	recalculate_minimap ()

void	lua_console ()

void	zoom_in ()

void	zoom_out ()

void	zoom_default ()

void	map_screenshot ()

void	quit_to_main_menu ()

Public Member Functions inherited from hotkey::command_executor
virtual void	cycle_units ()

virtual void	cycle_back_units ()

virtual void	end_turn ()

virtual void	goto_leader ()

virtual void	unit_hold_position ()

virtual void	end_unit_turn ()

virtual void	save_game ()

virtual void	save_replay ()

virtual void	load_game ()

virtual void	toggle_ellipses ()

virtual void	recall ()

virtual void	recruit ()

virtual void	repeat_recruit ()

virtual void	speak ()

virtual void	whisper ()

virtual void	shout ()

virtual void	create_unit ()

virtual void	change_side ()

virtual void	kill_unit ()

virtual void	objectives ()

virtual void	show_statistics ()

virtual void	stop_network ()

virtual void	start_network ()

virtual void	label_terrain (bool)

virtual void	clear_labels ()

virtual void	label_settings ()

virtual void	show_enemy_moves (bool)

virtual void	toggle_shroud_updates ()

virtual void	update_shroud_now ()

virtual void	continue_move ()

virtual void	search ()

virtual void	show_chat_log ()

virtual void	user_command ()

virtual void	custom_command ()

virtual void	ai_formula ()

virtual void	clear_messages ()

virtual void	change_language ()

virtual void	play_replay ()

virtual void	reset_replay ()

virtual void	stop_replay ()

virtual void	replay_next_turn ()

virtual void	replay_next_side ()

virtual void	replay_next_move ()

virtual void	replay_show_everything ()

virtual void	replay_show_each ()

virtual void	replay_show_team1 ()

virtual void	replay_skip_animation ()

virtual void	replay_exit ()

virtual void	whiteboard_toggle ()

virtual void	whiteboard_execute_action ()

virtual void	whiteboard_execute_all_actions ()

virtual void	whiteboard_delete_action ()

virtual void	whiteboard_bump_up_action ()

virtual void	whiteboard_bump_down_action ()

virtual void	whiteboard_suppose_dead ()

virtual void	select_hex ()

virtual void	deselect_hex ()

virtual void	move_action ()

virtual void	select_and_action ()

virtual void	select_teleport ()

virtual void	touch_hex ()

virtual void	left_mouse_click ()

virtual void	right_mouse_click ()

virtual void	toggle_accelerated_speed ()

virtual void	surrender_quit_game ()

virtual std::string	get_action_image (const hotkey::ui_command &) const

std::string	get_menu_image (display &disp, const std::string &command, int index=-1) const

void	get_menu_images (display &, std::vector< config > &items)

void	surrender_game ()

void	execute_action (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &gui)

void	queue_command (const SDL_Event &event, int index=-1)

bool	run_queued_commands ()

void	execute_quit_command ()

void	handle_keyup ()

Public Member Functions inherited from events::mouse_handler_base
	mouse_handler_base ()

virtual	~mouse_handler_base ()

bool	dragging_started () const
	If mouse/finger has moved far enough to consider it move/swipe, and not a click/touch. More...

bool	is_dragging () const

virtual int	drag_threshold () const
	Minimum dragging distance to fire the drag&drop. More...

void	mouse_motion_event (const SDL_MouseMotionEvent &event, const bool browse)

void	touch_motion_event (const SDL_TouchFingerEvent &event, const bool browse)

void	mouse_update (const bool browse, map_location loc)
	Update the mouse with a fake mouse motion. More...

bool	get_show_menu () const

bool	mouse_motion_default (int x, int y, bool update)
	This handles minimap scrolling and click-drag. More...

virtual void	mouse_press (const SDL_MouseButtonEvent &event, const bool browse)

virtual bool	mouse_button_event (const SDL_MouseButtonEvent &event, uint8_t button, map_location loc, bool click=false)

bool	is_left_click (const SDL_MouseButtonEvent &event) const

bool	is_middle_click (const SDL_MouseButtonEvent &event) const

bool	is_right_click (const SDL_MouseButtonEvent &event) const

bool	is_touch_click (const SDL_MouseButtonEvent &event) const

virtual void	mouse_wheel (int xscroll, int yscroll, bool browse)
	Called when scrolling with the mouse wheel. More...

virtual void	move_action (bool)
	Overridden in derived class. More...

virtual void	touch_action (const map_location hex, bool browse)

virtual void	mouse_wheel_up (int, int, const bool)
	Called when the mouse wheel is scrolled up. More...

virtual void	mouse_wheel_down (int, int, const bool)
	Called when the mouse wheel is scrolled down. More...

virtual void	mouse_wheel_left (int, int, const bool)
	Called when the mouse wheel is scrolled left. More...

virtual void	mouse_wheel_right (int, int, const bool)
	Called when the mouse wheel is scrolled right. More...

void	set_scroll_start (int x, int y)
	Called when the middle click scrolling. More...

const SDL_Point	get_scroll_start () const

bool	scroll_started () const

Public Attributes
const std::unique_ptr< context_manager >	context_manager_

Static Public Attributes
static std::string	current_addon_id_ = ""

Protected Member Functions
void	process_keyup_event (const SDL_Event &event) override
	Process keyup (always). More...

mouse_handler_base &	get_mouse_handler_base () override
	Get a reference to a mouse handler member a derived class uses. More...

editor_display &	get_display () override
	Get a reference to a display member a derived class uses. More...

const mouse_action &	get_mouse_action () const
	Get the current mouse action. More...

mouse_action &	get_mouse_action ()
	Get the current mouse action. More...

void	perform_delete (std::unique_ptr< editor_action > action)
	Perform an action, then delete the action object. More...

void	perform_refresh_delete (std::unique_ptr< editor_action > action, bool drag_part=false)
	Peform an action on the current map_context, then refresh the display and delete the pointer. More...

virtual std::vector< std::string >	additional_actions_pressed () override

Protected Member Functions inherited from controller_base
virtual bool	is_browsing () const

virtual soundsource::manager *	get_soundsource_man ()
	Get (optionally) a soundsources manager a derived class uses. More...

virtual plugins_context *	get_plugins_context ()
	Get (optionally) a plugins context a derived class uses. More...

virtual bool	have_keyboard_focus ()
	Derived classes should override this to return false when arrow keys should not scroll the map, hotkeys not processed etc, for example when a textbox is active. More...

bool	handle_scroll (int mousex, int mousey, int mouse_flags)
	Handle scrolling by keyboard, joystick and moving mouse near map edges. More...

void	handle_event (const SDL_Event &event) override
	Process mouse- and keypress-events from SDL. More...

virtual void	process_focus_keydown_event (const SDL_Event &)
	Process keydown (only when the general map display does not have focus). More...

virtual void	process () override

virtual void	process_keydown_event (const SDL_Event &)
	Process keydown (always). More...

virtual void	execute_action (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu)

virtual bool	in_context_menu (const hotkey::ui_command &cmd) const

void	long_touch_callback (int x, int y)

Protected Member Functions inherited from events::sdl_handler
	sdl_handler (const bool auto_join=true)

	sdl_handler (const sdl_handler &)

sdl_handler &	operator= (const sdl_handler &)

virtual	~sdl_handler ()

virtual std::vector< sdl_handler * >	handler_members ()

Protected Member Functions inherited from hotkey::command_executor
virtual	~command_executor ()

Protected Member Functions inherited from events::mouse_handler_base
void	cancel_dragging ()

void	clear_dragging (const SDL_MouseButtonEvent &event, bool browse)

void	clear_drag_from_hex ()

void	init_dragging (bool &dragging_flag)

Private Types
typedef std::map< std::string, std::pair< std::string,std::vector< time_of_day > > >	tods_map
	Pre-defined time of day lighting settings for the settings dialog. More...

Private Member Functions
void	init_gui ()
	init the display object and general set-up More...

void	init_tods (const game_config_view &game_config)
	init the available time-of-day settings More...

void	init_music (const game_config_view &game_config)
	init background music for the editor More...

void	refresh_image_cache ()
	Reload images. More...

void	display_redraw_callback (display &)
	Callback function passed to display to be called on queue_rerender. More...

void	undo () override
	Undos an action in the current map context. More...

void	redo () override
	Redos an action in the current map context. More...

Private Member Functions inherited from quit_confirmation
	quit_confirmation (const std::function< bool()> &prompt=&quit_confirmation::default_prompt)

	~quit_confirmation ()

Private Attributes
editor::menu_type	active_menu_

const std::unique_ptr< reports >	reports_
	Reports object. More...

const std::unique_ptr< editor_display >	gui_
	The display object used and owned by the editor. More...

tods_map	tods_

std::unique_ptr< editor_toolkit >	toolkit_

tooltips::manager	tooltip_manager_

std::unique_ptr< font::floating_label_context >	floating_label_manager_

std::unique_ptr< help::help_manager >	help_manager_

bool	do_quit_
	Quit main loop flag. More...

EXIT_STATUS	quit_mode_

std::vector< sound::music_track >	music_tracks_

Additional Inherited Members
Protected Attributes inherited from controller_base
const game_config_view &	game_config_

CKey	key_

bool	scrolling_

bool	scroll_up_

bool	scroll_down_

bool	scroll_left_

bool	scroll_right_

std::chrono::steady_clock::time_point	last_scroll_tick_

double	scroll_carry_x_

double	scroll_carry_y_

Protected Attributes inherited from events::mouse_handler_base
bool	simple_warp_
	MMB click (on game map) state flag. More...

bool	minimap_scrolling_
	minimap scrolling (scroll-drag) state flag More...

bool	dragging_left_
	LMB drag init flag. More...

bool	dragging_touch_
	Finger drag init flag. More...

bool	dragging_started_
	Actual drag flag. More...

bool	dragging_right_
	RMB drag init flag. More...

point	drag_from_
	Drag start position. More...

map_location	drag_from_hex_
	Drag start or mouse-down map location. More...

map_location	last_hex_
	last highlighted hex More...

bool	show_menu_
	Show context menu flag. More...

int	scroll_start_x_
	Relative to middle click scrolling. More...

int	scroll_start_y_

bool	scroll_started_

Static Private Member Functions inherited from quit_confirmation
static bool	quit ()
	Shows the quit confirmation if needed. More...

static void	quit_to_title ()

static void	quit_to_desktop ()

static bool	show_prompt (const std::string &message)

static bool	default_prompt ()

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 58 of file editor_controller.hpp.

Member Typedef Documentation

◆ tods_map

typedef std::map<std::string, std::pair<std::string ,std::vector<time_of_day> > > editor::editor_controller::tods_map

private

Pre-defined time of day lighting settings for the settings dialog.

Definition at line 235 of file editor_controller.hpp.

Constructor & Destructor Documentation

◆ editor_controller() [1/2]

editor::editor_controller::editor_controller ( const editor_controller & )

delete

◆ editor_controller() [2/2]

editor::editor_controller::editor_controller ( bool clear_id )

The constructor.

Definition at line 70 of file editor_controller.cpp.

References context_manager_, current_addon_id_, controller_base::game_config_, get_current_map_context(), gui(), gui_, help_manager_, init_gui(), init_music(), init_tods(), controller_base::key_, cursor::NORMAL, display::queue_rerender(), cursor::set(), editor::map_context::set_starting_position_labels(), and toolkit_.

◆ ~editor_controller()

editor::editor_controller::~editor_controller ( )

Definition at line 172 of file editor_controller.cpp.

References resources::classification, resources::filter_con, and resources::tod_manager.

Member Function Documentation

◆ add_area()

void editor::editor_controller::add_area ( )

Add a new area to the current context, filled with the selection if any.

Definition at line 1361 of file editor_controller.cpp.

References get_current_map_context(), editor::map_context::map(), editor::map_context::new_area(), and editor::editor_map::selection().

Referenced by do_execute_command().

◆ additional_actions_pressed()

std::vector< std::string > editor::editor_controller::additional_actions_pressed ( )

overrideprotectedvirtual

Reimplemented from controller_base.

Definition at line 1589 of file editor_controller.cpp.

References toolkit_.

◆ allow_mouse_wheel_scroll()

bool editor::editor_controller::allow_mouse_wheel_scroll	(	int	,
		int
	)

overridevirtual

Derived classes can override 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 1464 of file editor_controller.cpp.

References get_current_map_context(), gui(), editor::map_context::map(), and gamemap_base::on_board_with_border().

◆ can_execute_command()

bool editor::editor_controller::can_execute_command ( const hotkey::ui_command & command ) const

overridevirtual

command_executor override

Implements hotkey::command_executor.

Definition at line 307 of file editor_controller.cpp.

Referenced by show_menu().

◆ change_unit_id()

void editor::editor_controller::change_unit_id ( )

Definition at line 1309 of file editor_controller.cpp.

References unit_map::end(), unit_map::find(), get_current_map_context(), gui_, label, N_, and editor::map_context::units().

Referenced by do_execute_command().

◆ copy_selection()

void editor::editor_controller::copy_selection ( )

Copy the selection on the current map to the clipboard.

Definition at line 1301 of file editor_controller.cpp.

References context_manager_, and get_current_map_context().

Referenced by cut_selection(), and do_execute_command().

◆ custom_tods_dialog()

void editor::editor_controller::custom_tods_dialog ( )

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

the lighting settings

Definition at line 235 of file editor_controller.cpp.

References _(), context_manager_, current_addon_id_, chrono::format_local_timestamp(), get_current_map_context(), tod_manager::get_current_time(), gui2::dialogs::custom_tod::get_schedule(), editor::map_context::get_time_manager(), gui_, gui2::dialogs::custom_tod::register_callback(), editor::map_context::replace_schedule(), editor::map_context::save_schedule(), gui2::dialogs::modal_dialog::show(), gui2::show_error_message(), tod_manager::times(), timestamp, tods_, and update_map_schedule().

Referenced by do_execute_command().

◆ cut_selection()

void editor::editor_controller::cut_selection ( )

Cut the selection from the current map to the clipboard.

Definition at line 1349 of file editor_controller.cpp.

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

Referenced by do_execute_command().

◆ display_redraw_callback()

void editor::editor_controller::display_redraw_callback ( display & )

private

Callback function passed to display to be called on queue_rerender.

Redraws toolbar, brush bar and related items.

Definition at line 1405 of file editor_controller.cpp.

References get_current_map_context(), editor::map_context::get_labels(), map_labels::recalculate_labels(), hotkey::command_executor_default::set_button_state(), and toolkit_.

Referenced by init_gui().

◆ do_execute_command()

bool editor::editor_controller::do_execute_command	(	const hotkey::ui_command &	command,
		bool	press = `true`,
		bool	release = `false`
	)

overridevirtual

command_executor override

Reimplemented from hotkey::command_executor.

Definition at line 682 of file editor_controller.cpp.

◆ do_screenshot()

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

Takes a screenshot.

Definition at line 198 of file editor_controller.cpp.

References e, ERR_ED, gui(), image::save_image(), display::screenshot(), and image::success.

◆ export_selection_coords()

void editor::editor_controller::export_selection_coords ( )

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

Definition at line 1367 of file editor_controller.cpp.

References desktop::clipboard::copy_to_clipboard(), get_current_map_context(), i, editor::map_context::map(), and editor::editor_map::selection().

Referenced by do_execute_command().

◆ get_action_state()

hotkey::ACTION_STATE editor::editor_controller::get_action_state ( const hotkey::ui_command & command ) const

overridevirtual

command_executor override

Reimplemented from hotkey::command_executor.

Definition at line 540 of file editor_controller.cpp.

◆ get_current_map_context()

map_context& editor::editor_controller::get_current_map_context ( ) const

inline

◆ get_display()

editor_display& editor::editor_controller::get_display ( )

inlineoverrideprotectedvirtual

Get a reference to a display member a derived class uses.

Implements controller_base.

Definition at line 174 of file editor_controller.hpp.

References gui_.

◆ get_hotkey_command_executor()

hotkey::command_executor * editor::editor_controller::get_hotkey_command_executor ( )

overridevirtual

Optionally get a command executor to handle context menu events.

Reimplemented from controller_base.

Definition at line 1565 of file editor_controller.cpp.

◆ get_mouse_action() [1/2]

mouse_action& editor::editor_controller::get_mouse_action ( )

inlineprotected

Get the current mouse action.

Definition at line 179 of file editor_controller.hpp.

References toolkit_.

◆ get_mouse_action() [2/2]

const mouse_action& editor::editor_controller::get_mouse_action ( ) const

inlineprotected

Get the current mouse action.

Definition at line 177 of file editor_controller.hpp.

References toolkit_.

Referenced by can_execute_command(), left_click(), left_drag_end(), left_mouse_up(), mouse_motion(), process_keyup_event(), right_click(), right_click_show_menu(), right_drag_end(), and right_mouse_up().

◆ get_mouse_handler_base()

mouse_handler_base& editor::editor_controller::get_mouse_handler_base ( )

inlineoverrideprotectedvirtual

Get a reference to a mouse handler member a derived class uses.

Implements controller_base.

Definition at line 173 of file editor_controller.hpp.

◆ gui() [1/2]

const editor_display& editor::editor_controller::gui ( ) const

inlineoverridevirtual

Const version of gui.

Implements events::mouse_handler_base.

Definition at line 148 of file editor_controller.hpp.

References gui_.

◆ gui() [2/2]

editor_display& editor::editor_controller::gui ( )

inlineoverridevirtual

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 147 of file editor_controller.hpp.

References gui_.

Referenced by allow_mouse_wheel_scroll(), can_execute_command(), do_execute_command(), do_screenshot(), editor_controller(), init_gui(), left_click(), mouse_motion(), process_keyup_event(), right_click(), show_menu(), and terrain_description().

◆ init_gui()

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 display::DEBUG_COORDINATES, display::DEBUG_NUM_BITMAPS, display::DEBUG_TERRAIN_CODES, display_redraw_callback(), floating_label_manager_, prefs::get(), get_current_map_context(), gui(), gui_, display::set_debug_flag(), and editor::editor_display::set_help_string_enabled().

Referenced by editor_controller().

◆ init_music()

void editor::editor_controller::init_music ( const game_config_view & game_config )

private

init background music for the editor

Definition at line 153 of file editor_controller.cpp.

References config::child_range(), ERR_ED, sound::music_track::file_path(), sound::music_track::id(), music_tracks_, and WRN_ED.

Referenced by editor_controller().

◆ init_tods()

void editor::editor_controller::init_tods ( const game_config_view & game_config )

private

init the available time-of-day settings

Definition at line 120 of file editor_controller.cpp.

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

Referenced by editor_controller().

◆ initialize_addon()

bool editor::editor_controller::initialize_addon ( )

Initialize an addon if the addon id is empty.

Returns: If the initialization succeeded.

Definition at line 1156 of file editor_controller.cpp.

References context_manager_, current_addon_id_, and editor::initialize_addon().

Referenced by do_execute_command().

◆ left_click()

bool editor::editor_controller::left_click	(	int	x,
		int	y,
		const bool	browse
	)

overridevirtual

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 1474 of file editor_controller.cpp.

References editor::mouse_action::click_left(), get_current_map_context(), get_mouse_action(), gui(), gui_, display::hex_clicked_on(), LOG_ED, perform_refresh_delete(), hotkey::command_executor_default::set_button_state(), and toolkit_.

◆ left_drag_end()

void editor::editor_controller::left_drag_end	(	int	,
		int	,
		const bool	browse
	)

overridevirtual

Called whenever the left mouse drag has "ended".

Reimplemented from events::mouse_handler_base.

Definition at line 1495 of file editor_controller.cpp.

References editor::mouse_action::drag_end_left(), get_mouse_action(), gui_, and perform_delete().

◆ left_mouse_up()

void editor::editor_controller::left_mouse_up	(	int	,
		int	,
		const bool
	)

overridevirtual

Called when the left mouse button is up.

Reimplemented from events::mouse_handler_base.

Definition at line 1501 of file editor_controller.cpp.

References context_manager_, get_mouse_action(), gui_, perform_delete(), hotkey::command_executor_default::set_button_state(), toolkit_, and editor::mouse_action::up_left().

◆ main_loop()

EXIT_STATUS editor::editor_controller::main_loop ( )

Editor main loop.

Definition at line 180 of file editor_controller.cpp.

References _(), do_quit_, e, editor::EXIT_ERROR, controller_base::play_slice(), quit_mode_, and gui2::show_transient_message().

◆ mouse_motion()

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

overridevirtual

Called when a mouse motion event takes place.

Derived classes must provide an implementation, possibly using mouse_motion_default().

Implements events::mouse_handler_base.

Definition at line 1424 of file editor_controller.cpp.

References context_manager_, events::mouse_handler_base::drag_from_hex_, editor::mouse_action::drag_left(), editor::mouse_action::drag_right(), events::mouse_handler_base::dragging_left_, events::mouse_handler_base::dragging_right_, get_current_map_context(), get_mouse_action(), sdl::get_mouse_button_mask(), gui(), gui_, display::hex_clicked_on(), display::highlight_hex(), events::mouse_handler_base::is_dragging(), editor::map_context::last_undo_action(), editor::mouse_action::move(), partial, editor::map_context::perform_action(), editor::map_context::perform_partial_action(), and draw_manager::update().

◆ operator=()

editor_controller& editor::editor_controller::operator= ( const editor_controller & )

delete

◆ perform_delete()

void editor::editor_controller::perform_delete ( std::unique_ptr< editor_action > action )

protected

Perform an action, then delete the action object.

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

Definition at line 1385 of file editor_controller.cpp.

References get_current_map_context(), and editor::map_context::perform_action().

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

◆ perform_refresh_delete()

void editor::editor_controller::perform_refresh_delete	(	std::unique_ptr< 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 nullptr, in which case nothing will happen.

Definition at line 1392 of file editor_controller.cpp.

References context_manager_.

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

◆ preferences()

void editor::editor_controller::preferences ( )

overridevirtual

Show the preferences dialog.

Reimplemented from hotkey::command_executor.

Definition at line 1274 of file editor_controller.cpp.

References gui_.

◆ process_keyup_event()

void editor::editor_controller::process_keyup_event ( const SDL_Event & )

overrideprotectedvirtual

Process keyup (always).

Overridden in derived classes

Reimplemented from controller_base.

Definition at line 1558 of file editor_controller.cpp.

References get_mouse_action(), gui(), editor::mouse_action::key_event(), perform_refresh_delete(), and toolkit_.

◆ quit_confirm()

bool editor::editor_controller::quit_confirm ( )

Show a quit confirmation dialog and returns true if the user pressed 'yes'.

Definition at line 210 of file editor_controller.cpp.

References _(), context_manager_, get_current_map_context(), and quit_confirmation::show_prompt().

◆ redo()

void editor::editor_controller::redo ( )

overrideprivatevirtual

Redos an action in the current map context.

Reimplemented from hotkey::command_executor.

Definition at line 1418 of file editor_controller.cpp.

References context_manager_, get_current_map_context(), and editor::map_context::redo().

◆ refresh_image_cache()

void editor::editor_controller::refresh_image_cache ( )

private

Reload images.

Definition at line 1399 of file editor_controller.cpp.

References context_manager_, and image::flush_cache().

Referenced by do_execute_command().

◆ rename_unit()

void editor::editor_controller::rename_unit ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1326 of file editor_controller.cpp.

References unit_map::end(), unit_map::find(), get_current_map_context(), gui_, label, N_, and editor::map_context::units().

◆ right_click()

bool editor::editor_controller::right_click	(	int	x,
		int	y,
		const bool	browse
	)

overridevirtual

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 1512 of file editor_controller.cpp.

References editor::mouse_action::click_right(), get_current_map_context(), get_mouse_action(), gui(), gui_, display::hex_clicked_on(), LOG_ED, perform_refresh_delete(), hotkey::command_executor_default::set_button_state(), and toolkit_.

◆ right_click_show_menu()

bool editor::editor_controller::right_click_show_menu	(	int	,
		int	,
		const bool
	)

overridevirtual

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.

Returns: true when the menu should be displayed and false otherwise FIXME: This return value is currently ignored

Reimplemented from events::mouse_handler_base.

Definition at line 1469 of file editor_controller.cpp.

References get_mouse_action(), and editor::mouse_action::has_context_menu().

◆ right_drag_end()

void editor::editor_controller::right_drag_end	(	int	,
		int	,
		const bool
	)

overridevirtual

Called whenever the right mouse drag has "ended".

Reimplemented from events::mouse_handler_base.

Definition at line 1528 of file editor_controller.cpp.

References editor::mouse_action::drag_end_right(), get_mouse_action(), gui_, and perform_delete().

◆ right_mouse_up()

void editor::editor_controller::right_mouse_up	(	int	x,
		int	y,
		const bool	browse
	)

overridevirtual

Called when the right mouse button is up.

Reimplemented from events::mouse_handler_base.

Definition at line 1534 of file editor_controller.cpp.

References context_manager_, get_mouse_action(), gui_, perform_delete(), hotkey::command_executor_default::set_button_state(), toolkit_, and editor::mouse_action::up_right().

◆ save_area()

void editor::editor_controller::save_area ( )

Save the current selection to the active area.

Definition at line 1355 of file editor_controller.cpp.

References get_current_map_context(), editor::map_context::map(), editor::map_context::save_area(), and editor::editor_map::selection().

Referenced by do_execute_command().

◆ save_map()

void editor::editor_controller::save_map ( )

inlineoverridevirtual

Save the map, open dialog if not named yet.

Reimplemented from hotkey::command_executor.

Definition at line 93 of file editor_controller.hpp.

References context_manager_.

Referenced by do_execute_command().

◆ scroll_down()

void editor::editor_controller::scroll_down ( bool on )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1574 of file editor_controller.cpp.

References controller_base::set_scroll_down().

◆ scroll_left()

void editor::editor_controller::scroll_left ( bool on )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1579 of file editor_controller.cpp.

References controller_base::set_scroll_left().

◆ scroll_right()

void editor::editor_controller::scroll_right ( bool on )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1584 of file editor_controller.cpp.

References controller_base::set_scroll_right().

◆ scroll_up()

void editor::editor_controller::scroll_up ( bool on )

overridevirtual

Handle hotkeys to scroll map.

Reimplemented from hotkey::command_executor.

Definition at line 1569 of file editor_controller.cpp.

References controller_base::set_scroll_up().

◆ show_help()

void editor::editor_controller::show_help ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1165 of file editor_controller.cpp.

References help::show_help().

◆ show_menu()

void editor::editor_controller::show_menu	(	const std::vector< config > &	items_arg,
		int	xloc,
		int	yloc,
		bool	context_menu,
		display &	disp
	)

overridevirtual

controller_base override

Reimplemented from controller_base.

Definition at line 1170 of file editor_controller.cpp.

References active_menu_, editor::ADDON, editor::AREA, c, can_execute_command(), context_manager_, get_current_map_context(), hotkey::get_hotkey_command(), gui(), hotkey::ui_command::hotkey_command, hotkey::HOTKEY_NULL, controller_base::in_context_menu(), map_location::indeterminate, editor::LOAD_MRU, editor::LOCAL_TIME, editor::MAP, editor::MUSIC, music_tracks_, editor::PALETTE, editor::SIDE, editor::TIME, toolkit_, editor::UNIT_FACING, and map_location::write_translated_direction().

Referenced by do_execute_command().

◆ status_table()

void editor::editor_controller::status_table ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 195 of file editor_controller.cpp.

◆ terrain_description()

void editor::editor_controller::terrain_description ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1548 of file editor_controller.cpp.

References get_current_map_context(), gamemap::get_terrain_info(), gui(), editor::map_context::map(), display::mouseover_hex(), and help::show_terrain_description().

◆ toggle_grid()

void editor::editor_controller::toggle_grid ( )

overridevirtual

Grid toggle.

Reimplemented from hotkey::command_executor.

Definition at line 1282 of file editor_controller.cpp.

References prefs::get(), and gui_.

◆ touch_motion()

void editor::editor_controller::touch_motion	(	int	x,
		int	y,
		const bool	browse,
		bool	update = `false`,
		map_location	new_loc = `map_location::null_location()`
	)

overridevirtual

Implements events::mouse_handler_base.

Definition at line 1459 of file editor_controller.cpp.

◆ undo()

void editor::editor_controller::undo ( )

overrideprivatevirtual

Undos an action in the current map context.

Reimplemented from hotkey::command_executor.

Definition at line 1412 of file editor_controller.cpp.

References context_manager_, get_current_map_context(), and editor::map_context::undo().

Referenced by do_execute_command().

◆ unit_description()

void editor::editor_controller::unit_description ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1288 of file editor_controller.cpp.

References unit_map::end(), unit_map::find(), get_current_map_context(), gui_, help::show_help(), help::show_unit_help(), and editor::map_context::units().

◆ unit_editor_dialog()

void editor::editor_controller::unit_editor_dialog ( )

Show Unit Editor dialog.

Definition at line 227 of file editor_controller.cpp.

References current_addon_id_, controller_base::game_config_, gui2::dialogs::modal_dialog::show(), and gui2::dialogs::editor_edit_unit::write().

Referenced by do_execute_command().

◆ unit_list()

void editor::editor_controller::unit_list ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 1344 of file editor_controller.cpp.

References gui_, and gui2::dialogs::show_unit_list().

◆ update_map_schedule()

void editor::editor_controller::update_map_schedule ( std::vector< time_of_day > schedule )

Updates schedule and the map display.

Definition at line 300 of file editor_controller.cpp.

References context_manager_, get_current_map_context(), gui_, and editor::map_context::replace_schedule().

Referenced by custom_tods_dialog().

Member Data Documentation

◆ active_menu_

editor::menu_type editor::editor_controller::active_menu_

private

Definition at line 226 of file editor_controller.hpp.

Referenced by can_execute_command(), do_execute_command(), get_action_state(), and show_menu().

◆ context_manager_

const std::unique_ptr<context_manager> editor::editor_controller::context_manager_

◆ current_addon_id_

std::string editor::editor_controller::current_addon_id_ = ""

static

Definition at line 242 of file editor_controller.hpp.

Referenced by can_execute_command(), custom_tods_dialog(), do_execute_command(), editor_controller(), initialize_addon(), editor::context_manager::load_map_dialog(), and unit_editor_dialog().

◆ do_quit_

bool editor::editor_controller::do_quit_

private

Quit main loop flag.

Definition at line 251 of file editor_controller.hpp.

Referenced by do_execute_command(), and main_loop().

◆ floating_label_manager_

std::unique_ptr<font::floating_label_context> editor::editor_controller::floating_label_manager_

private

Definition at line 246 of file editor_controller.hpp.

Referenced by init_gui().

◆ gui_

const std::unique_ptr<editor_display> editor::editor_controller::gui_

private

The display object used and owned by the editor.

Definition at line 232 of file editor_controller.hpp.

Referenced by can_execute_command(), change_unit_id(), custom_tods_dialog(), do_execute_command(), editor_controller(), get_action_state(), get_display(), gui(), init_gui(), left_click(), left_drag_end(), left_mouse_up(), mouse_motion(), preferences(), rename_unit(), right_click(), right_drag_end(), right_mouse_up(), toggle_grid(), unit_description(), unit_list(), and update_map_schedule().

◆ help_manager_

std::unique_ptr<help::help_manager> editor::editor_controller::help_manager_

private

Definition at line 248 of file editor_controller.hpp.

Referenced by editor_controller().

◆ music_tracks_

std::vector<sound::music_track> editor::editor_controller::music_tracks_

private

Definition at line 254 of file editor_controller.hpp.

Referenced by do_execute_command(), get_action_state(), init_music(), and show_menu().

◆ quit_mode_

EXIT_STATUS editor::editor_controller::quit_mode_

private

Definition at line 252 of file editor_controller.hpp.

Referenced by do_execute_command(), and main_loop().

◆ reports_

const std::unique_ptr<reports> editor::editor_controller::reports_

private

Reports object.

Must be initialized before the gui_

Definition at line 229 of file editor_controller.hpp.

◆ tods_

tods_map editor::editor_controller::tods_

private

Definition at line 236 of file editor_controller.hpp.

Referenced by custom_tods_dialog(), do_execute_command(), get_action_state(), and init_tods().

◆ toolkit_

std::unique_ptr<editor_toolkit> editor::editor_controller::toolkit_

private

Definition at line 244 of file editor_controller.hpp.

Referenced by additional_actions_pressed(), can_execute_command(), display_redraw_callback(), do_execute_command(), editor_controller(), get_action_state(), get_mouse_action(), left_click(), left_mouse_up(), process_keyup_event(), right_click(), right_mouse_up(), and show_menu().

◆ tooltip_manager_

tooltips::manager editor::editor_controller::tooltip_manager_

private

Definition at line 245 of file editor_controller.hpp.

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

editor/controller/editor_controller.hpp
editor/controller/editor_controller.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ tods_map

Constructor & Destructor Documentation

◆ editor_controller() [1/2]

◆ editor_controller() [2/2]

◆ ~editor_controller()

Member Function Documentation

◆ add_area()

◆ additional_actions_pressed()

◆ allow_mouse_wheel_scroll()

◆ can_execute_command()

◆ change_unit_id()

◆ copy_selection()

◆ custom_tods_dialog()

◆ cut_selection()

◆ display_redraw_callback()

◆ do_execute_command()

◆ do_screenshot()

◆ export_selection_coords()

◆ get_action_state()

◆ get_current_map_context()

◆ get_display()

◆ get_hotkey_command_executor()

◆ get_mouse_action() [1/2]

◆ get_mouse_action() [2/2]

◆ get_mouse_handler_base()

◆ gui() [1/2]

◆ gui() [2/2]

◆ init_gui()

◆ init_music()

◆ init_tods()

◆ initialize_addon()

◆ left_click()

◆ left_drag_end()

◆ left_mouse_up()

◆ main_loop()

◆ mouse_motion()

◆ operator=()

◆ perform_delete()

◆ perform_refresh_delete()

◆ preferences()

◆ process_keyup_event()

◆ quit_confirm()

◆ redo()

◆ refresh_image_cache()

◆ rename_unit()

◆ right_click()

◆ right_click_show_menu()

◆ right_drag_end()

◆ right_mouse_up()

◆ save_area()

◆ save_map()

◆ scroll_down()

◆ scroll_left()

◆ scroll_right()

◆ scroll_up()

◆ show_help()

◆ show_menu()

◆ status_table()

◆ terrain_description()

◆ toggle_grid()

◆ touch_motion()

◆ undo()

◆ unit_description()

◆ unit_editor_dialog()

◆ unit_list()

◆ update_map_schedule()

Member Data Documentation

◆ active_menu_

◆ context_manager_

◆ current_addon_id_