#include <display.hpp>

Inheritance diagram for display:

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 gamemap &	get_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_map &	get_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_context &	get_disp_context () const

void	reset_halo_manager ()

void	reset_halo_manager (halo::manager &hm)

halo::manager &	get_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...

CVideo &	video ()
	Gets the underlying screen object. More...

surface &	get_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_location &	displayed_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_location &	selected_hex () const

const map_location &	mouseover_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...

theme &	get_theme ()

void	set_theme (config theme_cfg)

std::shared_ptr< gui::button >	find_action_button (const std::string &id)
	Retrieves a pointer to a theme UI button. More...

std::shared_ptr< gui::button >	find_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_builder &	get_builder ()

void	flip ()

void	update_display ()
	Copy the backbuffer to the framebuffer. More...

void	rebuild_all ()
	Rebuild all dynamic terrain. More...

const theme::action *	action_pressed ()

const theme::menu *	menu_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	toggle_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_event &	scroll_event () const
	Expose the event, so observers can be notified about map scrolling. More...

events::generic_event &	complete_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_labels &	labels ()

const map_labels &	labels () 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_day &	get_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_team (const team &)
	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 ()

sdl_handler &	operator= (sdl_handler &&)=delete
	Moving would require two instances' context membership to be handled, it's simpler to delete these and require the two instances to be separately constructed / destructed. More...

	sdl_handler (sdl_handler &&)=delete

Static Public Member Functions
static display *	get_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 (const 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_helper >	drawing_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< surface >	get_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_map &	get_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)

	sdl_handler (const sdl_handler &)

sdl_handler &	operator= (const sdl_handler &)

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_context *	dc_

std::unique_ptr< halo::manager >	halo_man_

std::weak_ptr< wb::manager >	wb_

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...

CVideo &	screen_

std::size_t	currentTeam_

bool	dont_show_all_

int	xpos_
	Position of the top-left corner of the viewport, in pixels. More...

int	ypos_

bool	view_locked_

theme	theme_

int	zoom_index_

const std::unique_ptr< fake_unit_manager >	fake_unit_man_

const std::unique_ptr< terrain_builder >	builder_

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_labels >	map_labels_

reports *	reports_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, surface >	reportSurfaces_

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

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

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

std::set< map_location >	invalidated_

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
	The current zoom, in pixels (on screen) per 72 pixels (in the graphic assets), i.e., 72 means 100%. More...

static unsigned int	last_zoom_ = SmallZoom
	The previous value of zoom_. More...

static display *	singleton_ = nullptr

Private Types
typedef std::list< arrow * >	arrows_list_t

typedef std::map< map_location, arrows_list_t >	arrows_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< surface >	terrain_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 1063 of file display.hpp.

◆ arrows_map_t

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

private

Definition at line 1064 of file display.hpp.

◆ drawing_buffer

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

protected

Definition at line 976 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 661 of file display.hpp.

◆ overlay_map

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

protected

Definition at line 1038 of file display.hpp.

◆ reach_map

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

protected

Definition at line 1032 of file display.hpp.

Member Enumeration Documentation

◆ drawing_layer

enum display::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 823 of file display.hpp.

◆ SCROLL_TYPE

enum display::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 718 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 280 of file display.cpp.

References resources::fake_units, and singleton_.

Member Function Documentation

◆ action_pressed()

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

Definition at line 1721 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 3143 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

loc	The location of the unit requesting exclusivity.
unit	The unit requesting exclusivity.

Returns: false if there's already an exclusive draw request for this location.

