Dokumentace třídy MapResourceHandler

Handler vnejsich prostredku mapy. ...

#include <map_resource_handler.h>

Seznam všech členů.

Veřejné metody

BombicMap * createEmptyMap ()

Vytvorit novou prazdnou mapu.

BombicMap * createMap (const QString &name)

Vytvorit novou mapu.

bool saveMap (BombicMap *map)

Ulozit mapu.

BombicMap * createMapCopy (BombicMap *oldMap, int newWidth, int newHeight, const QString &newBackground)

Vytvorit kopii mapy se zmenenymi parametry.

Privátní typy

typedef QList< BombicMap::Field > PositionsT

Seznam policek umisteni (pozic).

typedef struct
MapResourceHandler::_MapObjectS MapObjectT

Objekt mapy pro ulozeni.

typedef QHash< QString,
MapObjectT > ObjectsByNameT

Objekt podle jeho jmena.

typedef QHash
< BombicMapObject::Type,
ObjectsByNameT > ObjectsByTypeT

Objekty podle typu objektu.

Privátní metody

QString objectsElName (BombicMapObject::Type objectType)

Nazev definujiciho elementu podle typu objektu.

QString positionElName (BombicMapObject::Type objectType)

Nazev pozicniho elementu podle typu objektu.

BombicMap * createMap (const QDomElement &rootEl)

Vytvorit novou mapu.

bool loadMapPlayers (BombicMap *map)

Nacte hrace mapy.

bool loadMapPlayers (const QDomElement &playersEl, BombicMap *map)

Nacte hrace mapy.

bool loadMapObjects (const QDomElement &rootEl, BombicMapObject::Type type, BombicMap *map)

Nacte objekty mapy daneho typu.

bool loadMapNoboxes (const QDomElement &dontGenerateEl, BombicMap *map)

Nacte pole na kterych se nemaji generovat bedny.

bool loadMapNocreatures (const QDomElement &dontGenerateEl, BombicMap *map)

Nacte pole na kterych se nemaji generovat prisery.

bool insertMapObjects (const QDomElement &positionEl, BombicMapObject *insertedObject, BombicMap *map)

Vlozi do mapy objekt na urcite pozice.

bool insertMapObject (const QDomElement &positionEl, BombicMapObject *insertedObject, BombicMap *map)

Vlozi do mapy objekt na urcitou (jednu) pozici.

void initMapDataToSave (MapDataT &mapData, BombicMap *map)

Inicializovat data mapy pro ulozeni.

void registerPlacedObject (MapDataT &mapData, BombicMapObject *object, BombicMap::Field field)

Zaregistrovat umisteny objekt do dat mapy.

void countGeneratedObjects (ObjectsByTypeT &objects, const BombicMap::ObjectListT &generatedObjects)

Spocitat generovane objekty mapy.

void mapDataToXml (const MapDataT &mapData, QDomElement &rootEl)

Zkonvertovat data mapy do xml.

void positionsToXml (const PositionsT &positions, QDomElement &parentEl, const QString &positionElTagName)

Zkonvertovat umisteni objektu do xml.

Třídy

struct _MapObjectS

Objekt mapy pro ulozeni. ...

struct MapDataT

Data mapy pro ulozeni. ...

Detailní popis

Handler vnejsich prostredku mapy.

Obstarava nacitani a ukladani mapy. Take vytvari kopii mapy s pozmenenymi zasadnimy parametry jako je rozmer mapy nebo pozadi.

Dokumentace k členským typům

typedef QList<BombicMap::Field> MapResourceHandler::PositionsT [private]

Seznam policek umisteni (pozic).

typedef struct MapResourceHandler::_MapObjectS MapResourceHandler::MapObjectT [private]

Objekt mapy pro ulozeni.

typedef QHash<QString, MapObjectT> MapResourceHandler::ObjectsByNameT [private]

Objekt podle jeho jmena.

typedef QHash<BombicMapObject::Type, ObjectsByNameT> MapResourceHandler::ObjectsByTypeT [private]

Objekty podle typu objektu.

Dokumentace k metodám

