AaronCameron.net

Because you all make me very, very tired.

• 
• 
• 
• 
• 

Not a Member? - Login or Create an Account

Thursday the 24th of May 2012 @ 02:34am

Front Page Journal Projects Your Profile About

LibN2L N2L Home Older News Downloads Documentation (n2l5) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Documentation (libN2L-4) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Bugtracker Project Page Report a Bug Bug List Related Things Life 2130 Devel Game Journal

LibN2L-4 Library Code Reference Classes Compounds Files Members Method Index Full Reference n2l::cResourceManager Class Reference A caching resource loader which allows the request of files from a vfs root without the development overhead of searching, checking and casting. More... #include <cResourceManager.h> Collaboration diagram for n2l::cResourceManager: [legend]List of all members. Static Public Member Functions static void dataRoot (const cAutoPtr< const cVfsDirectoryInterface > &iDataRoot) Specify a data root to use for loading resource files. static const cAutoPtr< const cVfsDirectoryInterface > & dataRoot () Request the current data root. static const cAutoPtr< const cGuiElement > & getGuiElement (const tString &iName) static const cAutoPtr< const cVfsNodeInterface > & getVfsNode (const tString &iName) template<class TRes> static const cAutoPtr< const TRes > & get (const tString &iName) static void refreshTextures () Reload all textures. static const tUint numReferences (const tString &iName) Get the number of references to the requested file. static const tString getReferenceReport () static void clearAllCache () Remove all auto pointers to cached elements. static void clearUnusedCache () Remove any currently unused resources from the resource managers cache. static void clearCachedResource (const tString &iName) static const tUint aggLoadTime () static void clearAggLoadTime () Classes class cResource Common handle for internally stored resource items. class cResourceSheath A customizable child of cResource to specalize the loading of individual resources. Detailed Description A caching resource loader which allows the request of files from a vfs root without the development overhead of searching, checking and casting. Definition at line 46 of file cResourceManager.h. Member Function Documentation static const tUint n2l::cResourceManager::aggLoadTime (   )  [inline, static]   Definition at line 146 of file cResourceManager.h. static void n2l::cResourceManager::clearAggLoadTime (   )  [inline, static]   Definition at line 147 of file cResourceManager.h. void n2l::cResourceManager::clearAllCache (   )  [static]   Remove all auto pointers to cached elements. Any outstanding Instances of these resources will still be held, but the copy in the resource manager will be removed. Warning: If a resource is still held outside the resource manager, and it is cleared and re-requested the resource manager will have no knowledge of the outstanding copy and will load a new copy. Since this behaviour is generally not wanted it is usually better to call clearUnusedCache() instead, which will retain copies of resources still in use. See also: clearUnusedCache Note: It's usually a good idea to call this method right before you shut down your application and shut down n2l. Definition at line 175 of file cResourceManager.cpp. void n2l::cResourceManager::clearCachedResource (  const tString &  iName  )  [static]   Definition at line 182 of file cResourceManager.cpp. References n2l::n2lDebug(). void n2l::cResourceManager::clearUnusedCache (   )  [static]   Remove any currently unused resources from the resource managers cache. This is a good idea if you want to clean house, but don't want to end up with duplicate copies of resources in memory over time. See also: clearAllCache Definition at line 196 of file cResourceManager.cpp. References n2l::n2lDebug(). const cAutoPtr< const cVfsDirectoryInterface > & n2l::cResourceManager::dataRoot (   )  [static]   Request the current data root. Definition at line 52 of file cResourceManager.cpp. void n2l::cResourceManager::dataRoot (  const cAutoPtr< const cVfsDirectoryInterface > &  iDataRoot  )  [static]   Specify a data root to use for loading resource files. Definition at line 44 of file cResourceManager.cpp. template<class TRes> static const cAutoPtr<const TRes>& n2l::cResourceManager::get (  const tString &  iName  )  [inline, static]   Definition at line 68 of file cResourceManager.h. References n2l::n2lDebug(), n2l::n2lGetTicks(), and n2l::cException::rethrow(). const cAutoPtr< const cGuiElement > & n2l::cResourceManager::getGuiElement (  const tString &  iName  )  [static]   Definition at line 58 of file cResourceManager.cpp. References n2l::cGuiFactory::current(), n2l::cGuiFactory::load(), n2l::n2lDebug(), n2l::n2lGetTicks(), and n2l::cException::rethrow(). Referenced by n2l::cGuiTextDisplay::load(), n2l::cGuiSButtonSelectBox::load(), n2l::cGuiCanvas::load(), and n2l::cGuiButtonSelectBox::load(). const tString n2l::cResourceManager::getReferenceReport (   )  [static]   Definition at line 158 of file cResourceManager.cpp. References n2l::asString(). const cAutoPtr< const cVfsNodeInterface > & n2l::cResourceManager::getVfsNode (  const tString &  iName  )  [static]   Definition at line 92 of file cResourceManager.cpp. References n2l::n2lDebug(), n2l::n2lGetTicks(), and n2l::cException::rethrow(). Referenced by n2l::cGuiSEFactory::load(), and n2l::cGuiACFactory::load(). const tUint n2l::cResourceManager::numReferences (  const tString &  iName  )  [static]   Get the number of references to the requested file. Definition at line 150 of file cResourceManager.cpp. void n2l::cResourceManager::refreshTextures (   )  [static]   Reload all textures. Definition at line 127 of file cResourceManager.cpp. References n2l::n2lDebug(). The documentation for this class was generated from the following files: cResourceManager.h cResourceManager.cpp

©2012 Aaron Cameron