1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright (C) 2002-2024 by the Widelands Development Team
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*
*/
#ifndef WL_EDITOR_TOOLS_TOOL_H
#define WL_EDITOR_TOOLS_TOOL_H
#include "base/macros.h"
#include "editor/tools/action_args.h"
#include "editor/tools/tool_conf.h"
#include "graphic/image.h"
#include "logic/editor_game_base.h"
#include "logic/widelands_geometry.h"
enum class WindowID {
Unset = 0,
ChangeHeight,
ChangeResources,
Terrain,
NoiseHeight,
Critters,
Immovables,
Resize,
ToolHistory,
};
constexpr int kMaxToolArea = 9;
constexpr int32_t kAutoTreesIndex = std::numeric_limits<uint16_t>::max() - 4;
/**
* An editor tool is a tool that can be selected in the editor. Examples are:
* modify height, place immovable, place critter, place building. A Tool only
* makes one function (like delete_building, place building, modify building
* are 3 tools).
*/
class EditorTool {
public:
EditorTool(EditorInteractive& parent, EditorTool& second, EditorTool& third, bool uda = true)
: parent_(parent), second_(second), third_(third), undoable_(uda) {
}
virtual ~EditorTool() = default;
enum ToolIndex { First, Second, Third };
int32_t handle_click(ToolIndex i,
const Widelands::NodeAndTriangle<>& center,
EditorActionArgs* args,
Widelands::Map* map) {
return (i == First ? *this :
i == Second ? second_ :
third_)
.handle_click_impl(center, args, map);
}
int32_t handle_undo(ToolIndex i,
const Widelands::NodeAndTriangle<>& center,
EditorActionArgs* args,
Widelands::Map* map) {
return (i == First ? *this :
i == Second ? second_ :
third_)
.handle_undo_impl(center, args, map);
}
const Image* get_sel(const ToolIndex i) {
return (i == First ? *this : i == Second ? second_ : third_).get_sel_impl();
}
EditorActionArgs format_args(const ToolIndex i) {
return (i == First ? *this : i == Second ? second_ : third_).format_args_impl();
}
[[nodiscard]] bool is_undoable() const {
return undoable_;
}
[[nodiscard]] virtual bool has_size_one() const {
return false;
}
virtual EditorActionArgs format_args_impl() {
return EditorActionArgs(parent_);
}
// Default implementation if a tool doesn't hava a restorable configuration.
virtual std::string format_conf_description_impl(const ToolConf&) {
return "";
}
virtual int32_t
handle_click_impl(const Widelands::NodeAndTriangle<>&, EditorActionArgs*, Widelands::Map*) = 0;
virtual int32_t
handle_undo_impl(const Widelands::NodeAndTriangle<>&, EditorActionArgs*, Widelands::Map*) {
return 0;
} // non unduable tools don't need to implement this.
[[nodiscard]] virtual const Image* get_sel_impl() const = 0;
// Gives the tool the chance to modify the nodecaps to change what will be
// displayed as build help.
virtual Widelands::NodeCaps nodecaps_for_buildhelp(const Widelands::FCoords& fcoords,
const Widelands::EditorGameBase&) {
return fcoords.field->nodecaps();
}
// Gives the tool the chance to modify the maxcaps to change what will be
// displayed as maximum build help.
virtual Widelands::NodeCaps maxcaps_for_buildhelp(const Widelands::FCoords& fcoords,
const Widelands::EditorGameBase&) {
return fcoords.field->maxcaps();
}
[[nodiscard]] virtual bool operates_on_triangles() const {
return false;
}
virtual WindowID get_window_id() {
return WindowID::Unset;
}
bool save_configuration(ToolConf& conf) {
conf.primary = this;
return conf.primary->save_configuration_impl(conf);
}
// Returns false if didn't save anything
virtual bool save_configuration_impl(ToolConf&) {
return false;
}
virtual void load_configuration(const ToolConf&) {
}
/// Returns a string representing the given configuration
std::string format_conf_description(const ToolConf& conf) {
assert(conf.primary == this);
return format_conf_description_impl(conf);
}
protected:
EditorInteractive& parent_;
EditorTool &second_, &third_;
bool undoable_;
private:
DISALLOW_COPY_AND_ASSIGN(EditorTool);
};
#endif // end of include guard: WL_EDITOR_TOOLS_TOOL_H
|