Inheritance diagram for unit_animation::particle:

Public Types
enum	cycle_state { UNSET , CYCLE , NO_CYCLE }

Public Types inherited from animated< unit_frame >
typedef std::pair< int, unit_frame >	frame_description

typedef std::vector< frame_description >	anim_description

Public Member Functions
	particle (int start_time=0, const frame_builder &builder=frame_builder())

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

virtual	~particle ()

bool	need_update () const

bool	need_minimal_update () const

void	override (int start_time, int duration, const cycle_state cycles, 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="")

void	redraw (const frame_parameters &value, const map_location &src, const map_location &dst, halo::manager &halo_man)

std::set< map_location >	get_overlaped_hex (const frame_parameters &value, const map_location &src, const map_location &dst)

void	start_animation (int start_time)

frame_parameters	parameters (const frame_parameters &default_val) const

void	clear_halo ()

Public Member Functions inherited from animated< unit_frame >
	animated (int start_time=0)

	animated (const std::vector< frame_description > &cfg, int start_time=0, bool force_change=false)

virtual	~animated ()=default

void	add_frame (int duration, const unit_frame &value, bool force_change=false)
	Adds a frame to an animation. More...

void	start_animation (int start_time, bool cycles=false)
	Starts an animation cycle. More...

void	pause_animation ()

void	restart_animation ()

int	get_begin_time () const

int	get_end_time () const

void	set_begin_time (int new_begin_time)

int	time_to_tick (int animation_time) const

int	tick_to_time (int animation_tick) const

void	update_last_draw_time (double acceleration=0)

bool	need_update () const

bool	cycles () const

bool	animation_finished () const
	Returns true if the current animation was finished. More...

bool	animation_finished_potential () const

int	get_animation_time () const

int	get_animation_time_potential () const

void	set_animation_time (int time)

void	set_max_animation_time (int time)

int	get_animation_duration () const

const unit_frame &	get_current_frame () const

int	get_current_frame_begin_time () const

int	get_current_frame_end_time () const

int	get_current_frame_duration () const

int	get_current_frame_time () const

const unit_frame &	get_first_frame () const

const unit_frame &	get_frame (std::size_t n) const

const unit_frame &	get_last_frame () const

std::size_t	get_frames_count () const

void	force_change ()

bool	does_not_change () const

Public Attributes
bool	accelerate

Private Attributes
frame_parsed_parameters	parameters_

halo::handle	halo_id_

int	last_frame_begin_time_

bool	cycles_

Additional Inherited Members
Static Public Attributes inherited from animated< unit_frame >
static const unit_frame	void_value_

Protected Member Functions inherited from animated< unit_frame >
void	remove_frames_until (int starting_time)

void	set_end_time (int ending_time)

Protected Attributes inherited from animated< unit_frame >
int	starting_frame_time_

Detailed Description

Definition at line 123 of file animation.hpp.

Member Enumeration Documentation

◆ cycle_state

enum unit_animation::particle::cycle_state

Enumerator
UNSET
CYCLE
NO_CYCLE

Definition at line 139 of file animation.hpp.

Constructor & Destructor Documentation

◆ particle() [1/2]

unit_animation::particle::particle	(	int	start_time = `0`,
		const frame_builder &	builder = `frame_builder()`
	)

inlineexplicit

Definition at line 126 of file animation.hpp.

◆ particle() [2/2]

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

explicit

Definition at line 923 of file animation.cpp.

References animated< unit_frame >::add_frame(), config::child_range(), cycles_, frame_parsed_parameters::does_not_change(), unit_frame::does_not_change(), unit_frame::duration(), config::empty(), animated< unit_frame >::force_change(), animated< unit_frame >::get_animation_duration(), parameters_, and animated< unit_frame >::starting_frame_time_.

◆ ~particle()

unit_animation::particle::~particle ( )

virtual

Definition at line 1279 of file animation.cpp.

Member Function Documentation

◆ clear_halo()

void unit_animation::particle::clear_halo ( )

