Arena Class Reference

#include <arena.h>

Inheritance diagram for Arena:

Public Member Functions
	Arena ()
	~Arena ()
void	addPlayerPosition (const QPointF &p_position)
Cell	getCell (const int p_row, const int p_column) const
int	getColFromX (const qreal p_x) const
QPoint	getCoords (Cell *p_cell) const
QString	getName () const
int	getNbColumns () const
int	getNbRows () const
QPointF	getPlayerPosition (int p_player) const
int	getRowFromY (const qreal p_y) const
void	init (const int p_nbRows, const int p_nbColumns)
void	removeCellElement (const int p_row, const int p_column, Element *p_element)
void	setCellElement (const int p_row, const int p_column, Element *p_element)
void	setCellType (const int p_row, const int p_column, const Granatier::Cell::Type p_type)
void	setName (const QString &p_strArenaName)

Detailed Description

This class represents the Arena of the game.

Definition at line 36 of file arena.h.

Constructor & Destructor Documentation

Arena::Arena

(

)

Creates a new Arena instance.

Definition at line 27 of file arena.cpp.

Arena::~Arena

(

)

Deletes the Arena instance.

Definition at line 31 of file arena.cpp.

Member Function Documentation

void Arena::addPlayerPosition

(

const QPointF &

p_position

)

Sets a player position on the arena.

Parameters

p_position

the player position

Definition at line 90 of file arena.cpp.

Cell Arena::getCell	(	const int	p_row,
		const int	p_column
	)		const

Gets the Cell at the given coordinates.

Parameters

p_row	the row index
p_column	the column index

Returns

the Cell at the given row and column

Definition at line 120 of file arena.cpp.

int Arena::getColFromX

(

const qreal

p_x

)

const

Gets the column index corresponding to the given x-coordinate.

Parameters

p_x	the x-coordinate to convert into column index

Returns

the column index corresponding to the given x-coordinate

Definition at line 154 of file arena.cpp.

QPoint Arena::getCoords

(

Cell *

p_cell

)

const

Gets the coordinates of the given Cell as a QPoint.

Parameters

p_cell

the searched Cell

Returns

the row and column of the given Cell

Definition at line 129 of file arena.cpp.

QString Arena::getName

(

)

const

Returns the Arean name.

Returns

the Arena name

Definition at line 53 of file arena.cpp.

int Arena::getNbColumns

(

)

const

Gets the number of columns of the Arena.

Returns

the number of columns

Definition at line 164 of file arena.cpp.

int Arena::getNbRows

(

)

const

Gets the number of rows of the Arena.

Returns

the number of rows

Definition at line 169 of file arena.cpp.

QPointF Arena::getPlayerPosition

(

int

p_player

)

const

Gets the player position on the arena.

Parameters

p_player

the player number

Returns

p_position the player position

Definition at line 111 of file arena.cpp.

int Arena::getRowFromY

(

const qreal

p_y

)

const

Gets the row index corresponding to the given y-coordinate.

Parameters

p_y	the y-coordinate to convert into row index

Returns

the row index corresponding to the given y-coordinate

Definition at line 144 of file arena.cpp.

void Arena::init	(	const int	p_nbRows,
		const int	p_nbColumns
	)

Creates the Arena matrix.

Parameters

p_nbRows	the number of rows
p_nbColumns	the number of columns

Definition at line 40 of file arena.cpp.

void Arena::removeCellElement	(	const int	p_row,
		const int	p_column,
		Element *	p_element
	)

Removes the Element that is on the Cell whose coordinates are given in parameters.

Parameters

p_row	the Cell row
p_column	the Cell column
p_element	the Element that is on the Cell

Definition at line 81 of file arena.cpp.

void Arena::setCellElement	(	const int	p_row,
		const int	p_column,
		Element *	p_element
	)

Sets the Element that is on the Cell whose coordinates are given in parameters.

Parameters

p_row	the Cell row
p_column	the Cell column
p_element	the Element that is on the Cell

Definition at line 72 of file arena.cpp.

void Arena::setCellType	(	const int	p_row,
		const int	p_column,
		const Granatier::Cell::Type	p_type
	)

Sets the CellType of the Cell whose coordinates are given in parameters.

Parameters

p_row	the Cell row
p_column	the Cell column
p_type	the Cell type

Definition at line 63 of file arena.cpp.

void Arena::setName

(

const QString &

p_strArenaName

)

Sets the Arena name.

Parameters

p_strArenaName

the Arena name

Definition at line 58 of file arena.cpp.

---

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

• arena.h
• arena.cpp