BombicMap * MapResourceHandler::createEmptyMap ( )

Vytvorit novou prazdnou mapu.

Vytvori mapu s defaultnim pozadim DEFAULT_MAP_BACKGROUND a rozmery DEFAULT_MAP_WIDTH, DEFAULT_MAP_HEIGHT. Vlozi do mapy hrace na prvni vhodnou pozici. Vlastnictvi nove naalokovane mapy prechazi na volajiciho. Nastavi mape ze byla ulozena (nebyla editovana).

Návratová hodnota:: Nove alokovana prazdna mapa s pozadim.

Tato funkce volá...

Tuto funkci volají...

BombicMap * MapResourceHandler::createMap ( const QString & name )

Vytvorit novou mapu.

Pokusi se vytvorit mapu zadanou name a vlozit do ni vsechny objekty. Nastavi mape ze byla ulozena (nebyla editovana).

Parametry:

name

jmeno mapy (nebo primo cesta k souboru)

Návratová hodnota:: Objekt mapy.

Vracené hodnoty:

0

mapu se nepodarilo vyrobit

Tato funkce volá...

Tuto funkci volají...

bool MapResourceHandler::saveMap ( BombicMap * map )

Ulozit mapu.

Ulozi mapu do jejiho souboru ( BombicMap::filename() ). Z mapy ziska data pro ulozeni, vytvori xml dokument a ten nasledne ulozi do souboru. Pokud se akce povede, nastavi mape ze byla ulozena.

Parametry:

map

mapa, kterou chceme ulozit

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

BombicMap * MapResourceHandler::createMapCopy	(	BombicMap *	oldMap,
		int	newWidth,
		int	newHeight,
		const QString &	newBackground
	)

Vytvorit kopii mapy se zmenenymi parametry.

Vytvori novou mapu s novymi parametry a pokusi se do ni prekopirovat vsechny objekty ve stare mape. Pokud nelze vsechny objekty prekopirovat, vypisuje relevantni informace a selze.

Parametry:

	oldMap	mapa, od ktere chceme kopii
	newWidth	nova sirka mapy
	newHeight	nova vyska mapy
	newBackground	nazev noveho pozadi

Návratová hodnota:: Nove alokovana mapa s novymi parametry.

Vracené hodnoty:

0

Mapu nebylo mozne vytvorit.

Tato funkce volá...

Tuto funkci volají...

QString MapResourceHandler::objectsElName ( BombicMapObject::Type objectType ) [private]

Nazev definujiciho elementu podle typu objektu.

Parametry:

objectType

typ objektu, ktery je elementem definovat

Návratová hodnota:: Jmeno elementu, ktery definuje dany typ.

Tuto funkci volají...

QString MapResourceHandler::positionElName ( BombicMapObject::Type objectType ) [private]

Nazev pozicniho elementu podle typu objektu.

Parametry:

objectType

typ objektu, ktery je elementem pozicovan

Návratová hodnota:: Jmeno elementu, ktery pozicuje dany typ.

Tuto funkci volají...

BombicMap * MapResourceHandler::createMap ( const QDomElement & rootEl ) [private]

Vytvorit novou mapu.

Pokusi se vytvorit mapu definovanou korenovym elementem rootEl a vlozit do ni vsechny objekty.

Parametry:

rootEl

korenovy element definice mapy

Návratová hodnota:: Objekt mapy.

Vracené hodnoty:

0

mapu se nepodarilo vyrobit

Tato funkce volá...

bool MapResourceHandler::loadMapPlayers ( BombicMap * map ) [private]

Nacte hrace mapy.

Nacte hrace mapy a vlozi je na prvni vhodne misto. Hodi se zejmena pro vytvareni prazdne mapy.

Parametry:

map

mapa, do ktere chceme hrace vlozit

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

bool MapResourceHandler::loadMapPlayers	(	const QDomElement &	playersEl,
		BombicMap *	map
	)			`[private]`

Nacte hrace mapy.

Nacte hrace mapy a vlozi je do mapy. Misto vlozeni definuje playersEl.

Parametry:

	playersEl	element definujici pozice hracu
	map	mapa, do ktere chceme hrace vlozit