Definition at line 422 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 133 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 2472 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 464 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()`
	)

Announce a message prominently.

Definition at line 1771 of file display.cpp.

References font::add_floating_label(), display::announce_options::discard_previous, h, display::announce_options::lifetime, map_outside_area(), font::remove_floating_label(), font::floating_label::set_clip_rect(), font::floating_label::set_color(), font::floating_label::set_font_size(), font::floating_label::set_lifetime(), font::floating_label::set_position(), font::SIZE_XLARGE, and w.

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION(), play_controller::hotkey_handler::toggle_accelerated_speed(), and playsingle_controller::hotkey_handler::whiteboard_toggle().

◆ blindfold()

void display::blindfold ( bool flag )

Definition at line 525 of file display.cpp.

References blindfold_ctr_.

◆ bounds_check_position() [1/2]

void display::bounds_check_position ( )

Definition at line 2358 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

Definition at line 2377 of file display.cpp.

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

◆ change_display_context()

void display::change_display_context ( const display_context * dc )

Definition at line 509 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 2477 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_hp(), and unit_status().

◆ 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 2482 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 2486 of file display.cpp.

References draw().

◆ draw() [3/3]

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

Definition at line 2491 of file display.cpp.

References preferences::animate_water(), animate_water_, builder_, dirty_, draw_init(), draw_invalidated(), draw_sidebar(), draw_wrap(), drawing_buffer_commit(), get_map(), invalidate_animations(), invalidated_, post_commit(), post_draw(), pre_draw(), redraw_everything(), screen_, and CVideo::update_locked().

◆ draw_all_panels()

void display::draw_all_panels ( )

protected

redraw all panels associated with the map display

Definition at line 1466 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

Redraws a single gamemap location.

Reimplemented in game_display, and editor::editor_display.

Definition at line 2592 of file display.cpp.

References a, arrows_map_, tod_color::b, BACKGROUND, time_of_day::color, color_adjust_, game_config::debug, dont_show_all_, draw_coordinates_, arrow::draw_hex(), draw_num_of_bitmaps_, draw_terrain_codes_, drawing_buffer_add(), sdl::fill_surface_rect(), fog_images_, fogged(), FOREGROUND, tod_color::g, get_flag(), get_fog_shroud_images(), image::get_image(), get_image_type(), image::get_light_string(), image::get_lighted_image(), get_location_x(), get_location_y(), get_map(), get_overlays(), font::get_rendered_text(), get_teams(), get_terrain_images(), get_time_of_day(), get_variant(), grid_, game_config::images::grid_bottom, game_config::images::grid_top, hex_size(), time_of_day::id, time_of_day::image_mask, in_editor(), LAYER_FOG_SHROUD, LAYER_GRID_BOTTOM, LAYER_GRID_TOP, LAYER_MOUSEOVER_OVERLAY, LAYER_TERRAIN_BG, LAYER_TERRAIN_FG, LAYER_UNIT_DEFAULT, mouseover_hex_overlay_, mouseoverHex_, font::NORMAL_COLOR, gamemap::on_board(), tod_color::r, image::SCALED_TO_HEX, shroud_images_, shrouded(), font::SIZE_SMALL, utils::split(), terrain_image_vector_, image::TOD_COLORED, tod_hex_mask1, tod_hex_mask2, and viewing_team().

Referenced by editor::editor_display::draw_hex(), game_display::draw_hex(), and draw_invalidated().

◆ draw_image_for_report()

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

protected

Definition at line 2772 of file display.cpp.

References get_non_transparent_portion(), get_surface_portion(), CVideo::getSurface(), scale_surface(), screen_, and sdl_blit().

Referenced by refresh_report().

◆ 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 1644 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 2555 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

Definition at line 1787 of file display.cpp.

References theme::border(), currentTeam_, dc_, draw_centered_on_background(), draw_minimap_units(), get_map(), image::getMinimap(), CVideo::getSurface(), gamemap::h(), hex_size(), hex_width(), is_blindfolded(), map_area(), map_outside_area(), minimap_, minimap_area(), minimap_location_, reach_map_, screen_, selectedHex_, theme::border_t::size, display_context::teams(), theme_, map_location::valid(), gamemap::w(), xpos_, and ypos_.

Referenced by draw_wrap().

◆ 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 714 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 text on a hex.

(0.5, 0.5) is the center. The font size is adjusted to the zoom factor.

Definition at line 1514 of file display.cpp.

References font::BLACK_COLOR, drawing_buffer_add(), get_location_x(), get_location_y(), font::get_rendered_text(), get_zoom_factor(), and hex_size().

Referenced by wb::recall::draw_hex(), wb::recruit::draw_hex(), wb::move::draw_hex(), game_display::draw_hex(), game_display::draw_movement_info(), and wb::draw_numbers().

◆ draw_wrap()

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

protected

Definition at line 1683 of file display.cpp.

References CVideo::current_refresh_rate(), preferences::draw_delay(), draw_minimap(), fps_actual_, fps_counter_, fps_start_, frametimes_, last_frame_finished_, redrawMinimap_, screen_, and update_display().

Referenced by draw().

◆ 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

layer	The layer to draw on.
loc	The hex the image belongs to, needed for the drawing order.

Definition at line 1200 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 1207 of file display.cpp.

◆ drawing_buffer_clear()

void display::drawing_buffer_clear ( )

protected

Clears the drawing buffer.

Definition at line 1317 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 1279 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 1753 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 470 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 826 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(), turn_info::process_network_data(), hotkey::command_executor_default::set_button_state(), and play_controller::toggle_skipping_replay().

◆ find_menu_button()

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

Definition at line 836 of file display.cpp.

References i, and menu_buttons_.

Referenced by create_buttons(), editor::palette_manager::draw_contents(), editor::empty_palette::hide(), editor::location_palette::hide(), layout_buttons(), and hotkey::command_executor_default::set_button_state().

◆ flip()

void display::flip ( )

Definition at line 1332 of file display.cpp.

References font::draw_floating_labels(), CVideo::flip(), CVideo::getSurface(), events::raise_volatile_draw_event(), events::raise_volatile_undraw_event(), font::undraw_floating_labels(), and video().

Referenced by update_display().

◆ fogged()

bool display::fogged ( const map_location & loc ) const

Returns true if location (x,y) is covered in fog.

Definition at line 739 of file display.cpp.

References currentTeam_, dc_, dont_show_all_, is_blindfolded(), and display_context::teams().

Referenced by soundsource::positional_source::calculate_volume(), events::menu_handler::do_search(), draw_hex(), draw_minimap_units(), game_display::float_label(), get_flag(), get_fog_shroud_images(), invalidate_animations_location(), is_fogged(), events::mouse_handler::mouse_motion(), unit_creator::post_create(), scroll_to_tiles(), game_display::select_hex(), events::mouse_handler::select_hex(), events::menu_handler::show_enemy_moves(), events::mouse_handler::touch_motion(), unit_display::unit_attack(), unit_display::unit_die(), unit_display::unit_draw_weapon(), unit_display::unit_healing(), events::mouse_handler::unit_in_cycle(), unit_display::unit_recruited(), and unit_display::unit_sheath_weapon().

◆ 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 2550 of file display.cpp.

References map_area().

Referenced by draw_invalidated().

◆ get_disp_context()

const display_context& display::get_disp_context ( ) const

inline

Definition at line 168 of file display.hpp.

Referenced by display_chat_manager::add_chat_message(), events::menu_handler::goto_leader(), terrain_label::hidden(), help::load_terrain_types_data(), unit_display::unit_recruited(), and terrain_label::viewable().

◆ 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

Definition at line 376 of file display.cpp.

References animate_map_, dc_, game_config::images::flag, flags_, fogged(), image::get_image(), get_map(), display_context::get_team(), team::is_enemy(), t, display_context::teams(), image::TOD_COLORED, and viewing_side().

Referenced by draw_hex().

◆ get_fog_shroud_images()

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

protected

Definition at line 962 of file display.cpp.

References image::exists(), game_config::fog_prefix, fogged(), get_adjacent_tiles(), get_direction(), image::get_image(), i, names, game_config::shroud_prefix, shrouded(), and editor::start().

Referenced by draw_hex().

◆ 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 2764 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

Functions to get the on-screen positions of hexes.

Definition at line 744 of file display.cpp.

References theme::border(), hex_width(), map_area(), theme::border_t::size, theme_, map_location::x, and xpos_.

Referenced by add_overlay(), terrain_label::draw(), editor::editor_display::draw_hex(), wb::attack::draw_hex(), wb::suppose_dead::draw_hex(), arrow::draw_hex(), game_display::draw_hex(), draw_hex(), draw_invalidated(), game_display::draw_movement_info(), draw_text_in_hex(), game_display::float_label(), unit_frame::get_overlaped_hex(), terrain_label::get_rect(), play_controller::hotkey_handler::left_mouse_click(), editor::mouse_action_unit::move(), unit_frame::redraw(), unit_drawer::redraw_unit(), halo::halo_impl::effect::render(), play_controller::hotkey_handler::right_mouse_click(), scroll_to_tiles(), halo::halo_impl::effect::set_location(), tile_fully_on_screen(), tile_nearly_on_screen(), and halo::halo_impl::effect::unrender().

◆ get_location_y()

int display::get_location_y ( const map_location & loc ) const

Definition at line 749 of file display.cpp.

References theme::border(), is_odd(), map_area(), theme::border_t::size, theme_, map_location::x, map_location::y, ypos_, and zoom_.

Referenced by add_overlay(), terrain_label::draw(), editor::editor_display::draw_hex(), wb::attack::draw_hex(), wb::suppose_dead::draw_hex(), arrow::draw_hex(), game_display::draw_hex(), draw_hex(), draw_invalidated(), game_display::draw_movement_info(), draw_text_in_hex(), game_display::float_label(), unit_frame::get_overlaped_hex(), terrain_label::get_rect(), play_controller::hotkey_handler::left_mouse_click(), editor::mouse_action_unit::move(), unit_frame::redraw(), unit_drawer::redraw_unit(), halo::halo_impl::effect::render(), play_controller::hotkey_handler::right_mouse_click(), scroll_to_tiles(), halo::halo_impl::effect::set_location(), tile_fully_on_screen(), tile_nearly_on_screen(), and halo::halo_impl::effect::unrender().

◆ get_map()

const gamemap& display::get_map ( ) const

inline

Definition at line 92 of file display.hpp.

◆ get_middle_location()

map_location display::get_middle_location ( ) const

protected

Definition at line 3175 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

Implemented in game_display, and editor::editor_display.

Referenced by add_overlay(), draw_hex(), parse_team_overlays(), remove_overlay(), and remove_single_overlay().

◆ 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(), wb::move::calculate_moves_left(), battle_context::choose_defender_weapon(), actions::shroud_clearer::clear_loc(), actions::shroud_clearer::clear_unit(), wb::manager::create_temp_move(), quit_confirmation::default_prompt(), ai::readonly_context_impl::diagnostic(), do_replay(), do_replay_handle(), terrain_label::draw(), wb::attack::draw_hex(), wb::recall::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(), attack_type::list_ability(), 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(), tod_stats_at(), 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

Definition at line 1051 of file display.cpp.

References terrain_builder::BACKGROUND, builder_, d, terrain_builder::FOREGROUND, FOREGROUND, get_adjacent_tiles(), get_time_of_day(), and terrain_image_vector_.

Referenced by draw_hex().

◆ get_theme()

theme& display::get_theme ( )

inline

Definition at line 379 of file display.hpp.

References preferences::set_theme().

Referenced by replay_controller::add_replay_theme(), hotkey::command_executor::get_menu_image(), hotkey::command_executor::get_menu_images(), controller_base::handle_event(), editor::editor_toolkit::init_mouse_actions(), controller_base::long_touch_callback(), replay_controller::replay_controller(), events::mouse_handler_base::right_mouse_up(), hotkey::command_executor_default::set_button_state(), hotkey::command_executor::show_menu(), and replay_controller::~replay_controller().

◆ 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 447 of file display.cpp.

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

◆ get_units()

const unit_map& display::get_units ( ) const

inline

Definition at line 121 of file display.hpp.

Referenced by unit::ability_active(), editor::mouse_action_unit::click_left(), editor::mouse_action_unit::drag_end_left(), unit::get_abilities(), unit::get_ability_bool(), unit::has_ability_type(), attack_type::list_ability(), unit_animation::matches(), editor::mouse_action_unit::move(), unit_display::reset_helpers(), gui2::dialogs::show_unit_list(), attack_type::special_active(), and unit_display::unit_recruited().

◆ get_variant()

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

staticprotected

Definition at line 492 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

Returns the current zoom factor.

Definition at line 258 of file display.hpp.

References game_config::tile_size.

Referenced by draw_text_in_hex(), unit_animation_component::invalidate(), unit_frame::redraw(), editor::mouse_action_item::set_item_mouse_overlay(), editor::mouse_action_map_label::set_mouse_overlay(), editor::mouse_action_village::set_mouse_overlay(), editor::mouse_action_select::set_mouse_overlay(), editor::mouse_action_paste::set_mouse_overlay(), editor::mouse_action_starting_position::set_mouse_overlay(), and editor::mouse_action_unit::set_unit_mouse_overlay().

◆ handle_event()

void display::handle_event ( const SDL_Event & event )

virtual

Implements events::sdl_handler.

Definition at line 3252 of file display.cpp.

References gui2::dialogs::loading_screen::displaying(), draw(), DRAW_ALL_EVENT, and singleton_.

◆ handle_window_event()

void display::handle_window_event ( const SDL_Event & event )

virtual

Implements events::sdl_handler.

Definition at line 3237 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 593 of file display.cpp.

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

◆ hex_size()

static int display::hex_size ( )

inlinestatic

Function which returns the size of a hex in pixels (from top tip to bottom tip or left edge to right edge).

Definition at line 255 of file display.hpp.

Referenced by add_overlay(), draw_hex(), draw_minimap(), draw_text_in_hex(), unit_frame::get_overlaped_hex(), terrain_label::get_rect(), hexes_under_rect(), max_map_area(), minimap_location_on(), editor::mouse_action_unit::move(), outside_area(), pixel_position_to_hex(), unit_frame::redraw(), halo::halo_impl::effect::render(), scroll_to_tiles(), editor::mouse_action::set_terrain_mouse_overlay(), and tile_nearly_on_screen().

◆ 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

Return the rectangular area of hexes overlapped by r (r is in screen coordinates)

Definition at line 682 of file display.cpp.

References theme::border(), display::rect_of_hexes::bottom, hex_size(), hex_width(), display::rect_of_hexes::left, map_area(), display::rect_of_hexes::right, theme::border_t::size, theme_, game_config::tile_size, display::rect_of_hexes::top, xpos_, and ypos_.

Referenced by unit_frame::get_overlaped_hex(), invalidate_locations_in_rect(), and halo::halo_impl::effect::render().

◆ highlight_hex()

void display::highlight_hex ( map_location hex )

virtual

Reimplemented in game_display.

Definition at line 1619 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

Definition at line 492 of file display.hpp.

References preferences::set_idle_anim_rate().

Referenced by unit_animation_component::refresh(), and unit_animation_component::start_animation().

◆ idle_anim_rate()

double display::idle_anim_rate ( ) const

inline

Definition at line 494 of file display.hpp.

References image::set_zoom().

Referenced by unit_animation_component::refresh(), and unit_animation_component::start_animation().

◆ 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 the flag list and the team colors used by ~TC.

Definition at line 301 of file display.cpp.

References dc_, flags_, init_flags_for_side_internal(), image::set_team_colors(), t, and display_context::teams().

Referenced by display(), editor::context_manager::new_scenario(), and editor::context_manager::refresh_on_context_change().

◆ init_flags_for_side_internal()

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

private

Definition at line 323 of file display.cpp.

References animated< T >::add_frame(), dc_, randomness::rng::default_instance(), ERR_DP, f, game_config::images::flag, game_config::flag_rgb, flags_, animated< T >::get_end_time(), mp_ui_alerts::items, LOG_DP, n, utf8::size(), utils::split(), utils::square_parenthetical_split(), animated< T >::start_animation(), and display_context::teams().

Referenced by init_flags(), and reinit_flags_for_team().

◆ invalidate() [1/2]

bool display::invalidate ( const map_location & loc )

Function to invalidate a specific tile for redrawing.

Definition at line 3025 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_unit::move(), editor::mouse_action_item::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(), events::menu_handler::show_enemy_moves(), unit_display::unit_mover::start(), SYNCED_COMMAND_HANDLER_FUNCTION(), 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 3035 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 3100 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 3090 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

Function to invalidate the game status displayed on the sidebar.

Definition at line 291 of file display.hpp.

Referenced by wb::recall::apply_temp_modifier(), wb::recruit::apply_temp_modifier(), events::menu_handler::execute_gotos(), game_display::highlight_hex(), editor::editor_toolkit::hotkey_set_mouse_action(), actions::shroud_clearer::invalidate_after_clear(), events::mouse_handler::move_unit_along_route(), events::menu_handler::move_unit_to_loc(), actions::recall_unit(), actions::recruit_unit(), actions::undo_list::redo(), set_playing_team(), and actions::undo_list::undo().

◆ 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 3078 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

Definition at line 402 of file display.hpp.

Referenced by replay_controller::add_replay_theme(), set_theme(), and replay_controller::update_enabled_buttons().

◆ invalidate_visible_locations_in_rect()

bool display::invalidate_visible_locations_in_rect ( const SDL_Rect & rect )

Definition at line 3073 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 533 of file display.cpp.

References blindfold_ctr_.

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

◆ labels() [1/2]

◆ labels() [2/2]

const map_labels & display::labels ( ) const

Definition at line 2545 of file display.cpp.

References map_labels_.

◆ layout_buttons()

void display::layout_buttons ( )

Definition at line 846 of file display.cpp.

References theme::actions(), b, DBG_DP, find_action_button(), find_menu_button(), theme::menus(), screen_, CVideo::screen_area(), and theme_.

Referenced by create_buttons().

◆ map_area()

const SDL_Rect & display::map_area ( ) const

Returns the area used for the map.

Definition at line 556 of file display.cpp.

References map_outside_area(), map_screenshot_, and max_map_area().

Referenced by bounds_check_position(), soundsource::positional_source::calculate_volume(), draw_init(), draw_minimap(), get_clip_rect(), get_location_x(), get_location_y(), get_middle_location(), hex_clicked_on(), hexes_under_rect(), invalidate_visible_locations_in_rect(), render_image(), scroll(), scroll_to_tiles(), scroll_to_xy(), set_zoom(), tile_fully_on_screen(), and tile_nearly_on_screen().

◆ map_outside_area()

const SDL_Rect& display::map_outside_area ( ) const

inline

Returns the available area for a map, this may differ from the above.

This area will get the background area applied to it.

Definition at line 237 of file display.hpp.

Referenced by display_chat_manager::add_chat_message(), announce(), terrain_label::draw(), draw_init(), draw_minimap(), editor::editor_display::get_clip_rect(), controller_base::handle_scroll(), map_area(), unit_drawer::redraw_unit(), halo::halo_impl::effect::render(), set_diagnostic(), set_zoom(), halo::halo_impl::effect::unrender(), gui::floating_textbox::update_location(), and gui2::settings::update_screen_size_variables().

◆ 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 539 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 ( )

Definition at line 1737 of file display.cpp.

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

Referenced by controller_base::play_slice().

◆ 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 754 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(), events::mouse_handler_base::mouse_press(), and events::mouse_handler::touch_motion().

◆ mouseover_hex()

const map_location& display::mouseover_hex ( ) const

inline

Definition at line 285 of file display.hpp.

Referenced by editor::editor_controller::can_execute_command(), controller_base::play_slice(), editor::editor_controller::terrain_description(), play_controller::hotkey_handler::touch_hex(), and unit_display::unit_recruited().

◆ 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 584 of file display.cpp.

References hex_size().

Referenced by scroll_to_tiles(), set_zoom(), and tile_fully_on_screen().

◆ palette_area()

const SDL_Rect& display::palette_area ( ) const

inline

Definition at line 216 of file display.hpp.

Referenced by editor::palette_manager::adjust_size(), and editor::palette_manager::restore_palette_bg().

◆ parse_team_overlays()

void display::parse_team_overlays ( )

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

Definition at line 114 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 608 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 698 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 678 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 671 of file display.hpp.

Referenced by draw().

◆ process_reachmap_changes()

void display::process_reachmap_changes ( )

protected

Definition at line 3198 of file display.cpp.

References get_visible_hexes(), invalidate(), reach_map_, reach_map_changed_, and reach_map_old_.

Referenced by game_display::pre_draw().

◆ 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 3046 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 3190 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 498 of file display.cpp.

References builder_.

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

◆ recalculate_minimap()

void display::recalculate_minimap ( )

inline

Schedule the minimap for recalculation.

Useful if any terrain in the map has changed.

Definition at line 616 of file display.hpp.

Referenced by do_replay(), draw_all_panels(), game_lua_kernel::intf_redraw(), actions::shroud_clearer::invalidate_after_clear(), game_display::maybe_rebuild(), turn_info::process_network_data(), editor::context_manager::refresh_after_action(), editor::context_manager::refresh_all(), select_hex(), SYNCED_COMMAND_HANDLER_FUNCTION(), and replay_controller::update_gui().

◆ redraw_everything()

void display::redraw_everything ( )

Invalidates entire screen, including all tiles and sidebar.

Calls redraw observers.

Definition at line 2421 of file display.cpp.

References action_buttons_, bounds_check_position(), tooltips::clear_tooltips(), complete_redraw_event_, resources::controller, create_buttons(), draw(), f, play_controller::get_hotkey_command_executor(), gui::in_dialog(), invalidate_all(), invalidateGameStatus_, labels(), LOG_DP, menu_buttons_, events::generic_event::notify_observers(), panelsDrawn_, map_labels::recalculate_labels(), redraw_background_, redraw_observers_, reportRects_, reports_, reportSurfaces_, screen_, CVideo::screen_area(), hotkey::command_executor::set_button_state(), theme::set_resolution(), theme_, and CVideo::update_locked().

Referenced by draw(), editor::editor_controller::editor_controller(), events::menu_handler::preferences(), turn_info::process_network_data(), replay_controller::replay_controller(), set_theme(), SYNCED_COMMAND_HANDLER_FUNCTION(), replay_controller::update_enabled_buttons(), replay_controller::update_gui(), and replay_controller::~replay_controller().

◆ 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`
	)

