A simple canvas which can be drawn upon. More...

#include <canvas.hpp>

Classes
class	shape
	Abstract base class for all other shapes. More...

Public Types
typedef std::shared_ptr< shape >	shape_ptr

typedef std::shared_ptr< const shape >	const_shape_ptr

Public Member Functions
	canvas ()

	canvas (const canvas &)=delete

	canvas (canvas &&c) noexcept

	~canvas ()

void	draw (const bool force=false)
	Draws the canvas. More...

void	blit (surface &surf, SDL_Rect rect)
	Blits the canvas unto another surface. More...

void	set_cfg (const config &cfg, const bool force=false)
	Sets the config. More...

void	append_cfg (const config &cfg)
	Appends data to the config. More...

void	set_width (const unsigned width)

unsigned	get_width () const

void	set_height (const unsigned height)

unsigned	get_height () const

surface &	surf ()

void	set_variable (const std::string &key, const wfl::variant &value)

void	set_is_dirty (const bool is_dirty)

Private Member Functions
void	parse_cfg (const config &cfg)
	Parses a config object. More...

void	clear_shapes (const bool force)

void	invalidate_cache ()

Private Attributes
std::vector< shape_ptr >	shapes_
	Vector with the shapes to draw. More...

std::vector< shape_ptr >	drawn_shapes_
	All shapes which have been already drawn. More...

unsigned	blur_depth_
	The depth of the blur to use in the pre committing. More...

unsigned	w_
	Width of the canvas. More...

unsigned	h_
	Height of the canvas. More...

surface	canvas_
	The surface we draw all items on. More...

SDL_Renderer *	renderer_

wfl::map_formula_callable	variables_
	The variables of the canvas. More...

wfl::action_function_symbol_table	functions_
	Action function definitions for the canvas. More...

bool	is_dirty_
	The dirty state of the canvas. More...

Detailed Description

A simple canvas which can be drawn upon.

The class has a config which contains what to draw.

The copy constructor does a shallow copy of the shapes to draw. a clone() will be implemented if really needed.

Definition at line 41 of file canvas.hpp.

Member Typedef Documentation

◆ const_shape_ptr

typedef std::shared_ptr<const shape> gui2::canvas::const_shape_ptr

Definition at line 87 of file canvas.hpp.

◆ shape_ptr

typedef std::shared_ptr<shape> gui2::canvas::shape_ptr

Definition at line 86 of file canvas.hpp.

Constructor & Destructor Documentation

◆ canvas() [1/3]

gui2::canvas::canvas ( )

Definition at line 1350 of file canvas.cpp.

◆ canvas() [2/3]

gui2::canvas::canvas ( const canvas & )

delete

◆ canvas() [3/3]

gui2::canvas::canvas ( canvas && c )

noexcept

Definition at line 1364 of file canvas.cpp.

◆ ~canvas()

gui2::canvas::~canvas ( )

Definition at line 1378 of file canvas.cpp.

References renderer_.

Member Function Documentation

◆ append_cfg()

void gui2::canvas::append_cfg ( const config & cfg )

inline

Appends data to the config.

Parameters

cfg	The config object with the data to draw, see https://www.wesnoth.org/wiki/GUICanvasWML for more information.

Definition at line 135 of file canvas.hpp.

Referenced by gui2::dialogs::story_viewer::draw_floating_image().

◆ blit()

void gui2::canvas::blit	(	surface &	surf,
		SDL_Rect	rect
	)

Blits the canvas unto another surface.

It makes sure the image on the canvas is up to date. Also executes the pre-blitting functions.

Parameters

surf	The surface to blit upon.
rect	The place to blit to.

Definition at line 1427 of file canvas.cpp.

References blur_depth_, blur_surface(), canvas_, draw(), CVideo::get_singleton(), get_surface_portion(), surface::is_neutral(), s, and sdl_blit().

Referenced by gui2::panel::impl_draw_background(), gui2::styled_widget::impl_draw_background(), and gui2::panel::impl_draw_foreground().

◆ clear_shapes()

void gui2::canvas::clear_shapes ( const bool force )

private

Definition at line 1497 of file canvas.cpp.

References drawn_shapes_, s, and shapes_.

◆ draw()

void gui2::canvas::draw ( const bool force = false )

Draws the canvas.

Parameters

force If the canvas isn't dirty it isn't redrawn unless force is set to true.

Definition at line 1384 of file canvas.cpp.

References wfl::map_formula_callable::add(), canvas_, DBG_GUI_D, gui2::canvas::shape::draw(), drawn_shapes_, gui2::get_screen_size_variables(), h_, is_dirty_, gui2::log_gui_draw, log_scope2, renderer_, shapes_, variables_, and w_.

Referenced by blit().

◆ get_height()

unsigned gui2::canvas::get_height ( ) const

inline

Definition at line 161 of file canvas.hpp.

◆ get_width()

unsigned gui2::canvas::get_width ( ) const

inline

Definition at line 149 of file canvas.hpp.

References w_.

◆ invalidate_cache()

void gui2::canvas::invalidate_cache ( )

private

Definition at line 1513 of file canvas.cpp.

References canvas_, drawn_shapes_, and shapes_.

◆ parse_cfg()

void gui2::canvas::parse_cfg ( const config & cfg )

private

Parses a config object.

