#include <animation.hpp>

Classes
class	particle

Public Types
enum	variation_type { MATCH_FAIL = -10 , DEFAULT_ANIM = -9 }

Public Member Functions
	unit_animation ()=delete

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

int	matches (const map_location &loc, const map_location &second_loc, unit_const_ptr my_unit, const std::string &event="", const int value=0, strike_result::type hit=strike_result::type::invalid, const_attack_ptr attack=nullptr, const_attack_ptr second_attack=nullptr, int value2=0) const

const unit_frame &	get_last_frame () const

void	add_frame (int duration, const unit_frame &value, bool force_change=false)

std::vector< std::string >	get_flags () const

bool	need_update () const

bool	need_minimal_update () const

bool	animation_finished () const

bool	animation_finished_potential () const

void	update_last_draw_time ()

int	get_begin_time () const

int	get_end_time () const

int	time_to_tick (int animation_time) const

int	get_animation_time () const

void	set_max_animation_time (int time)

int	get_animation_time_potential () const

void	start_animation (int start_time, const map_location &src=map_location::null_location(), const map_location &dst=map_location::null_location(), const std::string &text="", const color_t text_color={0, 0, 0}, const bool accelerate=true)

void	update_parameters (const map_location &src, const map_location &dst)

void	pause_animation ()

void	restart_animation ()

int	get_current_frame_begin_time () const

void	redraw (frame_parameters &value, halo::manager &halo_man)

void	clear_haloes ()

bool	invalidate (frame_parameters &value)

std::string	debug () const

Static Public Member Functions
static void	fill_initial_animations (std::vector< unit_animation > &animations, const config &cfg)

static void	add_anims (std::vector< unit_animation > &animations, const config &cfg)

Protected Member Functions
const frame_parameters	get_current_params (const frame_parameters &default_val=frame_parameters()) const

Private Member Functions
	unit_animation (int start_time, const unit_frame &frame, const std::string &event="", const int variation=DEFAULT_ANIM, const frame_builder &builder=frame_builder())

Private Attributes
t_translation::ter_list	terrain_types_

std::vector< config >	unit_filter_

std::vector< config >	secondary_unit_filter_

std::vector< map_location::DIRECTION >	directions_

int	frequency_

int	base_score_

std::vector< std::string >	event_

std::vector< int >	value_

std::vector< config >	primary_attack_filter_

std::vector< config >	secondary_attack_filter_

std::vector< strike_result::type >	hits_

std::vector< int >	value2_

std::map< std::string, particle >	sub_anims_

particle	unit_anim_

map_location	src_

map_location	dst_

bool	invalidated_

bool	play_offscreen_

std::set< map_location >	overlaped_hex_

Friends
class	unit

class	unit_drawer

std::ostream &	operator<< (std::ostream &outstream, const unit_animation &u_animation)

Detailed Description

Definition at line 27 of file animation.hpp.

Member Enumeration Documentation

◆ variation_type

enum unit_animation::variation_type

Enumerator
MATCH_FAIL
DEFAULT_ANIM

Definition at line 33 of file animation.hpp.

Constructor & Destructor Documentation

◆ unit_animation() [1/3]

unit_animation::unit_animation ( )

delete

Referenced by fill_initial_animations().

◆ unit_animation() [2/3]

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

explicit

Definition at line 278 of file animation.cpp.

References config::all_children_range(), config::child_range(), d, directions_, event_, h, hits_, map_location::parse_direction(), play_offscreen_, primary_attack_filter_, secondary_attack_filter_, secondary_unit_filter_, utils::split(), sub_anims_, unit_filter_, value2_, and value_.

◆ unit_animation() [3/3]

unit_animation::unit_animation	(	int	start_time,
		const unit_frame &	frame,
		const std::string &	event = `""`,
		const int	variation = `DEFAULT_ANIM`,
		const frame_builder &	builder = `frame_builder()`
	)

explicitprivate

Definition at line 253 of file animation.cpp.

References add_frame(), unit_frame::does_not_change(), and unit_frame::duration().

Member Function Documentation

◆ add_anims()

void unit_animation::add_anims	(	std::vector< unit_animation > &	animations,
		const config &	cfg
	)

static

Definition at line 628 of file animation.cpp.

