///////////////////////////////////////////////////////////////////////////////
//            Copyright (C) 2004-2007 by The Allacrost Project
//                         All Rights Reserved
//
// This code is licensed under the GNU GPL version 2. It is free software 
// and you may modify it and/or redistribute it under the terms of this license.
// See http://www.gnu.org/copyleft/gpl.html for details.
///////////////////////////////////////////////////////////////////////////////

/*!****************************************************************************
 * \file    grid.h
 * \author  Philip Vorsilak, gorzuate@allacrost.org
 * \brief   Header file for editor's grid, used for the OpenGL map portion
 *          where tiles are painted, edited, etc.
 *****************************************************************************/

#ifndef __GRID_HEADER__
#define __GRID_HEADER__

#include "utils.h"
#include "defs.h"
#include "script.h"
#include "video.h"

#include "tileset.h"

#include <QGLWidget>
#include <QStringList>

//! All calls to the editor are wrapped in this namespace.
namespace hoa_editor
{

//! Different tile layers in the map.
enum LAYER_TYPE
{
	INVALID_LAYER = -1,
	LOWER_LAYER   = 0,
	MIDDLE_LAYER  = 1,
	UPPER_LAYER   = 2,
	SELECT_LAYER  = 3,
	TOTAL_LAYER   = 4
};

LAYER_TYPE& operator++(LAYER_TYPE& value, int dummy);

class Grid: public QGLWidget
{
	Q_OBJECT     // macro needed to use QT's slots and signals
	
	public:
		Grid(QWidget *parent = 0, const QString &name = QString("Untitled"),
			int width = 0, int height = 0); // constructor
		~Grid();                            // destructor

		//! Returns the map's modified status.
		bool GetChanged() const { return _changed; }
		//! Sets the map's modified status;
		void SetChanged(bool value);
		QString GetFileName() const { return _file_name; }
		void    SetFileName(QString filename); // sets the map's file name
		int  GetHeight() const { return _height; }
		int  GetWidth() const {return _width; }
		void SetHeight(int height);         // sets the map's height in tiles (rows)
		void SetWidth(int width);           // sets the map's width in tiles (columns)
		void SetLLOn(bool value);           // sets lower layer on/off
		void SetMLOn(bool value);           // sets middle layer on/off
		void SetULOn(bool value);           // sets upper layer on/off
		void SetGridOn(bool value);         // sets grid on/off
		void SetSelectOn(bool value);       // sets grid on/off

		std::vector<int32>& GetLayer(LAYER_TYPE layer);

		/*!
		 *  \brief Sets the map's background music. Currently the map can only support one music file.
		 *  \param music_file The file name of the music file that will be used.
		 */
		void SetMusic(const QString& music_file);

		/*!
		 *  \brief Gets the map's background music file name.
		 *  \return A QString of the music's file name.
		 */
		const QString& GetMusic() const;

		/*!
		 *  \brief Loads a map from a config (lua) file when the user selects Open Map... from the File menu.
		 */
		void LoadMap();

		/*!
		 *  \brief Saves the map to a config (lua) file when the user selects Save, Save as..., or Quit
		 *         from the File menu.
		 */
		void SaveMap();

		//! List of the tileset names being used.
		QStringList tileset_names;
		//! A vector which contains a pointer to each tileset and the tiles it has loaded via LoadMultiImage.
		std::vector<Tileset*> tilesets;

	protected:
		//! \brief Sets up the rendering context of the OpenGL portion of the editor.
		void initializeGL();

		//! \brief Paints the entire map with the Allacrost video engine.
		void paintGL();

		//! \brief Performs a resize operation of the OpenGL widget when appropriate.
		void resizeGL(int w, int h);

	private:
		//! The map's file name.
		QString _file_name;
		//! The height of the map in tiles.
		int _height;
		//! The width of the map in tiles.
		int _width;

		//! When TRUE the map has been modified.
		bool _changed;
		//! When TRUE the grid between tiles is displayed.
		bool _grid_on;
		//! When TRUE the rectangle of chosen tiles is displayed.
		bool _select_on;
		//! When TRUE the lower layer of tiles is displayed.
		bool _ll_on;
		//! When TRUE the middle layer of tiles is displayed.
		bool _ml_on;
		//! When TRUE the upper layer of tiles is displayed.
		bool _ul_on;

		//! A vector of tiles in the lower layer.
		std::vector<int32> _lower_layer;
		//! A vector of tiles in the middle layer.
		std::vector<int32> _middle_layer;
		//! A vector of tiles in the upper layer.
		std::vector<int32> _upper_layer;
		//! A vector of tiles in the selection rectangle. Exists only in the editor,
		//! not the game. Acts similarly to an actual layer as far as drawing
		//! is concerned.
		std::vector<int32> _select_layer;

		//! Stores the background music file.
		QString _music_file;
}; // class Grid

} // namespace hoa_editor

#endif
// __GRID_HEADER__