unit_animation::particule Class Reference

Inheritance diagram for unit_animation::particule:

Collaboration diagram for unit_animation::particule:

List of all members.

Public Types
enum	cycle_state { UNSET, CYCLE, NO_CYCLE }
Public Member Functions
	particule (int start_time=0, const frame_builder &builder=frame_builder())
	particule (const config &cfg, const std::string &frame_string="frame")
virtual	~particule ()
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="", Uint32 blend_color=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)
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)
const frame_parameters	parameters (const frame_parameters &default_val) const
void	clear_halo ()
Public Attributes
bool	accelerate
Private Attributes
frame_parsed_parameters	parameters_
int	halo_id_
int	last_frame_begin_time_
bool	cycles_

---

Detailed Description

Definition at line 82 of file unit_animation.hpp.

---

Member Enumeration Documentation

enum unit_animation::particule::cycle_state

Enumerator:

UNSET
CYCLE
NO_CYCLE

Definition at line 99 of file unit_animation.hpp.

---

Constructor & Destructor Documentation

unit_animation::particule::particule	(	int	start_time = 0,
		const frame_builder &	builder = frame_builder()
	)			[inline, explicit]

Definition at line 85 of file unit_animation.hpp.

unit_animation::particule::particule	(	const config &	cfg,
		const std::string &	frame_string = "frame"
	)			[explicit]

Definition at line 733 of file unit_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(), animated< unit_frame >::force_change(), animated< unit_frame >::get_animation_duration(), parameters_, and animated< unit_frame >::starting_frame_time_.

Here is the call graph for this function:

unit_animation::particule::~particule

(

)

[virtual]

Definition at line 976 of file unit_animation.cpp.

References halo_id_, halo::NO_HALO, and schema_validation::remove.

---

Member Function Documentation

void unit_animation::particule::clear_halo

(

)

Definition at line 961 of file unit_animation.cpp.

References halo_id_, halo::NO_HALO, and schema_validation::remove.

Referenced by unit_animation::clear_haloes().

Here is the caller graph for this function:

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

Definition at line 968 of file unit_animation.cpp.

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::get_overlaped_hex(), frame_parsed_parameters::parameters(), and parameters_.

Referenced by unit_animation::invalidate().

Here is the call graph for this function:

Here is the caller graph for this function:

bool unit_animation::particule::need_minimal_update

(

)

const

Definition at line 725 of file unit_animation.cpp.

References animated< unit_frame >::get_current_frame_begin_time(), and last_frame_begin_time_.

Referenced by unit_animation::need_minimal_update().

Here is the call graph for this function:

Here is the caller graph for this function:

bool unit_animation::particule::need_update

(

)

const

Reimplemented from animated< unit_frame >.

Definition at line 717 of file unit_animation.cpp.

References animated< unit_frame >::get_current_frame(), frame_parsed_parameters::need_update(), and parameters_.

Referenced by unit_animation::need_update().

Here is the call graph for this function:

Here is the caller graph for this function:

void unit_animation::particule::override	(	int	start_time,
		int	duration,
		const cycle_state	cycles,
		const std::string &	highlight = "",
		const std::string &	blend_ratio = "",
		Uint32	blend_color = 0,
		const std::string &	offset = "",
		const std::string &	layer = "",
		const std::string &	modifiers = ""
	)

Definition at line 687 of file unit_animation.cpp.

References animated< unit_frame >::add_frame(), CYCLE, 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().

Here is the call graph for this function:

const frame_parameters unit_animation::particule::parameters

(

const frame_parameters &

default_val

)

const [inline]

Definition at line 112 of file unit_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().

Here is the call graph for this function:

Here is the caller graph for this function:

void unit_animation::particule::redraw	(	const frame_parameters &	value,
		const map_location &	src,
		const map_location &	dst
	)

Definition at line 950 of file unit_animation.cpp.

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_begin_time(), animated< unit_frame >::get_current_frame_time(), halo_id_, last_frame_begin_time_, frame_parsed_parameters::parameters(), parameters_, and unit_frame::redraw().

Referenced by unit_animation::redraw().

Here is the call graph for this function:

Here is the caller graph for this function:

void unit_animation::particule::start_animation

(

int

start_time

)

Definition at line 982 of file unit_animation.cpp.

References cycles_, animated< unit_frame >::get_animation_duration(), animated< unit_frame >::get_begin_time(), halo_id_, last_frame_begin_time_, halo::NO_HALO, frame_parsed_parameters::override(), parameters_, and schema_validation::remove.

Referenced by unit_animation::start_animation().

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

bool unit_animation::particule::accelerate

Definition at line 114 of file unit_animation.hpp.

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

bool unit_animation::particule::cycles_ [private]

Reimplemented from animated< unit_frame >.

Definition at line 121 of file unit_animation.hpp.

Referenced by override(), particule(), and start_animation().

int unit_animation::particule::halo_id_ [private]

Definition at line 119 of file unit_animation.hpp.

Referenced by clear_halo(), redraw(), start_animation(), and ~particule().

int unit_animation::particule::last_frame_begin_time_ [private]

Definition at line 120 of file unit_animation.hpp.

Referenced by need_minimal_update(), redraw(), and start_animation().

frame_parsed_parameters unit_animation::particule::parameters_ [private]

Definition at line 118 of file unit_animation.hpp.

Referenced by get_overlaped_hex(), need_update(), override(), parameters(), particule(), redraw(), and start_animation().

---

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

• unit_animation.hpp
• unit_animation.cpp