git.maemo.org Git - lordsawar/blob - src/heroesmap.h

   1 //  Copyright (C) 2009 Ben Asselstine
   2 //
   3 //  This program is free software; you can redistribute it and/or modify
   4 //  it under the terms of the GNU General Public License as published by
   5 //  the Free Software Foundation; either version 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   8 //  This program is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 //  GNU Library General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU General Public License
  14 //  along with this program; if not, write to the Free Software
  15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16 //  02110-1301, USA.
  17
  18 #ifndef HEROESMAP_H
  19 #define HEROESMAP_H
  20
  21 #include <sigc++/signal.h>
  22
  23 #include "overviewmap.h"
  24 #include "input-events.h"
  25
  26 class Hero;
  27
  28 //! Draw a miniature map graphic with an indication of where a Hero is.
  29 /**
  30   * This is a map where you can highlight a city with a hero icon.  This
  31   * draws the shields for City objects and the icon for the Hero.
  32   *
  33   * @note This is used to show a map when a Hero initially emerges from a City.
  34   */
  35 class HeroesMap : public OverviewMap
  36 {
  37  public:
  38      //! Default constructor.  Make a new HeroesMap.
  39      /**
  40       * @param city  The city where the Hero has emerged.
  41       */
  42      HeroesMap(std::list<Hero*> heroes);
  43
  44      //! Realize the mouse click.
  45      void mouse_button_event(MouseButtonEvent e);
  46
  47      //! Return the currently selected/active hero.
  48      Hero *getSelectedHero() {return active_hero;};
  49      void setSelectedHero(Hero *h) {active_hero = h;};
  50
  51     //! Emitted when the map graphic has been altered.
  52     /**
  53      * Classes that use HeroesMap must catch this signal to display the map.
  54      */
  55     sigc::signal<void, Glib::RefPtr<Gdk::Pixmap> > map_changed;
  56
  57     //! Emitted when a hero is clicked on.
  58     sigc::signal<void, Hero* > hero_selected;
  59
  60  private:
  61     //! The heroes to show on the map.
  62     std::list<Hero*> heroes;
  63     Hero *active_hero;
  64
  65     //! Draw the Hero icons onto the miniature map graphic.
  66     /**
  67      * This draws the shields for each city as well as the icon to indicate
  68      * that a Hero is there.
  69      *
  70      * This method is automatically called by the HeroesMap::draw method.
  71      */
  72     virtual void after_draw();
  73
  74     //! draw the given hero on the map, in white (Active ==true) or black.
  75     void draw_hero(Hero *hero, bool active);
  76
  77 };
  78
  79 #endif