References config::add_child(), config::add_child_at(), add_simple_anim(), config::child_range(), config::empty(), image::locator::get_filename(), get_heal_sound(), image::locator::get_modifications(), display::LAYER_UNIT_DEFAULT, display::LAYER_UNIT_FIRST, display::LAYER_UNIT_MISSILE_DEFAULT, display::LAYER_UNIT_MOVE_DEFAULT, game_config::sounds::status::poisoned, prepare_animation(), and utils::split().

Referenced by unit_animation_component::apply_new_animation_effect(), and fill_initial_animations().

◆ add_frame()

void unit_animation::add_frame	(	int	duration,
		const unit_frame &	value,
		bool	force_change = `false`
	)

inline

Definition at line 47 of file animation.hpp.

References animated< T >::add_frame(), and unit_anim_.

Referenced by unit_animation().

◆ animation_finished()

bool unit_animation::animation_finished ( ) const

Definition at line 984 of file animation.cpp.

References animated< T >::animation_finished(), sub_anims_, and unit_anim_.

◆ animation_finished_potential()

bool unit_animation::animation_finished_potential ( ) const

Definition at line 994 of file animation.cpp.

References animated< T >::animation_finished_potential(), sub_anims_, and unit_anim_.

◆ clear_haloes()

void unit_animation::clear_haloes ( )

Definition at line 1097 of file animation.cpp.

References unit_animation::particle::clear_halo(), sub_anims_, and unit_anim_.

◆ debug()

std::string unit_animation::debug ( ) const

Definition at line 1150 of file animation.cpp.

◆ fill_initial_animations()

void unit_animation::fill_initial_animations	(	std::vector< unit_animation > &	animations,
		const config &	cfg
	)

static

Definition at line 484 of file animation.cpp.

References add_anims(), unit_animation::particle::CYCLE, DEFAULT_ANIM, get_heal_sound(), display::LAYER_UNIT_FIRST, display::LAYER_UNIT_MOVE_DEFAULT, unit_animation::particle::NO_CYCLE, game_config::sounds::status::poisoned, unit_animation(), and unit_animation::particle::UNSET.

Referenced by unit_type::animations().

◆ get_animation_time()

int unit_animation::get_animation_time ( ) const

inline

Definition at line 70 of file animation.hpp.

References animated< T >::get_animation_time(), and unit_anim_.

Referenced by unit_animation::particle::get_overlaped_hex(), unit_animation::particle::redraw(), and unit_animator::wait_until().

◆ get_animation_time_potential()

int unit_animation::get_animation_time_potential ( ) const

inline

Definition at line 80 of file animation.hpp.

References animated< T >::get_animation_time_potential(), and unit_anim_.

◆ get_begin_time()

int unit_animation::get_begin_time ( ) const

Definition at line 1023 of file animation.cpp.

References animated< T >::get_begin_time(), sub_anims_, and unit_anim_.

Referenced by unit_animator::add_animation(), unit_animation::particle::get_overlaped_hex(), unit_animation::particle::redraw(), and unit_animation::particle::start_animation().

◆ get_current_frame_begin_time()

int unit_animation::get_current_frame_begin_time ( ) const

inline

Definition at line 95 of file animation.hpp.

References animated< T >::get_current_frame_begin_time(), and unit_anim_.

Referenced by unit_animation::particle::need_minimal_update(), and unit_animation::particle::redraw().

◆ get_current_params()

const frame_parameters unit_animation::get_current_params ( const frame_parameters & default_val = frame_parameters() ) const

inlineprotected

Definition at line 111 of file animation.hpp.

References unit_animation::particle::parameters(), and unit_anim_.

◆ get_end_time()

int unit_animation::get_end_time ( ) const

Definition at line 1013 of file animation.cpp.

References animated< T >::get_end_time(), sub_anims_, and unit_anim_.

◆ get_flags()

std::vector<std::string> unit_animation::get_flags ( ) const

inline

Definition at line 52 of file animation.hpp.

References event_.

◆ get_last_frame()

const unit_frame& unit_animation::get_last_frame ( ) const

inline

Definition at line 42 of file animation.hpp.

References animated< T >::get_last_frame(), and unit_anim_.

◆ invalidate()

bool unit_animation::invalidate ( frame_parameters & value )

Definition at line 1106 of file animation.cpp.