Redraws the specified report (if anything has changed).

If a config is not supplied, it will be generated via reports::generate_report().

Definition at line 2810 of file display.cpp.

References config::add_child(), config::add_child_at(), tooltips::add_tooltip(), CVideo::blit_surface(), config::child(), config::child_range(), tooltips::clear_tooltips(), resources::controller, dc_, draw_image_for_report(), e, game_config::images::ellipsis, config::empty(), ERR_DP, theme::status_item::font_rgb(), theme::status_item::font_rgb_set(), theme::status_item::font_size(), reports::generate_report(), image::get_image(), play_controller::get_mouse_handler_base(), theme::get_status_item(), get_surface_portion(), CVideo::getSurface(), theme::object::location(), theme::status_item::postfix(), theme::status_item::prefix(), font::pango_text::render(), reportRects_, reports_, reports_object_, reportSurfaces_, s, screen_, CVideo::screen_area(), sdl_blit(), font::pango_text::set_font_size(), font::pango_text::set_foreground_color(), font::pango_text::set_maximum_height(), font::pango_text::set_maximum_width(), font::pango_text::set_text(), t, theme_, resources::tod_manager, and wb_.

Referenced by editor::editor_display::draw_sidebar(), and game_display::draw_sidebar().

◆ reinit_flags_for_team()

