1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
// Copyright (C) 2008, 2009, 2011, 2014 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.
#pragma once
#ifndef SHIELD_H
#define SHIELD_H
#include <gtkmm.h>
#include <sigc++/trackable.h>
#include <sigc++/signal.h>
#include "shieldstyle.h"
#include "tartan.h"
class XML_Helper;
class Shieldset;
//! A single set of shields for a player
/**
*
*/
class Shield : public std::list<ShieldStyle*>, public Tartan, public sigc::trackable
{
public:
//! The xml tag of this object in a shieldset configuration file.
static Glib::ustring d_tag;
//! The notional player that the Shield goes with.
enum Colour {WHITE = 0, GREEN = 1, YELLOW = 2, DARK_BLUE = 3, ORANGE = 4,
LIGHT_BLUE = 5, RED = 6, BLACK = 7, NEUTRAL = 8};
//! Loading constructor.
/**
* Make a new Shield object by reading it in from an opened shieldset
* configuration file.
*
* @param helper The opened shieldset configuration file to read the
* shield object from.
*/
Shield(XML_Helper* helper);
//! Copy constructor
Shield(const Shield& s);
//! Default constructor.
Shield(Shield::Colour owner, Gdk::RGBA color);
//! Destructor.
virtual ~Shield();
// Get Methods
//! Returns the player that this shield will belong to.
guint32 getOwner() const {return d_owner;}
//! Returns the colour of the player shield.
Gdk::RGBA getColor() const {return d_color;}
// Set Methods
//! Sets the colour of the player shield.
void setColor(Gdk::RGBA c) {d_color = c;}
// Methods that operate on class data and do not modify the class.
//! Save the shield to an opened shieldset configuration file.
bool save(XML_Helper *helper) const;
//! Get the first shieldstyle in the shield with the given type.
ShieldStyle *getFirstShieldstyle(ShieldStyle::Type type);
// Methods that operate on class data and modify the class.
//! Load the images associated with this shield.
void instantiateImages(Shieldset *s, bool scale, bool &broken);
//! Destroy the images associated with this shield.
void uninstantiateImages();
// Static Methods
/**
* Get the default colour for the Player with the given Id.
*
* @note This colour is used to graphically shade Army, Shield, Flags,
* and selector pictures.
*
* @note This is not used to obtain the Neutral player's colour.
*
* @param player_no The player's Id for which we want the colour.
*
* @return The default colour associated with the player.
*/
//! Get standard colour for a player.
static Gdk::RGBA get_default_color_for_no(int player_no);
//! Get standard colour for the neutral player.
static Gdk::RGBA get_default_color_for_neutral();
//! Convert the Shield::Colour enumerated value to a string.
static Glib::ustring colourToString(const Shield::Colour c);
//! Convert Shield::Colour into a string suitable for display.
static Glib::ustring colourToFriendlyName (const Shield::Colour c);
static guint32 get_next_shield(guint32 type);
protected:
//! The player of the shield.
/**
* Equates to the shieldset.shield.d_colour XML entities in the
* shieldset configuration file.
* Equates to the Shield::Colour enumeration.
*/
guint32 d_owner;
//! The player's colour.
/**
* Mask portions of images are shaded in this colour.
*/
Gdk::RGBA d_color;
};
#endif // SHIELD_H
|
