V-Gears 0
Free Final Fantasy VII engine.
Public Member Functions | List of all members
XmlMapFile Class Reference

Handles XML map files. More...

#include <XmlMapFile.h>

Inheritance diagram for XmlMapFile:
Inheritance graph
[legend]
Collaboration diagram for XmlMapFile:
Collaboration graph
[legend]

Public Member Functions

 XmlMapFile (const Ogre::String &file)
 Constructor. More...
 
virtual ~XmlMapFile ()
 Destructor. More...
 
void LoadMap ()
 Parses the file and loads the map data. More...
 
const Ogre::String GetWalkmeshFileName ()
 Retrieves the path to the map walkmesh file. More...
 
- Public Member Functions inherited from XmlFile
 XmlFile (const Ogre::String &file)
 Constructor. More...
 
virtual ~XmlFile ()
 Destructor. More...
 
bool GetBool (TiXmlNode *node, const Ogre::String &tag, bool def=false) const
 Retrieves a boolean from an XMl tag. More...
 
int GetInt (TiXmlNode *node, const Ogre::String &tag, int def=0) const
 Retrieves an integer from an XMl tag. More...
 
float GetFloat (TiXmlNode *node, const Ogre::String &tag, float def=0.0f) const
 Retrieves a defcimal from an XMl tag. More...
 
const Ogre::String GetString (TiXmlNode *node, const Ogre::String &tag, const Ogre::String &def="") const
 Retrieves a string from an XMl tag. More...
 
const Ogre::UTFString GetUTFString (TiXmlNode *node, const Ogre::String &tag, const Ogre::UTFString &def="") const
 Retrieves a string from an XMl tag. More...
 
const Ogre::Vector2 GetVector2 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Vector2 &def=Ogre::Vector2::ZERO) const
 Retrieves a 2-dimensional vector from an XMl tag. More...
 
const Ogre::Vector3 GetVector3 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Vector3 &def=Ogre::Vector3::ZERO) const
 Retrieves a 3-dimensional vector from an XMl tag. More...
 
const Ogre::Vector4 GetVector4 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Vector4 &def=Ogre::Vector4::ZERO) const
 Retrieves a 4-dimensional vector from an XMl tag. More...
 
const Ogre::Matrix4 GetMatrix4 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Matrix4 &def=Ogre::Matrix4::IDENTITY) const
 Retrieves a 4-dimensional matrix from an XMl tag. More...
 
const Ogre::Quaternion GetQuaternion (TiXmlNode *node, const Ogre::String &tag, const Ogre::Quaternion &def=Ogre::Quaternion::IDENTITY) const
 Retrieves a quaternion from an XMl tag. More...
 
const Ogre::ColourValue GetColourValue (TiXmlNode *node, const Ogre::String &tag, const Ogre::ColourValue &def=Ogre::ColourValue::ZERO) const
 Retrieves a colour from an XMl tag. More...
 

Additional Inherited Members

- Protected Attributes inherited from XmlFile
bool normal_file_
 Indicates if the file is a normal file. More...
 
TiXmlDocument file_
 The XML file. More...
 

Detailed Description

Handles XML map files.

Constructor & Destructor Documentation

◆ XmlMapFile()

XmlMapFile::XmlMapFile ( const Ogre::String &  file)
explicit

Constructor.

Parameters
[in]filePath to the XML map file.

◆ ~XmlMapFile()

XmlMapFile::~XmlMapFile ( )
virtual

Destructor.

Member Function Documentation

◆ GetWalkmeshFileName()

const Ogre::String XmlMapFile::GetWalkmeshFileName ( )

Retrieves the path to the map walkmesh file.

Returns
The path to the map walkmesh file. If there is no walkmesh associated to the map, an error message will be written to console and an empty string will be returned.

◆ LoadMap()

void XmlMapFile::LoadMap ( )

Parses the file and loads the map data.

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