Návratová hodnota:: Uspech akce.

Tato funkce volá...

bool MapResourceHandler::loadMapObjects	(	const QDomElement &	rootEl,
		BombicMapObject::Type	type,
		BombicMap *	map
	)			`[private]`

Nacte objekty mapy daneho typu.

Nacte objekty mapy daneho typu a vlozi je do mapy.

Parametry:

	rootEl	korenovy element definice mapy
	type	typ objektu
	map	mapa, do ktere chceme objekty vlozit

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

bool MapResourceHandler::loadMapNoboxes	(	const QDomElement &	dontGenerateEl,
		BombicMap *	map
	)			`[private]`

Nacte pole na kterych se nemaji generovat bedny.

Zakaze v mape policka, na ktery se nesmi generovat bedny.

Parametry:

	dontGenerateEl	element definice zakazanych policek
	map	mapa, ve ktere chceme generovani zakazovat

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

bool MapResourceHandler::loadMapNocreatures	(	const QDomElement &	dontGenerateEl,
		BombicMap *	map
	)			`[private]`

Nacte pole na kterych se nemaji generovat prisery.

Zakaze v mape policka, na ktery se nesmi generovat prisery.

Parametry:

	dontGenerateEl	element definice zakazanych policek
	map	mapa, ve ktere chceme generovani zakazovat

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

bool MapResourceHandler::insertMapObjects	(	const QDomElement &	positionEl,
		BombicMapObject *	insertedObject,
		BombicMap *	map
	)			`[private]`

Vlozi do mapy objekt na urcite pozice.

Na pozice (zacinajici positionEl a dalsi) vlozi kopie objektu (pokud to lze).

Parametry:

	positionEl	prvni pozicni element
	insertedObject	prototyp vkladaneho objektu
	map	mapa, do ktere chceme objekty umistit

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

bool MapResourceHandler::insertMapObject	(	const QDomElement &	posEl,
		BombicMapObject *	insertedObject,
		BombicMap *	map
	)			`[private]`

Vlozi do mapy objekt na urcitou (jednu) pozici.

Na pozici urcenou posEl vlozi kopii objektu (pokud to lze). Pokud nelze objekt vlozit, zobrazi chybove hlaseni a selze.

Parametry:

	posEl	pozicni element
	insertedObject	prototyp vkladaneho objektu
	map	mapa, do ktere chceme objekt umistit

Návratová hodnota:: Uspech akce.

Tato funkce volá...

Tuto funkci volají...

void MapResourceHandler::initMapDataToSave	(	MapDataT &	mapData,
		BombicMap *	map
	)			`[private]`

Inicializovat data mapy pro ulozeni.

Ziska z mapy map relevantni data a ulozi je do mapData.

Parametry:

`[out]`	mapData	data mapy pro ulozeni
	map	mapa, kterou chceme ulozit

Tuto funkci volají...

void MapResourceHandler::registerPlacedObject	(	MapDataT &	mapData,
		BombicMapObject *	object,
		BombicMap::Field	field
	)			`[private]`

Zaregistrovat umisteny objekt do dat mapy.

Pokud je to vhodne, zaregistruje umisteni objektu object na policko field. Resi problem rozlehlych objektu, obvodovych zdi a hracu (ty uklada jinam).

Parametry:

`[out]`	mapData	data mapy pro ulozeni
	object	objekt, ktery registrujeme
	field	policko, na ktere jej pripadne registrujeme

Tato funkce volá...

Tuto funkci volají...

void MapResourceHandler::countGeneratedObjects	(	ObjectsByTypeT &	objects,
		const BombicMap::ObjectListT &	generatedObjects
	)			`[private]`

Spocitat generovane objekty mapy.

* Nastavi pocty generovanych objektu. *

Parametry:

`[out]`	objects	objekty mapy *
	generatedObjects	seznam generovanych objektu mapy

Tato funkce volá...

Tuto funkci volají...

void MapResourceHandler::mapDataToXml	(	const MapDataT &	mapData,
		QDomElement &	rootEl
	)			`[private]`

