Keep most parameters in a separate class to simplify the handling of the large number of parameters between the frame level and animation level. More...

#include <frame.hpp>

Public Member Functions
	frame_parsed_parameters (const frame_builder &builder=frame_builder(), const std::chrono::milliseconds &override_duration=std::chrono::milliseconds{0})

void	override (const std::chrono::milliseconds &duration, const std::string &highlight="", const std::string &blend_ratio="", color_t blend_color={0, 0, 0}, const std::string &offset="", const std::string &layer="", const std::string &modifiers="")

frame_parameters	parameters (const std::chrono::milliseconds &current_time) const
	Getters for the different parameters. More...

const std::chrono::milliseconds &	duration () const

bool	does_not_change () const

bool	need_update () const

std::vector< std::string >	debug_strings () const
	Contents of frame in strings. More...

Private Attributes
std::chrono::milliseconds	duration_

progressive_image	image_

progressive_image	image_diagonal_

std::string	image_mod_

progressive_string	halo_

progressive_int	halo_x_

progressive_int	halo_y_

std::string	halo_mod_

std::string	sound_

std::string	text_

utils::optional< color_t >	text_color_

utils::optional< color_t >	blend_with_

progressive_double	blend_ratio_

progressive_double	highlight_ratio_

progressive_double	offset_

progressive_double	submerge_

progressive_int	x_

progressive_int	y_

progressive_int	directional_x_

progressive_int	directional_y_

boost::tribool	auto_vflip_

boost::tribool	auto_hflip_

boost::tribool	primary_frame_

progressive_int	drawing_layer_

Detailed Description

Keep most parameters in a separate class to simplify the handling of the large number of parameters between the frame level and animation level.

Definition at line 147 of file frame.hpp.

Constructor & Destructor Documentation

◆ frame_parsed_parameters()

frame_parsed_parameters::frame_parsed_parameters	(	const frame_builder &	builder = `frame_builder()`,
		const std::chrono::milliseconds &	override_duration = `std::chrono::milliseconds{0}`
	)

Definition at line 226 of file frame.cpp.

Member Function Documentation

◆ debug_strings()

std::vector< std::string > frame_parsed_parameters::debug_strings ( ) const

Contents of frame in strings.

Definition at line 388 of file frame.cpp.

References auto_hflip_, auto_vflip_, blend_ratio_, blend_with_, utils::bool_string(), directional_x_, directional_y_, drawing_layer_, duration_, progressive_base< T, D >::get_original(), utils::half_signed_value(), halo_, halo_mod_, halo_x_, halo_y_, highlight_ratio_, image_, image_diagonal_, image_mod_, offset_, primary_frame_, sound_, submerge_, text_, text_color_, x_, and y_.

Referenced by unit_frame::debug_strings().

◆ does_not_change()

bool frame_parsed_parameters::does_not_change ( ) const

Definition at line 253 of file frame.cpp.

References blend_ratio_, directional_x_, directional_y_, progressive_base< T, D >::does_not_change(), progressive_pair< T >::does_not_change(), drawing_layer_, halo_, halo_x_, halo_y_, highlight_ratio_, image_, image_diagonal_, offset_, submerge_, x_, and y_.

Referenced by unit_frame::does_not_change(), need_update(), and unit_animation::particle::particle().

◆ duration()

const std::chrono::milliseconds& frame_parsed_parameters::duration ( ) const

inline

Definition at line 164 of file frame.hpp.

References duration_.

Referenced by unit_frame::duration(), and override().

◆ need_update()

bool frame_parsed_parameters::need_update ( ) const

Definition at line 272 of file frame.cpp.

References does_not_change().

Referenced by unit_frame::need_update().

◆ override()

void frame_parsed_parameters::override	(	const std::chrono::milliseconds &	duration,
		const std::string &	highlight = `""`,
		const std::string &	blend_ratio = `""`,
		color_t	blend_color = `{0,0,0}`,
		const std::string &	offset = `""`,
		const std::string &	layer = `""`,
		const std::string &	modifiers = `""`
	)