item placement action class More...
#include <mouse_action_item.hpp>
Public Member Functions | |
mouse_action_item (const CKey &key, item_palette &palette) | |
bool | has_context_menu () const override |
void | move (editor_display &disp, const map_location &hex) override |
Mouse move (not a drag). More... | |
std::unique_ptr< editor_action > | click_left (editor_display &disp, int x, int y) override |
Left clicking places the currently selected item on the x,y map hex. More... | |
std::unique_ptr< editor_action > | click_right (editor_display &disp, int x, int y) override |
Right clicking removes the item on the x,y map hex. More... | |
std::unique_ptr< editor_action > | up_left (editor_display &disp, int x, int y) override |
TODO. More... | |
std::unique_ptr< editor_action > | drag_left (editor_display &disp, int x, int y, bool &partial, editor_action *last_undo) override |
Drag operation. More... | |
std::unique_ptr< editor_action > | drag_end_left (editor_display &disp, int x, int y) override |
Drag end replaces the item when clicked left, or adjusts the facing when clicked right. More... | |
virtual void | set_mouse_overlay (editor_display &disp) override |
Set the mouse overlay for this action. More... | |
void | set_item_mouse_overlay (editor_display &disp, const overlay &u) |
Public Member Functions inherited from editor::mouse_action | |
mouse_action (common_palette &palette, const CKey &key) | |
virtual | ~mouse_action () |
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::set< map_location > | affected_hexes (editor_display &disp, const map_location &hex) |
Locations that would be affected by a click, used by move to update highlights. 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_right (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... | |
Private Attributes | |
bool | click_ |
map_location | start_hex_ |
item_palette & | item_palette_ |
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... | |
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... | |
item placement action class
Definition at line 28 of file mouse_action_item.hpp.
|
inline |
Definition at line 31 of file mouse_action_item.hpp.
|
overridevirtual |
Left clicking places the currently selected item on the x,y map hex.
Implements editor::mouse_action.
Definition at line 46 of file mouse_action_item.cpp.
References display::add_overlay(), click_, display::get_map(), display::hex_clicked_on(), item_palette_, gamemap_base::on_board(), editor::editor_palette< Item >::selected_fg_item(), and start_hex_.
|
overridevirtual |
Right clicking removes the item on the x,y map hex.
Implements editor::mouse_action.
Definition at line 60 of file mouse_action_item.cpp.
References click_, display::get_map(), display::hex_clicked_on(), gamemap_base::on_board(), display::remove_overlay(), and start_hex_.
|
overridevirtual |
Drag end replaces the item when clicked left, or adjusts the facing when clicked right.
Reimplemented from editor::mouse_action.
Definition at line 118 of file mouse_action_item.cpp.
References click_, display::get_map(), display::hex_clicked_on(), gamemap_base::on_board(), and start_hex_.
|
overridevirtual |
Drag operation.
A click should have occurred earlier. Defaults to no action.
Reimplemented from editor::mouse_action.
Definition at line 73 of file mouse_action_item.cpp.
References click_, display::hex_clicked_on(), and start_hex_.
|
inlineoverridevirtual |
Reimplemented from editor::mouse_action.
Definition at line 39 of file mouse_action_item.hpp.
|
overridevirtual |
Mouse move (not a drag).
Never changes anything (other than temporary highlights and similar)
Reimplemented from editor::mouse_action.
Definition at line 29 of file mouse_action_item.cpp.
References get_adjacent_tiles(), display::invalidate(), editor::mouse_action::previous_move_hex_, and editor::mouse_action::update_brush_highlights().
void editor::mouse_action_item::set_item_mouse_overlay | ( | editor_display & | disp, |
const overlay & | u | ||
) |
Definition at line 140 of file mouse_action_item.cpp.
References image::get_texture(), overlay::image, and editor::editor_display::set_mouseover_hex_overlay().
Referenced by set_mouse_overlay().
|
overridevirtual |
Set the mouse overlay for this action.
Defaults to an empty overlay.
Reimplemented from editor::mouse_action.
Definition at line 134 of file mouse_action_item.cpp.
References item_palette_, editor::editor_palette< Item >::selected_fg_item(), and set_item_mouse_overlay().
|
overridevirtual |
TODO.
Reimplemented from editor::mouse_action.
Definition at line 80 of file mouse_action_item.cpp.
References click_, display::get_map(), display::hex_clicked_on(), and gamemap_base::on_board().
|
private |
Definition at line 72 of file mouse_action_item.hpp.
Referenced by click_left(), click_right(), drag_end_left(), drag_left(), and up_left().
|
private |
Definition at line 75 of file mouse_action_item.hpp.
Referenced by click_left(), and set_mouse_overlay().
|
private |
Definition at line 74 of file mouse_action_item.hpp.
Referenced by click_left(), click_right(), drag_end_left(), and drag_left().