Zkonvertovat data mapy do xml.

Nastavi atributy a vytvori podstrom korenoveho elementu definice mapy. rootEl by mel byt inicializovan a mel by patrit do platneho dokumentu.

Parametry:

	mapData	data mapy k ulozeni
	rootEl	korenovy element definice mapy

Tato funkce volá...

Tuto funkci volají...

void MapResourceHandler::positionsToXml	(	const PositionsT &	positions,
		QDomElement &	parentEl,
		const QString &	positionElName
	)			`[private]`

Zkonvertovat umisteni objektu do xml.

Vytvori podstrom pozic elementu definujiciho objekt. parentEl by mel byt inicializovan a mel by patrit do platneho dokumentu.

Parametry:

	positions	seznam pozic objektu
	parentEl	element definujici objekt mapy
	positionElName	nazev elementu pozice

Tuto funkci volají...

Dokumentace pro tuto třídu byla generována z následujících souborů:


Veřejné metody
BombicMap *	createEmptyMap ()
	Vytvorit novou prazdnou mapu.
BombicMap *	createMap (const QString &name)
	Vytvorit novou mapu.
bool	saveMap (BombicMap *map)
	Ulozit mapu.
BombicMap *	createMapCopy (BombicMap *oldMap, int newWidth, int newHeight, const QString &newBackground)
	Vytvorit kopii mapy se zmenenymi parametry.
Privátní typy
typedef QList< BombicMap::Field >	PositionsT
	Seznam policek umisteni (pozic).
typedef struct MapResourceHandler::_MapObjectS	MapObjectT
	Objekt mapy pro ulozeni.
typedef QHash< QString, MapObjectT >	ObjectsByNameT
	Objekt podle jeho jmena.
typedef QHash < BombicMapObject::Type, ObjectsByNameT >	ObjectsByTypeT
	Objekty podle typu objektu.
Privátní metody
QString	objectsElName (BombicMapObject::Type objectType)
	Nazev definujiciho elementu podle typu objektu.
QString	positionElName (BombicMapObject::Type objectType)
	Nazev pozicniho elementu podle typu objektu.
BombicMap *	createMap (const QDomElement &rootEl)
	Vytvorit novou mapu.
bool	loadMapPlayers (BombicMap *map)
	Nacte hrace mapy.
bool	loadMapPlayers (const QDomElement &playersEl, BombicMap *map)
	Nacte hrace mapy.
bool	loadMapObjects (const QDomElement &rootEl, BombicMapObject::Type type, BombicMap *map)
	Nacte objekty mapy daneho typu.
bool	loadMapNoboxes (const QDomElement &dontGenerateEl, BombicMap *map)
	Nacte pole na kterych se nemaji generovat bedny.
bool	loadMapNocreatures (const QDomElement &dontGenerateEl, BombicMap *map)
	Nacte pole na kterych se nemaji generovat prisery.
bool	insertMapObjects (const QDomElement &positionEl, BombicMapObject insertedObject, BombicMap map)
	Vlozi do mapy objekt na urcite pozice.
bool	insertMapObject (const QDomElement &positionEl, BombicMapObject insertedObject, BombicMap map)
	Vlozi do mapy objekt na urcitou (jednu) pozici.
void	initMapDataToSave (MapDataT &mapData, BombicMap *map)
	Inicializovat data mapy pro ulozeni.
void	registerPlacedObject (MapDataT &mapData, BombicMapObject *object, BombicMap::Field field)
	Zaregistrovat umisteny objekt do dat mapy.
void	countGeneratedObjects (ObjectsByTypeT &objects, const BombicMap::ObjectListT &generatedObjects)
	Spocitat generovane objekty mapy.
void	mapDataToXml (const MapDataT &mapData, QDomElement &rootEl)
	Zkonvertovat data mapy do xml.
void	positionsToXml (const PositionsT &positions, QDomElement &parentEl, const QString &positionElTagName)
	Zkonvertovat umisteni objektu do xml.
Třídy
struct	_MapObjectS
	Objekt mapy pro ulozeni. ...
struct	MapDataT
	Data mapy pro ulozeni. ...