frame_builder Class Reference

#include <frame.hpp>

Public Member Functions
	frame_builder ()
	frame_builder (const config &cfg, const std::string &frame_string="")
frame_builder &	duration (const int duration)
	allow easy chained modifications will raised assert if used after initialization More...
frame_builder &	image (const std::string &image, const std::string &image_mod="")
frame_builder &	image_diagonal (const std::string &image_diagonal, const std::string &image_mod="")
frame_builder &	sound (const std::string &sound)
frame_builder &	text (const std::string &text, const Uint32 text_color)
frame_builder &	halo (const std::string &halo, const std::string &halo_x, const std::string &halo_y, const std::string &halo_mod)
frame_builder &	blend (const std::string &blend_ratio, const Uint32 blend_color)
frame_builder &	highlight (const std::string &highlight)
frame_builder &	offset (const std::string &offset)
frame_builder &	submerge (const std::string &submerge)
frame_builder &	x (const std::string &x)
frame_builder &	y (const std::string &y)
frame_builder &	directional_x (const std::string &directional_x)
frame_builder &	directional_y (const std::string &directional_y)
frame_builder &	auto_vflip (const bool auto_vflip)
frame_builder &	auto_hflip (const bool auto_hflip)
frame_builder &	primary_frame (const bool primary_frame)
frame_builder &	drawing_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_
Uint32	text_color_
Uint32	blend_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_
tristate	auto_vflip_
tristate	auto_hflip_
tristate	primary_frame_
std::string	drawing_layer_

Friends
class	frame_parsed_parameters
	getters for the different parameters More...

Detailed Description

Definition at line 104 of file frame.hpp.

Constructor & Destructor Documentation

frame_builder::frame_builder

(

)

Definition at line 249 of file frame.cpp.

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

Definition at line 276 of file frame.cpp.

References auto_hflip_, auto_vflip_, blend_with_, duration(), duration_, config::get(), halo_, config::has_attribute(), image_, image_diagonal_, primary_frame_, display::rgb(), utils::split(), t_false, t_true, t_unset, and text_color_.

Member Function Documentation

frame_builder & frame_builder::auto_hflip

(

const bool

auto_hflip

)

Definition at line 432 of file frame.cpp.

References auto_hflip_, t_false, and t_true.

frame_builder & frame_builder::auto_vflip

(

const bool

auto_vflip

)

Definition at line 426 of file frame.cpp.

References auto_vflip_, t_false, and t_true.

frame_builder & frame_builder::blend	(	const std::string &	blend_ratio,
		const Uint32	blend_color
	)

Definition at line 385 of file frame.cpp.

References blend_ratio_, and blend_with_.

frame_builder & frame_builder::directional_x

(

const std::string &

directional_x

)

Definition at line 416 of file frame.cpp.

References directional_x_.

frame_builder & frame_builder::directional_y

(

const std::string &

directional_y

)

Definition at line 421 of file frame.cpp.

References directional_y_.

frame_builder & frame_builder::drawing_layer

(

const std::string &

drawing_layer

)

Definition at line 444 of file frame.cpp.

References drawing_layer_.

frame_builder & frame_builder::duration

(

const int

duration

)

allow easy chained modifications will raised assert if used after initialization

Definition at line 380 of file frame.cpp.

References duration_.

Referenced by frame_builder().

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 372 of file frame.cpp.

References halo_, halo_mod_, halo_x_, and halo_y_.

frame_builder & frame_builder::highlight

(

const std::string &

highlight

)

Definition at line 391 of file frame.cpp.

References highlight_ratio_.

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

Definition at line 349 of file frame.cpp.

References image_, and image_mod_.

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

Definition at line 355 of file frame.cpp.

References image_diagonal_, and image_mod_.

frame_builder & frame_builder::offset

(

const std::string &

offset

)

Definition at line 396 of file frame.cpp.

References offset_.

frame_builder & frame_builder::primary_frame

