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

Ogre::MeshManager Class Reference

Handles the management of mesh resources. More...

#include <OgreMeshManager.h>

Inheritance diagram for Ogre::MeshManager:

Ogre::ResourceManager Ogre::Singleton< MeshManager > List of all members.

Public Methods

 MeshManager ()
void _initialise (void)
 Initialises the manager, only to be called by OGRE internally. More...

Meshload (const String &filename, int priority=1)
 Loads a mesh from a file, making it available for use. More...

Resourcecreate (const String &name)
 Creates a Mesh resource. More...

MeshcreateManual (const String &name)
 Creates a new Mesh specifically for manual definition rather than loading from an object file. More...

MeshcreatePlane (const String &name, const Plane &plane, Real width, Real height, int xsegments=1, int ysegments=1, bool normals=true, int numTexCoordSets=1, Real uTile=1.0f, Real vTile=1.0f, const Vector3 &upVector=Vector3::UNIT_Y)
 Creates a basic plane, by default majoring on the x/y axes facing positive Z. More...

MeshcreateCurvedPlane (const String &name, const Plane &plane, Real width, Real height, Real bow=0.5f, int xsegments=1, int ysegments=1, bool normals=false, int numTexCoordSets=1, Real xTile=1.0f, Real yTile=1.0f, const Vector3 &upVector=Vector3::UNIT_Y)
 Creates a curved plane, by default majoring on the x/y axes facing positive Z. 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

MeshManager & 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...

MeshManager * getSingletonPtr (void)

Protected Types

typedef HashMap< String, ArchiveEx *,
_StringHash
FileMap

Protected Methods

void tesselate2DMesh (SubMesh *pSub, int meshWidth, int meshHeight, bool doubleSided=false)
 Utility method for tesselating 2D meshes. More...

void checkUsage (void)
 Checks memory usage and pages out if required. More...


Protected Attributes

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...

MeshManager * ms_Singleton = 0

Detailed Description

Handles the management of mesh resources.

Remarks:
This class deals with the runtime management of mesh data; like other resource managers it handles the creation of resources (in this case mesh data), working within a fixed memory budget.


Member Typedef Documentation

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


Constructor & Destructor Documentation

Ogre::MeshManager::MeshManager  
 


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::MeshManager::_initialise void   
 

Initialises the manager, only to be called by OGRE internally.

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::MeshManager::create const String   name [virtual]
 

Creates a Mesh resource.

Note:
Mainly used internally.

Implements Ogre::ResourceManager.

Mesh * Ogre::MeshManager::createCurvedPlane const String   name,
const Plane   plane,
Real    width,
Real    height,
Real    bow = 0.5f,
int    xsegments = 1,
int    ysegments = 1,
bool    normals = false,
int    numTexCoordSets = 1,
Real    xTile = 1.0f,
Real    yTile = 1.0f,
const Vector3   upVector = Vector3::UNIT_Y
 

Creates a curved plane, by default majoring on the x/y axes facing positive Z.

Parameters:
name  The name to give the resulting mesh
plane  The orientation of the plane and distance from the origin
width  The width of the plane in world coordinates
height  The height of the plane in world coordinates
bow  The amount of 'bow' in the curved plane. (Could also be concidered the depth.)
xsegments  The number of segements to the plane in the x direction
ysegments  The number of segements to the plane in the y direction
normals  If true, normals are created perpendicular to the plane
numTexCoordSets  The number of 2D texture coordinate sets created - by default the corners are created to be the corner of the texture.
uTile  The number of times the texture should be repeated in the u direction
vTile  The number of times the texture should be repeated in the v direction
upVector  The 'Up' direction of the plane.

Mesh * Ogre::MeshManager::createManual const String   name
 

Creates a new Mesh specifically for manual definition rather than loading from an object file.

Remarks:
Note that once you've defined your mesh, you must call Mesh::_updateBounds in order to define the bounding box of your mesh.

Mesh * Ogre::MeshManager::createPlane const String   name,
const Plane   plane,
Real    width,
Real    height,
int    xsegments = 1,
int    ysegments = 1,
bool    normals = true,
int    numTexCoordSets = 1,
Real    uTile = 1.0f,
Real    vTile = 1.0f,
const Vector3   upVector = Vector3::UNIT_Y
 

Creates a basic plane, by default majoring on the x/y axes facing positive Z.

Parameters:
name  The name to give the resulting mesh
plane  The orientation of the plane and distance from the origin
width  The width of the plane in world coordinates
height  The height of the plane in world coordinates
xsegments  The number of segements to the plane in the x direction
ysegments  The number of segements to the plane in the y direction
normals  If true, normals are created perpendicular to the plane
numTexCoordSets  The number of 2D texture coordinate sets created - by default the corners are created to be the corner of the texture.
uTile  The number of times the texture should be repeated in the u direction
vTile  The number of times the texture should be repeated in the v direction
upVector  The 'Up' direction of the plane.

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

Retrieves a pointer to a resource by name.

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

Override standard Singleton retrieval.

Remarks:
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< MeshManager >.

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

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

Load a resource.

Resources will be subclasses.

Reimplemented in Ogre::TextureManager.

Mesh * Ogre::MeshManager::load const String   filename,
int    priority = 1
 

Loads a mesh from a file, making it available for use.

Note:
If the model has already been loaded, the existing instance will be returned.
Remarks:
Ogre loads model files from it's own proprietary format called .mesh. This is because having a single file format is better for runtime performance, and we also have control over pre-processed data (such as collision boxes, LOD reductions etc).

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::MeshManager::tesselate2DMesh SubMesh   pSub,
int    meshWidth,
int    meshHeight,
bool    doubleSided = false
[protected]
 

Utility method for tesselating 2D meshes.

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.

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

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

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

MeshManager * Ogre::Singleton< MeshManager >::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.

Copyright © 2002 by The OGRE Team