icons.h

Go to the documentation of this file.

//       _________ __                 __
//      /   _____//  |_____________ _/  |______     ____  __ __  ______
//      \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
//      /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ |
//     /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
//             \/                  \/          \//_____/            \/
//  ______________________                           ______________________
//                        T H E   W A R   B E G I N S
//         Stratagus - A free fantasy real time strategy game engine
//
//
//      (c) Copyright 1998-2005 by Lutz Sammer
//
//      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; only version 2 of the License.
//
//      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 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., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.
//
 
#ifndef __ICONS_H__
#define __ICONS_H__
 
 
#include "vec2i.h"
#include "color.h"
#include <string>
 
/*----------------------------------------------------------------------------
--  Documentation
----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
--  Defines
----------------------------------------------------------------------------*/
 
#define IconActive   1  
#define IconClicked  2  
#define IconSelected 4  
#define IconDisabled 8  
#define IconAutoCast 16 
 
/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/
 
class CUnit;
class CGraphic;
class CPlayerColorGraphic;
class CPlayer;
class ButtonStyle;
 
class CIcon
{
public:
        CIcon(const std::string &ident);
        ~CIcon();
 
        static CIcon *New(const std::string &ident);
        static CIcon *Get(const std::string &ident);
 
        void Load();
 
        void DrawIcon(const PixelPos &pos, const int player = -1) const;
        void DrawGrayscaleIcon(const PixelPos &pos, const int player = -1) const;
        void DrawCooldownSpellIcon(const PixelPos &pos, const int percent) const;
        void DrawUnitIcon(const ButtonStyle &style,
                                          unsigned flags, const PixelPos &pos, const std::string &text, const int playerIndex = -1) const;
        void DrawSingleSelectionIcon(const ButtonStyle &style,
                                          unsigned flags, const PixelPos &pos, const std::string &text, const CUnit &unit) const;
        void DrawGroupSelectionIcon(const ButtonStyle &style,
                                          unsigned flags, const PixelPos &pos, const std::string &text, const CUnit &unit) const;
        void DrawContainedIcon(const ButtonStyle &style,
                                          unsigned flags, const PixelPos &pos, const std::string &text, const CUnit &unit) const;
 
        const std::string &GetIdent() const { return this->Ident; }
 
        void ClearExtraGraphics();
        void AddSingleSelectionGraphic(CPlayerColorGraphic *g);
        void AddGroupSelectionGraphic(CPlayerColorGraphic *g);
        void AddContainedGraphic(CPlayerColorGraphic *g);
 
        void SetPaletteSwaps(std::vector<PaletteSwap> &newSwaps);
 
public:
        CPlayerColorGraphic *G;              
        CPlayerColorGraphic *GScale;         
        int Frame;                
private:
        std::string Ident;        
 
        /*
         * These following lists of icons are used to allow different icons for single and multi-selection as
         * well as when the unit is contained in some container like a transport or a bunker.
         * Additionally, these are lists, and the health percentage of the unit is mapped into this list. this
         * way, units can have different (damaged) icons. all of these are optional, the default is to just use
         * the graphic stored in the *G field above.
         */
        std::vector<CPlayerColorGraphic *> SingleSelectionG; 
        std::vector<CPlayerColorGraphic *> GroupSelectionG;  
        std::vector<CPlayerColorGraphic *> ContainedG;       
 
        /*
         * These following lists are used to map percentages of arbitrary unit variables (e.g. health, shield,
         * mana, ...) to palette swaps in the selection icons.
         */
        std::vector<PaletteSwap> PaletteSwaps;
};
 
class IconConfig
{
public:
        IconConfig() : Icon(NULL) {}
 
        bool LoadNoLog();
        bool Load();
public:
        std::string Name;    
        CIcon *Icon;         
};
 
/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/
 
extern void LoadIcons();   
extern void CleanIcons();  
 
 
#endif // !__ICONS_H__