VGears::HRCFileManager Class Reference

A manager for HRC files. More...

#include <VGearsHRCFileManager.h>

Inheritance diagram for VGears::HRCFileManager:

Collaboration diagram for VGears::HRCFileManager:

Public Member Functions
	HRCFileManager ()
	Constructor. More...
virtual	~HRCFileManager ()
	Destructor. More...
virtual void	ParseScript (Ogre::DataStreamPtr &stream, const String &group_name)
	Parses a HRC script and creates a skeleton. More...

Static Public Member Functions
static HRCFileManager &	GetSingleton ()
	Retrieves a singleton to the manager. More...
static HRCFileManager *	GetSingletonPtr ()
	Retrieves a pointer to the manager singleton. More...

Protected Member Functions
virtual Ogre::Resource *	createImpl (const Ogre::String &name, Ogre::ResourceHandle handle, const Ogre::String &group, bool is_manual, Ogre::ManualResourceLoader *loader, const Ogre::NameValuePairList *create_params) override final
	Loads the manager. More...

Detailed Description

A manager for HRC files.

Constructor & Destructor Documentation

HRCFileManager()

VGears::HRCFileManager::HRCFileManager

(

)

Constructor.

~HRCFileManager()

VGears::HRCFileManager::~HRCFileManager ( )

virtual

Destructor.

Member Function Documentation

createImpl()

Ogre::Resource * VGears::HRCFileManager::createImpl ( const Ogre::String &  name, Ogre::ResourceHandle  handle, const Ogre::String &  group, bool  is_manual, Ogre::ManualResourceLoader *  loader, const Ogre::NameValuePairList *  create_params  )

finaloverrideprotectedvirtual

Loads the manager.

Parameters

[in]	name	The unique name of the manager.
[in]	handle

Todo:

Understand and document.

Parameters

[in]	group	The name of the resource group to which this resource belong.
[in]	is_manual	True if the resource is manually loaded, false otherwise.
[in]	loader	Pointer to a ManualResourceLoader implementation which will be called when the Resource wishes to load (should be supplied if is_manual is set to true). It can be null, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualResourceLoader instance is strongly recommended.
[in]	create_params	Unused.

GetSingleton()

HRCFileManager & VGears::HRCFileManager::GetSingleton ( )

static

Retrieves a singleton to the manager.

GetSingletonPtr()

HRCFileManager * VGears::HRCFileManager::GetSingletonPtr ( )

static

Retrieves a pointer to the manager singleton.

ParseScript()

void VGears::HRCFileManager::ParseScript ( Ogre::DataStreamPtr &  stream, const String &  group_name  )

virtual

Parses a HRC script and creates a skeleton.

Parameters

[in]	stream	Script content.
[in]	group_name	GRoup to add the skeleton to.

---

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

• src/data/VGearsHRCFileManager.h
• src/data/VGearsHRCFileManager.cpp