initial commit, lordsawar source, slightly modified
[lordsawar] / src / armymap.h
1 //  Copyright (C) 2007, 2008, 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 ARMYMAP_H
19 #define ARMYMAP_H
20
21 #include <sigc++/signal.h>
22
23 #include "overviewmap.h"
24 #include "input-events.h"
25
26 //! Display a miniature map that shows where Stack objects are on the game map.
27 /** 
28  * This is a map where you can see all the armies in the field.  Army units
29  * in City objects are not shown.
30  */
31 class ArmyMap : public OverviewMap
32 {
33  public:
34      //! Default constructor.  Make a new ArmyMap.
35      ArmyMap();
36
37     //! Emitted when the Army units are finished being drawn on the map surface.
38     /**
39      * Classes that use ArmyMap must catch this signal to display the map.
40      */
41     sigc::signal<void, Glib::RefPtr<Gdk::Pixmap> > map_changed;
42     
43  private:
44     
45     //! Draw the City objects and Stack objects onto the miniature map graphic.
46     /**
47      * This method is automatically called by the ArmyMap::draw method.
48      */
49     virtual void after_draw();
50
51     //! Draw just the Stack objects onto the miniature map graphic.
52     void draw_stacks();
53
54 };
55
56 #endif