____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

cursor.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2007 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 <vector>

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CGraphic;
class CUnitType;

/*----------------------------------------------------------------------------
--  Definitions
----------------------------------------------------------------------------*/

class CCursor {
public:
    CCursor() : HotX(0), HotY(0),
        SpriteFrame(0), FrameRate(0), G(NULL) {}

    std::string Ident;  

    int HotX;     
    int HotY;     

    int SpriteFrame;  
    int FrameRate;    

// --- FILLED UP ---

    CGraphic *G; 
};

class CursorConfig {
public:
    CursorConfig() : Cursor(NULL) {}

    void Load();

    std::string Name; 
    CCursor *Cursor;  
};

enum CursorStates {
    CursorStatePoint,      
    CursorStateSelect,     
    CursorStateRectangle,  
    CursorStatePieMenu,    
};

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/

extern std::vector<CCursor> AllCursors;

extern CursorStates CursorState;  
extern int CursorAction;          
extern int CursorValue;           
extern CUnitType *CursorBuilding; 

extern CCursor *GameCursor;     
extern int CursorX;             
extern int CursorY;             
extern int CursorStartX;        
extern int CursorStartY;        
extern int CursorStartScrMapX;  
extern int CursorStartScrMapY;  

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

extern void LoadCursors();

extern CCursor *CursorByIdent(const std::string &ident);

extern void DrawCursor(void);
extern void HideCursor(void);
extern void CursorAnimate(unsigned ticks);

extern void InitVideoCursors(void);
extern void CleanCursors(void);


#endif // !__CURSOR_H__

---