void display::reinit_flags_for_team ( const team & t )

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

Definition at line 318 of file display.cpp.

References team::color(), init_flags_for_side_internal(), and team::side().

◆ 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 503 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 3152 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 435 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 148 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 153 of file display.cpp.

References get_overlays().

◆ render_buttons()

void display::render_buttons ( )

Definition at line 932 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 1543 of file display.cpp.

References adjust_surface_alpha(), blend_surface(), brighten_image(), surface::clone(), DefaultZoom, drawing_buffer_add(), ERR_DP, flop_surface(), ftofxp, greyscale_image(), 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 515 of file display.cpp.

References halo_man_.

◆ reset_halo_manager() [2/2]

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

Definition at line 520 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 3136 of file display.cpp.

References dc_, and display_context::units().

◆ screenshot()

surface display::screenshot ( bool map_screenshot = false )

Capture a (map-)screenshot into a surface.

Definition at line 784 of file display.cpp.

References surface::clone(), DBG_DP, draw(), ERR_DP, get_map(), CVideo::getSurface(), invalidateAll_, map_screenshot_, map_screenshot_surf_, max_map_area(), screen_, xpos_, and ypos_.

Referenced by editor::editor_controller::do_screenshot().

◆ scroll()

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

Scrolls the display by xmov,ymov pixels.

