#include <canvas_private.hpp>

Inheritance diagram for gui2::image_shape:

Public Member Functions
	image_shape (const config &cfg, wfl::action_function_symbol_table &functions)
	Constructor. More...

void	draw (wfl::map_formula_callable &variables) override
	Draws the canvas. More...

Public Member Functions inherited from gui2::canvas::shape
	shape (const config &cfg)

virtual	~shape ()

bool	immutable () const

Private Types
enum class	resize_mode { scale , scale_sharp , stretch , tile , tile_center , tile_highres }
	Determines the way an image will be resized. More...

Private Member Functions
resize_mode	get_resize_mode (const std::string &resize_mode)
	Converts a string to a resize mode. More...

Static Private Member Functions
static void	dimension_validation (unsigned value, const std::string &name, const std::string &key)

Private Attributes
typed_formula< unsigned >	x_
	The x coordinate of the image. More...

typed_formula< unsigned >	y_
	The y coordinate of the image. More...

typed_formula< unsigned >	w_
	The width of the image. More...

typed_formula< unsigned >	h_
	The height of the image. More...

typed_formula< std::string >	image_name_
	Name of the image. More...

resize_mode	resize_mode_
	The resize mode for an image. More...

typed_formula< bool >	mirror_
	Mirror the image over the vertical axis. More...

wfl::formula	actions_formula_

Detailed Description

Keys:

Key	Type	Default	Description
x	f_unsigned	0	The x coordinate of the top left corner.
y	f_unsigned	0	The y coordinate of the top left corner.
w	f_unsigned	0	The width of the image, if not zero the image will be scaled to the desired width.
h	f_unsigned	0	The height of the image, if not zero the image will be scaled to the desired height.
resize_mode	resize_mode	scale	Determines how an image is scaled to fit the wanted size.
vertical_mirror	f_bool	false	Mirror the image over the vertical axis.
name	string	""	The name of the image.
debug	string	""	Debug message to show upon creation this message is not stored.

Variables:

Key	Type	Description
image_width	unsigned	The width of the image, either the requested width or the natural width of the image. This value can be used to set the x (or y) value of the image. (This means x and y are evaluated after the width and height.)
image_height	unsigned	The height of the image, either the requested height or the natural height of the image. This value can be used to set the y (or x) value of the image. (This means x and y are evaluated after the width and height.)
image_original_width	unsigned	The width of the image as stored on disk, can be used to set x or w (also y and h can be set).
image_original_height	unsigned	The height of the image as stored on disk, can be used to set y or h (also x and y can be set).

Also the general variables are available, see line_shape

Definition at line 316 of file canvas_private.hpp.

Member Enumeration Documentation

◆ resize_mode

enum gui2::image_shape::resize_mode

strongprivate

Determines the way an image will be resized.

If the image is smaller is needed it needs to resized, how is determined by the value of this enum.

Enumerator
scale
scale_sharp
stretch
tile
tile_center
tile_highres

Definition at line 350 of file canvas_private.hpp.

Constructor & Destructor Documentation

◆ image_shape()

gui2::image_shape::image_shape	(	const config &	cfg,
		wfl::action_function_symbol_table &	functions
	)

Constructor.

Parameters

cfg	The config object to define the image.
functions	WFL functions to execute.

Definition at line 251 of file canvas.cpp.

References DBG_GUI_P, and debug.

Member Function Documentation

◆ dimension_validation()

void gui2::image_shape::dimension_validation	(	unsigned	value,
		const std::string &	name,
		const std::string &	key
	)

staticprivate

Definition at line 268 of file canvas.cpp.

References _(), and VALIDATE_WITH_DEV_MESSAGE.

Referenced by draw().

◆ draw()

void gui2::image_shape::draw ( wfl::map_formula_callable & variables )

overridevirtual

Draws the canvas.

Parameters

variables The canvas can have formulas in it's definition, this parameter contains the values for these formulas.

Todo:: formulas are now recalculated every draw cycle which is a bit silly unless there has been a resize. So to optimize we should use an extra flag or do the calculation in a separate routine.

Implements gui2::canvas::shape.

Definition at line 277 of file canvas.cpp.

References actions_formula_, wfl::map_formula_callable::add(), draw::blit(), DBG_GUI_D, dimension_validation(), ERR_GUI_D, wfl::formula::evaluate(), wfl::variant::execute_variant(), wfl::formula_callable::fake_ptr(), draw::flipped(), image::get_texture(), texture::h(), h, h_, image_name_, image::linear, mirror_, image::nearest, resize_mode_, scale, scale_sharp, stretch, tile, tile_center, tile_highres, draw::tiled(), draw::tiled_highres(), w, texture::w(), w_, x_, and y_.

◆ get_resize_mode()

image_shape::resize_mode gui2::image_shape::get_resize_mode ( const std::string & resize_mode )

private

Converts a string to a resize mode.

Definition at line 367 of file canvas.cpp.

References ERR_GUI_E, scale, scale_sharp, stretch, tile, tile_center, and tile_highres.

Member Data Documentation

◆ actions_formula_

wfl::formula gui2::image_shape::actions_formula_

private

Definition at line 369 of file canvas_private.hpp.

Referenced by draw().

◆ h_

typed_formula<unsigned> gui2::image_shape::h_

private

The height of the image.

Definition at line 333 of file canvas_private.hpp.

Referenced by draw().

◆ image_name_

typed_formula<std::string> gui2::image_shape::image_name_

private

Name of the image.

This value is only used when the image name is a formula. If it isn't a formula the image will be loaded in the constructor. If it's a formula it will be loaded every draw cycles. This allows 'changing' images.

Definition at line 342 of file canvas_private.hpp.

Referenced by draw().

◆ mirror_

typed_formula<bool> gui2::image_shape::mirror_

private

Mirror the image over the vertical axis.

Definition at line 366 of file canvas_private.hpp.

Referenced by draw().

◆ resize_mode_

resize_mode gui2::image_shape::resize_mode_

private

The resize mode for an image.

Definition at line 363 of file canvas_private.hpp.

Referenced by draw().

◆ w_

typed_formula<unsigned> gui2::image_shape::w_

private

The width of the image.

Definition at line 332 of file canvas_private.hpp.

Referenced by draw().

◆ x_

typed_formula<unsigned> gui2::image_shape::x_

private

The x coordinate of the image.

Definition at line 330 of file canvas_private.hpp.

Referenced by draw().

◆ y_

typed_formula<unsigned> gui2::image_shape::y_

private

The y coordinate of the image.

Definition at line 331 of file canvas_private.hpp.

Referenced by draw().

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

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

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ resize_mode

Constructor & Destructor Documentation

◆ image_shape()

Member Function Documentation

◆ dimension_validation()

◆ draw()

◆ get_resize_mode()

Member Data Documentation

◆ actions_formula_

◆ h_

◆ image_name_

◆ mirror_

◆ resize_mode_

◆ w_

◆ x_

◆ y_