Fill action. More...

#include <mouse_action.hpp>

Inheritance diagram for editor::mouse_action_fill:

Public Member Functions
	mouse_action_fill (const CKey &key, terrain_palette &terrain_palette)

std::set< map_location >	affected_hexes (editor_display &disp, const map_location &hex) override
	Tiles that will be painted to, possibly use modifier keys here. More...

std::unique_ptr< editor_action >	click_left (editor_display &disp, int x, int y) override
	Left / right click fills with the respective terrain. More...

std::unique_ptr< editor_action >	click_right (editor_display &disp, int x, int y) override
	Left / right click fills with the respective terrain. More...

virtual void	set_mouse_overlay (editor_display &disp) override
	Set the mouse overlay for this action. More...

Public Member Functions inherited from editor::mouse_action
	mouse_action (common_palette &palette, const CKey &key)

virtual	~mouse_action ()

virtual bool	has_context_menu () const

virtual void	move (editor_display &disp, const map_location &hex)
	Mouse move (not a drag). More...

void	update_brush_highlights (editor_display &disp, const map_location &hex)
	Unconditionally update the brush highlights for the current tool when hex is the center location. More...

virtual std::unique_ptr< editor_action >	drag_left (editor_display &disp, int x, int y, bool &partial, editor_action *last_undo)
	Drag operation. More...

virtual std::unique_ptr< editor_action >	drag_right (editor_display &disp, int x, int y, bool &partial, editor_action *last_undo)
	Drag operation. More...

virtual std::unique_ptr< editor_action >	drag_end_left (editor_display &disp, int x, int y)
	The end of dragging. More...

virtual std::unique_ptr< editor_action >	drag_end_right (editor_display &disp, int x, int y)

virtual std::unique_ptr< editor_action >	up_left (editor_display &disp, int x, int y)

virtual std::unique_ptr< editor_action >	up_right (editor_display &disp, int x, int y)

virtual std::unique_ptr< editor_action >	key_event (editor_display &disp, const SDL_Event &e)
	Function called by the controller on a key event for the current mouse action. More...

void	set_toolbar_button (const theme::menu *value)
	Helper variable setter - pointer to a toolbar menu/button used for highlighting the current action. More...

const theme::menu *	toolbar_button () const
	Getter for the (possibly nullptr) associated menu/button. More...

common_palette &	get_palette ()
	Getter for the associated palette. More...

virtual bool	supports_brushes () const
	Whether we need the brush bar, is used to grey it out. More...

Protected Attributes
terrain_palette &	terrain_palette_

Protected Attributes inherited from editor::mouse_action
map_location	previous_move_hex_
	The hex previously used in move operations. More...

const CKey &	key_
	Key presses, used for modifiers (alt, shift) in some operations. More...

Additional Inherited Members
Protected Member Functions inherited from editor::mouse_action
bool	has_alt_modifier () const

bool	has_shift_modifier () const

bool	has_ctrl_modifier () const

void	set_terrain_mouse_overlay (editor_display &disp, const t_translation::terrain_code &fg, const t_translation::terrain_code &bg)
	Helper function for derived classes that need a active-terrain mouse overlay. More...

Detailed Description

Fill action.

No dragging capabilities. Uses keyboard modifiers for one-layer painting.

Definition at line 331 of file mouse_action.hpp.

Constructor & Destructor Documentation

◆ mouse_action_fill()

editor::mouse_action_fill::mouse_action_fill	(	const CKey &	key,
		terrain_palette &	terrain_palette
	)

inline

Definition at line 334 of file mouse_action.hpp.

Member Function Documentation

◆ affected_hexes()

std::set< map_location > editor::mouse_action_fill::affected_hexes	(	editor_display &	disp,
		const map_location &	hex
	)

overridevirtual

Tiles that will be painted to, possibly use modifier keys here.

Reimplemented from editor::mouse_action.

Definition at line 340 of file mouse_action.cpp.

References editor::editor_map::get_contiguous_terrain_tiles(), and editor::editor_display::get_map().

◆ click_left()

std::unique_ptr< editor_action > editor::mouse_action_fill::click_left	(	editor_display &	disp,
		int	x,
		int	y
	)

overridevirtual

Left / right click fills with the respective terrain.

Todo:: only take the base terrain into account when searching for contiguous terrain when painting base only

Implements editor::mouse_action.

Definition at line 346 of file mouse_action.cpp.

References editor::editor_display::get_map(), gamemap_base::get_terrain(), editor::mouse_action::has_ctrl_modifier(), editor::mouse_action::has_shift_modifier(), display::hex_clicked_on(), editor::terrain_palette::select_fg_item(), editor::terrain_palette::selected_fg_item(), and terrain_palette_.

◆ click_right()

std::unique_ptr< editor_action > editor::mouse_action_fill::click_right	(	editor_display &	disp,
		int	x,
		int	y
	)

overridevirtual

Left / right click fills with the respective terrain.

Todo:: only take the base terrain into account when searching for contiguous terrain when painting base only

Implements editor::mouse_action.

Definition at line 360 of file mouse_action.cpp.

References editor::editor_display::get_map(), gamemap_base::get_terrain(), editor::mouse_action::has_ctrl_modifier(), editor::mouse_action::has_shift_modifier(), display::hex_clicked_on(), editor::terrain_palette::select_bg_item(), editor::terrain_palette::selected_bg_item(), and terrain_palette_.

◆ set_mouse_overlay()

void editor::mouse_action_fill::set_mouse_overlay ( editor_display & disp )

overridevirtual

Set the mouse overlay for this action.

Defaults to an empty overlay.

Reimplemented from editor::mouse_action.

Definition at line 374 of file mouse_action.cpp.

References editor::terrain_palette::selected_bg_item(), editor::terrain_palette::selected_fg_item(), editor::mouse_action::set_terrain_mouse_overlay(), and terrain_palette_.

Member Data Documentation

◆ terrain_palette_

terrain_palette& editor::mouse_action_fill::terrain_palette_

protected

Definition at line 359 of file mouse_action.hpp.

Referenced by click_left(), click_right(), and set_mouse_overlay().

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

editor/action/mouse/mouse_action.hpp
editor/action/mouse/mouse_action.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ mouse_action_fill()

Member Function Documentation

◆ affected_hexes()

◆ click_left()

◆ click_right()

◆ set_mouse_overlay()

Member Data Documentation

◆ terrain_palette_