Invalidation and redrawing will be scheduled.

Returns: true if the map actually moved.

Definition at line 1925 of file display.cpp.

References bounds_check_position(), surface::clone(), CVideo::getSurface(), sdl::intersect_rects(), invalidate_locations_in_rect(), labels(), map_area(), events::generic_event::notify_observers(), map_labels::recalculate_shroud(), redrawMinimap_, screen_, scroll_event_, font::scroll_floating_labels(), CVideo::update_locked(), view_locked_, xpos_, and ypos_.

Referenced by controller_base::handle_scroll(), events::mouse_handler_base::mouse_wheel(), scroll_to_xy(), and events::mouse_handler::touch_motion().

◆ 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 such that location loc is on-screen.

WARP jumps to loc; SCROLL uses scroll speed; ONSCREEN only scrolls if x,y is offscreen force : scroll even if preferences tell us not to, or the view is locked.

Definition at line 2205 of file display.cpp.

References ERR_DP, get_map(), and scroll_to_tiles().

Referenced by editor::location_palette::adjust_size(), events::mouse_handler::cycle_units(), events::menu_handler::do_search(), events::menu_handler::goto_leader(), editor::mouse_action::key_event(), events::mouse_handler_base::left_click(), events::mouse_handler_base::mouse_motion_default(), events::mouse_handler_base::mouse_press(), game_display::scroll_to_leader(), gui2::dialogs::show_unit_list(), events::mouse_handler::touch_motion(), unit_display::unit_healing(), and unit_display::unit_recruited().

◆ 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 2217 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 2227 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

Definition at line 2126 of file display.cpp.

References bounds_check_position(), draw(), map_area(), ONSCREEN_WARP, events::pump(), screen_, scroll(), preferences::scroll_speed(), preferences::scroll_to_action(), t, turbo_speed(), CVideo::update_locked(), view_locked_, WARP, xpos_, and ypos_.

Referenced by scroll_to_tiles().

◆ select_hex()

void display::select_hex ( map_location hex )

virtual

Reimplemented in game_display.

Definition at line 1611 of file display.cpp.

References invalidate(), recalculate_minimap(), and selectedHex_.

Referenced by game_display::select_hex(), gui2::dialogs::show_unit_list(), and unit_display::unit_attack().

◆ selected_hex()

const map_location& display::selected_hex ( ) const

inline

Definition at line 284 of file display.hpp.

Referenced by get_selected_unit().

◆ set_diagnostic()

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

Definition at line 1626 of file display.cpp.

References font::add_floating_label(), diagnostic_label_, map_outside_area(), font::remove_floating_label(), font::floating_label::set_clip_rect(), font::floating_label::set_color(), font::floating_label::set_font_size(), font::floating_label::set_position(), font::SIZE_PLUS, and font::YELLOW_COLOR.

Referenced by ai::readonly_context_impl::diagnostic().

◆ 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 2416 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

mouseover_hex_overlay_ require a prerendered surface and is drawn underneath the mouse's location

Definition at line 443 of file display.hpp.

◆ 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 415 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 396 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 )

Definition at line 290 of file display.cpp.

References action_buttons_, theme::border(), builder_, create_buttons(), invalidate_theme(), menu_buttons_, rebuild_all(), redraw_everything(), screen_, CVideo::screen_area(), theme::border_t::show_border, preferences::theme(), and theme_.

Referenced by preferences::show_theme_dialog().

◆ 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 2029 of file display.cpp.

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

Referenced by toggle_default_zoom().

◆ set_zoom() [2/2]

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

Sets the display zoom to the specified amount.

Definition at line 2039 of file display.cpp.

