OpenTTD
tree_gui.cpp
Go to the documentation of this file.
1 /* $Id: tree_gui.cpp 26482 2014-04-23 20:13:33Z rubidium $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD 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, version 2.
6  * OpenTTD 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.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "window_gui.h"
14 #include "gfx_func.h"
15 #include "tilehighlight_func.h"
16 #include "company_func.h"
17 #include "company_base.h"
18 #include "command_func.h"
19 #include "sound_func.h"
20 #include "tree_map.h"
21 
22 #include "widgets/tree_widget.h"
23 
24 #include "table/sprites.h"
25 #include "table/strings.h"
26 #include "table/tree_land.h"
27 
28 #include "safeguards.h"
29 
30 void PlaceTreesRandomly();
31 
34  { 1621, PAL_NONE }, { 1587, PAL_NONE }, { 1656, PAL_NONE }, { 1579, PAL_NONE },
35  { 1607, PAL_NONE }, { 1593, PAL_NONE }, { 1614, PAL_NONE }, { 1586, PAL_NONE },
36  { 1663, PAL_NONE }, { 1677, PAL_NONE }, { 1691, PAL_NONE }, { 1705, PAL_NONE },
37  { 1711, PAL_NONE }, { 1746, PAL_NONE }, { 1753, PAL_NONE }, { 1732, PAL_NONE },
38  { 1739, PAL_NONE }, { 1718, PAL_NONE }, { 1725, PAL_NONE }, { 1760, PAL_NONE },
39  { 1838, PAL_NONE }, { 1844, PAL_NONE }, { 1866, PAL_NONE }, { 1871, PAL_NONE },
40  { 1899, PAL_NONE }, { 1935, PAL_NONE }, { 1928, PAL_NONE }, { 1915, PAL_NONE },
41  { 1887, PAL_NONE }, { 1908, PAL_NONE }, { 1824, PAL_NONE }, { 1943, PAL_NONE },
42  { 1950, PAL_NONE }, { 1957, PALETTE_TO_GREEN }, { 1964, PALETTE_TO_RED }, { 1971, PAL_NONE },
43  { 1978, PAL_NONE }, { 1985, PALETTE_TO_RED, }, { 1992, PALETTE_TO_PALE_GREEN }, { 1999, PALETTE_TO_YELLOW }, { 2006, PALETTE_TO_RED }
44 };
45 
46 
50 class BuildTreesWindow : public Window
51 {
52  uint16 base;
53  uint16 count;
55 
56 public:
58  {
59  this->InitNested(window_number);
61  }
62 
68  {
69  Dimension size, this_size;
70  Point offset;
71  /* Avoid to use it uninitialized */
72  size.width = 32; // default width - 2
73  size.height = 39; // default height - 7
74  offset.x = 0;
75  offset.y = 0;
76 
77  for (int i = this->base; i < this->base + this->count; i++) {
78  if (i >= (int)lengthof(tree_sprites)) return size;
79  this_size = GetSpriteSize(tree_sprites[i].sprite, &offset);
80  size.width = max<int>(size.width, 2 * max<int>(this_size.width, -offset.x));
81  size.height = max<int>(size.height, max<int>(this_size.height, -offset.y));
82  }
83 
84  return size;
85  }
86 
87  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
88  {
89  if (widget >= WID_BT_TYPE_11 && widget <= WID_BT_TYPE_34) {
91  /* Allow some pixels extra width and height */
92  size->width = d.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
93  size->height = d.height + WD_FRAMERECT_RIGHT + WD_FRAMERECT_BOTTOM + 7; // we need some more space
94  return;
95  }
96 
97  if (widget != WID_BT_MANY_RANDOM) return;
98 
99  if (_game_mode != GM_EDITOR) {
100  size->width = 0;
101  size->height = 0;
102  }
103  }
104 
105  virtual void DrawWidget(const Rect &r, int widget) const
106  {
107  if (widget < WID_BT_TYPE_11 || widget > WID_BT_TYPE_34 || widget - WID_BT_TYPE_11 >= this->count) return;
108 
109  int i = this->base + widget - WID_BT_TYPE_11;
110  /* Trees "grow" in the centre on the bottom line of the buttons */
111  DrawSprite(tree_sprites[i].sprite, tree_sprites[i].pal, (r.left + r.right) / 2 + WD_FRAMERECT_LEFT, r.bottom - 7);
112  }
113 
114  virtual void OnClick(Point pt, int widget, int click_count)
115  {
116  switch (widget) {
120  if (widget - WID_BT_TYPE_11 >= this->count) break;
121 
122  if (HandlePlacePushButton(this, widget, SPR_CURSOR_TREE, HT_RECT)) {
123  this->tree_to_plant = (TreeType)(this->base + widget - WID_BT_TYPE_11);
124  }
125  break;
126 
127  case WID_BT_TYPE_RANDOM: // tree of random type.
128  if (HandlePlacePushButton(this, WID_BT_TYPE_RANDOM, SPR_CURSOR_TREE, HT_RECT)) {
129  this->tree_to_plant = TREE_INVALID;
130  }
131  break;
132 
133  case WID_BT_MANY_RANDOM: // place trees randomly over the landscape
134  if (_settings_client.sound.confirm) SndPlayFx(SND_15_BEEP);
137  break;
138  }
139  }
140 
141  virtual void OnPlaceObject(Point pt, TileIndex tile)
142  {
144  }
145 
146  virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
147  {
148  VpSelectTilesWithMethod(pt.x, pt.y, select_method);
149  }
150 
151  virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
152  {
153  if (pt.x != -1 && select_proc == DDSP_PLANT_TREES) {
154  DoCommandP(end_tile, this->tree_to_plant, start_tile,
155  CMD_PLANT_TREE | CMD_MSG(STR_ERROR_CAN_T_PLANT_TREE_HERE));
156  }
157  }
158 
162  virtual void OnInit()
163  {
164  this->base = _tree_base_by_landscape[_settings_game.game_creation.landscape];
165  this->count = _tree_count_by_landscape[_settings_game.game_creation.landscape];
166  }
167 
168  virtual void OnPlaceObjectAbort()
169  {
170  this->RaiseButtons();
171  }
172 };
173 
174 static const NWidgetPart _nested_build_trees_widgets[] = {
176  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
177  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_PLANT_TREE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
178  NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
179  NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
180  EndContainer(),
181  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
187  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_11), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
188  EndContainer(),
190  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_12), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
191  EndContainer(),
193  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_13), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
194  EndContainer(),
196  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_14), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
197  EndContainer(),
198  EndContainer(),
201  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_21), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
202  EndContainer(),
204  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_22), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
205  EndContainer(),
207  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_23), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
208  EndContainer(),
210  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_24), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
211  EndContainer(),
212  EndContainer(),
215  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_31), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
216  EndContainer(),
218  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_32), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
219  EndContainer(),
221  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_33), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
222  EndContainer(),
224  NWidget(WWT_PANEL, COLOUR_GREY, WID_BT_TYPE_34), SetMinimalSize(34, 46), SetDataTip(0x0, STR_PLANT_TREE_TOOLTIP),
225  EndContainer(),
226  EndContainer(),
228  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BT_TYPE_RANDOM), SetMinimalSize(139, 12), SetDataTip(STR_TREES_RANDOM_TYPE, STR_TREES_RANDOM_TYPE_TOOLTIP),
230  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_BT_MANY_RANDOM), SetMinimalSize(139, 12), SetDataTip(STR_TREES_RANDOM_TREES_BUTTON, STR_TREES_RANDOM_TREES_TOOLTIP),
232  EndContainer(),
234  EndContainer(),
235  EndContainer(),
236 };
237 
238 static WindowDesc _build_trees_desc(
239  WDP_AUTO, "build_tree", 0, 0,
242  _nested_build_trees_widgets, lengthof(_nested_build_trees_widgets)
243 );
244 
245 void ShowBuildTreesToolbar()
246 {
247  if (_game_mode != GM_EDITOR && !Company::IsValidID(_local_company)) return;
248  AllocateWindowDescFront<BuildTreesWindow>(&_build_trees_desc, 0);
249 }
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you&#39;ve selected it...
Definition: viewport_type.h:97
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
const PalSpriteID tree_sprites[]
Tree Sprites with their palettes.
Definition: tree_gui.cpp:33
Definition of stuff that is very close to a company, like the company struct itself.
virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
The user has dragged over the map when the tile highlight mode has been set.
Definition: tree_gui.cpp:151
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
byte landscape
the landscape we&#39;re currently in
High level window description.
Definition: window_gui.h:168
Tree 3st column 2nd row.
Definition: tree_widget.h:26
Tree 2st column 2nd row.
Definition: tree_widget.h:22
plant a tree
Definition: command_type.h:213
Horizontal container.
Definition: widget_type.h:75
void PlaceTreesRandomly()
Place some trees randomly.
Definition: tree_cmd.cpp:246
Combination of a palette sprite and a &#39;real&#39; sprite.
Definition: gfx_type.h:24
virtual void OnInit()
Initialize the window data.
Definition: tree_gui.cpp:162
Close box (at top-left of a window)
Definition: widget_type.h:69
Map accessors for tree tiles.
Button to build many random trees.
Definition: tree_widget.h:30
Tree 2st column 3rd row.
Definition: tree_widget.h:23
virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
The user is dragging over the map when the tile highlight mode has been set.
Definition: tree_gui.cpp:146
Functions, definitions and such used only by the GUI.
virtual void OnPlaceObjectAbort()
The user cancelled a tile highlight mode that has been set.
Definition: tree_gui.cpp:168
An invalid tree.
Definition: tree_map.h:33
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
Data structure for an opened window.
Definition: window_gui.h:271
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1833
Types related to the tree widgets.
Invisible widget that takes some space.
Definition: widget_type.h:79
Plant trees.
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:210
uint16 count
Number of different trees available.
Definition: tree_gui.cpp:53
SoundSettings sound
sound effect settings
Sprites to use and how to display them for tree tiles.
uint16 base
Base tree number used for drawing the window.
Definition: tree_gui.cpp:52
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
Definition: viewport_type.h:78
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition: window.cpp:553
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
Functions related to the gfx engine.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:76
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
Tree 2st column 1st row.
Definition: tree_widget.h:21
Definition of base types and functions in a cross-platform compatible way.
Tree 1st column 2nd row.
Definition: tree_widget.h:18
A number of safeguards to prevent using unsafe methods.
Tree 3st column 1st row.
Definition: tree_widget.h:25
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
rectangle (stations, depots, ...)
Simple depressed panel.
Definition: widget_type.h:50
TreeType tree_to_plant
Tree number to plant, TREE_INVALID for a random tree.
Definition: tree_gui.cpp:54
Button to build random type of tree.
Definition: tree_widget.h:29
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: tree_gui.cpp:114
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1114
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:527
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
Definition: viewport.cpp:2471
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
Functions related to sound.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
Definition: viewport.cpp:2940
Build trees toolbar; Window numbers:
Definition: window_type.h:81
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
Functions related to companies.
area of land in X and Y directions
Definition: viewport_type.h:82
Tree 1st column 3rd row.
Definition: tree_widget.h:19
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
bool HandlePlacePushButton(Window *w, int widget, CursorID cursor, HighLightStyle mode)
This code is shared for the majority of the pushbuttons.
Definition: main_gui.cpp:103
Vertical container.
Definition: widget_type.h:77
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
The build trees window.
Definition: tree_gui.cpp:50
Dimension GetMaxTreeSpriteSize()
Calculate the maximum size of all tree sprites.
Definition: tree_gui.cpp:67
Tree 3st column 4th row.
Definition: tree_widget.h:28
bool confirm
Play sound effect on succesful constructions or other actions.
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: tree_gui.cpp:105
Functions related to commands.
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:768
TreeType
List of tree types along all landscape types.
Definition: tree_map.h:26
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-NULL) Titem.
Definition: pool_type.hpp:235
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:66
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:366
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:695
GameCreationSettings game_creation
settings used during the creation of a game (map)
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3211
Specification of a rectangle with absolute coordinates of all edges.
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
Functions related to tile highlights.
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: tree_gui.cpp:87
Tree 1st column 1st row.
Definition: tree_widget.h:17
Find a place automatically.
Definition: window_gui.h:156
Tree 1st column 4th row.
Definition: tree_widget.h:20
Tree 3st column 3rd row.
Definition: tree_widget.h:27
Dimensions (a width and height) of a rectangle in 2D.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
This file contains all sprite-related enums and defines.
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:64
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:833
Tree 2st column 4th row.
Definition: tree_widget.h:24
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1461
(Toggle) Button with text
Definition: widget_type.h:55
virtual void OnPlaceObject(Point pt, TileIndex tile)
The user clicked some place on the map when a tile highlight mode has been set.
Definition: tree_gui.cpp:141