(

const bool

primary_frame

)

Definition at line 438 of file frame.cpp.

References primary_frame_, t_false, and t_true.

frame_builder & frame_builder::sound

(

const std::string &

sound

)

Definition at line 361 of file frame.cpp.

References sound_.

frame_builder & frame_builder::submerge

(

const std::string &

submerge

)

Definition at line 401 of file frame.cpp.

References submerge_.

frame_builder & frame_builder::text	(	const std::string &	text,
		const Uint32	text_color
	)

Definition at line 366 of file frame.cpp.

References text_, and text_color_.

frame_builder & frame_builder::x

(

const std::string &

x

)

Definition at line 406 of file frame.cpp.

References x_.

frame_builder & frame_builder::y

(

const std::string &

y

)

Definition at line 411 of file frame.cpp.

References y_.

Friends And Related Function Documentation

friend class frame_parsed_parameters

friend

getters for the different parameters

Definition at line 129 of file frame.hpp.

Member Data Documentation

tristate frame_builder::auto_hflip_

private

Definition at line 151 of file frame.hpp.

Referenced by auto_hflip(), and frame_builder().

tristate frame_builder::auto_vflip_

private

Definition at line 150 of file frame.hpp.

Referenced by auto_vflip(), and frame_builder().

std::string frame_builder::blend_ratio_

private

Definition at line 142 of file frame.hpp.

Referenced by blend().

Uint32 frame_builder::blend_with_

private

Definition at line 141 of file frame.hpp.

Referenced by blend(), and frame_builder().

std::string frame_builder::directional_x_

private

Definition at line 148 of file frame.hpp.

Referenced by directional_x().

std::string frame_builder::directional_y_

private

Definition at line 149 of file frame.hpp.

Referenced by directional_y().

std::string frame_builder::drawing_layer_

private

Definition at line 153 of file frame.hpp.

Referenced by drawing_layer().

int frame_builder::duration_

private

Definition at line 130 of file frame.hpp.

Referenced by duration(), and frame_builder().

std::string frame_builder::halo_

private

Definition at line 134 of file frame.hpp.

Referenced by frame_builder(), and halo().

std::string frame_builder::halo_mod_

private

Definition at line 137 of file frame.hpp.

Referenced by halo().

std::string frame_builder::halo_x_

private

Definition at line 135 of file frame.hpp.

Referenced by halo().

std::string frame_builder::halo_y_

private

Definition at line 136 of file frame.hpp.

Referenced by halo().

std::string frame_builder::highlight_ratio_

private

Definition at line 143 of file frame.hpp.

Referenced by highlight().

std::string frame_builder::image_

private

Definition at line 131 of file frame.hpp.

Referenced by frame_builder(), and image().

std::string frame_builder::image_diagonal_

private

Definition at line 132 of file frame.hpp.

Referenced by frame_builder(), and image_diagonal().

std::string frame_builder::image_mod_

private

Definition at line 133 of file frame.hpp.

Referenced by image(), and image_diagonal().

std::string frame_builder::offset_

private

Definition at line 144 of file frame.hpp.

Referenced by offset().

tristate frame_builder::primary_frame_

private

Definition at line 152 of file frame.hpp.

Referenced by frame_builder(), and primary_frame().

std::string frame_builder::sound_

private

Definition at line 138 of file frame.hpp.

Referenced by sound().

std::string frame_builder::submerge_

private

Definition at line 145 of file frame.hpp.

Referenced by submerge().

std::string frame_builder::text_

private

Definition at line 139 of file frame.hpp.

Referenced by text().

Uint32 frame_builder::text_color_

private

Definition at line 140 of file frame.hpp.

Referenced by frame_builder(), and text().

std::string frame_builder::x_

private

Definition at line 146 of file frame.hpp.

Referenced by x().

std::string frame_builder::y_

private

Definition at line 147 of file frame.hpp.

Referenced by y().

---

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

• units/frame.hpp
• units/frame.cpp