References bounds_check_position(), utils::clamp(), DefaultZoom, draw(), get_zoom_levels_index(), invalidate_all(), labels(), last_zoom_, LOG_DP, map_area(), map_outside_area(), MaxZoom, MinZoom, outside_area(), map_labels::recalculate_labels(), redraw_background_, preferences::set_tile_size(), image::set_zoom(), xpos_, ypos_, zoom_, zoom_index_, and zoom_levels.

◆ show_everything()

bool display::show_everything ( ) const

inline

Definition at line 90 of file display.hpp.

Referenced by attack_info(), events::menu_handler::current_unit(), get_selected_unit(), get_visible_unit(), and gui2::dialogs::game_stats::pre_show().

◆ shrouded()

bool display::shrouded ( const map_location & loc ) const

Returns true if location (x,y) is covered in shroud.

Definition at line 734 of file display.cpp.

References currentTeam_, dc_, dont_show_all_, is_blindfolded(), and display_context::teams().

Referenced by soundsource::positional_source::calculate_volume(), playsingle_controller::hotkey_handler::can_execute_command(), events::menu_handler::do_search(), game_display::draw_hex(), draw_hex(), get_fog_shroud_images(), invalidate_animations(), is_shrouded(), halo::halo_impl::effect::render(), events::menu_handler::terrain_description(), tod_stats_at(), and halo::halo_impl::effect::unrender().

◆ string_to_button_type()

gui::button::TYPE display::string_to_button_type ( const std::string & type )

static

Definition at line 946 of file display.cpp.

References gui::button::TYPE_CHECK, gui::button::TYPE_IMAGE, gui::button::TYPE_PRESS, gui::button::TYPE_RADIO, and gui::button::TYPE_TURBO.

Referenced by create_buttons().

◆ team_valid()

bool display::team_valid ( ) const

Definition at line 729 of file display.cpp.

References currentTeam_, dc_, and display_context::teams().

Referenced by events::menu_handler::clear_labels(), game_display::current_team_name(), game_display::draw_sidebar(), and unit_drawer::redraw_unit().

◆ 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 2109 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 2116 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 1322 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 1327 of file display.cpp.

◆ toggle_default_zoom()

void display::toggle_default_zoom ( )

Sets the zoom amount to the default.

Definition at line 2097 of file display.cpp.

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

◆ turbo_speed()

double display::turbo_speed ( ) const

Definition at line 2402 of file display.cpp.

References CVideo::faked(), keys_, screen_, turbo_, and turbo_speed_.

Referenced by game_display::float_label(), game_display::new_turn(), scroll_to_xy(), unit_animation::update_last_draw_time(), and unit_animator::wait_until().

◆ 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 3161 of file display.cpp.

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

◆ update_display()

void display::update_display ( )

Copy the backbuffer to the framebuffer.

Definition at line 1355 of file display.cpp.

References font::add_floating_label(), font::BAD_COLOR, calculate_fps(), game_config::debug, drawn_hexes_, flip(), fps_actual_, fps_handle_, frametimes_, invalidated_hexes_, font::LEFT_ALIGN, font::NORMAL_COLOR, font::remove_floating_label(), screen_, font::floating_label::set_font_size(), preferences::show_fps(), and CVideo::update_locked().

Referenced by draw_wrap().

◆ 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_override The ToD to apply to the map instead of that of the current ToD's.

Definition at line 453 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

Gets the underlying screen object.

Definition at line 196 of file display.hpp.

Referenced by display_chat_manager::add_chat_message(), editor::location_palette::adjust_size(), BOOST_AUTO_TEST_CASE(), draw_all_panels(), editor::editor_display::editor_display(), flip(), game_display::game_display(), test_utils::get_fake_display(), controller_base::handle_scroll(), editor::location_palette::hide(), editor::editor_palette< overlay >::hide(), editor::location_palette::select_item(), and gui::floating_textbox::show().

◆ view_locked()

bool display::view_locked ( ) const

inline

Definition at line 518 of file display.hpp.

◆ viewing_side()

int display::viewing_side ( ) const

inline

Definition at line 103 of file display.hpp.

Referenced by wb::move::calculate_moves_left(), play_controller::hotkey_handler::can_execute_command(), wb::manager::create_temp_move(), events::mouse_handler::current_unit_attacks_from(), editor::unit_palette::draw_item(), get_flag(), events::menu_handler::goto_leader(), gray_inactive(), play_controller::hotkey_handler::in_context_menu(), events::menu_handler::label_terrain(), events::mouse_handler::move_unit_along_route(), events::menu_handler::rename_unit(), unit_display::unit_mover::replace_temporary(), game_display::scroll_to_leader(), events::mouse_handler::select_hex(), events::menu_handler::send_chat_message(), editor::mouse_action_unit::set_unit_mouse_overlay(), gui2::dialogs::show_unit_list(), unit_display::unit_recruited(), editor::mouse_action_unit::up_left(), and wb::viewer_side().

◆ viewing_team()

std::size_t display::viewing_team ( ) const

inline

The viewing team is the team currently viewing the game.

Definition at line 102 of file display.hpp.

Referenced by attack_info(), events::menu_handler::current_unit(), game_display::display_unit_hex(), events::menu_handler::do_search(), game_display::draw_hex(), draw_hex(), get_selected_unit(), get_visible_time_of_day_at(), get_visible_unit(), events::menu_handler::has_friends(), game_display::highlight_hex(), events::menu_handler::label_terrain(), pathfind::mark_route(), turn_info::process_network_data(), events::menu_handler::send_chat_message(), events::menu_handler::show_enemy_moves(), events::menu_handler::status_table(), wb::viewer_actions(), wb::viewer_team(), play_controller::hotkey_handler::viewing_team(), events::mouse_handler::viewing_team(), play_controller::hotkey_handler::viewing_team_is_playing(), and pathfind::vision_path::vision_path().

◆ write()

void display::write ( config & cfg ) const

Definition at line 3181 of file display.cpp.

References config::add_child(), tod_color::b, color_adjust_, tod_color::g, get_middle_location(), tod_color::r, view_locked_, and map_location::write().

◆ zoom_at_max()

bool display::zoom_at_max ( )

static

Definition at line 2019 of file display.cpp.

References MaxZoom, and zoom_.

◆ zoom_at_min()

bool display::zoom_at_min ( )

static

Definition at line 2024 of file display.cpp.

References MinZoom, and zoom_.

Member Data Documentation

◆ action_buttons_

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

protected

Definition at line 785 of file display.hpp.

