#include <halo.hpp>

Public Member Functions
	manager (display &disp)

handle	add (int x, int y, const std::string &image, const map_location &loc, halo::ORIENTATION orientation=NORMAL, bool infinite=true)
	Add a haloing effect using 'image centered on (x,y). More...

void	set_location (const handle &h, int x, int y)
	Set the position of an existing haloing effect, according to its handle. More...

void	remove (const handle &h)
	Remove the halo with the given handle. More...

void	unrender (std::set< map_location > invalidated_locations)
	Render and unrender haloes. More...

void	render ()

Private Attributes
boost::shared_ptr< halo_impl >	impl_

Detailed Description

Definition at line 42 of file halo.hpp.

Constructor & Destructor Documentation

halo::manager::manager ( display & disp )

Definition at line 475 of file halo.cpp.

Member Function Documentation

handle halo::manager::add	(	int	x,
		int	y,
		const std::string &	image,
		const map_location &	loc,
		halo::ORIENTATION	orientation = `NORMAL`,
		bool	infinite = `true`
	)

Add a haloing effect using 'image centered on (x,y).

Returns: The handle to the halo object.

Return values

0	is the invalid handle.

If the halo is attached to an item, it needs to be hidden if the shroud is active. (Note it will be shown with the fog active.) If it is not attached to an item, the location should be set to -1, -1

Definition at line 478 of file halo.cpp.

References impl_.

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

void halo::manager::remove ( const handle & h )

Remove the halo with the given handle.

Definition at line 492 of file halo.cpp.

References impl_, and halo::NO_HALO.

Referenced by unit_drawer::redraw_unit().

void halo::manager::render ( )

Definition at line 509 of file halo.cpp.

References impl_.