Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::OverlayManager Class Reference

Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...

#include <OgreOverlayManager.h>

Inheritance diagram for Ogre::OverlayManager:

Ogre::ResourceManager Ogre::Singleton< OverlayManager > Ogre::TargetManager List of all members.

Public Methods

 OverlayManager ()
virtual ~OverlayManager ()
void parseOverlayFile (DataChunk &chunk)
 Parses an overlay file passed as a chunk. More...

void parseAllSources (const String &extension=".overlay")
 Parses all overlay files in resource folders & archives. More...

virtual Resourcecreate (const String &name)
 Create implementation required by ResourceManager. More...

void _queueOverlaysForRendering (Camera *cam, RenderQueue *pQueue, Viewport *vp)
 Internal method for queueing the visible overlays for rendering. More...

bool hasViewportChanged (void)
 Method for determining if the viewport has changed dimensions. More...

int getViewportHeight (void)
 Gets the height of the destination viewport in pixels. More...

int getViewportWidth (void)
 Gets the width of the destination viewport in pixels. More...

PositionTargetgetPositionTargetAt (Real x, Real y)
 This returns a PositionTarget at position x,y. More...

void setCursorGui (GuiContainer *cursor, MouseMotionListener *cursorListener)
 register the cursor GUI implementation with the manager. More...

GuiContainergetCursorGui ()
 returns the registered cursor GUI. More...

void createCursorOverlay ()
 create the high cursor level overlay and add the registered Cursor GUI implementation to it. More...

virtual void setMemoryBudget (size_t bytes)
 Set a limit on the amount of memory this resource handler may use. More...

virtual void load (Resource *res, int priority)
 Load a resource. More...

virtual void unload (Resource *res)
 Unloads a Resource from the managed resources list, calling it's unload() method. More...

virtual void unloadAndDestroyAll (void)
 Unloads all Resources from memory. More...

virtual ResourcegetByName (const String &name)
 Retrieves a pointer to a resource by name. More...

void addSearchPath (const String &path)
 Adds a relative path to search for resources of this type. More...

void addArchiveEx (const String &strName, const String &strDriverName)
 Adds an archive to the search path for this type of resource. More...

bool _findResourceData (const String &filename, DataChunk &refChunk)
 Internal method, used for locating resource data in the file system / archives. More...


Static Public Methods

OverlayManager & getSingleton (void)
 Override standard Singleton retrieval. More...

void addCommonSearchPath (const String &path)
 Adds a relative search path for resources of ALL types. More...

void addCommonArchiveEx (const String &strName, const String &strDriverName)
 Adds an archive to the search path for all resources. More...

std::set< String_getAllCommonNamesLike (const String &startPath, const String &extension)
 Returns a collection of files with the given extension in the common resource paths. More...

bool _findCommonResourceData (const String &filename, DataChunk &refChunk)
 Internal method, used for locating common resource data in the file system / archives. More...

OverlayManager * getSingletonPtr (void)

Protected Types

typedef HashMap< String, ArchiveEx *,
_StringHash
FileMap

Protected Methods

void parseNewElement (DataChunk &chunk, String &elemType, String &elemName, bool isContainer, Overlay *pOverlay, bool isTemplate, String templateName=String(""), GuiContainer *container=0)
void parseAttrib (const String &line, Overlay *pOverlay)
void parseElementAttrib (const String &line, Overlay *pOverlay, GuiElement *pElement)
void parseNewMesh (DataChunk &chunk, String &meshName, String &entityName, Overlay *pOverlay)
void skipToNextCloseBrace (DataChunk &chunk)
void skipToNextOpenBrace (DataChunk &chunk)
bool parseChildren (DataChunk &chunk, const String &line, Overlay *pOverlay, bool isTemplate, GuiContainer *parent=NULL)
void checkUsage (void)
 Checks memory usage and pages out if required. More...


Protected Attributes

GuiContainermCursorGuiRegistered
MouseMotionListenermCursorListener
OverlaymCursorLevelOverlay
int mLastViewportWidth
int mLastViewportHeight
bool mViewportDimensionsChanged
FileMap mArchiveFiles
ResourceMap mResources
size_t mMemoryBudget
size_t mMemoryUsage
std::vector< ArchiveEx * > mVFS
 Collection of searchable ArchiveEx classes (virtual file system) for this resource type. More...


Static Protected Attributes

FileMap mCommonArchiveFiles
std::vector< ArchiveEx * > mCommonVFS
 Collection of searchable ArchiveEx classes (virtual file system) for all resource types. More...