The config object is parsed and serialized by this function after which the config object is no longer required and thus not stored in the object.

Parameters

cfg	The config object with the data to draw, see https://www.wesnoth.org/wiki/GUICanvasWML

Definition at line 1451 of file canvas.cpp.

References config::all_children_range(), blur_depth_, DBG_GUI_P, ERR_GUI_P, functions_, gui2::log_gui_parse, log_scope2, and shapes_.

◆ set_cfg()

void gui2::canvas::set_cfg	(	const config &	cfg,
		const bool	force = `false`
	)

inline

Sets the config.

Parameters

cfg	The config object with the data to draw, see https://www.wesnoth.org/wiki/GUICanvasWML for more information.

Definition at line 121 of file canvas.hpp.

Referenced by gui2::dialogs::story_viewer::display_part().

◆ set_height()

void gui2::canvas::set_height ( const unsigned height )

inline

Definition at line 154 of file canvas.hpp.

Referenced by gui2::styled_widget::place().

◆ set_is_dirty()

void gui2::canvas::set_is_dirty ( const bool is_dirty )

inline

Definition at line 178 of file canvas.hpp.

Referenced by gui2::dialogs::story_viewer::display_part(), gui2::dialogs::outro::draw_callback(), and gui2::dialogs::story_viewer::draw_floating_image().

◆ set_variable()

void gui2::canvas::set_variable	(	const std::string &	key,
		const wfl::variant &	value
	)

inline

Definition at line 171 of file canvas.hpp.

Referenced by gui2::dialogs::story_viewer::display_part(), gui2::dialogs::outro::draw_callback(), gui2::dialogs::attack_predictions::draw_hp_graph(), gui2::dialogs::end_credits::pre_show(), gui2::dialogs::outro::pre_show(), gui2::dialogs::title_screen::pre_show(), gui2::dialogs::wml_message_base::pre_show(), gui2::dialogs::wml_message_double::pre_show(), gui2::toggle_button::update_canvas(), gui2::styled_widget::update_canvas(), and gui2::dialogs::debug_clock::update_time().

◆ set_width()

void gui2::canvas::set_width ( const unsigned width )

inline

Definition at line 142 of file canvas.hpp.

References w_.

Referenced by gui2::styled_widget::place().

◆ surf()

surface& gui2::canvas::surf ( )

inline

Definition at line 166 of file canvas.hpp.

Member Data Documentation

◆ blur_depth_

unsigned gui2::canvas::blur_depth_

private

The depth of the blur to use in the pre committing.

Note: at the moment there's one pre commit function, namely the blurring so use a variable here, might get more functions in the future. When that happens need to evaluate whether variables are the best thing to use.

Definition at line 199 of file canvas.hpp.

Referenced by blit(), and parse_cfg().

◆ canvas_

surface gui2::canvas::canvas_

private

The surface we draw all items on.

Definition at line 208 of file canvas.hpp.

Referenced by blit(), draw(), and invalidate_cache().

◆ drawn_shapes_

std::vector<shape_ptr> gui2::canvas::drawn_shapes_

private

All shapes which have been already drawn.

Kept around in case the cache needs to be invalidated.

Definition at line 189 of file canvas.hpp.

Referenced by clear_shapes(), draw(), and invalidate_cache().

◆ functions_

wfl::action_function_symbol_table gui2::canvas::functions_

private

Action function definitions for the canvas.

Definition at line 216 of file canvas.hpp.

Referenced by parse_cfg().

◆ h_

unsigned gui2::canvas::h_

private

Height of the canvas.

Definition at line 205 of file canvas.hpp.

Referenced by draw().

◆ is_dirty_

bool gui2::canvas::is_dirty_

private

The dirty state of the canvas.

Definition at line 219 of file canvas.hpp.

Referenced by draw().

◆ renderer_

SDL_Renderer* gui2::canvas::renderer_

private

Definition at line 210 of file canvas.hpp.

Referenced by draw(), and ~canvas().

◆ shapes_

std::vector<shape_ptr> gui2::canvas::shapes_

private

Vector with the shapes to draw.

Definition at line 185 of file canvas.hpp.

Referenced by clear_shapes(), draw(), invalidate_cache(), and parse_cfg().

◆ variables_

wfl::map_formula_callable gui2::canvas::variables_

private

The variables of the canvas.

Definition at line 213 of file canvas.hpp.

Referenced by draw().

◆ w_

unsigned gui2::canvas::w_

private

Width of the canvas.

Definition at line 202 of file canvas.hpp.

Referenced by draw().

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

gui/core/canvas.hpp
gui/core/canvas.cpp

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_shape_ptr

◆ shape_ptr

Constructor & Destructor Documentation

◆ canvas() [1/3]

◆ canvas() [2/3]

◆ canvas() [3/3]

◆ ~canvas()

Member Function Documentation

◆ append_cfg()

◆ blit()

◆ clear_shapes()

◆ draw()

◆ get_height()

◆ get_width()

◆ invalidate_cache()

◆ parse_cfg()

◆ set_cfg()

◆ set_height()

◆ set_is_dirty()

◆ set_variable()

◆ set_width()

◆ surf()

Member Data Documentation

◆ blur_depth_

◆ canvas_

◆ drawn_shapes_

◆ functions_

◆ h_

◆ is_dirty_

◆ renderer_

◆ shapes_

◆ variables_

◆ w_