Referenced by action_pressed(), create_buttons(), display(), find_action_button(), redraw_everything(), render_buttons(), and set_theme().

◆ activeTeam_

std::size_t display::activeTeam_

protected

Definition at line 894 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 799 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 802 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 1066 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 653 of file display.hpp.

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

◆ builder_

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

protected

Definition at line 751 of file display.hpp.

Referenced by change_display_context(), draw(), get_terrain_images(), invalidate_animations(), rebuild_all(), editor::editor_display::rebuild_terrain(), reload_map(), and set_theme().

◆ color_adjust_

tod_color display::color_adjust_

private

Definition at line 1068 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 773 of file display.hpp.

Referenced by redraw_everything().

◆ currentTeam_

std::size_t display::currentTeam_

protected

Definition at line 735 of file display.hpp.

Referenced by game_display::current_team_name(), game_display::draw_hex(), draw_minimap(), draw_minimap_units(), game_display::draw_movement_info(), fogged(), invalidate_animations_location(), set_team(), shrouded(), and team_valid().

◆ dc_

◆ diagnostic_label_

int display::diagnostic_label_

protected

Definition at line 758 of file display.hpp.

Referenced by set_diagnostic().

◆ dirty_

bool display::dirty_

private

Definition at line 1070 of file display.hpp.

Referenced by draw(), and handle_window_event().

◆ dont_show_all_

bool display::dont_show_all_

protected

Definition at line 736 of file display.hpp.

Referenced by game_display::display_unit_hex(), draw_hex(), fogged(), game_display::highlight_hex(), set_team(), and shrouded().

◆ draw_coordinates_

bool display::draw_coordinates_

private

Debug flag - overlay x,y coords on tiles.

Definition at line 1057 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 1061 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 1059 of file display.hpp.

Referenced by draw_hex().

◆ drawing_buffer_

drawing_buffer display::drawing_buffer_

protected

Definition at line 977 of file display.hpp.

Referenced by drawing_buffer_clear().

◆ drawn_hexes_

int display::drawn_hexes_

private

Definition at line 1047 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 663 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 750 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 810 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 791 of file display.hpp.

Referenced by display(), and draw_hex().

◆ fps_actual_

unsigned int display::fps_actual_

protected

Definition at line 778 of file display.hpp.

Referenced by draw_wrap(), and update_display().

◆ fps_counter_

unsigned int display::fps_counter_

protected

Definition at line 776 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 1044 of file display.hpp.

Referenced by update_display().

◆ fps_start_

std::chrono::seconds display::fps_start_

protected

Definition at line 777 of file display.hpp.

Referenced by draw_wrap().

◆ frametimes_

boost::circular_buffer<unsigned> display::frametimes_

protected

Definition at line 775 of file display.hpp.

Referenced by draw_wrap(), and update_display().

◆ grid_

bool display::grid_

protected

Definition at line 757 of file display.hpp.

Referenced by draw_hex().

◆ halo_man_

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

protected

Definition at line 658 of file display.hpp.

Referenced by add_overlay(), game_display::draw_invalidated(), game_display::post_commit(), and reset_halo_manager().

◆ idle_anim_

bool display::idle_anim_

private

Definition at line 1049 of file display.hpp.

◆ idle_anim_rate_

double display::idle_anim_rate_

private

Definition at line 1050 of file display.hpp.

Referenced by set_idle_anim_rate().

◆ invalidateAll_

bool display::invalidateAll_

protected

Definition at line 756 of file display.hpp.

Referenced by draw_init(), invalidate(), invalidate_all(), invalidate_locations_in_rect(), propagate_invalidation(), and screenshot().

◆ invalidated_

std::set<map_location> display::invalidated_

protected

Definition at line 786 of file display.hpp.

Referenced by draw(), game_display::draw_invalidated(), draw_invalidated(), invalidate(), invalidate_all(), and propagate_invalidation().

◆ invalidated_hexes_

int display::invalidated_hexes_

private

Count work done for the debug info displayed under fps.

Definition at line 1046 of file display.hpp.

Referenced by draw_invalidated(), and update_display().

◆ invalidateGameStatus_

bool display::invalidateGameStatus_

protected

Definition at line 762 of file display.hpp.

Referenced by game_display::draw_sidebar(), game_display::invalidate_unit(), and redraw_everything().

◆ keys_

CKey display::keys_

protected

Definition at line 796 of file display.hpp.

Referenced by turbo_speed().

◆ last_frame_finished_

uint32_t display::last_frame_finished_ = 0u

protected

Definition at line 779 of file display.hpp.

Referenced by draw_wrap().

◆ last_zoom_

unsigned int display::last_zoom_ = SmallZoom

staticprotected

The previous value of zoom_.

Definition at line 749 of file display.hpp.

Referenced by set_zoom(), and toggle_default_zoom().

◆ map_labels_

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

protected

Definition at line 763 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 1018 of file display.hpp.

Referenced by map_area(), and screenshot().

◆ map_screenshot_surf_

surface display::map_screenshot_surf_

private

Definition at line 1052 of file display.hpp.

Referenced by screenshot().

◆ menu_buttons_

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

protected

Definition at line 785 of file display.hpp.

Referenced by create_buttons(), display(), draw_all_panels(), enable_menu(), find_menu_button(), menu_pressed(), redraw_everything(), render_buttons(), and set_theme().

◆ minimap_

surface display::minimap_

protected

Definition at line 752 of file display.hpp.

Referenced by draw_minimap().

◆ minimap_location_

SDL_Rect display::minimap_location_

protected

Definition at line 753 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 787 of file display.hpp.

Referenced by draw_hex().

◆ mouseoverHex_

map_location display::mouseoverHex_

protected

Definition at line 795 of file display.hpp.

Referenced by game_display::draw_hex(), draw_hex(), game_display::draw_movement_info(), editor::editor_display::draw_sidebar(), game_display::highlight_hex(), and highlight_hex().

◆ panelsDrawn_

bool display::panelsDrawn_

protected

Definition at line 759 of file display.hpp.

Referenced by draw_init(), and redraw_everything().

◆ reach_map_

reach_map display::reach_map_

protected

Definition at line 1033 of file display.hpp.

Referenced by game_display::draw_hex(), draw_minimap(), game_display::draw_movement_info(), game_display::highlight_another_reach(), process_reachmap_changes(), and game_display::unhighlight_reach().

◆ reach_map_changed_

bool display::reach_map_changed_

protected

Definition at line 1035 of file display.hpp.

