frame_parameters Struct Reference

All parameters from a frame at a given instant. More...

#include <frame.hpp>

Public Attributes
std::chrono::milliseconds	duration {0}
image::locator	image
image::locator	image_diagonal
std::string	image_mod
std::string	halo
int	halo_x = 0
int	halo_y = 0
std::string	halo_mod
std::string	sound
std::string	text
utils::optional< color_t >	text_color
utils::optional< color_t >	blend_with
double	blend_ratio = 0.0
double	highlight_ratio = 1.0
double	offset = 0.0
double	submerge = 0.0
int	x = 0
int	y = 0
int	directional_x = 0
int	directional_y = 0
boost::tribool	auto_vflip = boost::logic::indeterminate
boost::tribool	auto_hflip = boost::logic::indeterminate
boost::tribool	primary_frame = boost::logic::indeterminate
int	drawing_layer = get_abs_frame_layer(drawing_layer::unit_default)

Detailed Description

All parameters from a frame at a given instant.

Definition at line 43 of file frame.hpp.

Member Data Documentation

auto_hflip

boost::tribool frame_parameters::auto_hflip = boost::logic::indeterminate

Definition at line 74 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

auto_vflip

boost::tribool frame_parameters::auto_vflip = boost::logic::indeterminate

Definition at line 73 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

blend_ratio

double frame_parameters::blend_ratio = 0.0

Definition at line 63 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

blend_with

utils::optional<color_t> frame_parameters::blend_with

Definition at line 61 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

directional_x

int frame_parameters::directional_x = 0

Definition at line 70 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

directional_y

int frame_parameters::directional_y = 0

Definition at line 71 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

drawing_layer

int frame_parameters::drawing_layer = get_abs_frame_layer(drawing_layer::unit_default)

Definition at line 77 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

duration

std::chrono::milliseconds frame_parameters::duration {0}

Definition at line 45 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), and frame_parsed_parameters::parameters().

halo

std::string frame_parameters::halo

Definition at line 51 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

halo_mod

std::string frame_parameters::halo_mod

Definition at line 56 of file frame.hpp.

Referenced by unit_animation_component::invalidate(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

halo_x

int frame_parameters::halo_x = 0

Definition at line 53 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

halo_y

int frame_parameters::halo_y = 0

Definition at line 54 of file frame.hpp.

Referenced by unit_animation_component::invalidate(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

highlight_ratio

double frame_parameters::highlight_ratio = 1.0

Definition at line 64 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

image

image::locator frame_parameters::image

Definition at line 47 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_animation_component::invalidate(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

image_diagonal

image::locator frame_parameters::image_diagonal

Definition at line 48 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

image_mod

std::string frame_parameters::image_mod

Definition at line 50 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_animation_component::invalidate(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

offset

double frame_parameters::offset = 0.0

Definition at line 65 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

primary_frame

boost::tribool frame_parameters::primary_frame = boost::logic::indeterminate

Definition at line 75 of file frame.hpp.

Referenced by unit_animation::invalidate(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_animation::redraw(), and unit_drawer::redraw_unit().

sound

std::string frame_parameters::sound

Definition at line 57 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

submerge

double frame_parameters::submerge = 0.0

Definition at line 66 of file frame.hpp.

Referenced by unit_drawer::draw_ellipses(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

text

std::string frame_parameters::text

Definition at line 58 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

text_color

utils::optional<color_t> frame_parameters::text_color

Definition at line 60 of file frame.hpp.

Referenced by unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

x

int frame_parameters::x = 0

Definition at line 68 of file frame.hpp.

Referenced by unit_frame::get_overlaped_hex(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and unit_frame::redraw().

y

int frame_parameters::y = 0

Definition at line 69 of file frame.hpp.

Referenced by unit_drawer::draw_ellipses(), unit_frame::get_overlaped_hex(), unit_animation_component::invalidate(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), unit_frame::redraw(), and unit_drawer::redraw_unit().

---

The documentation for this struct was generated from the following file:

• units/frame.hpp