V-Gears 0
Free Final Fantasy VII engine.
VGears::BackgroundFileManager Class Reference

A manager for background files. More...

#include <VGearsBackgroundFileManager.h>

Inheritance diagram for VGears::BackgroundFileManager:
Collaboration diagram for VGears::BackgroundFileManager:

Public Member Functions

 BackgroundFileManager ()
 Constructor. More...
 
virtual ~BackgroundFileManager ()
 Destructor. More...
 

Static Public Member Functions

static BackgroundFileManagerGetSingleton ()
 Retrieves a singleton to the manager. More...
 
static BackgroundFileManagerGetSingletonPtr ()
 Retrieves a pointer to the manager singleton. More...
 

Protected Member Functions

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)
 Loads the manager. More...
 

Detailed Description

A manager for background files.

Constructor & Destructor Documentation

◆ BackgroundFileManager()

VGears::BackgroundFileManager::BackgroundFileManager ( )

Constructor.

◆ ~BackgroundFileManager()

VGears::BackgroundFileManager::~BackgroundFileManager ( )
virtual

Destructor.

Member Function Documentation

◆ createImpl()

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

Loads the manager.

Parameters
[in]nameThe unique name of the manager.
[in]handle
Todo:
Understand and document.
Parameters
[in]groupThe name of the resource group to which this resource belong.
[in]is_manualTrue if the resource is manually loaded, false otherwise.
[in]loaderPointer 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_paramsUnused.

◆ GetSingleton()

BackgroundFileManager & VGears::BackgroundFileManager::GetSingleton ( )
static

Retrieves a singleton to the manager.

◆ GetSingletonPtr()

BackgroundFileManager * VGears::BackgroundFileManager::GetSingletonPtr ( )
static

Retrieves a pointer to the manager singleton.


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