The Battle for Wesnoth  1.19.7+dev
game_display.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2024
3  by David White <dave@whitevine.net>
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 
18 class config;
19 class game_board;
20 
21 #include "display.hpp"
22 #include "display_chat_manager.hpp"
23 #include "pathfind/pathfind.hpp"
24 
25 
26 // This needs to be separate from display.h because of the static
27 // singleton member, which will otherwise trigger link failure
28 // when building the editor.
29 
30 class game_display : public display
31 {
32 public:
33  game_display(game_board& board,
34  std::weak_ptr<wb::manager> wb,
35  reports & reports_object,
36  const std::string& theme_id,
37  const config& level);
38 
39  ~game_display();
40 
41  game_display(const game_display&) = delete;
42  game_display& operator=(const game_display&) = delete;
43 
45  {
46  return static_cast<game_display*>(singleton_);
47  }
48 
49  /**
50  * Update lighting settings.
51  *
52  * Should be called on every new turn.
53  */
54  void new_turn();
55 
56  virtual const std::set<std::string>& observers() const override { return chat_man_->observers(); }
57  /**
58  * Scrolls to the leader of a certain side.
59  *
60  * This will normally be the playing team.
61  */
62  void scroll_to_leader(int side, SCROLL_TYPE scroll_type = ONSCREEN,bool force = true);
63 
64  /**
65  * Function to display a location as selected.
66  *
67  * If a unit is in the location, and there is no unit in the currently
68  * highlighted hex, the unit will be displayed in the sidebar.
69  */
70  virtual void select_hex(map_location hex) override;
71 
72  /**
73  * Function to highlight a location.
74  *
75  * If a unit is in the location, it will be displayed in the sidebar.
76  * Selection is used when a unit has been clicked on, while highlighting is
77  * used when a location has been moused over.
78  */
79  virtual void highlight_hex(map_location hex) override;
80 
81  /**
82  * Change the unit to be displayed in the sidebar.
83  *
84  * This is used when selecting or highlighting is not wanted.
85  */
87 
88  /**
89  * Sets the paths that are currently displayed as available
90  * for the unit to move along.
91  * All other paths will be grayed out.
92  */
93  void highlight_reach(const pathfind::paths &paths_list);
94 
95  /**
96  * Add more paths to highlight. Print numbers where they overlap.
97  * Used by Show Enemy Moves. If @a goal is not @c null_location, highlight
98  * enemy units that can reach @a goal.
99  */
100  void highlight_another_reach(const pathfind::paths &paths_list,
101  const map_location& goal = map_location::null_location());
102  /**
103  * Return the locations of units that can reach @a goal (@see highlight_another_reach()).
104  */
105  const std::set<map_location>& units_that_can_reach_goal() const { return units_that_can_reach_goal_; }
106 
107  /** Reset highlighting of paths. */
108  bool unhighlight_reach();
109 
110  /**
111  * Sets the route along which footsteps are drawn to show movement of a
112  * unit. If nullptr, no route is displayed. @a route does not have to remain
113  * valid after being set.
114  */
115  void set_route(const pathfind::marked_route *route);
116  /**
117  * Gets the route along which footsteps are drawn to show movement of a
118  * unit. If no route is currently being shown, the array get_route().steps
119  * will be empty.
120  */
122 
123  /** Function to float a label above a tile */
124  void float_label(const map_location& loc, const std::string& text, const color_t& color);
125 
126  /** Draws the movement info (turns available) for a given location. */
127  void draw_movement_info(const map_location& loc);
128 
129  /** Function to invalidate that unit status displayed on the sidebar. */
131 
132  /** Same as invalidate_unit() if moving the displayed unit. */
134 
135  virtual const time_of_day& get_time_of_day(const map_location& loc) const override;
136 
137  virtual bool has_time_area() const override;
138 
139  /**
140  * TLD update() override. Replaces old pre_draw(). Be sure to call
141  * the base class method as well.
142  *
143  * game_display does specific things related e.g. to unit rendering
144  * and calls the whiteboard pre-draw method here.
145  */
146  virtual void update() override;
147 
148  /**
149  * TLD layout() override. Replaces old refresh_reports(). Be sure to
150  * call the base class method as well.
151  *
152  * This updates some reports, like clock, that need to be refreshed
153  * every frame.
154  */
155  virtual void layout() override;
156 
157  /**
158  * TLD render() override. Replaces old post_draw(). Be sure to call
159  * the base class method as well.
160  *
161  * This calls the whiteboard's post-draw method after rendering.
162  */
163  virtual void render() override;
164 
165 protected:
166  virtual void draw_invalidated() override;
167 
168  virtual void draw_hex(const map_location& loc) override;
169 
170  /** Inherited from display. */
171  virtual overlay_map& get_overlays() override;
172 
173  std::set<map_location> units_that_can_reach_goal_;
174 
175  std::vector<texture> get_reachmap_images(const map_location& loc) const;
176 
177 public:
178  /** Set the attack direction indicator. */
180  void clear_attack_indicator();
181  // TODO: compare reports::context::mhb()->current_unit_attacks_from()
183 
184  /** Function to get attack direction suffix. */
185  std::string attack_indicator_direction() const {
188  }
189 
190  virtual const map_location &displayed_unit_hex() const override { return displayedUnitHex_; }
191 
193 
194  void begin_game();
195 
196  virtual bool in_game() const override { return in_game_; }
197 
198  /**
199  * Sets the linger mode for the display.
200  * There have been some discussions on what to do with fog and shroud
201  * the extra variables make it easier to modify the behavior. There
202  * might even be a split between victory and defeat.
203  *
204  * @todo if the current implementation is wanted we can change
205  * the stuff back to a boolean
206  */
207  enum game_mode {
208  RUNNING, /**< no linger overlay, show fog and shroud. */
209  LINGER }; /**< linger overlay, show fog and shroud. */
210 
211  void set_game_mode(const game_mode mode);
212 
213  /** Sets whether the screen (map visuals) needs to be rebuilt. This is typically after the map has been changed by wml. */
214  void needs_rebuild(bool b);
215 
216  /** Rebuilds the screen if needs_rebuild(true) was previously called, and resets the flag. */
217  bool maybe_rebuild();
218 
219 private:
221 
222  // Locations of the attack direction indicator's parts
225 
227 
228  void invalidate_route();
229 
231 
233 
234  const std::unique_ptr<display_chat_manager> chat_man_;
235 
237 
239 
240 };
map_location loc
Definition: move.cpp:172
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:158
Sort-of-Singleton that many classes, both GUI and non-GUI, use to access the game data.
Definition: display.hpp:97
std::map< map_location, std::vector< overlay > > overlay_map
Definition: display.hpp:903
@ ONSCREEN
Definition: display.hpp:509
static display * singleton_
Definition: display.hpp:964
bool invalidateGameStatus_
Definition: display.hpp:753
Game board class.
Definition: game_board.hpp:47
virtual void draw_invalidated() override
Only called when there's actual redrawing to do.
void draw_movement_info(const map_location &loc)
Draws the movement info (turns available) for a given location.
game_display(const game_display &)=delete
void display_unit_hex(map_location hex)
Change the unit to be displayed in the sidebar.
virtual bool in_game() const override
void invalidate_unit_after_move(const map_location &src, const map_location &dst)
Same as invalidate_unit() if moving the displayed unit.
std::string attack_indicator_direction() const
Function to get attack direction suffix.
const map_location & get_attack_indicator_src()
const pathfind::marked_route & get_route()
Gets the route along which footsteps are drawn to show movement of a unit.
game_mode mode_
virtual void highlight_hex(map_location hex) override
Function to highlight a location.
virtual const map_location & displayed_unit_hex() const override
Virtual functions shadowed in game_display.
map_location displayedUnitHex_
void invalidate_route()
std::vector< texture > get_reachmap_images(const map_location &loc) const
void scroll_to_leader(int side, SCROLL_TYPE scroll_type=ONSCREEN, bool force=true)
Scrolls to the leader of a certain side.
void set_game_mode(const game_mode mode)
virtual void draw_hex(const map_location &loc) override
Redraws a single gamemap location.
const std::set< map_location > & units_that_can_reach_goal() const
Return the locations of units that can reach goal (.
void set_attack_indicator(const map_location &src, const map_location &dst)
Set the attack direction indicator.
const std::unique_ptr< display_chat_manager > chat_man_
pathfind::marked_route route_
virtual void render() override
TLD render() override.
void set_route(const pathfind::marked_route *route)
Sets the route along which footsteps are drawn to show movement of a unit.
virtual overlay_map & get_overlays() override
Inherited from display.
std::set< map_location > units_that_can_reach_goal_
void invalidate_unit()
Function to invalidate that unit status displayed on the sidebar.
virtual const std::set< std::string > & observers() const override
virtual void select_hex(map_location hex) override
Function to display a location as selected.
static game_display * get_singleton()
void highlight_reach(const pathfind::paths &paths_list)
Sets the paths that are currently displayed as available for the unit to move along.
void new_turn()
Update lighting settings.
void clear_attack_indicator()
virtual const time_of_day & get_time_of_day(const map_location &loc) const override
void highlight_another_reach(const pathfind::paths &paths_list, const map_location &goal=map_location::null_location())
Add more paths to highlight.
map_location attack_indicator_dst_
game_mode
Sets the linger mode for the display.
@ RUNNING
no linger overlay, show fog and shroud.
bool unhighlight_reach()
Reset highlighting of paths.
void needs_rebuild(bool b)
Sets whether the screen (map visuals) needs to be rebuilt.
overlay_map overlay_map_
bool maybe_rebuild()
Rebuilds the screen if needs_rebuild(true) was previously called, and resets the flag.
virtual void layout() override
TLD layout() override.
virtual bool has_time_area() const override
display_chat_manager & get_chat_manager()
game_display(game_board &board, std::weak_ptr< wb::manager > wb, reports &reports_object, const std::string &theme_id, const config &level)
virtual void update() override
TLD update() override.
map_location attack_indicator_src_
game_display & operator=(const game_display &)=delete
void float_label(const map_location &loc, const std::string &text, const color_t &color)
Function to float a label above a tile.
map_display and display: classes which take care of displaying the map and game-data on the screen.
Unit and team statistics.
Definition: display.hpp:45
This module contains various pathfinding functions and utilities.
rect dst
Location on the final composed sheet.
rect src
Non-transparent portion of the surface to compose.
The basic class for representing 8-bit RGB or RGBA colour values.
Definition: color.hpp:59
Encapsulates the map of the game.
Definition: location.hpp:45
static std::string write_direction(direction dir)
Definition: location.cpp:154
direction get_relative_dir(const map_location &loc, map_location::RELATIVE_DIR_MODE mode) const
Definition: location.cpp:240
static const map_location & null_location()
Definition: location.hpp:102
Structure which holds a single route and marks for special events.
Definition: pathfind.hpp:142
Object which contains all the possible locations a unit can move to, with associated best routes to t...
Definition: pathfind.hpp:73
Object which defines a time of day with associated bonuses, image, sounds etc.
Definition: time_of_day.hpp:57
#define b