OverlayManager * ms_Singleton = 0

Detailed Description

Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them.


Member Typedef Documentation

typedef HashMap< String, ArchiveEx *, _StringHash > Ogre::ResourceManager::FileMap [protected, inherited]
 


Constructor & Destructor Documentation

Ogre::OverlayManager::OverlayManager  
 

Ogre::OverlayManager::~OverlayManager   [virtual]
 


Member Function Documentation

bool Ogre::ResourceManager::_findCommonResourceData const String   filename,
DataChunk   refChunk
[static, inherited]
 

Internal method, used for locating common resource data in the file system / archives.

Remarks:
This is a static version of _findResourceData specifically designed to only search in the common resource archives, and is therefore usable from non-ResourceManager subclasses.
Parameters:
filename  File to find
refChunk  Reference to a DataChunk object to fill with the data from the file
Returns:
On success, true is returned

On failiure, false is returned

bool Ogre::ResourceManager::_findResourceData const String   filename,
DataChunk   refChunk
[inherited]
 

Internal method, used for locating resource data in the file system / archives.

Parameters:
filename  File to find
refChunk  Reference to a DataChunk object to fill with the data from the file
Returns:
On success, true is returned

On failiure, false is returnec

std::set< String > Ogre::ResourceManager::_getAllCommonNamesLike const String   startPath,
const String   extension
[static, inherited]
 

Returns a collection of files with the given extension in the common resource paths.

Remarks:
This is a convenience method to allow non-subclasses to search for files in the common paths.
Parameters:
startPath  The path, relative to each common resource start, to search in (use "./" for the root)
extension  The extension of file to search for.
Returns:
A set of String filenames (it is a set because duplicates will be ignored)

void Ogre::OverlayManager::_queueOverlaysForRendering Camera   cam,
RenderQueue   pQueue,
Viewport   vp
 

Internal method for queueing the visible overlays for rendering.

void Ogre::ResourceManager::addArchiveEx const String   strName,
const String   strDriverName
[inherited]
 

Adds an archive to the search path for this type of resource.

Remarks:
Ogre can load resources from archives. This method adds the named archive to the search path for the type of resource managed by the specific resource manager. Archives are not searched for themselves so a complete path must be specified here (or relative to the current path). Archives take precedence over files in the filesystem.

void Ogre::ResourceManager::addCommonArchiveEx const String   strName,
const String   strDriverName
[static, inherited]
 

Adds an archive to the search path for all resources.

Remarks:
As ResourceManager::addArchive, except this archive is used for all types of resources, not just the type managed by the resource manager in question.

void Ogre::ResourceManager::addCommonSearchPath const String   path [static, inherited]
 

Adds a relative search path for resources of ALL types.

This method has the same effect as ResourceManager::addSearchPath, except that the path added applies to ALL resources, not just the one managed by the subclass in question.

void Ogre::ResourceManager::addSearchPath const String   path [inherited]
 

Adds a relative path to search for resources of this type.

Remarks:
This method adds the supplied path to the list of relative locations that that will be searched for a single type of resource only. Each subclass of ResourceManager will maintain it's own list of specific subpaths, which it will append to the current path as it searches for matching files.

void Ogre::ResourceManager::checkUsage void    [protected, inherited]
 

Checks memory usage and pages out if required.

Resource * Ogre::OverlayManager::create const String   name [virtual]
 

Create implementation required by ResourceManager.

Implements Ogre::ResourceManager.

void Ogre::OverlayManager::createCursorOverlay  
 

create the high cursor level overlay and add the registered Cursor GUI implementation to it.

Resource * Ogre::ResourceManager::getByName const String   name [virtual, inherited]
 

Retrieves a pointer to a resource by name.

GuiContainer * Ogre::OverlayManager::getCursorGui  
 

returns the registered cursor GUI.

PositionTarget * Ogre::OverlayManager::getPositionTargetAt Real    x,
Real    y
[virtual]
 

This returns a PositionTarget at position x,y.

Implements Ogre::TargetManager.

OverlayManager & Ogre::OverlayManager::getSingleton void    [static]
 

Override standard Singleton retrieval.

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< OverlayManager >.

OverlayManager* Ogre::Singleton< OverlayManager >::getSingletonPtr void    [inline, static, inherited]
 

int Ogre::OverlayManager::getViewportHeight void   
 

Gets the height of the destination viewport in pixels.

int Ogre::OverlayManager::getViewportWidth void   
 

Gets the width of the destination viewport in pixels.

bool Ogre::OverlayManager::hasViewportChanged void   
 