References dst_, unit_animation::particle::get_overlaped_hex(), display::get_singleton(), display::invalidate(), invalidated_, need_minimal_update(), need_update(), overlaped_hex_, frame_parameters::primary_frame, display::propagate_invalidation(), src_, sub_anims_, display::tile_nearly_on_screen(), and unit_anim_.

Referenced by unit_animation_component::invalidate().

◆ matches()

int unit_animation::matches	(	const map_location &	loc,
		const map_location &	second_loc,
		unit_const_ptr	my_unit,
		const std::string &	event = `""`,
		const int	value = `0`,
		strike_result::type	hit = `strike_result::type::invalid`,
		const_attack_ptr	attack = `nullptr`,
		const_attack_ptr	second_attack = `nullptr`,
		int	value2 = `0`
	)		const

Definition at line 377 of file animation.cpp.

References base_score_, c, randomness::rng::default_instance(), directions_, event_, f, unit_map::find(), frequency_, display::get_map(), display::get_singleton(), gamemap_base::get_terrain(), display::get_units(), hits_, MATCH_FAIL, primary_attack_filter_, secondary_attack_filter_, secondary_unit_filter_, t_translation::terrain_matches(), terrain_types_, unit_filter_, value2_, and value_.

◆ need_minimal_update()

bool unit_animation::need_minimal_update ( ) const

Definition at line 969 of file animation.cpp.

References unit_animation::particle::need_minimal_update(), play_offscreen_, sub_anims_, and unit_anim_.

Referenced by invalidate().

◆ need_update()

bool unit_animation::need_update ( ) const

Definition at line 959 of file animation.cpp.

References unit_animation::particle::need_update(), sub_anims_, and unit_anim_.

Referenced by invalidate(), and unit_animation::particle::need_update().

◆ pause_animation()

void unit_animation::pause_animation ( )

Definition at line 1065 of file animation.cpp.

References animated< T >::pause_animation(), sub_anims_, and unit_anim_.

◆ redraw()

void unit_animation::redraw	(	frame_parameters &	value,
		halo::manager &	halo_man
	)

Definition at line 1083 of file animation.cpp.

References dst_, invalidated_, overlaped_hex_, frame_parameters::primary_frame, unit_animation::particle::redraw(), src_, sub_anims_, and unit_anim_.

◆ restart_animation()

void unit_animation::restart_animation ( )

Definition at line 1074 of file animation.cpp.

References animated< T >::restart_animation(), sub_anims_, and unit_anim_.

◆ set_max_animation_time()

void unit_animation::set_max_animation_time ( int time )

inline

Definition at line 75 of file animation.hpp.

References animated< T >::set_max_animation_time(), and unit_anim_.

◆ start_animation()

void unit_animation::start_animation	(	int	start_time,
		const map_location &	src = `map_location::null_location()`,
		const map_location &	dst = `map_location::null_location()`,
		const std::string &	text = `""`,
		const color_t	text_color = `{0,0,0}`,
		const bool	accelerate = `true`
	)

Definition at line 1033 of file animation.cpp.

References unit_animation::particle::accelerate, animated< T >::add_frame(), dst_, src_, unit_animation::particle::start_animation(), sub_anims_, and unit_anim_.

◆ time_to_tick()

int unit_animation::time_to_tick ( int animation_time ) const

inline

Definition at line 65 of file animation.hpp.

References animated< T >::time_to_tick(), and unit_anim_.

◆ update_last_draw_time()

void unit_animation::update_last_draw_time ( )

Definition at line 1004 of file animation.cpp.

References unit_animation::particle::accelerate, display::get_singleton(), sub_anims_, display::turbo_speed(), unit_anim_, and animated< T >::update_last_draw_time().

◆ update_parameters()

void unit_animation::update_parameters	(	const map_location &	src,
		const map_location &	dst
	)

Definition at line 1059 of file animation.cpp.

References dst_, and src_.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	outstream,
		const unit_animation &	u_animation
	)

friend

Definition at line 1157 of file animation.cpp.

◆ unit

friend class unit

friend

Definition at line 106 of file animation.hpp.

◆ unit_drawer

friend class unit_drawer

friend

Definition at line 107 of file animation.hpp.

Member Data Documentation

◆ base_score_

int unit_animation::base_score_

private

