The Battle for Wesnoth  1.17.0-dev
mouse_action_village.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2021
3  by Fabian Mueller <fabianmueller5@gmx.de>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
19 
20 class CKey;
21 class empty_palette;
22 
23 namespace editor {
24 
25 /**
26  * Editor mouse action class.
27  * Called by the editor tool to assign village ownership to defined sides.
28  */
30 {
31 public:
33  : mouse_action(palette, key)
34  {
35  }
36 
37  /**
38  * No action.
39  */
40  std::unique_ptr<editor_action> click_left(editor_display& /*disp*/, int /*x*/, int /*y*/) override {return nullptr;}
41 
42  /**
43  * If clicked on a village hex field, assigns the ownership of it to the current side.
44  */
45  std::unique_ptr<editor_action> up_left(editor_display& disp, int x, int y) override;
46 
47  /**
48  * No action.
49  */
50  std::unique_ptr<editor_action> click_right(editor_display& /*disp*/, int /*x*/, int /*y*/) override {return nullptr;}
51 
52  /**
53  * If clicked on a village hex field, unassigns it's ownership.
54  */
55  std::unique_ptr<editor_action> up_right(editor_display& disp, int x, int y) override;
56 
57  virtual void set_mouse_overlay(editor_display& disp) override;
58 };
59 
60 
61 } //end namespace editor
std::unique_ptr< editor_action > up_left(editor_display &disp, int x, int y) override
If clicked on a village hex field, assigns the ownership of it to the current side.
std::vector< color_t > palette(const color_range &cr)
Creates a reference color palette from a color range.
Definition: color_range.cpp:84
std::unique_ptr< editor_action > up_right(editor_display &disp, int x, int y) override
If clicked on a village hex field, unassigns it&#39;s ownership.
std::unique_ptr< editor_action > click_right(editor_display &, int, int) override
No action.
virtual void set_mouse_overlay(editor_display &disp) override
Set the mouse overlay for this action.
std::unique_ptr< editor_action > click_left(editor_display &, int, int) override
No action.
Manage the empty-palette in the editor.
Definition: action.cpp:30
mouse_action_village(const CKey &key, empty_palette &palette)
Editor mouse action class.
A mouse action receives events from the controller, and responds to them by creating an appropriate e...
Class that keeps track of all the keys on the keyboard.
Definition: key.hpp:28