mapsquare_area Class Reference

Area of mapsquares, for use with landmap. More...

#include <mapsquare.h>

Collaboration diagram for mapsquare_area:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 mapsquare_area ()
 Default constructor.
 ~mapsquare_area ()
 Destructor.
void clear ()
 Totally clears the area.
Area settings
u_int16 area_length () const
 Returns the length of the area.
u_int16 area_height () const
 Returns the height of the area.
mapsquareget_square (u_int16 x, u_int16 y) const
 Returns a pointer to a desired square.
void resize_area (u_int16 nl, u_int16 nh)
 Resize the area.

Friends

class mapcharacter
class mapview
class landmap


Detailed Description

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.

Definition at line 368 of file mapsquare.h.


Constructor & Destructor Documentation

mapsquare_area::mapsquare_area (  ) 

Default constructor.

Definition at line 91 of file mapsquare.cc.

mapsquare_area::~mapsquare_area (  ) 

Destructor.

Definition at line 95 of file mapsquare.cc.


Member Function Documentation

void mapsquare_area::clear (  ) 

Totally clears the area.

Definition at line 99 of file mapsquare.cc.

u_int16 mapsquare_area::area_length (  )  const [inline]

Returns the length of the area.

Returns:
length (in number of squares) of the area.

Definition at line 401 of file mapsquare.h.

u_int16 mapsquare_area::area_height (  )  const [inline]

Returns the height of the area.

Returns:
height (in number of squares) of the area.

Definition at line 412 of file mapsquare.h.

mapsquare* mapsquare_area::get_square ( u_int16  x,
u_int16  y 
) const [inline]

Returns a pointer to a desired square.

Parameters:
x X position of the square to get.
y Y position of the square to get.
Returns:
pointer to the (x,y) square.

Definition at line 426 of file mapsquare.h.

void mapsquare_area::resize_area ( u_int16  nl,
u_int16  nh 
)

Resize the area.

Parameters:
nl new length (in number of squares) of the area.
nh new height (in number of squares) of the area.

Definition at line 233 of file mapsquare.cc.


The documentation for this class was generated from the following files:

Generated on Thu Sep 25 18:55:58 2008 for Adonthell by  doxygen 1.5.6