Ogre::ResourceGroupListener Class Reference

This abstract class defines an interface which is called back during resource group loading to indicate the progress of the load. More...

#include <OgreResourceGroupManager.h>

Public Member Functions
virtual	~ResourceGroupListener ()
virtual void	resourceCreated (const ResourcePtr &resource)
	This event is fired when a resource was just created. More...
virtual void	resourceGroupLoadEnded (const String &groupName)=0
	This event is fired when a resource group finished loading. More...
virtual void	resourceGroupLoadStarted (const String &groupName, size_t resourceCount)=0
	This event is fired when a resource group begins loading. More...
virtual void	resourceGroupPrepareEnded (const String &groupName)
	This event is fired when a resource group finished preparing. More...
virtual void	resourceGroupPrepareStarted (const String &groupName, size_t resourceCount)
	This event is fired when a resource group begins preparing. More...
virtual void	resourceGroupScriptingEnded (const String &groupName)=0
	This event is fired when a resource group finished parsing scripts. More...
virtual void	resourceGroupScriptingStarted (const String &groupName, size_t scriptCount)=0
	This event is fired when a resource group begins parsing scripts. More...
virtual void	resourceLoadEnded ()=0
	This event is fired when the resource has been loaded. More...
virtual void	resourceLoadStarted (const ResourcePtr &resource)=0
	This event is fired when a declared resource is about to be loaded. More...
virtual void	resourcePrepareEnded ()
	This event is fired when the resource has been prepared. More...
virtual void	resourcePrepareStarted (const ResourcePtr &resource)
	This event is fired when a declared resource is about to be prepared. More...
virtual void	resourceRemove (const ResourcePtr &resource)
	This event is fired when a resource is about to be removed. More...
virtual void	scriptParseEnded (const String &scriptName, bool skipped)=0
	This event is fired when the script has been fully parsed. More...
virtual void	scriptParseStarted (const String &scriptName, bool &skipThisScript)=0
	This event is fired when a script is about to be parsed. More...

Detailed Description

This abstract class defines an interface which is called back during resource group loading to indicate the progress of the load.

Remarks

Resource group loading is in 2 phases - creating resources from declarations (which includes parsing scripts), and loading resources. Note that you don't necessarily have to have both; it is quite possible to just parse all the scripts for a group (see ResourceGroupManager::initialiseResourceGroup, but not to load the resource group. The sequence of events is (* signifies a repeating item):

• resourceGroupScriptingStarted
• scriptParseStarted (*)
• scriptParseEnded (*)
• resourceGroupScriptingEnded
• resourceGroupLoadStarted
• resourceLoadStarted (*)
• resourceLoadEnded (*)
• resourceGroupLoadEnded
• resourceGroupPrepareStarted
• resourcePrepareStarted (*)
• resourcePrepareEnded (*)
• resourceGroupPrepareEnded

Note

If OGRE_THREAD_SUPPORT is 1, this class is thread-safe.

Constructor & Destructor Documentation

~ResourceGroupListener()

virtual Ogre::ResourceGroupListener::~ResourceGroupListener ( )

virtual

Member Function Documentation

resourceCreated()

virtual void Ogre::ResourceGroupListener::resourceCreated ( const ResourcePtr &  resource )

inlinevirtual

This event is fired when a resource was just created.

Parameters

resource

Weak reference to the resource created.

resourceGroupLoadEnded()

virtual void Ogre::ResourceGroupListener::resourceGroupLoadEnded ( const String &  groupName )

pure virtual

This event is fired when a resource group finished loading.

resourceGroupLoadStarted()

virtual void Ogre::ResourceGroupListener::resourceGroupLoadStarted ( const String &  groupName, size_t  resourceCount  )

pure virtual

This event is fired when a resource group begins loading.

Parameters

groupName	The name of the group being loaded
resourceCount	The number of resources which will be loaded, including a number of stages required to load any linked world geometry

resourceGroupPrepareEnded()

virtual void Ogre::ResourceGroupListener::resourceGroupPrepareEnded ( const String &  groupName )

inlinevirtual

This event is fired when a resource group finished preparing.

resourceGroupPrepareStarted()

virtual void Ogre::ResourceGroupListener::resourceGroupPrepareStarted ( const String &  groupName, size_t  resourceCount  )

inlinevirtual

This event is fired when a resource group begins preparing.

Parameters

groupName	The name of the group being prepared
resourceCount	The number of resources which will be prepared, including a number of stages required to prepare any linked world geometry

resourceGroupScriptingEnded()

virtual void Ogre::ResourceGroupListener::resourceGroupScriptingEnded ( const String &  groupName )

pure virtual

This event is fired when a resource group finished parsing scripts.

resourceGroupScriptingStarted()

virtual void Ogre::ResourceGroupListener::resourceGroupScriptingStarted ( const String &  groupName, size_t  scriptCount  )

pure virtual

This event is fired when a resource group begins parsing scripts.

Note

Remember that if you are loading resources through ResourceBackgroundQueue, these callbacks will occur in the background thread, so you should not perform any thread-unsafe actions in this callback if that's the case (check the group name / script name).

Parameters

groupName	The name of the group
scriptCount	The number of scripts which will be parsed

resourceLoadEnded()

virtual void Ogre::ResourceGroupListener::resourceLoadEnded ( )

pure virtual

This event is fired when the resource has been loaded.

resourceLoadStarted()

virtual void Ogre::ResourceGroupListener::resourceLoadStarted ( const ResourcePtr &  resource )

pure virtual

This event is fired when a declared resource is about to be loaded.

Parameters

resource

Weak reference to the resource loaded.

resourcePrepareEnded()

virtual void Ogre::ResourceGroupListener::resourcePrepareEnded ( )

inlinevirtual

This event is fired when the resource has been prepared.

resourcePrepareStarted()

virtual void Ogre::ResourceGroupListener::resourcePrepareStarted ( const ResourcePtr &  resource )

inlinevirtual

This event is fired when a declared resource is about to be prepared.

Parameters

resource

Weak reference to the resource prepared.

resourceRemove()

virtual void Ogre::ResourceGroupListener::resourceRemove ( const ResourcePtr &  resource )

inlinevirtual

This event is fired when a resource is about to be removed.

Parameters

resource

Weak reference to the resource removed.

scriptParseEnded()

virtual void Ogre::ResourceGroupListener::scriptParseEnded ( const String &  scriptName, bool  skipped  )

pure virtual

This event is fired when the script has been fully parsed.

scriptParseStarted()

virtual void Ogre::ResourceGroupListener::scriptParseStarted ( const String &  scriptName, bool &  skipThisScript  )

pure virtual

This event is fired when a script is about to be parsed.

Parameters

scriptName	Name of the to be parsed
skipThisScript	A boolean passed by reference which is by default set to false. If the event sets this to true, the script will be skipped and not parsed. Note that in this case the scriptParseEnded event will not be raised for this script.

---

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

• OgreResourceGroupManager.h