The Battle for Wesnoth  1.15.0-dev
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
display Class Referenceabstract

#include <display.hpp>

Inheritance diagram for display:
Inheritance graph

Classes

struct  announce_options
 Holds options for calls to function 'announce' (announce). More...
 
class  blit_helper
 Helper structure for rendering the terrains. More...
 
class  drawing_buffer_key
 In order to render a hex properly it needs to be rendered per row. More...
 
struct  rect_of_hexes
 Rectangular area of hexes, allowing to decide how the top and bottom edges handles the vertical shift for each parity of the x coordinate. More...
 

Public Types

enum  SCROLL_TYPE { SCROLL, WARP, ONSCREEN, ONSCREEN_WARP }
 
enum  drawing_layer {
  LAYER_TERRAIN_BG, LAYER_GRID_TOP, LAYER_MOUSEOVER_OVERLAY, LAYER_FOOTSTEPS,
  LAYER_MOUSEOVER_TOP, LAYER_UNIT_FIRST, LAYER_UNIT_BG = LAYER_UNIT_FIRST+10, LAYER_UNIT_DEFAULT =LAYER_UNIT_FIRST+40,
  LAYER_TERRAIN_FG = LAYER_UNIT_FIRST+50, LAYER_GRID_BOTTOM, LAYER_UNIT_MOVE_DEFAULT =LAYER_UNIT_FIRST+60, LAYER_UNIT_FG = LAYER_UNIT_FIRST+80,
  LAYER_UNIT_MISSILE_DEFAULT = LAYER_UNIT_FIRST+90, LAYER_UNIT_LAST =LAYER_UNIT_FIRST+100, LAYER_REACHMAP, LAYER_MOUSEOVER_BOTTOM,
  LAYER_FOG_SHROUD, LAYER_ARROWS, LAYER_ACTIONS_NUMBERING, LAYER_SELECTED_HEX,
  LAYER_ATTACK_INDICATOR, LAYER_UNIT_BAR, LAYER_MOVE_INFO, LAYER_LINGER_OVERLAY,
  LAYER_BORDER
}
 The layers to render something on. More...
 

Public Member Functions

 display (const display_context *dc, std::weak_ptr< wb::manager > wb, reports &reports_object, const config &theme_cfg, const config &level, bool auto_join=true)
 
virtual ~display ()
 
bool show_everything () const
 
const gamemapget_map () const
 
const std::vector< team > & get_teams () const
 
std::size_t playing_team () const
 The playing team is the team whose turn it is. More...
 
bool team_valid () const
 
std::size_t viewing_team () const
 The viewing team is the team currently viewing the game. More...
 
int viewing_side () const
 
void set_team (std::size_t team, bool observe=false)
 Sets the team controlled by the player using the computer. More...
 
void set_playing_team (std::size_t team)
 set_playing_team sets the team whose turn it currently is More...
 
void clear_exclusive_draws ()
 Cancels all the exclusive draw requests. More...
 
const unit_mapget_units () const
 
bool add_exclusive_draw (const map_location &loc, unit &unit)
 Allows a unit to request to be the only one drawn in its hex. More...
 
std::string remove_exclusive_draw (const map_location &loc)
 Cancels an exclusive draw request. More...
 
void parse_team_overlays ()
 Check the overlay_map for proper team-specific overlays to be displayed/hidden. More...
 
void add_overlay (const map_location &loc, const std::string &image, const std::string &halo="", const std::string &team_name="", const std::string &item_id="", bool visible_under_fog=true, float z_order=0)
 Functions to add and remove overlays from locations. More...
 
void remove_overlay (const map_location &loc)
 remove_overlay will remove all overlays on a tile. More...
 
void remove_single_overlay (const map_location &loc, const std::string &toDelete)
 remove_single_overlay will remove a single overlay from a tile More...
 
void reload_map ()
 Updates internals that cache map size. More...
 
void change_display_context (const display_context *dc)
 
const display_contextget_disp_context () const
 
void reset_halo_manager ()
 
void reset_halo_manager (halo::manager &hm)
 
halo::managerget_halo_manager ()
 
void update_tod (const time_of_day *tod_override=nullptr)
 Applies r,g,b coloring to the map. More...
 
void adjust_color_overlay (int r, int g, int b)
 Add r,g,b to the colors for all images displayed on the map. More...
 
CVideovideo ()
 Gets the underlying screen object. More...
 
surfaceget_screen_surface ()
 return the screen surface or the surface used for map_screenshot. More...
 
virtual bool in_game () const
 
virtual bool in_editor () const
 
virtual const map_locationdisplayed_unit_hex () const
 Virtual functions shadowed in game_display. More...
 
virtual int playing_side () const
 
virtual const std::set< std::string > & observers () const
 
const SDL_Rect & minimap_area () const
 mapx is the width of the portion of the display which shows the game area. More...
 
const SDL_Rect & palette_area () const
 
const SDL_Rect & unit_image_area () const
 
const SDL_Rect & max_map_area () const
 Returns the maximum area used for the map regardless to resolution and view size. More...
 
const SDL_Rect & map_area () const
 Returns the area used for the map. More...
 
const SDL_Rect & map_outside_area () const
 Returns the available area for a map, this may differ from the above. More...
 
const map_location hex_clicked_on (int x, int y) const
 given x,y co-ordinates of an onscreen pixel, will return the location of the hex that this pixel corresponds to. More...
 
const map_location pixel_position_to_hex (int x, int y) const
 given x,y co-ordinates of a pixel on the map, will return the location of the hex that this pixel corresponds to. More...
 
map_location minimap_location_on (int x, int y)
 given x,y co-ordinates of the mouse, will return the location of the hex in the minimap that the mouse is currently over, or an invalid location if the mouse isn't over the minimap. More...
 
const map_locationselected_hex () const
 
const map_locationmouseover_hex () const
 
virtual void select_hex (map_location hex)
 
virtual void highlight_hex (map_location hex)
 
void invalidate_game_status ()
 Function to invalidate the game status displayed on the sidebar. More...
 
int get_location_x (const map_location &loc) const
 Functions to get the on-screen positions of hexes. More...
 
int get_location_y (const map_location &loc) const
 
const rect_of_hexes hexes_under_rect (const SDL_Rect &r) const
 Return the rectangular area of hexes overlapped by r (r is in screen coordinates) More...
 
const rect_of_hexes get_visible_hexes () const
 Returns the rectangular area of visible hexes. More...
 
bool shrouded (const map_location &loc) const
 Returns true if location (x,y) is covered in shroud. More...
 
bool fogged (const map_location &loc) const
 Returns true if location (x,y) is covered in fog. More...
 
void set_grid (const bool grid)
 Determines whether a grid should be overlayed on the game board. More...
 
bool get_draw_coordinates () const
 Getter for the x,y debug overlay on tiles. More...
 
void set_draw_coordinates (bool value)
 Setter for the x,y debug overlay on tiles. More...
 
bool get_draw_terrain_codes () const
 Getter for the terrain code debug overlay on tiles. More...
 
void set_draw_terrain_codes (bool value)
 Setter for the terrain code debug overlay on tiles. More...
 
bool get_draw_num_of_bitmaps () const
 Getter for the number of bitmaps debug overlay on tiles. More...
 
void set_draw_num_of_bitmaps (bool value)
 Setter for the terrain code debug overlay on tiles. More...
 
surface screenshot (bool map_screenshot=false)
 Capture a (map-)screenshot into a surface. More...
 
void redraw_everything ()
 Invalidates entire screen, including all tiles and sidebar. More...
 
void add_redraw_observer (std::function< void(display &)> f)
 Adds a redraw observer, a function object to be called when redraw_everything is used. More...
 
void clear_redraw_observers ()
 Clear the redraw observers. More...
 
themeget_theme ()
 
void set_theme (config theme_cfg)
 
std::shared_ptr< gui::buttonfind_action_button (const std::string &id)
 Retrieves a pointer to a theme UI button. More...
 
std::shared_ptr< gui::buttonfind_menu_button (const std::string &id)
 
void create_buttons ()
 
void layout_buttons ()
 
void render_buttons ()
 
void invalidate_theme ()
 
void refresh_report (const std::string &report_name, const config *new_cfg=nullptr)
 Redraws the specified report (if anything has changed). More...
 
void draw_minimap_units ()
 
void invalidate_all ()
 Function to invalidate all tiles. More...
 
bool invalidate (const map_location &loc)
 Function to invalidate a specific tile for redrawing. More...
 
bool invalidate (const std::set< map_location > &locs)
 
bool propagate_invalidation (const std::set< map_location > &locs)
 If this set is partially invalidated, invalidate all its hexes. More...
 
bool invalidate_locations_in_rect (const SDL_Rect &rect)
 invalidate all hexes under the rectangle rect (in screen coordinates) More...
 
bool invalidate_visible_locations_in_rect (const SDL_Rect &rect)
 
void invalidate_animations ()
 Function to invalidate animated terrains and units which may have changed. More...
 
void invalidate_animations_location (const map_location &loc)
 Per-location invalidation called by invalidate_animations() Extra game per-location invalidation (village ownership) More...
 
void reset_standing_animations ()
 
void set_mouseover_hex_overlay (const surface &image)
 mouseover_hex_overlay_ require a prerendered surface and is drawn underneath the mouse's location More...
 
void clear_mouseover_hex_overlay ()
 
terrain_builderget_builder ()
 
void flip ()
 
void update_display ()
 Copy the backbuffer to the framebuffer. More...
 
void rebuild_all ()
 Rebuild all dynamic terrain. More...
 
const theme::actionaction_pressed ()
 
const theme::menumenu_pressed ()
 
void enable_menu (const std::string &item, bool enable)
 Finds the menu which has a given item in it, and enables or disables it. More...
 
void set_diagnostic (const std::string &msg)
 
void set_turbo (const bool turbo)
 Set/Get whether 'turbo' mode is on. More...
 
double turbo_speed () const
 
void set_turbo_speed (const double speed)
 
void set_idle_anim (bool ison)
 control unit idle animations and their frequency More...
 
bool idle_anim () const
 
void set_idle_anim_rate (int rate)
 
double idle_anim_rate () const
 
void bounds_check_position ()
 
void bounds_check_position (int &xpos, int &ypos) const
 
bool scroll (int xmov, int ymov, bool force=false)
 Scrolls the display by xmov,ymov pixels. More...
 
bool set_zoom (bool increase)
 Zooms the display in (true) or out (false). More...
 
