initial commit, lordsawar source, slightly modified

[lordsawar] / src / heromap.h

diff --git a/src/heromap.h b/src/heromap.h
new file mode 100644 (file)
index 0000000..38cd4ed
--- /dev/null
+++ b/src/heromap.h
@@ -0,0 +1,64 @@
+//  Copyright (C) 2007, 2008, 2009 Ben Asselstine
+//
+//  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 3 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; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Library General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 
+//  02110-1301, USA.
+
+#ifndef HEROMAP_H
+#define HEROMAP_H
+
+#include <sigc++/signal.h>
+
+#include "overviewmap.h"
+#include "input-events.h"
+
+class City;
+
+//! Draw a miniature map graphic with an indication of where a Hero is.
+/** 
+  * This is a map where you can highlight a city with a hero icon.  This
+  * draws the shields for City objects and the icon for the Hero.
+  *
+  * @note This is used to show a map when a Hero initially emerges from a City.
+  */
+class HeroMap : public OverviewMap
+{
+ public:
+     //! Default constructor.  Make a new HeroMap.
+     /**
+      * @param city  The city where the Hero has emerged.
+      */
+     HeroMap(City *city);
+
+    //! Emitted when the Hero icon is finished being drawn on the map surface.
+    /**
+     * Classes that use HeroMap must catch this signal to display the map.
+     */
+    sigc::signal<void, Glib::RefPtr<Gdk::Pixmap> > map_changed;
+    
+ private:
+    //! The City of where to draw the Hero icon.
+    City *city;
+    
+    //! Draw the Hero icon onto the miniature map graphic.
+    /**
+     * This draws the shields for each city as well as the icon to indicate
+     * that a Hero is there.
+     *
+     * This method is automatically called by the HeroMap::draw method.
+     */
+    virtual void after_draw();
+};
+
+#endif