cursor.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 __CURSOR_H__
#define __CURSOR_H__
 
 
/*----------------------------------------------------------------------------
--  Documentation
----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
--  Includes
----------------------------------------------------------------------------*/
 
#include <SDL.h>
#include <vec2i.h>
 
/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/
 
class CGraphic;
class CUnitType;
 
/*----------------------------------------------------------------------------
--  Definitions
----------------------------------------------------------------------------*/
 
class CCursor
{
public:
        CCursor() : HotPos(0, 0),
                SpriteFrame(0), FrameRate(0), G(NULL) {}
 
        ~CCursor();
 
        std::string Ident;  
        std::string Race;   
 
        PixelPos HotPos;     
 
        unsigned int SpriteFrame;  
        int FrameRate;    
 
        // --- FILLED UP ---
 
        CGraphic *G; 
 
        SDL_Cursor *GetSDLCursor();
        void Reset(); // Clear all cursor surfaces
 
private:
        std::vector<SDL_Cursor*> SdlCursors;
        std::vector<SDL_Surface*> SdlCursorSurfaces;
};
 
class CursorConfig
{
public:
        CursorConfig() : Cursor(NULL) {}
 
        void Load();
 
        std::string Name; 
        CCursor *Cursor;  
};
 
enum CursorStates {
        CursorStatePoint,      
        CursorStateSelect,     
        CursorStateRectangle,  
        CursorStatePieMenu     
};
 
/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/
 
extern CursorStates CursorState;  
extern int CursorAction;          
extern int CursorValue;           
extern CUnitType *CursorBuilding; 
extern std::string CustomCursor;  
 
extern CCursor *GameCursor;     
extern PixelPos CursorScreenPos; 
extern PixelPos CursorStartScreenPos; 
extern PixelPos CursorStartMapPos; 
 
/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/
 
extern void LoadCursors(const std::string &racename);
 
extern CCursor *CursorByIdent(const std::string &ident);
 
extern void DrawCursor();
extern void HideCursor();
extern void CursorAnimate(unsigned ticks);
 
extern void InitVideoCursors();
extern void CleanCursors();
 
extern void CursorCclRegister();
 
 
#endif // !__CURSOR_H__