The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
gui2::image_shape Class Reference

Definition of an image shape. More...

#include <canvas_private.hpp>

Inheritance diagram for gui2::image_shape:
Inheritance graph

Public Member Functions

 image_shape (const config &cfg, wfl::action_function_symbol_table &functions)
 Constructor. More...
 
void draw (surface &canvas, SDL_Renderer *renderer, wfl::map_formula_callable &variables) override
 Implement shape::draw(). More...
 
- Public Member Functions inherited from gui2::canvas::shape
 shape (const config &cfg)
 
virtual ~shape ()
 
bool immutable () const
 

Private Types

enum  resize_mode { scale, stretch, tile, tile_center }
 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...
 
SDL_Rect src_clip_
 Contains the size of the image. More...
 
surface image_
 The image is cached in this surface. 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 > vertical_mirror_
 Mirror the image over the vertical axis. More...
 
wfl::formula actions_formula_
 

Detailed Description

Definition of an image shape.

Definition at line 177 of file canvas_private.hpp.

Member Enumeration Documentation

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 
stretch 
tile 
tile_center 

Definition at line 220 of file canvas_private.hpp.

Constructor & Destructor Documentation

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

Constructor.

Parameters
cfgThe config object to define the image see http://www.wesnoth.org/wiki/GUICanvasWML#Image for more information.

Definition at line 1016 of file canvas.cpp.

References DBG_GUI_P, and debug.

Member Function Documentation

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

Definition at line 1035 of file canvas.cpp.

References _(), and VALIDATE_WITH_DEV_MESSAGE.

Referenced by draw().

void gui2::image_shape::draw ( surface canvas,
SDL_Renderer *  renderer,
wfl::map_formula_callable variables 
)
overridevirtual

Implement shape::draw().

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 1044 of file canvas.cpp.

References actions_formula_, wfl::map_formula_callable::add(), surface::assign(), blit_surface(), sdl::create_rect(), DBG_GUI_D, dimension_validation(), ERR_GUI_D, wfl::formula::evaluate(), wfl::formula_callable::fake_ptr(), flip_surface(), gui2::image::get_image(), h, h_, image_, image_name_, make_neutral_surface(), name(), resize_mode_, scale_surface_legacy(), src_clip_, stretch, stretch_surface_horizontal(), stretch_surface_vertical(), tile, tile_center, tile_surface(), vertical_mirror_, w, w_, x_, and y_.

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 1171 of file canvas.cpp.

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

Member Data Documentation

wfl::formula gui2::image_shape::actions_formula_
private

Definition at line 237 of file canvas_private.hpp.

Referenced by draw().

typed_formula<unsigned> gui2::image_shape::h_
private

The height of the image.

Definition at line 194 of file canvas_private.hpp.

Referenced by draw().

surface gui2::image_shape::image_
private

The image is cached in this surface.

Definition at line 203 of file canvas_private.hpp.

Referenced by draw().

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 212 of file canvas_private.hpp.

Referenced by draw().

resize_mode gui2::image_shape::resize_mode_
private

The resize mode for an image.

Definition at line 231 of file canvas_private.hpp.

Referenced by draw().

SDL_Rect gui2::image_shape::src_clip_
private

Contains the size of the image.

Definition at line 200 of file canvas_private.hpp.

Referenced by draw().

typed_formula<bool> gui2::image_shape::vertical_mirror_
private

Mirror the image over the vertical axis.

Definition at line 234 of file canvas_private.hpp.

Referenced by draw().

typed_formula<unsigned> gui2::image_shape::w_
private

The width of the image.

Definition at line 194 of file canvas_private.hpp.

Referenced by draw().

typed_formula<unsigned> gui2::image_shape::x_
private

The x coordinate of the image.

Definition at line 194 of file canvas_private.hpp.

Referenced by draw().

typed_formula<unsigned> gui2::image_shape::y_
private

The y coordinate of the image.

Definition at line 194 of file canvas_private.hpp.

Referenced by draw().


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