Referenced by game_display::highlight_another_reach(), process_reachmap_changes(), and game_display::unhighlight_reach().

◆ reach_map_old_

reach_map display::reach_map_old_

protected

Definition at line 1034 of file display.hpp.

Referenced by process_reachmap_changes().

◆ redraw_background_

bool display::redraw_background_

protected

Definition at line 755 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 1054 of file display.hpp.

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

◆ redrawMinimap_

bool display::redrawMinimap_

protected

Definition at line 754 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 782 of file display.hpp.

Referenced by redraw_everything(), and refresh_report().

◆ reports_

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

protected

Definition at line 784 of file display.hpp.

Referenced by redraw_everything(), and refresh_report().

◆ reports_object_

reports* display::reports_object_

protected

Definition at line 764 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 783 of file display.hpp.

Referenced by redraw_everything(), and refresh_report().

◆ screen_

CVideo& display::screen_

protected

Definition at line 734 of file display.hpp.

Referenced by create_buttons(), display(), draw(), draw_all_panels(), draw_image_for_report(), draw_minimap(), draw_minimap_units(), draw_wrap(), layout_buttons(), redraw_everything(), refresh_report(), screenshot(), scroll(), scroll_to_xy(), set_theme(), turbo_speed(), and update_display().

◆ scroll_event_

events::generic_event display::scroll_event_

mutableprotected

Event raised when the map is being scrolled.

Definition at line 767 of file display.hpp.

Referenced by scroll().

◆ selectedHex_

map_location display::selectedHex_

protected

Definition at line 794 of file display.hpp.

Referenced by game_display::draw_hex(), draw_minimap(), game_display::draw_movement_info(), game_display::highlight_hex(), and select_hex().

◆ shroud_images_

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

protected

Definition at line 792 of file display.hpp.

Referenced by display(), and draw_hex().

◆ singleton_

display * display::singleton_ = nullptr

staticprotected

Definition at line 1073 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 814 of file display.hpp.

Referenced by draw_hex(), and get_terrain_images().

◆ theme_

theme display::theme_

protected

Definition at line 743 of file display.hpp.

Referenced by action_pressed(), bounds_check_position(), create_buttons(), draw_all_panels(), draw_init(), draw_minimap(), enable_menu(), get_location_x(), get_location_y(), hexes_under_rect(), layout_buttons(), max_map_area(), menu_pressed(), pixel_position_to_hex(), redraw_everything(), refresh_report(), and set_theme().

◆ tod_hex_mask1

surface display::tod_hex_mask1

protected

Definition at line 790 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 790 of file display.hpp.

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

◆ turbo_

bool display::turbo_

protected

Definition at line 761 of file display.hpp.

Referenced by turbo_speed().

◆ turbo_speed_

double display::turbo_speed_

protected

Definition at line 760 of file display.hpp.

Referenced by turbo_speed().

◆ view_locked_

bool display::view_locked_

protected

Definition at line 742 of file display.hpp.

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

◆ wb_

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

protected

Definition at line 659 of file display.hpp.

Referenced by game_display::draw_hex(), game_display::draw_movement_info(), game_display::post_draw(), game_display::pre_draw(), refresh_report(), and set_team().

◆ xpos_

int display::xpos_

protected

Position of the top-left corner of the viewport, in pixels.

Dependent on zoom_.. For example, ypos_==72 only means we're one hex below the top of the map when zoom_ == 72 (the default value).

Definition at line 741 of file display.hpp.

Referenced by bounds_check_position(), draw_minimap(), get_location_x(), get_middle_location(), hex_clicked_on(), hexes_under_rect(), screenshot(), scroll(), scroll_to_xy(), and set_zoom().

◆ ypos_

int display::ypos_

protected

Definition at line 741 of file display.hpp.

Referenced by bounds_check_position(), draw_minimap(), get_location_y(), get_middle_location(), hex_clicked_on(), hexes_under_rect(), screenshot(), scroll(), scroll_to_xy(), and set_zoom().

◆ zoom_

unsigned int display::zoom_ = DefaultZoom

staticprotected

The current zoom, in pixels (on screen) per 72 pixels (in the graphic assets), i.e., 72 means 100%.

Definition at line 746 of file display.hpp.

Referenced by bounds_check_position(), display(), draw_invalidated(), game_display::float_label(), get_location_y(), render_image(), set_zoom(), toggle_default_zoom(), zoom_at_max(), and zoom_at_min().

◆ zoom_index_

int display::zoom_index_

protected

Definition at line 747 of file display.hpp.

Referenced by display(), and set_zoom().

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

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

Detailed Description

Member Typedef Documentation

◆ arrows_list_t

◆ arrows_map_t

◆ drawing_buffer

◆ exclusive_unit_draw_requests_t

◆ overlay_map

◆ reach_map

Member Enumeration Documentation

◆ drawing_layer

◆ SCROLL_TYPE

◆ TERRAIN_TYPE

Constructor & Destructor Documentation

◆ display()

◆ ~display()

Member Function Documentation

◆ action_pressed()

◆ add_arrow()

◆ add_exclusive_draw()

◆ add_overlay()

◆ add_redraw_observer()

◆ adjust_color_overlay()

◆ announce()

◆ blindfold()

◆ bounds_check_position() [1/2]

◆ bounds_check_position() [2/2]

◆ change_display_context()

◆ clear_exclusive_draws()

◆ clear_mouseover_hex_overlay()

◆ clear_redraw_observers()

◆ complete_redraw_event()

◆ create_buttons()

◆ displayed_unit_hex()

◆ draw() [1/3]

◆ draw() [2/3]

◆ draw() [3/3]

◆ draw_all_panels()

◆ draw_hex()

◆ draw_image_for_report()

◆ draw_init()

◆ draw_invalidated()

◆ draw_minimap()

◆ draw_minimap_units()

◆ draw_sidebar()

◆ draw_text_in_hex()

◆ draw_wrap()

◆ drawing_buffer_add() [1/2]

◆ drawing_buffer_add() [2/2]

◆ drawing_buffer_clear()

◆ drawing_buffer_commit()

◆ enable_menu()

◆ fill_images_list()

◆ find_action_button()

◆ find_menu_button()

◆ flip()

◆ fogged()

◆ get_builder()

◆ get_clip_rect()

◆ get_disp_context()

◆ get_draw_coordinates()

◆ get_draw_num_of_bitmaps()

◆ get_draw_terrain_codes()

◆ get_flag()

◆ get_fog_shroud_images()

◆ get_halo_manager()

◆ get_image_type()

◆ get_location_x()

◆ get_location_y()