/*
$Id: mapsquare.h,v 1.13 2003/02/23 23:14:34 ksterker Exp $
Copyright (C) 2001 Alexandre Courbot
Part of the Adonthell Project http://adonthell.linuxgames.com
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY.
See the COPYING file for more details.
*/
/**
* @file mapsquare.h
* @author Alexandre Courbot <alexandrecourbot@linuxgames.com>
*
* @brief Declares the mapsquare and mapsquare_area classes.
*
*
*/
#ifndef MAPSQUARE_H_
#define MAPSQUARE_H_
#include <list>
#include "mapsquare_walkable.h"
class mapobject;
class mapcharacter;
/**
* Contains informations about the position of an object on a map.
*
* Objects of this class has no reason to exist outside of a mapsquare.
* You'll NEVER want to manipulate this class directly - only mapsquare,
* mapsquare_area and landmap will.
*/
class mapsquare_tile
{
public:
/**
* Default constructor.
*/
mapsquare_tile ();
/**
* Destructor.
*/
~mapsquare_tile ();
#ifndef SWIG
/**
* Compare the location on the landsubmap of two mapsquare_tiles.
* A mapsquare_tile is < to another if it's Y position is < to the other
* one's or if it's Y position == the other one's and it's X position is
* < to the other one's.
*
* @attention Not available from Python.
*
* @sa operator <= ()
* @sa operator == ()
*/
bool operator < (const mapsquare_tile & mt)
{
return (mt.y > y || (mt.y == y && mt.x > x));
}
/**
* Compare the location on the landsubmap of two mapsquare_tiles.
* A mapsquare_tile is <= to another if it's Y position is < to the other
* one's or if it's Y position == the other one's and it's X position is
* <= to the other one's.
*
* @attention Not available from Python.
*
* @sa operator < ()
* @sa operator == ()
*/
bool operator <= (const mapsquare_tile & mt)
{
return (mt.y > y || (mt.y == y && mt.x >= x));
}
/**
* Compare the location on the landsubmap of two mapsquare_tiles.
* A mapsquare_tile is == to another if their X and Y position are
* equal.
*
* @attention Not available from Python.
*
* @sa operator < ()
* @sa operator <= ()
*/
bool operator == (const mapsquare_tile & mt)
{
return (mt.y == y && mt.x == x);
}
#endif
private:
/// Pointer to the object here.
mapobject * mapobj;
/// Is this mapsquare_tile a base square?
bool is_base;
#ifndef SWIG
/// Iterator to the base tile of this mapsquare_tile.
list <mapsquare_tile>::iterator base_tile;
#endif
/// x and y positions.
u_int16 x, y;
#ifndef SWIG
friend class mapsquare;
friend class mapsquare_area;
friend class landmap;
friend class mapview;
#endif
};
/**
* Contains informations about the position of a character on a map.
*
* Objects of this class has no reason to exist outside of a mapsquare.
* You'll NEVER want to manipulate this class directly - only mapsquare,
* mapsquare_area and landmap will.
*/
class mapsquare_char
{
public:
/**
* Default constructor.
*/
mapsquare_char ();
/**
* Destructor.
*/
~mapsquare_char ();
#ifndef SWIG
/**
* Compare the location on the landsubmap of two mapsquare_chars.
* A mapsquare_char is < to another if it's Y position is < to the other
* one's or if it's Y position == the other one's and it's X position is
* < to the other one's.
* @sa operator <= ()
* @sa operator == ()
*/
bool operator < (const mapsquare_char & mt)
{
return (mt.y > y || (mt.y == y && mt.x > x));
}
/**
* Compare the location on the landsubmap of two mapsquare_chars.
* A mapsquare_char is <= to another if it's Y position is < to the other
* one's or if it's Y position == the other one's and it's X position is
* <= to the other one's.
* @sa operator < ()
* @sa operator == ()
*/
bool operator <= (const mapsquare_char & mt)
{
return (mt.y > y || (mt.y == y && mt.x >= x));
}
/**
* Compare the location on the landsubmap of two mapsquare_chars.
* A mapsquare_char is == to another if their X and Y position are
* equal.
* @sa operator < ()
* @sa operator <= ()
*/
bool operator == (const mapsquare_char & mt)
{
return (mt.y == y && mt.x == x);
}
#endif
private:
/// Pointer to the mapcharacter concerned by this mapchar_square.
mapcharacter *mchar;
/// Is it the base tile?
bool is_base;
/// Is this mapsquare_tile walkable?
bool walkable;
#ifndef SWIG
/// Iterator to the base tile of this mapsquare_char.
list <mapsquare_char>::iterator base_tile;
#endif
/// x and y positions.
u_int16 x, y;
#ifndef SWIG
friend class mapcharacter;
friend class mapsquare;
friend class landmap;
friend class mapview;
#endif
};
/**
* Base unit of a landsubmap, where you can place mapobjects or mapcharacters.
* A landsubmap is a 2 dimensionnal array of mapsquares. When a mapobject is
* placed on a landsubmap, it belongs to one or several mapsquares. A mapsquare
* is made of a list of mapsquare_tiles, containing informations about the objects
* that are on it, and a list of mapsquare_char, which informs about the mapcharacters
* here. This make it possible to have several mapobjects
* and mapcharacters on the same mapsquare.
*
* These two lists are sorted by the position of the object or mapcharacter's base square
* on the map. This make it fast to iterate through the lists during drawing, as we always
* want to iterate the list in this order.
*/
class mapsquare : public mapsquare_walkable
{
public:
/**
* Default constructor.
*
*/
mapsquare ();
#ifndef SWIG
/**
* Copy constructor.
*
*/
mapsquare (const mapsquare& src);
#endif
/**
* Destructor.
*
*/
~mapsquare ();
/**
* Returns the X position of this mapsquare.
*
*
* @return X position of this mapsquare.
*/
u_int16 x ()
{
return x_;
}
/**
* Returns the Y position of this mapsquare.
*
*
* @return Y position of this mapsquare.
*/
u_int16 y ()
{
return y_;
}
/**
* Returns whether the mapsquare is free for a character to go on or not.
* It only checks if a mapcharacter is already here. It doesn't deal with the
* walkable problem.
* @return
* - false if the mapsquare isn't free.
* - true if the mapsquare is free.
*/
bool is_free ();
/**
* Return a pointer to the mapcharacter that occupies this mapsquare.
*
* @return pointer to the mapcharacter that occupies the mapsquare, NULL if none.
*/
mapcharacter *whoshere ();
/**
* @name Pathfinding data members.
*
* These members are here to allow faster and more efficient
* pathfinding. Though they can as well be used for something else,
* but their value isn't guaranteed to stay constant. It is safe
* to modify them however, so they are public and uninitialised.
*
*/
//@{
/**
* Distance from the source square.
*
*/
u_int16 g;
/**
* Estimated distance to the goal square.
*
*/
u_int16 h;
/**
* Sum of g + h.
*
*/
u_int16 f;
/**
* Parent square for the path
*
*/
mapsquare * parent;
/**
* If == false, then this square will never be considered
* as walkable by pathfinding functions.
*
*/
bool can_use_for_pathfinding;
//@}
private:
#ifndef SWIG
/// List of mapsquare_tiles.
list <mapsquare_tile> tiles;
/// Iterator to where the base tiles begin.
/// This serves as an "accelerator" for mapview::draw () which
/// can go directly to the base tiles of a squares with this
/// iterator.
list <mapsquare_tile>::iterator base_begin;
/// List of mapsquare_chars.
list <mapsquare_char> mapchars;
/// Coordinates of the square.
u_int16 x_, y_;
friend class mapcharacter;
friend class mapsquare_area;
friend class landmap;
friend class mapview;
#endif
}; // mapsquare
/**
* Area of mapsquares, for use with landmap.
*
* This class has no reason to exist is not belonging
* to a landmap. You'll NEVER use this class directly -
* anyway you can't do anything usefull with it alone.
*
*/
class mapsquare_area
{
public:
/**
* Default constructor.
*
*/
mapsquare_area ();
/**
* Destructor.
*
*/
~mapsquare_area ();
/**
* Totally clears the area.
*
*/
void clear ();
/**
* @name Area settings
*
*/
//@{
/**
* Returns the length of the area.
*
* @return length (in number of squares) of the area.
*
*/
u_int16 area_length () const
{
return area.size ();
}
/**
* Returns the height of the area.
*
* @return height (in number of squares) of the area.
*
*/
u_int16 area_height () const
{
if (area.size ()) return area[0].size ();
else return 0;
}
/**
* Returns a pointer to a desired square.
*
* @param x X position of the square to get.
* @param y Y position of the square to get.
*
* @return pointer to the (x,y) square.
*/
mapsquare * get_square (u_int16 x, u_int16 y) const
{
return &(area[x][y]);
}
/**
* Resize the area.
*
* @param nl new length (in number of squares) of the area.
* @param nh new height (in number of squares) of the area.
*/
void resize_area (u_int16 nl, u_int16 nh);
//@}
private:
/**
* Forbids value passing.
*
*/
mapsquare_area (const mapsquare_area& src);
#ifndef SWIG
/**
* Forbids mapsquare_area copy.
*
*/
mapsquare_area & operator = (const mapsquare_area & mo);
#endif
/**
* Place a mapobject on the submap.
*
* @param px X position of the base square of the object.
* @param py Y position of the base square of the object.
* @param mobj pointer to the mapobject to remove.
*/
s_int8 put_mapobject (u_int16 px, u_int16 py, mapobject * mobj);
/**
* Remove a mapobject from the submap.
*
* @param px X position of the base square of the object.
* @param py Y position of the base square of the object.
* @param mobj pointer to the mapobject to remove.
*/
void remove_mapobject (u_int16 px, u_int16 py, mapobject * mobj);
/**
* 2 dimensionnal array of mapsquares - the actual map
*
*/
#ifndef SWIG
mutable vector <vector<mapsquare> > area;
friend class mapcharacter;
friend class mapview;
friend class landmap;
#endif
};
#endif