Method for determining if the viewport has changed dimensions.

Remarks:
This is used by pixel-based GuiElements to work out if they need to reclaculate their sizes.

void Ogre::ResourceManager::load Resource   res,
int    priority
[virtual, inherited]
 

Load a resource.

Resources will be subclasses.

Reimplemented in Ogre::TextureManager.

void Ogre::OverlayManager::parseAllSources const String   extension = ".overlay"
 

Parses all overlay files in resource folders & archives.

void Ogre::OverlayManager::parseAttrib const String   line,
Overlay   pOverlay
[protected]
 

bool Ogre::OverlayManager::parseChildren DataChunk   chunk,
const String   line,
Overlay   pOverlay,
bool    isTemplate,
GuiContainer   parent = NULL
[protected]
 

void Ogre::OverlayManager::parseElementAttrib const String   line,
Overlay   pOverlay,
GuiElement   pElement
[protected]
 

void Ogre::OverlayManager::parseNewElement DataChunk   chunk,
String   elemType,
String   elemName,
bool    isContainer,
Overlay   pOverlay,
bool    isTemplate,
String    templateName = String(""),
GuiContainer   container = 0
[protected]
 

void Ogre::OverlayManager::parseNewMesh DataChunk   chunk,
String   meshName,
String   entityName,
Overlay   pOverlay
[protected]
 

void Ogre::OverlayManager::parseOverlayFile DataChunk   chunk
 

Parses an overlay file passed as a chunk.

void Ogre::OverlayManager::setCursorGui GuiContainer   cursor,
MouseMotionListener   cursorListener
 

register the cursor GUI implementation with the manager.

void Ogre::ResourceManager::setMemoryBudget size_t    bytes [virtual, inherited]
 

Set a limit on the amount of memory this resource handler may use.

Remarks:
If, when asked to load a new resource, the manager believes it will exceed this memory budget, it will temporarily unload a resource to make room for the new one. This unloading is not permanent and the Resource is not destroyed; it simply needs to be reloaded when next used.

void Ogre::OverlayManager::skipToNextCloseBrace DataChunk   chunk [protected]
 

void Ogre::OverlayManager::skipToNextOpenBrace DataChunk   chunk [protected]
 

void Ogre::ResourceManager::unload Resource   res [virtual, inherited]
 

Unloads a Resource from the managed resources list, calling it's unload() method.

Remarks:
This method removes a resource from the list maintained by this manager, and unloads it from memory. It does NOT destroy the resource itself, although the memory used by it will be largely freed up. This would allow you to reload the resource again if you wished.

Permanently destroying the resource is, as mentioned in ResourceManager::create, the library user's responsibility.

void Ogre::ResourceManager::unloadAndDestroyAll void    [virtual, inherited]
 

Unloads all Resources from memory.

Remarks:
Note that unlike ResourceManager::unload, Resource objects are DESTROYED as well as unloaded. This is because you are unlikely to be managing the deletion of the objects individually in this case.

Reimplemented in Ogre::D3D8TextureManager.


Member Data Documentation

FileMap Ogre::ResourceManager::mArchiveFiles [protected, inherited]
 

ResourceManager::FileMap Ogre::ResourceManager::mCommonArchiveFiles [static, protected, inherited]
 

std::vector< ArchiveEx * > Ogre::ResourceManager::mCommonVFS [static, protected, inherited]
 

Collection of searchable ArchiveEx classes (virtual file system) for all resource types.

GuiContainer* Ogre::OverlayManager::mCursorGuiRegistered [protected]
 

Overlay* Ogre::OverlayManager::mCursorLevelOverlay [protected]
 

MouseMotionListener* Ogre::OverlayManager::mCursorListener [protected]
 

int Ogre::OverlayManager::mLastViewportHeight [protected]
 

int Ogre::OverlayManager::mLastViewportWidth [protected]
 

size_t Ogre::ResourceManager::mMemoryBudget [protected, inherited]
 

size_t Ogre::ResourceManager::mMemoryUsage [protected, inherited]
 

ResourceMap Ogre::ResourceManager::mResources [protected, inherited]
 

OverlayManager * Ogre::Singleton< OverlayManager >::ms_Singleton = 0 [static, protected, inherited]
 

std::vector<ArchiveEx*> Ogre::ResourceManager::mVFS [protected, inherited]
 

Collection of searchable ArchiveEx classes (virtual file system) for this resource type.

bool Ogre::OverlayManager::mViewportDimensionsChanged [protected]
 

Copyright © 2002 by The OGRE Team