The Battle for Wesnoth  1.17.0-dev
Public Member Functions | Private Attributes | Friends | List of all members
frame_builder Class Reference

#include <frame.hpp>

Public Member Functions

 frame_builder ()
 frame_builder (const config &cfg, const std::string &frame_string="")
frame_builderduration (const int duration)
 Allow easy chained modifications. More...
frame_builderimage (const std::string &image, const std::string &image_mod="")
frame_builderimage_diagonal (const std::string &image_diagonal, const std::string &image_mod="")
frame_buildersound (const std::string &sound)
frame_buildertext (const std::string &text, const color_t text_color)
frame_builderhalo (const std::string &halo, const std::string &halo_x, const std::string &halo_y, const std::string &halo_mod)
frame_builderblend (const std::string &blend_ratio, const color_t blend_color)
frame_builderhighlight (const std::string &highlight)
frame_builderoffset (const std::string &offset)
frame_buildersubmerge (const std::string &submerge)
frame_builderx (const std::string &x)
frame_buildery (const std::string &y)
frame_builderdirectional_x (const std::string &directional_x)
frame_builderdirectional_y (const std::string &directional_y)
frame_builderauto_vflip (const bool auto_vflip)
frame_builderauto_hflip (const bool auto_hflip)
frame_builderprimary_frame (const bool primary_frame)
frame_builderdrawing_layer (const std::string &drawing_layer)

Private Attributes

int duration_
std::string image_
std::string image_diagonal_
std::string image_mod_
std::string halo_
std::string halo_x_
std::string halo_y_
std::string halo_mod_
std::string sound_
std::string text_
std::optional< color_ttext_color_
std::optional< color_tblend_with_
std::string blend_ratio_
std::string highlight_ratio_
std::string offset_
std::string submerge_
std::string x_
std::string y_
std::string directional_x_
std::string directional_y_
boost::tribool auto_vflip_
boost::tribool auto_hflip_
boost::tribool primary_frame_
std::string drawing_layer_


class frame_parsed_parameters

Detailed Description

Definition at line 78 of file frame.hpp.

Constructor & Destructor Documentation

◆ frame_builder() [1/2]

frame_builder::frame_builder ( )

Definition at line 44 of file frame.cpp.

◆ frame_builder() [2/2]

