halo.hpp

Go to the documentation of this file.

/* $Id: halo.hpp 52533 2012-01-07 02:35:17Z shadowmaster $ */
/*
   Copyright (C) 2003 - 2012 by David White <dave@whitevine.net>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

/** @file */

#ifndef HALO_HPP_INCLUDED
#define HALO_HPP_INCLUDED

class display;

#include "map_location.hpp"

namespace halo
{

struct manager
{
    manager(display& disp);
    ~manager();

private:
    display* const old;
};

enum ORIENTATION { NORMAL, HREVERSE, VREVERSE, HVREVERSE };
const int NO_HALO = 0;

/**
 * Add a haloing effect using 'image centered on (x,y).
 * @return  The handle to the halo object.
 * @retval  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
 */
int add(int x, int y, const std::string& image, const map_location& loc,
        ORIENTATION orientation=NORMAL, bool infinite=true);

/** Set the position of an existing haloing effect, according to its handle. */
void set_location(int handle, int x, int y);

/** Remove the halo with the given handle. */
void remove(int handle);

struct remover
{
    void operator()(int handle) const { remove(handle); }
};

/**
 * Render and unrender haloes.
 *
 * Which haloes are rendered is determined by invalidated_locations and the
 * internal state in the control sets (in halo.cpp).
 */
void unrender(std::set<map_location> invalidated_locations);
void render();

} // end namespace halo

#endif