Definition at line 1267 of file animation.cpp.

Referenced by unit_animation::clear_haloes().

◆ get_overlaped_hex()

std::set< map_location > unit_animation::particle::get_overlaped_hex	(	const frame_parameters &	value,
		const map_location &	src,
		const map_location &	dst
	)

Definition at line 1272 of file animation.cpp.

References dst, unit_animation::get_animation_time(), unit_animation::get_begin_time(), unit_frame::get_overlaped_hex(), and src.

Referenced by unit_animation::invalidate().

◆ need_minimal_update()

bool unit_animation::particle::need_minimal_update ( ) const

Definition at line 918 of file animation.cpp.

References unit_animation::get_current_frame_begin_time().

Referenced by unit_animation::need_minimal_update().

◆ need_update()

bool unit_animation::particle::need_update ( ) const

Definition at line 910 of file animation.cpp.

References unit_animation::need_update().

Referenced by unit_animation::need_update().

◆ override()

void unit_animation::particle::override	(	int	start_time,
		int	duration,
		const cycle_state	cycles,
		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 = `""`
	)

Definition at line 884 of file animation.cpp.

References animated< unit_frame >::add_frame(), CYCLE, animated< unit_frame >::cycles(), cycles_, animated< unit_frame >::get_animation_duration(), animated< unit_frame >::get_last_frame(), NO_CYCLE, frame_parsed_parameters::override(), parameters_, animated< unit_frame >::set_begin_time(), and animated< unit_frame >::set_end_time().

◆ parameters()

frame_parameters unit_animation::particle::parameters ( const frame_parameters & default_val ) const

inline

Definition at line 152 of file animation.hpp.

References animated< unit_frame >::get_animation_time(), animated< unit_frame >::get_begin_time(), animated< unit_frame >::get_current_frame(), animated< unit_frame >::get_current_frame_time(), unit_frame::merge_parameters(), frame_parsed_parameters::parameters(), and parameters_.

Referenced by unit_animation::get_current_params().

◆ redraw()

void unit_animation::particle::redraw	(	const frame_parameters &	value,
		const map_location &	src,
		const map_location &	dst,
		halo::manager &	halo_man
	)

Definition at line 1243 of file animation.cpp.

References dst, unit_animation::get_animation_time(), unit_animation::get_begin_time(), unit_animation::get_current_frame_begin_time(), unit_frame::redraw(), and src.

Referenced by unit_animation::redraw().

◆ start_animation()

void unit_animation::particle::start_animation ( int start_time )

Definition at line 1284 of file animation.cpp.

References unit_animation::get_begin_time(), and animated< T >::start_animation().

Referenced by unit_animation::start_animation().

Member Data Documentation

◆ accelerate

bool unit_animation::particle::accelerate

Definition at line 157 of file animation.hpp.

Referenced by unit_animation::start_animation(), and unit_animation::update_last_draw_time().

◆ cycles_

bool unit_animation::particle::cycles_

private

Definition at line 164 of file animation.hpp.

Referenced by override(), and particle().

◆ halo_id_

halo::handle unit_animation::particle::halo_id_

private

Definition at line 162 of file animation.hpp.

◆ last_frame_begin_time_

int unit_animation::particle::last_frame_begin_time_

private

Definition at line 163 of file animation.hpp.

◆ parameters_

frame_parsed_parameters unit_animation::particle::parameters_

private

Definition at line 161 of file animation.hpp.

Referenced by override(), parameters(), and particle().

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

units/animation.hpp
units/animation.cpp

Public Types

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ cycle_state

Constructor & Destructor Documentation

◆ particle() [1/2]

◆ particle() [2/2]

◆ ~particle()

Member Function Documentation

◆ clear_halo()

◆ get_overlaped_hex()

◆ need_minimal_update()

◆ need_update()

◆ override()

◆ parameters()

◆ redraw()

◆ start_animation()

Member Data Documentation

◆ accelerate

◆ cycles_

◆ halo_id_

◆ last_frame_begin_time_

◆ parameters_