frame_builder::frame_builder ( const config cfg,
const std::string &  frame_string = "" 

Member Function Documentation

◆ auto_hflip()

frame_builder & frame_builder::auto_hflip ( const bool  auto_hflip)

Definition at line 222 of file frame.cpp.

References auto_hflip_.

◆ auto_vflip()

frame_builder & frame_builder::auto_vflip ( const bool  auto_vflip)

Definition at line 216 of file frame.cpp.

References auto_vflip_.

◆ blend()

frame_builder & frame_builder::blend ( const std::string &  blend_ratio,
const color_t  blend_color 

Definition at line 167 of file frame.cpp.

References blend_ratio_, and blend_with_.

◆ directional_x()

frame_builder & frame_builder::directional_x ( const std::string &  directional_x)

Definition at line 204 of file frame.cpp.

References directional_x_.

◆ directional_y()

frame_builder & frame_builder::directional_y ( const std::string &  directional_y)

Definition at line 210 of file frame.cpp.

References directional_y_.

◆ drawing_layer()

frame_builder & frame_builder::drawing_layer ( const std::string &  drawing_layer)

Definition at line 234 of file frame.cpp.

References drawing_layer_.

◆ duration()

frame_builder & frame_builder::duration ( const int  duration)

Allow easy chained modifications.

Will raised assert if used after initialization

Definition at line 161 of file frame.cpp.

References duration_.

Referenced by frame_builder().

◆ halo()

frame_builder & frame_builder::halo ( const std::string &  halo,
const std::string &  halo_x,
const std::string &  halo_y,
const std::string &  halo_mod 

Definition at line 152 of file frame.cpp.

References halo_, halo_mod_, halo_x_, and halo_y_.

◆ highlight()

frame_builder & frame_builder::highlight ( const std::string &  highlight)

Definition at line 174 of file frame.cpp.

References highlight_ratio_.

◆ image()

frame_builder & frame_builder::image ( const std::string &  image,
const std::string &  image_mod = "" 

Definition at line 125 of file frame.cpp.

References image_, and image_mod_.

◆ image_diagonal()

frame_builder & frame_builder::image_diagonal ( const std::string &  image_diagonal,
const std::string &  image_mod = "" 

Definition at line 132 of file frame.cpp.

References image_diagonal_, and image_mod_.

◆ offset()

frame_builder & frame_builder::offset ( const std::string &  offset)

Definition at line 180 of file frame.cpp.

References offset_.

◆ primary_frame()

frame_builder & frame_builder::primary_frame ( const bool  primary_frame)

Definition at line 228 of file frame.cpp.

References primary_frame_.

◆ sound()

frame_builder & frame_builder::sound ( const std::string &  sound)

Definition at line 139 of file frame.cpp.

References sound_.

◆ submerge()

frame_builder & frame_builder::submerge ( const std::string &  submerge)

Definition at line 186 of file frame.cpp.

References submerge_.

◆ text()

frame_builder & frame_builder::text ( const std::string &  text,
const color_t  text_color 

Definition at line 145 of file frame.cpp.

References text_, and text_color_.

◆ x()

frame_builder & frame_builder::x ( const std::string &  x)

Definition at line 192 of file frame.cpp.

References x_.

◆ y()

frame_builder & frame_builder::y ( const std::string &  y)

Definition at line 198 of file frame.cpp.

References y_.

Friends And Related Function Documentation

◆ frame_parsed_parameters

friend class frame_parsed_parameters

Definition at line 105 of file frame.hpp.

Member Data Documentation

◆ auto_hflip_

boost::tribool frame_builder::auto_hflip_

Definition at line 132 of file frame.hpp.

Referenced by auto_hflip(), and frame_builder().

◆ auto_vflip_

boost::tribool frame_builder::auto_vflip_

Definition at line 131 of file frame.hpp.

Referenced by auto_vflip(), and frame_builder().

◆ blend_ratio_

std::string frame_builder::blend_ratio_

Definition at line 122 of file frame.hpp.

Referenced by blend().

◆ blend_with_

std::optional<color_t> frame_builder::blend_with_

Definition at line 120 of file frame.hpp.

Referenced by blend(), and frame_builder().

◆ directional_x_

std::string frame_builder::directional_x_

Definition at line 128 of file frame.hpp.

Referenced by directional_x().

◆ directional_y_

std::string frame_builder::directional_y_

Definition at line 129 of file frame.hpp.

Referenced by directional_y().

◆ drawing_layer_

std::string frame_builder::drawing_layer_

Definition at line 135 of file frame.hpp.

Referenced by drawing_layer().

◆ duration_

int frame_builder::duration_

Definition at line 107 of file frame.hpp.

Referenced by duration(), and frame_builder().

◆ halo_

std::string frame_builder::halo_

Definition at line 112 of file frame.hpp.

Referenced by frame_builder(), and halo().

◆ halo_mod_

std::string frame_builder::halo_mod_

Definition at line 115 of file frame.hpp.

Referenced by halo().

◆ halo_x_

std::string frame_builder::halo_x_

Definition at line 113 of file frame.hpp.

Referenced by halo().

◆ halo_y_

std::string frame_builder::halo_y_

Definition at line 114 of file frame.hpp.

Referenced by halo().

◆ highlight_ratio_

std::string frame_builder::highlight_ratio_

Definition at line 123 of file frame.hpp.

Referenced by highlight().

◆ image_

std::string frame_builder::image_

Definition at line 109 of file frame.hpp.

Referenced by frame_builder(), and image().

◆ image_diagonal_

std::string frame_builder::image_diagonal_

Definition at line 110 of file frame.hpp.

Referenced by frame_builder(), and image_diagonal().

◆ image_mod_

std::string frame_builder::image_mod_

Definition at line 111 of file frame.hpp.

Referenced by image(), and image_diagonal().

◆ offset_

std::string frame_builder::offset_

Definition at line 124 of file frame.hpp.

Referenced by offset().

◆ primary_frame_

boost::tribool frame_builder::primary_frame_

Definition at line 133 of file frame.hpp.

Referenced by frame_builder(), and primary_frame().

◆ sound_

std::string frame_builder::sound_

Definition at line 116 of file frame.hpp.

Referenced by sound().

◆ submerge_

std::string frame_builder::submerge_

Definition at line 125 of file frame.hpp.

Referenced by submerge().

◆ text_

std::string frame_builder::text_

Definition at line 117 of file frame.hpp.

Referenced by text().

◆ text_color_

std::optional<color_t> frame_builder::text_color_

Definition at line 119 of file frame.hpp.

Referenced by frame_builder(), and text().

◆ x_

std::string frame_builder::x_

Definition at line 126 of file frame.hpp.

Referenced by x().

◆ y_

std::string frame_builder::y_

Definition at line 127 of file frame.hpp.

Referenced by y().

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