bool set_zoom (unsigned int amount, const bool validate_value_and_set_index=true)
 Sets the display zoom to the specified amount. More...
 
void set_default_zoom ()
 Sets the zoom amount to the default. More...
 
bool view_locked () const
 
void set_view_locked (bool value)
 Sets whether the map view is locked (e.g. More...
 
void scroll_to_tile (const map_location &loc, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool force=true)
 Scroll such that location loc is on-screen. More...
 
void scroll_to_tiles (map_location loc1, map_location loc2, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, double add_spacing=0.0, bool force=true)
 Scroll such that location loc1 is on-screen. More...
 
void scroll_to_tiles (const std::vector< map_location >::const_iterator &begin, const std::vector< map_location >::const_iterator &end, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool only_if_possible=false, double add_spacing=0.0, bool force=true)
 Scroll to fit as many locations on-screen as possible, starting with the first. More...
 
void scroll_to_tiles (const std::vector< map_location > &locs, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool only_if_possible=false, double add_spacing=0.0, bool force=true)
 Scroll to fit as many locations on-screen as possible, starting with the first. More...
 
events::generic_eventscroll_event () const
 Expose the event, so observers can be notified about map scrolling. More...
 
events::generic_eventcomplete_redraw_event ()
 
bool tile_fully_on_screen (const map_location &loc) const
 Check if a tile is fully visible on screen. More...
 
bool tile_nearly_on_screen (const map_location &loc) const
 Checks if location loc or one of the adjacent tiles is visible on screen. More...
 
virtual void draw ()
 Draws invalidated items. More...
 
void draw (bool update)
 
void draw (bool update, bool force)
 
map_labelslabels ()
 
const map_labelslabels () const
 
void announce (const std::string &msg, const color_t &color=font::GOOD_COLOR, const announce_options &options=announce_options())
 Announce a message prominently. More...
 
void recalculate_minimap ()
 Schedule the minimap for recalculation. More...
 
void redraw_minimap ()
 Schedule the minimap to be redrawn. More...
 
virtual const time_of_dayget_time_of_day (const map_location &loc=map_location::null_location()) const
 
virtual bool has_time_area () const
 
void blindfold (bool flag)
 
bool is_blindfolded () const
 
void write (config &cfg) const
 
virtual void handle_event (const SDL_Event &)
 
virtual void handle_window_event (const SDL_Event &event)
 
void init_flags ()
 Init the flag list and the team colors used by ~TC. More...
 
void reinit_flags_for_side (std::size_t side)
 Rebuild the flag list (not team colors) for a single side. More...
 
void reset_reports (reports &reports_object)
 
void render_image (int x, int y, const display::drawing_layer drawing_layer, const map_location &loc, surface image, bool hreverse=false, bool greyscale=false, fixed_t alpha=ftofxp(1.0), color_t blendto={0, 0, 0}, double blend_ratio=0, double submerged=0.0, bool vreverse=false)
 Draw an image at a certain location. More...
 
void draw_text_in_hex (const map_location &loc, const drawing_layer layer, const std::string &text, std::size_t font_size, color_t color, double x_in_hex=0.5, double y_in_hex=0.5)
 Draw text on a hex. More...
 
void drawing_buffer_add (const drawing_layer layer, const map_location &loc, int x, int y, const surface &surf, const SDL_Rect &clip=SDL_Rect())
 Add an item to the drawing buffer. More...
 
void drawing_buffer_add (const drawing_layer layer, const map_location &loc, int x, int y, const std::vector< surface > &surf, const SDL_Rect &clip=SDL_Rect())
 
void add_arrow (arrow &)
 
void remove_arrow (arrow &)
 
void update_arrow (arrow &a)
 Called by arrow objects when they change. More...
 
- Public Member Functions inherited from events::sdl_handler
virtual void process_event ()
 
virtual void volatile_draw ()
 
virtual void volatile_undraw ()
 
virtual bool requires_event_focus (const SDL_Event *=nullptr) const
 
virtual void process_help_string (int, int)
 
virtual void process_tooltip_string (int, int)
 
virtual void join ()
 
virtual void join (context &c)
 
virtual void join_same (sdl_handler *parent)
 
virtual void leave ()
 
virtual void join_global ()
 
virtual void leave_global ()
 
virtual bool has_joined ()
 
virtual bool has_joined_global ()
 

Static Public Member Functions

static displayget_singleton ()
 Returns the display object if a display object exists. More...
 
static bool outside_area (const SDL_Rect &area, const int x, const int y)
 Check if the bbox of the hex at x,y has pixels outside the area rectangle. More...
 
static int hex_width ()
 Function which returns the width of a hex in pixels, up to where the next hex starts. More...
 
static int hex_size ()
 Function which returns the size of a hex in pixels (from top tip to bottom tip or left edge to right edge). More...
 
static double get_zoom_factor ()
 Returns the current zoom factor. More...
 
static gui::button::TYPE string_to_button_type (std::string type)
 
static void toggle_benchmark ()
 Toggle to continuously redraw the screen. More...
 
static void toggle_debug_foreground ()
 Toggle to debug foreground terrain. More...
 
static bool zoom_at_max ()
 
static bool zoom_at_min ()
 

Protected Types

enum  TERRAIN_TYPE { BACKGROUND, FOREGROUND }
 
typedef std::map< map_location, std::string > exclusive_unit_draw_requests_t
 
typedef std::list< blit_helperdrawing_buffer
 
typedef std::map< map_location, unsigned int > reach_map
 
typedef std::map< map_location, std::vector< overlay > > overlay_map
 

Protected Member Functions

map_location get_middle_location () const
 
virtual void pre_draw ()
 Called near the beginning of each draw() call. More...
 
virtual void post_draw ()
 Called at the very end of each draw() call. More...
 
virtual const SDL_Rect & get_clip_rect ()
 Get the clipping rectangle for drawing. More...
 
virtual void draw_invalidated ()
 Only called when there's actual redrawing to do. More...
 
virtual void post_commit ()
 Hook for actions to take right after draw() calls drawing_buffer_commit No action here by default. More...
 
virtual void draw_hex (const map_location &loc)
 Redraws a single gamemap location. More...
 
virtual image::TYPE get_image_type (const map_location &loc)
 
virtual void draw_sidebar ()
 Called near the end of a draw operation, derived classes can use this to render a specific sidebar. More...
 
void draw_minimap ()
 
void get_terrain_images (const map_location &loc, const std::string &timeid, TERRAIN_TYPE terrain_type)
 
std::vector< surfaceget_fog_shroud_images (const map_location &loc, image::TYPE image_type)
 
void draw_image_for_report (surface &img, SDL_Rect &rect)
 
void scroll_to_xy (int screenxpos, int screenypos, SCROLL_TYPE scroll_type, bool force=true)
 
void drawing_buffer_commit ()
 Draws the drawing_buffer_ and clears it. More...
 
void drawing_buffer_clear ()
 Clears the drawing buffer. More...
 
void draw_all_panels ()
 redraw all panels associated with the map display More...
 
void draw_init ()
 Initiate a redraw. More...
 
void draw_wrap (bool update, bool force)
 
void process_reachmap_changes ()
 
virtual overlay_mapget_overlays ()=0
 
- Protected Member Functions inherited from video2::draw_layering
 draw_layering (const bool auto_join=true)
 
virtual ~draw_layering ()
 
- Protected Member Functions inherited from events::sdl_handler
 sdl_handler (const bool auto_join=true)
 
virtual ~sdl_handler ()
 
virtual std::vector< sdl_handler * > handler_members ()
 

Static Protected Member Functions

static void fill_images_list (const std::string &prefix, std::vector< std::string > &images)
 
static const std::string & get_variant (const std::vector< std::string > &variants, const map_location &loc)
 

Protected Attributes

const display_contextdc_
 
std::unique_ptr< halo::managerhalo_man_
 
std::weak_ptr< wb::managerwb_
 
exclusive_unit_draw_requests_t exclusive_unit_draw_requests_
 map of hexes where only one unit should be drawn, the one identified by the associated id string More...
 
CVideoscreen_
 
std::size_t currentTeam_
 
bool dont_show_all_
 
int xpos_
 
int ypos_
 
bool view_locked_
 
theme theme_
 
int zoom_index_
 
const std::unique_ptr< fake_unit_managerfake_unit_man_
 
const std::unique_ptr< terrain_builderbuilder_
 
surface minimap_
 
SDL_Rect minimap_location_
 
bool redrawMinimap_
 
bool redraw_background_
 
bool invalidateAll_
 
bool grid_
 
int diagnostic_label_
 
bool panelsDrawn_
 
double turbo_speed_
 
bool turbo_
 
bool invalidateGameStatus_
 
const std::unique_ptr< map_labelsmap_labels_
 
reportsreports_object_
 
events::generic_event scroll_event_
 Event raised when the map is being scrolled. More...
 
events::generic_event complete_redraw_event_
 notify observers that the screen has been redrawn completely atm this is used for replay_controller to add replay controls to the standard theme More...
 
boost::circular_buffer< unsigned > frametimes_
 
unsigned int fps_counter_
 
std::chrono::seconds fps_start_
 
unsigned int fps_actual_
 
uint32_t last_frame_finished_ = 0u
 
std::map< std::string, SDL_Rect > reportRects_
 
std::map< std::string, surfacereportSurfaces_
 
std::map< std::string, configreports_
 
std::vector< std::shared_ptr< gui::button > > menu_buttons_
 
std::vector< std::shared_ptr< gui::button > > action_buttons_
 
std::set< map_locationinvalidated_
 
surface mouseover_hex_overlay_
 
surface tod_hex_mask1
 
surface tod_hex_mask2
 
std::vector< std::string > fog_images_
 
std::vector< std::string > shroud_images_
 
map_location selectedHex_
 
map_location mouseoverHex_
 
CKey keys_
 
bool animate_map_
 Local cache for preferences::animate_map, since it is constantly queried. More...
 
bool animate_water_
 Local version of preferences::animate_water, used to detect when it's changed. More...
 
std::size_t activeTeam_
 
drawing_buffer drawing_buffer_
 
bool map_screenshot_
 Used to indicate to drawing functions that we are doing a map screenshot. More...
 
reach_map reach_map_
 
reach_map reach_map_old_
 
bool reach_map_changed_
 

Static Protected Attributes

static unsigned int zoom_ = DefaultZoom
 
static unsigned int last_zoom_ = SmallZoom
 
static displaysingleton_ = nullptr
 

Private Types

typedef std::list< arrow * > arrows_list_t
 
typedef std::map< map_location, arrows_list_tarrows_map_t
 

Private Member Functions

void read (const config &cfg)
 
void init_flags_for_side_internal (std::size_t side, const std::string &side_color)
 
surface get_flag (const map_location &loc)
 

Private Attributes

int blindfold_ctr_
 
std::vector< animated< image::locator > > flags_
 Animated flags for each team. More...
 
std::vector< surfaceterrain_image_vector_
 
int fps_handle_
 Handle for the label which displays frames per second. More...
 
int invalidated_hexes_
 Count work done for the debug info displayed under fps. More...
 
int drawn_hexes_
 
bool idle_anim_
 
double idle_anim_rate_
 
surface map_screenshot_surf_
 
std::vector< std::function< void(display &)> > redraw_observers_
 
bool draw_coordinates_
 Debug flag - overlay x,y coords on tiles. More...
 
bool draw_terrain_codes_
 Debug flag - overlay terrain codes on tiles. More...
 
bool draw_num_of_bitmaps_
 Debug flag - overlay number of bitmaps on tiles. More...
 
arrows_map_t arrows_map_
 Maps the list of arrows for each location. More...
 
tod_color color_adjust_
 
bool dirty_
 

Detailed Description

Definition at line 78 of file display.hpp.

Member Typedef Documentation

◆ arrows_list_t

typedef std::list<arrow*> display::arrows_list_t
private

Definition at line 1055 of file display.hpp.

◆ arrows_map_t

typedef std::map<map_location, arrows_list_t > display::arrows_map_t
private

Definition at line 1056 of file display.hpp.

◆ drawing_buffer

typedef std::list<blit_helper> display::drawing_buffer
protected

Definition at line 968 of file display.hpp.

◆ exclusive_unit_draw_requests_t

typedef std::map<map_location, std::string> display::exclusive_unit_draw_requests_t
protected

Definition at line 660 of file display.hpp.

◆ overlay_map

typedef std::map<map_location, std::vector<overlay> > display::overlay_map
protected

Definition at line 1030 of file display.hpp.

◆ reach_map

typedef std::map<map_location,unsigned int> display::reach_map
protected

Definition at line 1024 of file display.hpp.

Member Enumeration Documentation

◆ drawing_layer

The layers to render something on.

This value should never be stored it's the internal drawing order and adding removing and reordering the layers should be safe. If needed in WML use the name and map that to the enum value.

Enumerator
LAYER_TERRAIN_BG 

Layer for the terrain drawn behind the unit.

LAYER_GRID_TOP 

Top half part of grid image.

LAYER_MOUSEOVER_OVERLAY 

Mouseover overlay used by editor.

LAYER_FOOTSTEPS 

Footsteps showing path from unit to mouse.

LAYER_MOUSEOVER_TOP 

Top half of image following the mouse.

LAYER_UNIT_FIRST 

Reserve layers to be selected for WML.

LAYER_UNIT_BG 

Used for the ellipse behind the unit.

LAYER_UNIT_DEFAULT 

default layer for drawing units

LAYER_TERRAIN_FG 

Layer for the terrain drawn in front of the unit.

LAYER_GRID_BOTTOM 

Used for the bottom half part of grid image.

Should be under moving units, to avoid masking south move.

LAYER_UNIT_MOVE_DEFAULT 

default layer for drawing moving units

LAYER_UNIT_FG 

Used for the ellipse in front of the unit.

LAYER_UNIT_MISSILE_DEFAULT 

default layer for missile frames

LAYER_UNIT_LAST 
LAYER_REACHMAP 

"black stripes" on unreachable hexes.

LAYER_MOUSEOVER_BOTTOM 

Bottom half of image following the mouse.

LAYER_FOG_SHROUD 

Fog and shroud.

LAYER_ARROWS 

Arrows from the arrows framework.

Used for planned moves display.

LAYER_ACTIONS_NUMBERING 

Move numbering for the whiteboard.

LAYER_SELECTED_HEX 

Image on the selected unit.

LAYER_ATTACK_INDICATOR 

Layer which holds the attack indicator.

LAYER_UNIT_BAR 

Unit bars and overlays are drawn on this layer (for testing here).

LAYER_MOVE_INFO 

Movement info (defense%, etc...).

LAYER_LINGER_OVERLAY 

The overlay used for the linger mode.

LAYER_BORDER 

The border of the map.

Definition at line 815 of file display.hpp.

◆ SCROLL_TYPE

Enumerator
SCROLL 
WARP 
ONSCREEN 
ONSCREEN_WARP 

Definition at line 523 of file display.hpp.

◆ TERRAIN_TYPE

enum display::TERRAIN_TYPE
protected
Enumerator
BACKGROUND 
FOREGROUND 

Definition at line 717 of file display.hpp.

Constructor & Destructor Documentation

◆ display()

display::display ( const display_context dc,
std::weak_ptr< wb::manager wb,
reports reports_object,
const config theme_cfg,
const config level,
bool  auto_join = true 
)

◆ ~display()

display::~display ( )
virtual

Definition at line 252 of file display.cpp.

References resources::fake_units, and singleton_.

Member Function Documentation

◆ action_pressed()

const theme::action * display::action_pressed ( )

Definition at line 1698 of file display.cpp.

References action_buttons_, theme::actions(), i, utf8::index(), and theme_.

Referenced by controller_base::play_slice().

◆ add_arrow()

void display::add_arrow ( arrow arrow)

Definition at line 3104 of file display.cpp.

References arrows_map_, and arrow::get_path().

◆ add_exclusive_draw()

bool display::add_exclusive_draw ( const map_location loc,
unit unit 
)

Allows a unit to request to be the only one drawn in its hex.

Useful for situations where multiple units (one real, multiple temporary) can end up stacked, such as with the whiteboard.

Parameters
locThe location of the unit requesting exclusivity.
unitThe unit requesting exclusivity.
Returns
false if there's already an exclusive draw request for this location.

Definition at line 397 of file display.cpp.

References exclusive_unit_draw_requests_, unit::id(), and map_location::valid().

Referenced by wb::highlighter::highlight(), wb::highlighter::highlight_main_visitor::visit(), wb::highlighter::highlight_secondary_visitor::visit(), and wb::highlighter::unhighlight_visitor::visit().

◆ add_overlay()

void display::add_overlay ( const map_location loc,
const std::string &  image,
const std::string &  halo = "",
const std::string &  team_name = "",
const std::string &  item_id = "",
bool  visible_under_fog = true,
float  z_order = 0 
)

Functions to add and remove overlays from locations.

An overlay is an image that is displayed on top of the tile. One tile may have multiple overlays.

Definition at line 111 of file display.cpp.

References get_location_x(), get_location_y(), get_overlays(), halo_man_, and hex_size().

Referenced by editor::mouse_action_item::click_left().

◆ add_redraw_observer()

void display::add_redraw_observer ( std::function< void(display &)>  f)

Adds a redraw observer, a function object to be called when redraw_everything is used.

Definition at line 2425 of file display.cpp.

References f, and redraw_observers_.

◆ adjust_color_overlay()

void display::adjust_color_overlay ( int  r,
int  g,
int  b 
)

Add r,g,b to the colors for all images displayed on the map.

Used for special effects like flashes.

Definition at line 439 of file display.cpp.

References color_adjust_, and update_tod().

◆ announce()

void display::announce ( const std::string &  msg,
const color_t color = font::GOOD_COLOR,
const announce_options options = announce_options() 
)

◆ blindfold()

void display::blindfold ( bool  flag)

Definition at line 500 of file display.cpp.

References blindfold_ctr_.

◆ bounds_check_position() [1/2]

void display::bounds_check_position ( )

Definition at line 2311 of file display.cpp.

References MaxZoom, MinZoom, image::set_zoom(), xpos_, ypos_, and zoom_.

Referenced by redraw_everything(), scroll(), scroll_to_xy(), and set_zoom().

◆ bounds_check_position() [2/2]

void display::bounds_check_position ( int &  xpos,
int &  ypos 
) const

◆ change_display_context()

void display::change_display_context ( const display_context dc)

Definition at line 484 of file display.cpp.

References builder_, dc_, and display_context::map().

Referenced by editor::context_manager::refresh_on_context_change().

◆ clear_exclusive_draws()

void display::clear_exclusive_draws ( )
inline

Cancels all the exclusive draw requests.

Definition at line 120 of file display.hpp.

Referenced by wb::manager::on_gamestate_change().

◆ clear_mouseover_hex_overlay()

void display::clear_mouseover_hex_overlay ( )
inline

Definition at line 446 of file display.hpp.

Referenced by editor::editor_toolkit::clear_mouseover_overlay().

◆ clear_redraw_observers()

void display::clear_redraw_observers ( )

Clear the redraw observers.

Definition at line 2430 of file display.cpp.

References redraw_observers_.

◆ complete_redraw_event()

events::generic_event& display::complete_redraw_event ( )
inline

Definition at line 563 of file display.hpp.

◆ create_buttons()

void display::create_buttons ( )

◆ displayed_unit_hex()

virtual const map_location& display::displayed_unit_hex ( ) const
inlinevirtual

Virtual functions shadowed in game_display.

These are needed to generate reports easily, without dynamic casting. Hope to factor out eventually.

Reimplemented in game_display.

Definition at line 205 of file display.hpp.

References map_location::null_location().

Referenced by get_visible_unit(), unit_alignment(), unit_hp(), unit_status(), and unit_weapons().

◆ draw() [1/3]

void display::draw ( )
virtual

Draws invalidated items.

If update is true, will also copy the display to the frame buffer. If force is true, will not skip frames, even if running behind. Not virtual, since it gathers common actions. Calls various protected virtuals (further below) to allow specialized behavior in derived classes.

Reimplemented from events::sdl_handler.

Definition at line 2435 of file display.cpp.

Referenced by actions::shroud_clearer::clear_unit(), draw(), handle_event(), game_lua_kernel::intf_redraw(), redraw_everything(), screenshot(), scroll_to_xy(), set_zoom(), unit_display::unit_recruited(), and gui2::dialogs::custom_tod::update_tod_display().

◆ draw() [2/3]

void display::draw ( bool  update)

Definition at line 2439 of file display.cpp.

References draw().

◆ draw() [3/3]

void display::draw ( bool  update,
bool  force 
)

◆ draw_all_panels()

void display::draw_all_panels ( )
protected

redraw all panels associated with the map display

Definition at line 1442 of file display.cpp.

References draw_label(), draw_panel(), CVideo::getSurface(), theme::labels(), menu_buttons_, theme::panels(), recalculate_minimap(), render_buttons(), screen_, theme_, and video().

Referenced by draw_init().

◆ draw_hex()

void display::draw_hex ( const map_location loc)
protectedvirtual

◆ draw_image_for_report()

void display::draw_image_for_report ( surface img,
SDL_Rect &  rect 
)
protected

◆ draw_init()

void display::draw_init ( )
protected

Initiate a redraw.

Invalidate controls and panels when changed after they have been drawn initially. Useful for dynamic theme modification.

Definition at line 1621 of file display.cpp.

References theme::border_t::background_image, theme::border(), DBG_DP, draw_all_panels(), draw_background(), get_map(), get_screen_surface(), invalidate_locations_in_rect(), invalidateAll_, map_area(), map_outside_area(), panelsDrawn_, redraw_background_, redrawMinimap_, and theme_.

Referenced by draw().

◆ draw_invalidated()

void display::draw_invalidated ( )
protectedvirtual

Only called when there's actual redrawing to do.

Loops through invalidated locations and redraws them. Derived classes can override this, possibly to insert pre- or post-processing around a call to the base class's function.

Reimplemented in game_display.

Definition at line 2508 of file display.cpp.

References sdl::create_rect(), dc_, draw_hex(), drawn_hexes_, unit_map::end(), exclusive_unit_draw_requests_, unit_map::find(), get_clip_rect(), get_location_x(), get_location_y(), get_screen_surface(), invalidated_, invalidated_hexes_, sdl::rects_overlap(), unit_drawer::redraw_unit(), display_context::teams(), display_context::units(), and zoom_.

Referenced by draw(), and game_display::draw_invalidated().

◆ draw_minimap()

void display::draw_minimap ( )
protected

◆ draw_minimap_units()

void display::draw_minimap_units ( )

◆ draw_sidebar()

virtual void display::draw_sidebar ( )
inlineprotectedvirtual

Called near the end of a draw operation, derived classes can use this to render a specific sidebar.

Very similar to post_commit.

Reimplemented in game_display, and editor::editor_display.

Definition at line 713 of file display.hpp.

Referenced by draw().

◆ draw_text_in_hex()

void display::draw_text_in_hex ( const map_location loc,
const drawing_layer  layer,
const std::string &  text,
std::size_t  font_size,
color_t  color,
double  x_in_hex = 0.5,
double  y_in_hex = 0.5 
)

◆ draw_wrap()

void display::draw_wrap ( bool  update,
bool  force 
)
protected

◆ drawing_buffer_add() [1/2]

void display::drawing_buffer_add ( const drawing_layer  layer,
const map_location loc,
int  x,
int  y,
const surface surf,
const SDL_Rect &  clip = SDL_Rect() 
)

Add an item to the drawing buffer.

You need to update screen on affected area

Parameters
layerThe layer to draw on.
locThe hex the image belongs to, needed for the drawing order.

Definition at line 1176 of file display.cpp.

Referenced by unit_drawer::draw_bar(), editor::editor_display::draw_hex(), wb::attack::draw_hex(), wb::suppose_dead::draw_hex(), game_display::draw_hex(), draw_hex(), game_display::draw_movement_info(), draw_text_in_hex(), unit_drawer::redraw_unit(), and render_image().

◆ drawing_buffer_add() [2/2]

void display::drawing_buffer_add ( const drawing_layer  layer,
const map_location loc,
int  x,
int  y,
const std::vector< surface > &  surf,
const SDL_Rect &  clip = SDL_Rect() 
)

Definition at line 1183 of file display.cpp.

◆ drawing_buffer_clear()

void display::drawing_buffer_clear ( )
protected

Clears the drawing buffer.

Definition at line 1293 of file display.cpp.

References drawing_buffer_.

Referenced by drawing_buffer_commit().

◆ drawing_buffer_commit()

void display::drawing_buffer_commit ( )
protected

Draws the drawing_buffer_ and clears it.

Definition at line 1255 of file display.cpp.

References drawing_buffer_clear(), and sdl_blit().

Referenced by draw().

◆ enable_menu()

void display::enable_menu ( const std::string &  item,
bool  enable 
)

Finds the menu which has a given item in it, and enables or disables it.

Definition at line 1730 of file display.cpp.

References c, utf8::index(), menu_buttons_, theme::menus(), and theme_.

◆ fill_images_list()

void display::fill_images_list ( const std::string &  prefix,
std::vector< std::string > &  images 
)
staticprotected

Definition at line 445 of file display.cpp.

References image::exists(), i, and s.

Referenced by display().

◆ find_action_button()

std::shared_ptr< gui::button > display::find_action_button ( const std::string &  id)

Retrieves a pointer to a theme UI button.

Note
The returned pointer may either be nullptr, meaning the button isn't defined by the current theme, or point to a valid gui::button object. However, the objects retrieved will be destroyed and recreated by draw() method calls. Do NOT store these pointers for longer than strictly necessary to accomplish a specific task before the next screen refresh.

Definition at line 802 of file display.cpp.

References action_buttons_, and i.

Referenced by create_buttons(), editor::location_palette::draw_contents(), editor::palette_manager::draw_contents(), replay_controller::handle_generic_event(), editor::empty_palette::hide(), layout_buttons(), replay_controller::play_button(), replay_controller::play_move_button(), replay_controller::play_side_button(), replay_controller::play_turn_button(), turn_info::process_network_data(), replay_controller::reset_button(), hotkey::command_executor_default::set_button_state(), replay_controller::stop_button(), and play_controller::toggle_skipping_replay().

◆ find_menu_button()

std::shared_ptr< gui::button > display::find_menu_button ( const std::string &  id)

◆ flip()

void display::flip ( )

◆ fogged()

bool display::fogged ( const map_location loc) const

◆ get_builder()

terrain_builder& display::get_builder ( )
inline

Definition at line 459 of file display.hpp.

References wfl::msg().

◆ get_clip_rect()

const SDL_Rect & display::get_clip_rect ( )
protectedvirtual

Get the clipping rectangle for drawing.

Virtual since the editor might use a slightly different approach.

Reimplemented in editor::editor_display.

Definition at line 2503 of file display.cpp.

References map_area().

Referenced by draw_invalidated().

◆ get_disp_context()

const display_context& display::get_disp_context ( ) const
inline

◆ get_draw_coordinates()

bool display::get_draw_coordinates ( ) const
inline

Getter for the x,y debug overlay on tiles.

Definition at line 353 of file display.hpp.

◆ get_draw_num_of_bitmaps()

bool display::get_draw_num_of_bitmaps ( ) const
inline

Getter for the number of bitmaps debug overlay on tiles.

Definition at line 363 of file display.hpp.

◆ get_draw_terrain_codes()

bool display::get_draw_terrain_codes ( ) const
inline

Getter for the terrain code debug overlay on tiles.

Definition at line 358 of file display.hpp.

Referenced by editor::terrain_palette::draw_item().

◆ get_flag()

surface display::get_flag ( const map_location loc)
private

◆ get_fog_shroud_images()

std::vector< surface > display::get_fog_shroud_images ( const map_location loc,
image::TYPE  image_type 
)
protected

◆ get_halo_manager()

halo::manager& display::get_halo_manager ( )
inline

Definition at line 175 of file display.hpp.

References b, and g.

◆ get_image_type()

image::TYPE display::get_image_type ( const map_location loc)
protectedvirtual
Returns
the image type to be used for the passed hex

Reimplemented in editor::editor_display.

Definition at line 2713 of file display.cpp.

References image::TOD_COLORED.

Referenced by draw_hex().

◆ get_location_x()

int display::get_location_x ( const map_location loc) const

◆ get_location_y()

int display::get_location_y ( const map_location loc) const

◆ get_map()

const gamemap& display::get_map ( ) const
inline

◆ get_middle_location()

map_location display::get_middle_location ( ) const
protected

Definition at line 3136 of file display.cpp.

References map_area(), pixel_position_to_hex(), xpos_, and ypos_.

Referenced by write().

◆ get_overlays()

virtual overlay_map& display::get_overlays ( )
protectedpure virtual

◆ get_screen_surface()

surface& display::get_screen_surface ( )
inline

return the screen surface or the surface used for map_screenshot.

Definition at line 199 of file display.hpp.

Referenced by draw_init(), draw_invalidated(), halo::halo_impl::effect::render(), and halo::halo_impl::effect::unrender().

◆ get_singleton()

static display* display::get_singleton ( )
inlinestatic

Returns the display object if a display object exists.

Otherwise it returns nullptr. the display object represents the game gui which handles themewml and drawing the map. A display object only exists during a game or while the mapeditor is running.

Definition at line 88 of file display.hpp.

Referenced by unit::ability_active(), unit_animator::add_animation(), wb::recall::apply_temp_modifier(), wb::recruit::apply_temp_modifier(), attack_type::bool_ability(), calculate_healing(), wb::move::calculate_moves_left(), battle_context::choose_defender_weapon(), actions::shroud_clearer::clear_loc(), actions::shroud_clearer::clear_unit(), attack_type::combat_ability(), wb::manager::create_temp_move(), quit_confirmation::default_prompt(), ai::readonly_context_impl::diagnostic(), do_replay(), do_replay_handle(), terrain_label::draw(), wb::recall::draw_hex(), wb::attack::draw_hex(), wb::recruit::draw_hex(), wb::suppose_dead::draw_hex(), arrow::draw_hex(), wb::move::draw_hex(), wb::draw_numbers(), wb::side_actions::execute_net_cmd(), unit::get_abilities(), unit::get_ability_bool(), unit_frame::get_overlaped_hex(), terrain_label::get_rect(), actions::get_village(), image::getMinimap(), wb::ghost_owner_unit(), unit::has_ability_type(), terrain_label::hidden(), arrow::hide(), wb::highlighter::highlight(), wb::attack::init(), wb::suppose_dead::init(), intf_get_viewing_side(), wb::attack::invalidate(), unit_animation::invalidate(), actions::shroud_clearer::invalidate_after_clear(), arrow::invalidate_arrow_path(), unit::is_visible_to_team(), gui2::dialogs::label_settings::label_settings(), help::load_terrain_types_data(), pathfind::mark_route(), arrow::notify_arrow_changed(), wb::manager::on_gamestate_change(), actions::place_recruit(), unit_creator::post_create(), turn_info::process_network_data(), actions::recalculate_fog(), actions::recall_unit(), actions::recruit_unit(), wb::attack::redraw(), wb::recall::redraw(), wb::recruit::redraw(), wb::suppose_dead::redraw(), wb::move::redraw(), unit_frame::redraw(), unit_animation_component::refresh(), unit_animator::replace_anim_if_invalid(), REPORT_GENERATOR(), unit_display::reset_helpers(), wb::manager::save_recall(), wb::manager::save_recruit(), wb::manager::save_temp_attack(), unit_animation_component::set_disabled_ghosted(), CVideo::set_fullscreen(), unit_animation_component::set_ghosted(), preferences::set_grid(), preferences::set_idle_anim(), preferences::set_idle_anim_rate(), unit_animation_component::set_idling(), CVideo::set_resolution(), unit_animation_component::set_selecting(), preferences::set_show_standing_animations(), unit_animation_component::set_standing(), preferences::set_turbo(), preferences::set_turbo_speed(), arrow::show(), ai::default_recruitment::recruitment::show_important_hexes(), preferences::show_theme_dialog(), attack_type::special_active(), unit_animation_component::start_animation(), hotkey::command_executor::surrender_game(), SYNCED_COMMAND_HANDLER_FUNCTION(), wb::unghost_owner_unit(), wb::highlighter::unhighlight(), unit_display::unit_die(), unit_display::unit_draw_weapon(), unit_display::unit_sheath_weapon(), unit_animation::update_last_draw_time(), gui2::settings::update_screen_size_variables(), gui2::dialogs::custom_tod::update_tod_display(), wb::viewer_actions(), wb::viewer_side(), wb::viewer_team(), pathfind::vision_path::vision_path(), wb::highlighter::highlight_main_visitor::visit(), wb::highlighter::highlight_secondary_visitor::visit(), wb::highlighter::unhighlight_visitor::visit(), unit_animator::wait_until(), game_events::WML_HANDLER_FUNCTION(), wb::manager::~manager(), and wb::suppose_dead::~suppose_dead().

◆ get_teams()

const std::vector<team>& display::get_teams ( ) const
inline

Definition at line 94 of file display.hpp.

Referenced by draw_hex().

◆ get_terrain_images()

void display::get_terrain_images ( const map_location loc,
const std::string &  timeid,
TERRAIN_TYPE  terrain_type 
)
protected

◆ get_theme()

theme& display::get_theme ( )
inline

◆ get_time_of_day()

const time_of_day & display::get_time_of_day ( const map_location loc = map_location::null_location()) const
virtual

Reimplemented in game_display, and editor::editor_display.

Definition at line 422 of file display.cpp.

Referenced by draw_hex(), get_terrain_images(), and update_tod().

◆ get_units()

const unit_map& display::get_units ( ) const
inline

◆ get_variant()

const std::string & display::get_variant ( const std::vector< std::string > &  variants,
const map_location loc 
)
staticprotected

Definition at line 467 of file display.cpp.

References map_location::x, and map_location::y.

Referenced by draw_hex().

◆ get_visible_hexes()

const rect_of_hexes display::get_visible_hexes ( ) const
inline

Returns the rectangular area of visible hexes.

Definition at line 338 of file display.hpp.

Referenced by invalidate_animations(), and process_reachmap_changes().

◆ get_zoom_factor()

static double display::get_zoom_factor ( )
inlinestatic

◆ handle_event()

void display::handle_event ( const SDL_Event &  event)
virtual

◆ handle_window_event()

void display::handle_window_event ( const SDL_Event &  event)
virtual

Implements events::sdl_handler.

Definition at line 3198 of file display.cpp.

References dirty_.

◆ has_time_area()

virtual bool display::has_time_area ( ) const
inlinevirtual

Reimplemented in game_display.

Definition at line 626 of file display.hpp.

References game_config::images::flag, read(), and write().

◆ hex_clicked_on()

const map_location display::hex_clicked_on ( int  x,
int  y 
) const

given x,y co-ordinates of an onscreen pixel, will return the location of the hex that this pixel corresponds to.

Returns an invalid location if the mouse isn't over any valid location.

Definition at line 568 of file display.cpp.

References map_area(), pixel_position_to_hex(), sdl::point_in_rect(), xpos_, and ypos_.

Referenced by soundsource::positional_source::calculate_volume(), editor::mouse_action_map_label::click_left(), editor::mouse_action_unit::click_left(), editor::mouse_action_item::click_left(), editor::brush_drag_mouse_action::click_left(), editor::mouse_action_paint::click_left(), editor::mouse_action_paste::click_left(), editor::mouse_action_fill::click_left(), editor::brush_drag_mouse_action::click_right(), editor::mouse_action_paint::click_right(), editor::mouse_action_fill::click_right(), editor::mouse_action_unit::drag_end_left(), editor::mouse_action_item::drag_end_left(), editor::brush_drag_mouse_action::drag_generic(), editor::mouse_action_map_label::drag_left(), editor::mouse_action_unit::drag_left(), editor::mouse_action_item::drag_left(), events::mouse_handler::hovered_hex(), events::mouse_handler_base::init_dragging(), editor::editor_controller::left_click(), events::mouse_handler::mouse_motion(), editor::editor_controller::mouse_motion(), events::mouse_handler_base::mouse_press(), editor::editor_controller::right_click(), editor::mouse_action_village::up_left(), editor::mouse_action_map_label::up_left(), editor::mouse_action_item::up_left(), editor::mouse_action_unit::up_left(), editor::mouse_action_starting_position::up_left(), editor::mouse_action_map_label::up_right(), editor::mouse_action_village::up_right(), editor::mouse_action_starting_position::up_right(), and editor::editor_toolkit::update_mouse_action_highlights().

◆ hex_size()

static int display::hex_size ( )
inlinestatic

◆ hex_width()

static int display::hex_width ( )
inlinestatic

Function which returns the width of a hex in pixels, up to where the next hex starts.

(i.e. not entirely from tip to tip – use hex_size() to get the distance from tip to tip)

Definition at line 249 of file display.hpp.

Referenced by bounds_check_position(), draw_minimap(), get_location_x(), hexes_under_rect(), max_map_area(), minimap_location_on(), pixel_position_to_hex(), and tile_nearly_on_screen().

◆ hexes_under_rect()

const display::rect_of_hexes display::hexes_under_rect ( const SDL_Rect &  r) const

◆ highlight_hex()

void display::highlight_hex ( map_location  hex)
virtual

Reimplemented in game_display.

Definition at line 1596 of file display.cpp.

References invalidate(), and mouseoverHex_.

Referenced by game_display::highlight_hex(), and editor::editor_controller::mouse_motion().

◆ idle_anim()

bool display::idle_anim ( ) const
inline

◆ idle_anim_rate()

double display::idle_anim_rate ( ) const
inline

◆ in_editor()

virtual bool display::in_editor ( ) const
inlinevirtual

Reimplemented in editor::editor_display.

Definition at line 202 of file display.hpp.

Referenced by draw_hex(), and terrain_label::viewable().

◆ in_game()

virtual bool display::in_game ( ) const
inlinevirtual

Reimplemented in game_display.

Definition at line 201 of file display.hpp.

◆ init_flags()

void display::init_flags ( )

◆ init_flags_for_side_internal()

void display::init_flags_for_side_internal ( std::size_t  side,
const std::string &  side_color 
)
private

◆ invalidate() [1/2]

bool display::invalidate ( const map_location loc)

Function to invalidate a specific tile for redrawing.

Definition at line 2977 of file display.cpp.

References invalidateAll_, and invalidated_.

Referenced by editor::editor_display::add_brush_loc(), battle_context::choose_defender_weapon(), editor::editor_display::clear_brush_locs(), actions::shroud_clearer::clear_loc(), events::menu_handler::end_unit_turn(), wb::side_actions::execute_net_cmd(), unit_display::unit_mover::finish(), actions::get_village(), wb::ghost_owner_unit(), highlight_hex(), wb::attack::init(), wb::suppose_dead::init(), wb::attack::invalidate(), unit_animation::invalidate(), invalidate_animations(), invalidate_animations_location(), invalidate_locations_in_rect(), game_display::invalidate_route(), editor::mouse_action_item::move(), editor::mouse_action_unit::move(), parse_team_overlays(), actions::place_recruit(), fake_unit_manager::place_temporary_unit(), unit_creator::post_create(), unit_display::unit_mover::proceed_to(), process_reachmap_changes(), wb::attack::redraw(), wb::recall::redraw(), wb::recruit::redraw(), wb::suppose_dead::redraw(), wb::move::redraw(), editor::context_manager::refresh_after_action(), editor::editor_display::remove_brush_loc(), fake_unit_manager::remove_temporary_unit(), wb::manager::save_temp_attack(), select_hex(), game_display::set_attack_indicator(), editor::editor_display::set_brush_locs(), unit_display::unit_mover::start(), SYNCED_COMMAND_HANDLER_FUNCTION(), actions::undo::recall_action::undo(), actions::undo::recruit_action::undo(), wb::unghost_owner_unit(), events::menu_handler::unit_hold_position(), unit_display::unit_mover::wait_for_anims(), and wb::suppose_dead::~suppose_dead().

◆ invalidate() [2/2]

bool display::invalidate ( const std::set< map_location > &  locs)

Definition at line 2990 of file display.cpp.

References invalidateAll_, and invalidated_.

◆ invalidate_all()

void display::invalidate_all ( )

◆ invalidate_animations()

void display::invalidate_animations ( )

Function to invalidate animated terrains and units which may have changed.

Definition at line 3061 of file display.cpp.

References preferences::animate_map(), animate_map_, builder_, dc_, fake_unit_man_, get_visible_hexes(), invalidate(), invalidate_animations_location(), new_animation_frame(), shrouded(), and display_context::units().

Referenced by draw().

◆ invalidate_animations_location()

void display::invalidate_animations_location ( const map_location loc)

Per-location invalidation called by invalidate_animations() Extra game per-location invalidation (village ownership)

Definition at line 3051 of file display.cpp.

References currentTeam_, dc_, flags_, fogged(), get_map(), invalidate(), display_context::teams(), and display_context::village_owner().

Referenced by invalidate_animations().

◆ invalidate_game_status()

void display::invalidate_game_status ( )
inline

◆ invalidate_locations_in_rect()

bool display::invalidate_locations_in_rect ( const SDL_Rect &  rect)

invalidate all hexes under the rectangle rect (in screen coordinates)

Definition at line 3039 of file display.cpp.

References hexes_under_rect(), invalidate(), and invalidateAll_.

Referenced by draw_init(), invalidate_visible_locations_in_rect(), and scroll().

◆ invalidate_theme()

void display::invalidate_theme ( )
inline

◆ invalidate_visible_locations_in_rect()

bool display::invalidate_visible_locations_in_rect ( const SDL_Rect &  rect)

Definition at line 3034 of file display.cpp.

References sdl::intersect_rects(), invalidate_locations_in_rect(), and map_area().

◆ is_blindfolded()

bool display::is_blindfolded ( ) const

Definition at line 508 of file display.cpp.

References blindfold_ctr_.

Referenced by draw_minimap(), draw_minimap_units(), fogged(), image::getMinimap(), and shrouded().

◆ labels() [1/2]

map_labels & display::labels ( )

◆ labels() [2/2]

const map_labels & display::labels ( ) const

Definition at line 2498 of file display.cpp.

References map_labels_.

◆ layout_buttons()

void display::layout_buttons ( )

◆ map_area()

const SDL_Rect & display::map_area ( ) const

◆ map_outside_area()

const SDL_Rect& display::map_outside_area ( ) const
inline

◆ max_map_area()

const SDL_Rect & display::max_map_area ( ) const

Returns the maximum area used for the map regardless to resolution and view size.

Definition at line 514 of file display.cpp.

References theme::border(), get_map(), gamemap::h(), hex_size(), hex_width(), theme::border_t::size, theme_, and gamemap::w().

Referenced by map_area(), and screenshot().

◆ menu_pressed()

const theme::menu * display::menu_pressed ( )

◆ minimap_area()

const SDL_Rect& display::minimap_area ( ) const
inline

mapx is the width of the portion of the display which shows the game area.

Between mapx and x is the sidebar region.

Definition at line 214 of file display.hpp.

Referenced by draw_minimap(), and minimap_location_on().

◆ minimap_location_on()

map_location display::minimap_location_on ( int  x,
int  y 
)

given x,y co-ordinates of the mouse, will return the location of the hex in the minimap that the mouse is currently over, or an invalid location if the mouse isn't over the minimap.

Definition at line 729 of file display.cpp.

References get_map(), gamemap::h(), h, hex_size(), hex_width(), minimap_area(), minimap_location_, pixel_position_to_hex(), sdl::point_in_rect(), gamemap::w(), w, map_location::x, and map_location::y.

Referenced by events::mouse_handler_base::left_click(), events::mouse_handler_base::mouse_motion_default(), and events::mouse_handler_base::mouse_press().

◆ mouseover_hex()

const map_location& display::mouseover_hex ( ) const
inline

◆ observers()

virtual const std::set<std::string>& display::observers ( ) const
inlinevirtual

Reimplemented in game_display.

Definition at line 207 of file display.hpp.

◆ outside_area()

bool display::outside_area ( const SDL_Rect &  area,
const int  x,
const int  y 
)
static

Check if the bbox of the hex at x,y has pixels outside the area rectangle.

Definition at line 559 of file display.cpp.

References hex_size().

Referenced by scroll_to_tiles(), and tile_fully_on_screen().

◆ palette_area()

const SDL_Rect& display::palette_area ( ) const
inline

◆ parse_team_overlays()

void display::parse_team_overlays ( )

Check the overlay_map for proper team-specific overlays to be displayed/hidden.

Definition at line 92 of file display.cpp.

References dc_, get_overlays(), display_context::get_team(), i, invalidate(), playing_team(), overlay::team_name, team::team_name(), and display_context::teams().

◆ pixel_position_to_hex()

const map_location display::pixel_position_to_hex ( int  x,
int  y 
) const

given x,y co-ordinates of a pixel on the map, will return the location of the hex that this pixel corresponds to.

Returns an invalid location if the mouse isn't over any valid location.

Definition at line 583 of file display.cpp.

References theme::border(), hex_size(), hex_width(), s, theme::border_t::size, and theme_.

Referenced by get_middle_location(), hex_clicked_on(), and minimap_location_on().

◆ playing_side()

virtual int display::playing_side ( ) const
inlinevirtual

Reimplemented in game_display.

Definition at line 206 of file display.hpp.

Referenced by attack_info(), gray_inactive(), and unit_moves().

◆ playing_team()

std::size_t display::playing_team ( ) const
inline

The playing team is the team whose turn it is.

Definition at line 97 of file display.hpp.

Referenced by parse_team_overlays(), editor::mouse_action_village::up_left(), and play_controller::hotkey_handler::viewing_team_is_playing().

◆ post_commit()

virtual void display::post_commit ( )
inlineprotectedvirtual

Hook for actions to take right after draw() calls drawing_buffer_commit No action here by default.

Reimplemented in game_display.

Definition at line 697 of file display.hpp.

Referenced by draw().

◆ post_draw()

virtual void display::post_draw ( )
inlineprotectedvirtual

Called at the very end of each draw() call.

Derived classes can use this to add extra actions after redrawing invalidated hexes takes place. No action here by default.

Reimplemented in game_display.

Definition at line 677 of file display.hpp.

Referenced by draw().

◆ pre_draw()

virtual void display::pre_draw ( )
inlineprotectedvirtual

Called near the beginning of each draw() call.

Derived classes can use this to add extra actions before redrawing invalidated hexes takes place. No action here by default.

Reimplemented in game_display, and editor::editor_display.

Definition at line 670 of file display.hpp.

Referenced by draw().

◆ process_reachmap_changes()

void display::process_reachmap_changes ( )
protected

◆ propagate_invalidation()

bool display::propagate_invalidation ( const std::set< map_location > &  locs)

If this set is partially invalidated, invalidate all its hexes.

Returns if any new invalidation was needed

Definition at line 3004 of file display.cpp.

References i, invalidateAll_, and invalidated_.

Referenced by unit_animation::invalidate().

◆ read()

void display::read ( const config cfg)
private

Definition at line 3151 of file display.cpp.

References tod_color::b, color_adjust_, tod_color::g, tod_color::r, and view_locked_.

Referenced by display().

◆ rebuild_all()

void display::rebuild_all ( )

Rebuild all dynamic terrain.

Definition at line 473 of file display.cpp.

References builder_.

Referenced by game_display::maybe_rebuild(), editor::context_manager::refresh_after_action(), and editor::context_manager::refresh_all().

◆ recalculate_minimap()

void display::recalculate_minimap ( )
inline

◆ redraw_everything()

void display::redraw_everything ( )

◆ redraw_minimap()

void display::redraw_minimap ( )
inline

Schedule the minimap to be redrawn.

Useful if units have moved about on the map.

Definition at line 622 of file display.hpp.

References map_location::null_location().

Referenced by battle_context::choose_defender_weapon(), actions::place_recruit(), actions::undo_list::redo(), SYNCED_COMMAND_HANDLER_FUNCTION(), actions::undo_list::undo(), and replay_controller::update_gui().

◆ refresh_report()

void display::refresh_report ( const std::string &  report_name,
const config new_cfg = nullptr 
)

◆ reinit_flags_for_side()

void display::reinit_flags_for_side ( std::size_t  side)

Rebuild the flag list (not team colors) for a single side.

Definition at line 288 of file display.cpp.

References dc_, ERR_DP, init_flags_for_side_internal(), and display_context::teams().

◆ reload_map()

void display::reload_map ( )

Updates internals that cache map size.

This should be called when the map size has changed.

Definition at line 478 of file display.cpp.

References builder_, and redraw_background_.

Referenced by editor::context_manager::reload_map(), and game_events::WML_HANDLER_FUNCTION().

◆ remove_arrow()

void display::remove_arrow ( arrow arrow)

Definition at line 3113 of file display.cpp.

References arrows_map_, and arrow::get_path().

◆ remove_exclusive_draw()

std::string display::remove_exclusive_draw ( const map_location loc)

Cancels an exclusive draw request.

Returns
The id of the unit whose exclusive draw request was canceled, or else the empty string if there was no exclusive draw request for this location.

Definition at line 410 of file display.cpp.

References exclusive_unit_draw_requests_, and map_location::valid().

Referenced by wb::highlighter::unhighlight().

◆ remove_overlay()

void display::remove_overlay ( const map_location loc)

remove_overlay will remove all overlays on a tile.

Definition at line 126 of file display.cpp.

References get_overlays().

◆ remove_single_overlay()

void display::remove_single_overlay ( const map_location loc,
const std::string &  toDelete 
)

remove_single_overlay will remove a single overlay from a tile

Definition at line 131 of file display.cpp.

References get_overlays().

◆ render_buttons()

void display::render_buttons ( )

Definition at line 908 of file display.cpp.

References action_buttons_, and menu_buttons_.

Referenced by draw_all_panels().

◆ render_image()

void display::render_image ( int  x,
int  y,
const display::drawing_layer  drawing_layer,
const map_location loc,
surface  image,
bool  hreverse = false,
bool  greyscale = false,
fixed_t  alpha = ftofxp(1.0),
color_t  blendto = {0,0,0},
double  blend_ratio = 0,
double  submerged = 0.0,
bool  vreverse = false 
)

Draw an image at a certain location.

x,y: pixel location on screen to draw the image image: the image to draw reverse: if the image should be flipped across the x axis greyscale: used for instance to give the petrified appearance to a unit image alpha: the merging to use with the background blendto: blend to this color using blend_ratio submerged: the amount of the unit out of 1.0 that is submerged (presumably under water) and thus shouldn't be drawn

Definition at line 1519 of file display.cpp.

References adjust_surface_alpha(), blend_surface(), brighten_image(), DefaultZoom, drawing_buffer_add(), ERR_DP, flop_surface(), ftofxp, greyscale_image(), make_neutral_surface(), map_area(), sdl::rects_overlap(), image::reverse_image(), submerge_alpha(), and zoom_.

Referenced by arrow::draw_hex(), and unit_frame::redraw().

◆ reset_halo_manager() [1/2]

void display::reset_halo_manager ( )

Definition at line 490 of file display.cpp.

References halo_man_.

◆ reset_halo_manager() [2/2]

void display::reset_halo_manager ( halo::manager hm)

Definition at line 495 of file display.cpp.

References halo_man_.

◆ reset_reports()

void display::reset_reports ( reports reports_object)
inline

Definition at line 645 of file display.hpp.

◆ reset_standing_animations()

void display::reset_standing_animations ( )

Definition at line 3097 of file display.cpp.

References dc_, and display_context::units().

◆ screenshot()

surface display::screenshot ( bool  map_screenshot = false)

◆ scroll()

bool display::scroll ( int  xmov,
int  ymov,
bool  force = false 
)

◆ scroll_event()

events::generic_event& display::scroll_event ( ) const
inline

Expose the event, so observers can be notified about map scrolling.

Definition at line 561 of file display.hpp.

Referenced by soundsource::manager::manager().

◆ scroll_to_tile()

void display::scroll_to_tile ( const map_location loc,
SCROLL_TYPE  scroll_type = ONSCREEN,
bool  check_fogged = true,
bool  force = true 
)

◆ scroll_to_tiles() [1/3]

void display::scroll_to_tiles ( map_location  loc1,
map_location  loc2,
SCROLL_TYPE  scroll_type = ONSCREEN,
bool  check_fogged = true,
double  add_spacing = 0.0,
bool  force = true 
)

Scroll such that location loc1 is on-screen.

It will also try to make it such that loc2 is on-screen, but this is not guaranteed. For ONSCREEN scrolls add_spacing sets the desired minimum distance from the border in hexes.

Definition at line 2170 of file display.cpp.

Referenced by unit_display::unit_mover::proceed_to(), scroll_to_tile(), unit_display::unit_mover::start(), unit_display::unit_attack(), and unit_display::unit_recruited().

◆ scroll_to_tiles() [2/3]

void display::scroll_to_tiles ( const std::vector< map_location >::const_iterator &  begin,
const std::vector< map_location >::const_iterator &  end,
SCROLL_TYPE  scroll_type = ONSCREEN,
bool  check_fogged = true,
bool  only_if_possible = false,
double  add_spacing = 0.0,
bool  force = true 
)

Scroll to fit as many locations on-screen as possible, starting with the first.

Definition at line 2180 of file display.cpp.

References ERR_DP, fogged(), get_location_x(), get_location_y(), get_map(), h, hex_size(), map_area(), ONSCREEN, ONSCREEN_WARP, outside_area(), scroll_to_xy(), and w.

◆ scroll_to_tiles() [3/3]

void display::scroll_to_tiles ( const std::vector< map_location > &  locs,
SCROLL_TYPE  scroll_type = ONSCREEN,
bool  check_fogged = true,
bool  only_if_possible = false,
double  add_spacing = 0.0,
bool  force = true 
)
inline

Scroll to fit as many locations on-screen as possible, starting with the first.

Definition at line 551 of file display.hpp.

◆ scroll_to_xy()

void display::scroll_to_xy ( int  screenxpos,
int  screenypos,
SCROLL_TYPE  scroll_type,
bool  force = true 
)
protected

◆ select_hex()

void display::select_hex ( map_location  hex)
virtual

◆ selected_hex()

const map_location& display::selected_hex ( ) const
inline

Definition at line 284 of file display.hpp.

Referenced by get_selected_unit(), and controller_base::play_slice().

◆ set_default_zoom()

void display::set_default_zoom ( )

Sets the zoom amount to the default.

Definition at line 2050 of file display.cpp.

References DefaultZoom, last_zoom_, set_zoom(), and zoom_.

◆ set_diagnostic()

void display::set_diagnostic ( const std::string &  msg)

◆ set_draw_coordinates()

void display::set_draw_coordinates ( bool  value)
inline

Setter for the x,y debug overlay on tiles.

Definition at line 355 of file display.hpp.

Referenced by editor::editor_controller::do_execute_command(), and editor::editor_controller::init_gui().

◆ set_draw_num_of_bitmaps()

void display::set_draw_num_of_bitmaps ( bool  value)
inline

Setter for the terrain code debug overlay on tiles.

Definition at line 365 of file display.hpp.

References f.

Referenced by editor::editor_controller::do_execute_command(), and editor::editor_controller::init_gui().

◆ set_draw_terrain_codes()

void display::set_draw_terrain_codes ( bool  value)
inline

Setter for the terrain code debug overlay on tiles.

Definition at line 360 of file display.hpp.

Referenced by editor::editor_controller::do_execute_command(), and editor::editor_controller::init_gui().

◆ set_grid()

void display::set_grid ( const bool  grid)
inline

Determines whether a grid should be overlayed on the game board.

(to more clearly show where hexes are)

Definition at line 350 of file display.hpp.

References preferences::grid().

Referenced by preferences::set_grid().

◆ set_idle_anim()

void display::set_idle_anim ( bool  ison)
inline

control unit idle animations and their frequency

Definition at line 491 of file display.hpp.

Referenced by preferences::set_idle_anim().

◆ set_idle_anim_rate()

void display::set_idle_anim_rate ( int  rate)

Definition at line 2369 of file display.cpp.

References idle_anim_rate_.

Referenced by display(), and preferences::set_idle_anim_rate().

◆ set_mouseover_hex_overlay()

void display::set_mouseover_hex_overlay ( const surface image)
inline

◆ set_playing_team()

void display::set_playing_team ( std::size_t  team)

set_playing_team sets the team whose turn it currently is

Definition at line 390 of file display.cpp.

References activeTeam_, invalidate_game_status(), and utf8::size().

◆ set_team()

void display::set_team ( std::size_t  team,
bool  observe = false 
)

Sets the team controlled by the player using the computer.

Data from this team will be displayed in the game status.

Definition at line 371 of file display.cpp.

References currentTeam_, dc_, dont_show_all_, labels(), map_labels::recalculate_labels(), map_labels::set_team(), utf8::size(), display_context::teams(), w, and wb_.

Referenced by turn_info::process_network_data().

◆ set_theme()

void display::set_theme ( config  theme_cfg)

◆ set_turbo()

void display::set_turbo ( const bool  turbo)
inline

Set/Get whether 'turbo' mode is on.

When turbo mode is on, everything moves much faster.

Definition at line 484 of file display.hpp.

References preferences::turbo(), and preferences::turbo_speed().

Referenced by preferences::set_turbo().

◆ set_turbo_speed()

void display::set_turbo_speed ( const double  speed)
inline

Definition at line 488 of file display.hpp.

Referenced by preferences::set_turbo_speed().

◆ set_view_locked()

void display::set_view_locked ( bool  value)
inline

Sets whether the map view is locked (e.g.

so the user can't scroll away)

Definition at line 521 of file display.hpp.

◆ set_zoom() [1/2]

bool display::set_zoom ( bool  increase)

Zooms the display in (true) or out (false).

Definition at line 1982 of file display.cpp.

References utils::clamp(), final_zoom_index, zoom_index_, and zoom_levels.

Referenced by set_default_zoom().

◆ set_zoom() [2/2]

bool display::set_zoom ( unsigned int  amount,
const bool  validate_value_and_set_index = true 
)

◆ show_everything()

bool display::show_everything ( ) const
inline

Definition at line 90 of file display.hpp.

Referenced by get_selected_unit(), and get_visible_unit().

◆ shrouded()

bool display::shrouded ( const map_location loc) const

◆ string_to_button_type()

gui::button::TYPE display::string_to_button_type ( std::string  type)
static

◆ team_valid()

bool display::team_valid ( ) const

◆ tile_fully_on_screen()

bool display::tile_fully_on_screen ( const map_location loc) const

Check if a tile is fully visible on screen.

Definition at line 2062 of file display.cpp.

References get_location_x(), get_location_y(), map_area(), and outside_area().

Referenced by unit_display::unit_mover::proceed_to().

◆ tile_nearly_on_screen()

bool display::tile_nearly_on_screen ( const map_location loc) const

Checks if location loc or one of the adjacent tiles is visible on screen.

Definition at line 2069 of file display.cpp.

References get_location_x(), get_location_y(), hex_size(), hex_width(), and map_area().

Referenced by unit_animation::invalidate(), and unit_animation_component::refresh().

◆ toggle_benchmark()

void display::toggle_benchmark ( )
static

Toggle to continuously redraw the screen.

Definition at line 1298 of file display.cpp.

◆ toggle_debug_foreground()

void display::toggle_debug_foreground ( )
static

Toggle to debug foreground terrain.

Separate background and foreground layer to better spot any error there.

Definition at line 1303 of file display.cpp.

◆ turbo_speed()

double display::turbo_speed ( ) const

◆ unit_image_area()

const SDL_Rect& display::unit_image_area ( ) const
inline

Definition at line 218 of file display.hpp.

◆ update_arrow()

void display::update_arrow ( arrow a)

Called by arrow objects when they change.

You should not need to call this directly.

Definition at line 3122 of file display.cpp.

References arrows_map_, arrow::get_path(), and arrow::get_previous_path().

◆ update_display()

void display::update_display ( )

◆ update_tod()

void display::update_tod ( const time_of_day tod_override = nullptr)

Applies r,g,b coloring to the map.

The color is usually taken from get_time_of_day unless tod_override is given, in which case that color is used.

Parameters
tod_overrideThe ToD to apply to the map instead of that of the current ToD's.

Definition at line 428 of file display.cpp.

References tod_color::b, time_of_day::color, color_adjust_, tod_color::g, get_time_of_day(), tod_color::r, and image::set_color_adjustment().

Referenced by adjust_color_overlay(), game_display::new_turn(), and gui2::dialogs::custom_tod::update_tod_display().

◆ video()

CVideo& display::video ( )
inline

◆ view_locked()

bool display::view_locked ( ) const
inline

Definition at line 518 of file display.hpp.

◆ viewing_side()

int display::viewing_side ( ) const
inline

◆ viewing_team()

std::size_t display::viewing_team ( ) const
inline

◆ write()

void display::write ( config cfg) const

◆ zoom_at_max()

bool display::zoom_at_max ( )
static

Definition at line 1972 of file display.cpp.

References MaxZoom, and zoom_.

◆ zoom_at_min()

bool display::zoom_at_min ( )
static

Definition at line 1977 of file display.cpp.

References MinZoom, and zoom_.

Member Data Documentation

◆ action_buttons_

std::vector<std::shared_ptr<gui::button> > display::action_buttons_
protected

◆ activeTeam_

std::size_t display::activeTeam_
protected

Definition at line 886 of file display.hpp.

Referenced by game_display::playing_side(), and set_playing_team().

◆ animate_map_

bool display::animate_map_
protected

Local cache for preferences::animate_map, since it is constantly queried.

Definition at line 791 of file display.hpp.

Referenced by get_flag(), and invalidate_animations().

◆ animate_water_

bool display::animate_water_
protected

Local version of preferences::animate_water, used to detect when it's changed.

Definition at line 794 of file display.hpp.

Referenced by draw().

◆ arrows_map_

arrows_map_t display::arrows_map_
private

Maps the list of arrows for each location.

Definition at line 1058 of file display.hpp.

Referenced by add_arrow(), draw_hex(), remove_arrow(), and update_arrow().

◆ blindfold_ctr_

int display::blindfold_ctr_
private

Definition at line 652 of file display.hpp.

Referenced by blindfold(), display(), and is_blindfolded().

◆ builder_

const std::unique_ptr<terrain_builder> display::builder_
protected

◆ color_adjust_

tod_color display::color_adjust_
private

Definition at line 1060 of file display.hpp.

Referenced by adjust_color_overlay(), draw_hex(), read(), update_tod(), and write().

◆ complete_redraw_event_

events::generic_event display::complete_redraw_event_
protected

notify observers that the screen has been redrawn completely atm this is used for replay_controller to add replay controls to the standard theme

Definition at line 765 of file display.hpp.

Referenced by redraw_everything().

◆ currentTeam_

std::size_t display::currentTeam_
protected

◆ dc_

const display_context* display::dc_
protected

◆ diagnostic_label_

int display::diagnostic_label_
protected

Definition at line 750 of file display.hpp.

Referenced by set_diagnostic().

◆ dirty_

bool display::dirty_
private

Definition at line 1062 of file display.hpp.

Referenced by draw(), and handle_window_event().

◆ dont_show_all_

bool display::dont_show_all_
protected

◆ draw_coordinates_

bool display::draw_coordinates_
private

Debug flag - overlay x,y coords on tiles.

Definition at line 1049 of file display.hpp.

Referenced by draw_hex().

◆ draw_num_of_bitmaps_

bool display::draw_num_of_bitmaps_
private

Debug flag - overlay number of bitmaps on tiles.

Definition at line 1053 of file display.hpp.

Referenced by draw_hex().

◆ draw_terrain_codes_

bool display::draw_terrain_codes_
private

Debug flag - overlay terrain codes on tiles.

Definition at line 1051 of file display.hpp.

Referenced by draw_hex().

◆ drawing_buffer_

drawing_buffer display::drawing_buffer_
protected

Definition at line 969 of file display.hpp.

Referenced by drawing_buffer_clear().

◆ drawn_hexes_

int display::drawn_hexes_
private

Definition at line 1039 of file display.hpp.

Referenced by draw_invalidated(), and update_display().

◆ exclusive_unit_draw_requests_

exclusive_unit_draw_requests_t display::exclusive_unit_draw_requests_
protected

map of hexes where only one unit should be drawn, the one identified by the associated id string

Definition at line 662 of file display.hpp.

Referenced by add_exclusive_draw(), game_display::draw_invalidated(), draw_invalidated(), and remove_exclusive_draw().

◆ fake_unit_man_

const std::unique_ptr<fake_unit_manager> display::fake_unit_man_
protected

Definition at line 742 of file display.hpp.

Referenced by display(), game_display::draw_invalidated(), and invalidate_animations().

◆ flags_

std::vector<animated<image::locator> > display::flags_
private

Animated flags for each team.

Definition at line 802 of file display.hpp.

Referenced by get_flag(), init_flags(), init_flags_for_side_internal(), and invalidate_animations_location().

◆ fog_images_

std::vector<std::string> display::fog_images_
protected

Definition at line 783 of file display.hpp.

Referenced by display(), and draw_hex().

◆ fps_actual_

unsigned int display::fps_actual_
protected

Definition at line 770 of file display.hpp.

Referenced by draw_wrap(), and update_display().

◆ fps_counter_

unsigned int display::fps_counter_
protected

Definition at line 768 of file display.hpp.

Referenced by draw_wrap().

◆ fps_handle_

int display::fps_handle_
private

Handle for the label which displays frames per second.

Definition at line 1036 of file display.hpp.

Referenced by update_display().

◆ fps_start_

std::chrono::seconds display::fps_start_
protected

Definition at line 769 of file display.hpp.

Referenced by draw_wrap().

◆ frametimes_

boost::circular_buffer<unsigned> display::frametimes_
protected

Definition at line 767 of file display.hpp.

Referenced by draw_wrap(), and update_display().

◆ grid_

bool display::grid_
protected

Definition at line 749 of file display.hpp.

Referenced by draw_hex().

◆ halo_man_

std::unique_ptr<halo::manager> display::halo_man_
protected

◆ idle_anim_

bool display::idle_anim_
private

Definition at line 1041 of file display.hpp.

◆ idle_anim_rate_

double display::idle_anim_rate_
private

Definition at line 1042 of file display.hpp.

Referenced by set_idle_anim_rate().

◆ invalidateAll_

bool display::invalidateAll_
protected

◆ invalidated_

std::set<map_location> display::invalidated_
protected

◆ invalidated_hexes_

int display::invalidated_hexes_
private

Count work done for the debug info displayed under fps.

Definition at line 1038 of file display.hpp.

Referenced by draw_invalidated(), and update_display().

◆ invalidateGameStatus_

bool display::invalidateGameStatus_
protected

◆ keys_

CKey display::keys_
protected

Definition at line 788 of file display.hpp.

Referenced by turbo_speed().

◆ last_frame_finished_

uint32_t display::last_frame_finished_ = 0u
protected

Definition at line 771 of file display.hpp.

Referenced by draw_wrap().

◆ last_zoom_

unsigned int display::last_zoom_ = SmallZoom
staticprotected

Definition at line 741 of file display.hpp.

Referenced by set_default_zoom(), and set_zoom().

◆ map_labels_

const std::unique_ptr<map_labels> display::map_labels_
protected

Definition at line 755 of file display.hpp.

Referenced by labels().

◆ map_screenshot_

bool display::map_screenshot_
protected

Used to indicate to drawing functions that we are doing a map screenshot.

Definition at line 1010 of file display.hpp.

Referenced by map_area(), and screenshot().

◆ map_screenshot_surf_

surface display::map_screenshot_surf_
private

Definition at line 1044 of file display.hpp.

Referenced by screenshot().

◆ menu_buttons_

std::vector<std::shared_ptr<gui::button> > display::menu_buttons_
protected

◆ minimap_

surface display::minimap_
protected

Definition at line 744 of file display.hpp.

Referenced by draw_minimap().

◆ minimap_location_

SDL_Rect display::minimap_location_
protected

Definition at line 745 of file display.hpp.

Referenced by draw_minimap(), draw_minimap_units(), and minimap_location_on().

◆ mouseover_hex_overlay_

surface display::mouseover_hex_overlay_
protected

Definition at line 779 of file display.hpp.

Referenced by draw_hex().

◆ mouseoverHex_

map_location display::mouseoverHex_
protected

◆ panelsDrawn_

bool display::panelsDrawn_
protected

Definition at line 751 of file display.hpp.

Referenced by draw_init(), and redraw_everything().

◆ reach_map_

reach_map display::reach_map_
protected

◆ reach_map_changed_

bool display::reach_map_changed_
protected

◆ reach_map_old_

reach_map display::reach_map_old_
protected

Definition at line 1026 of file display.hpp.

Referenced by process_reachmap_changes().

◆ redraw_background_

bool display::redraw_background_
protected

Definition at line 747 of file display.hpp.

Referenced by draw_init(), redraw_everything(), reload_map(), and set_zoom().

◆ redraw_observers_

std::vector<std::function<void(display&)> > display::redraw_observers_
private

Definition at line 1046 of file display.hpp.

Referenced by add_redraw_observer(), clear_redraw_observers(), and redraw_everything().

◆ redrawMinimap_

bool display::redrawMinimap_
protected

Definition at line 746 of file display.hpp.

Referenced by draw_init(), draw_wrap(), and scroll().

◆ reportRects_

std::map<std::string, SDL_Rect> display::reportRects_
protected

Definition at line 774 of file display.hpp.

Referenced by redraw_everything(), and refresh_report().

◆ reports_

std::map<std::string, config> display::reports_
protected

Definition at line 776 of file display.hpp.

Referenced by redraw_everything(), and refresh_report().

◆ reports_object_

reports* display::reports_object_
protected

Definition at line 756 of file display.hpp.

Referenced by game_display::draw_sidebar(), and refresh_report().

◆ reportSurfaces_

std::map<std::string, surface> display::reportSurfaces_
protected

Definition at line 775 of file display.hpp.

Referenced by redraw_everything(), and refresh_report().

◆ screen_

CVideo& display::screen_
protected

◆ scroll_event_

events::generic_event display::scroll_event_
mutableprotected

Event raised when the map is being scrolled.

Definition at line 759 of file display.hpp.

Referenced by scroll().

◆ selectedHex_

map_location display::selectedHex_
protected

◆ shroud_images_

std::vector<std::string> display::shroud_images_
protected

Definition at line 784 of file display.hpp.

Referenced by display(), and draw_hex().

◆ singleton_

display * display::singleton_ = nullptr
staticprotected

Definition at line 1065 of file display.hpp.

Referenced by display(), game_display::get_singleton(), handle_event(), and ~display().

◆ terrain_image_vector_

std::vector<surface> display::terrain_image_vector_
private

Definition at line 806 of file display.hpp.

Referenced by draw_hex(), and get_terrain_images().

◆ theme_

theme display::theme_
protected

◆ tod_hex_mask1

surface display::tod_hex_mask1
protected

Definition at line 782 of file display.hpp.

Referenced by draw_hex(), and game_display::new_turn().

◆ tod_hex_mask2

surface display::tod_hex_mask2
protected

Definition at line 782 of file display.hpp.

Referenced by draw_hex(), and game_display::new_turn().

◆ turbo_

bool display::turbo_
protected

Definition at line 753 of file display.hpp.

Referenced by turbo_speed().

◆ turbo_speed_

double display::turbo_speed_
protected

Definition at line 752 of file display.hpp.

Referenced by turbo_speed().

◆ view_locked_

bool display::view_locked_
protected

Definition at line 737 of file display.hpp.

Referenced by read(), scroll(), scroll_to_xy(), and write().

◆ wb_

std::weak_ptr<wb::manager> display::wb_
protected

◆ xpos_

int display::xpos_
protected

◆ ypos_

int display::ypos_
protected

◆ zoom_

unsigned int display::zoom_ = DefaultZoom
staticprotected

◆ zoom_index_

int display::zoom_index_
protected

Definition at line 740 of file display.hpp.

Referenced by display(), and set_zoom().


The documentation for this class was generated from the following files: