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

       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"

---

editor.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 2002-2008 by Lutz Sammer and Jimmy Salmon
//
//      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 __EDITOR_H__
#define __EDITOR_H__


#include <vector>
#include <string>
#include "icons.h"

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

class CUnitType;
class CPatchType;

enum EditorRunningType {
    EditorNotRunning = 0,    
    EditorStarted = 1,       
    EditorCommandLine = 2,   
    EditorEditing = 4,       
};

enum EditorStateType {
    EditorSelecting,         
    EditorEditPatch,         
    EditorEditUnit,          
    EditorSetStartLocation   
};

struct CPatchIcon
{
    CPatchIcon(CPatchType *patchType, CGraphic *g) :
        PatchType(patchType), G(g)
    {}

    CPatchType *PatchType;
    CGraphic *G;
};

class CEditor {
public:
    CEditor() : StartUnit(NULL),
        UnitIndex(0), CursorUnitIndex(-1), SelectedUnitIndex(-1),
        PatchIndex(0), CursorPatchIndex(-1), SelectedPatchIndex(-1),
        CursorPlayer(-1), SelectedPlayer(-1), MapLoaded(false),
        ShowPatchOutlines(false)
        {};
    ~CEditor() {};

    void Init();

    std::vector<std::string> UnitTypes;             
    std::vector<const CUnitType *> ShownUnitTypes;  

    std::vector<CPatchIcon> ShownPatchTypes;        

    IconConfig Select;           
    IconConfig Units;            
    IconConfig Patch;            
    std::string StartUnitName;   
    const CUnitType *StartUnit;  

    int UnitIndex;               
    int CursorUnitIndex;         
    int SelectedUnitIndex;       

    int PatchIndex;              
    int CursorPatchIndex;        
    int SelectedPatchIndex;      

    int CursorPlayer;            
    int SelectedPlayer;          

    bool MapLoaded;              

    bool ShowPatchOutlines;      
    Uint32 PatchOutlineColor;    

    EditorRunningType Running;   

    EditorStateType State;       
};

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

extern CEditor Editor;

extern const char *EditorStartFile;  

extern bool PatchEditorRunning;

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

extern void SetEditorSelectIcon(const std::string &icon);
extern void SetEditorUnitsIcon(const std::string &icon);
extern void SetEditorPatchIcon(const std::string &icon);
extern void SetEditorStartUnit(const std::string &name);

extern void StartEditor(const std::string &filename);

extern int EditorSaveMap(const std::string &file);

extern void StartPatchEditor(const std::string &patchName);


#endif // !__EDITOR_H__

---