Handles background XML files. More...

#include <XmlBackground2DFile.h>

Inheritance diagram for XmlBackground2DFile:

Collaboration diagram for XmlBackground2DFile:

Public Member Functions
	XmlBackground2DFile (const Ogre::String &file)
	Constructor. More...

virtual	~XmlBackground2DFile ()
	Destructor. More...

void	Load ()
	Reads the XML file set on construction and loads the data. 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 background XML files.

Constructor & Destructor Documentation

◆ XmlBackground2DFile()

XmlBackground2DFile::XmlBackground2DFile ( const Ogre::String & file )

Constructor.

Parameters

[in] file Path to the file with the background data.

◆ ~XmlBackground2DFile()

XmlBackground2DFile::~XmlBackground2DFile ( )

virtual

Destructor.

Member Function Documentation

◆ Load()

void XmlBackground2DFile::Load ( )

Reads the XML file set on construction and loads the data.

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

src/core/XmlBackground2DFile.h
src/core/XmlBackground2DFile.cpp