Definition at line 172 of file animation.hpp.

Referenced by matches().

◆ directions_

std::vector<map_location::DIRECTION> unit_animation::directions_

private

Definition at line 170 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ dst_

map_location unit_animation::dst_

private

Definition at line 183 of file animation.hpp.

Referenced by invalidate(), redraw(), start_animation(), and update_parameters().

◆ event_

std::vector<std::string> unit_animation::event_

private

Definition at line 173 of file animation.hpp.

Referenced by get_flags(), matches(), and unit_animation().

◆ frequency_

int unit_animation::frequency_

private

Definition at line 171 of file animation.hpp.

Referenced by matches().

◆ hits_

std::vector<strike_result::type> unit_animation::hits_

private

Definition at line 177 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ invalidated_

bool unit_animation::invalidated_

private

Definition at line 185 of file animation.hpp.

Referenced by invalidate(), and redraw().

◆ overlaped_hex_

std::set<map_location> unit_animation::overlaped_hex_

private

Definition at line 187 of file animation.hpp.

Referenced by invalidate(), and redraw().

◆ play_offscreen_

bool unit_animation::play_offscreen_

private

Definition at line 186 of file animation.hpp.

Referenced by need_minimal_update(), and unit_animation().

◆ primary_attack_filter_

std::vector<config> unit_animation::primary_attack_filter_

private

Definition at line 175 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ secondary_attack_filter_

std::vector<config> unit_animation::secondary_attack_filter_

private

Definition at line 176 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ secondary_unit_filter_

std::vector<config> unit_animation::secondary_unit_filter_

private

Definition at line 169 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ src_

map_location unit_animation::src_

private

Definition at line 182 of file animation.hpp.

Referenced by invalidate(), redraw(), start_animation(), and update_parameters().

◆ sub_anims_

std::map<std::string,particle> unit_animation::sub_anims_

private

Definition at line 179 of file animation.hpp.

Referenced by animation_finished(), animation_finished_potential(), clear_haloes(), get_begin_time(), get_end_time(), invalidate(), need_minimal_update(), need_update(), pause_animation(), redraw(), restart_animation(), start_animation(), unit_animation(), and update_last_draw_time().

◆ terrain_types_

t_translation::ter_list unit_animation::terrain_types_

private

Definition at line 167 of file animation.hpp.

Referenced by matches().

◆ unit_anim_

particle unit_animation::unit_anim_

private

◆ unit_filter_

std::vector<config> unit_animation::unit_filter_

private

Definition at line 168 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ value2_

std::vector<int> unit_animation::value2_

private

Definition at line 178 of file animation.hpp.

Referenced by matches(), and unit_animation().

◆ value_

std::vector<int> unit_animation::value_

private

Definition at line 174 of file animation.hpp.

Referenced by matches(), and unit_animation().

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

units/animation.hpp
units/animation.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ variation_type

Constructor & Destructor Documentation

◆ unit_animation() [1/3]

◆ unit_animation() [2/3]

◆ unit_animation() [3/3]

Member Function Documentation

◆ add_anims()

◆ add_frame()

◆ animation_finished()

◆ animation_finished_potential()

◆ clear_haloes()

◆ debug()

◆ fill_initial_animations()

◆ get_animation_time()

◆ get_animation_time_potential()

◆ get_begin_time()

◆ get_current_frame_begin_time()

◆ get_current_params()

◆ get_end_time()

◆ get_flags()

◆ get_last_frame()

◆ invalidate()

◆ matches()

◆ need_minimal_update()

◆ need_update()

◆ pause_animation()

◆ redraw()

◆ restart_animation()

◆ set_max_animation_time()

◆ start_animation()

◆ time_to_tick()

◆ update_last_draw_time()

◆ update_parameters()

Friends And Related Function Documentation

◆ operator<<

◆ unit

◆ unit_drawer

Member Data Documentation

◆ base_score_

◆ directions_

◆ dst_

◆ event_

◆ frequency_

◆ hits_

◆ invalidated_

◆ overlaped_hex_

◆ play_offscreen_

◆ primary_attack_filter_

◆ secondary_attack_filter_

◆ secondary_unit_filter_

◆ src_

◆ sub_anims_

◆ terrain_types_

◆ unit_anim_

◆ unit_filter_

◆ value2_

◆ value_