← Back to branch summary

~ubuntu-branches/ubuntu/trusty/lordsawar/trusty

« back to all changes in this revision

Viewing changes to src/armymap.h

  • Committer: Bazaar Package Importer
  • Author(s): Barry deFreese
  • Date: 2008-06-17 16:07:00 UTC
  • mto: (5.1.1 lenny) (1.1.5 upstream)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20080617160700-6d8ofoz0qkasxlnw
Import upstream version 0.1.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/armymap.h
 
1
//  Copyright (C) 2007, 2008 Ben Asselstine
 
2
//
1
3
//  This program is free software; you can redistribute it and/or modify
2
4
//  it under the terms of the GNU General Public License as published by
3
5
//  the Free Software Foundation; either version 2 of the License, or
10
12
//
11
13
//  You should have received a copy of the GNU General Public License
12
14
//  along with this program; if not, write to the Free Software
13
 
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
15
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 
 
16
//  02110-1301, USA.
14
17
 
15
18
#ifndef ARMYMAP_H
16
19
#define ARMYMAP_H
20
23
#include "overviewmap.h"
21
24
#include "input-events.h"
22
25
 
23
 
/** Display of the whole game map.
24
 
  * 
25
 
  * This is a map where you can see all the armies in the field
26
 
  */
27
 
 
 
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
 */
28
31
class ArmyMap : public OverviewMap
29
32
{
30
33
 public:
31
 
    ArmyMap();
 
34
     //! Default constructor.  Make a new ArmyMap.
 
35
     ArmyMap();
32
36
 
33
 
    // emitted when the map surface has changed
 
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
     */
34
41
    sigc::signal<void, SDL_Surface *> map_changed;
35
42
    
36
43
 private:
37
44
    
38
 
    // hook from base class
 
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
     */
39
49
    virtual void after_draw();
40
50
 
41
 
    //! draw stacks on the map
 
51
    //! Draw just the Stack objects onto the miniature map graphic.
42
52
    void draw_stacks();
43
53
 
44
54
};