Ogre::MeshManager Class Reference
Core » Resources

Handles the management of mesh resources. More...

`#include <OgreMeshManager.h>`

Inheritance diagram for Ogre::MeshManager:
[legend]

## Classes

struct | MeshBuildParams
| Saved parameters used to (re)build a manual mesh built by this class. More...

## Public Types

typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap
typedef HashMap< String, ResourcePtr > | ResourceMap
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap

## Public Member Functions

| MeshManager ()
| ~MeshManager ()
void | _initialise (void)
| Initialises the manager, only to be called by OGRE internally. More...
virtual void | _notifyResourceLoaded (Resource *res)
| Notify this manager that a resource which it manages has been loaded. More...
virtual void | _notifyResourceTouched (Resource *res)
| Notify this manager that a resource which it manages has been 'touched', i.e. More...
virtual void | _notifyResourceUnloaded (Resource *res)
| Notify this manager that a resource which it manages has been unloaded. More...
MeshPtr | create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
| Create a new mesh. More...

PatchMeshPtr

createBezierPatch (const String &name, const String &groupName, void *controlPointBuffer, VertexDeclaration *declaration, size_t width, size_t height, size_t uMaxSubdivisionLevel=PatchSurface::AUTO_LEVEL, size_t vMaxSubdivisionLevel=PatchSurface::AUTO_LEVEL, PatchSurface::VisibleSide visibleSide=PatchSurface::VS_FRONT, HardwareBuffer::Usage vbUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage ibUsage=HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY, bool vbUseShadow=true, bool ibUseShadow=true)

| Creates a Bezier patch based on an array of control vertices. More...

MeshPtr

createCurvedIllusionPlane (const String &name, const String &groupName, const Plane &plane, Real width, Real height, Real curvature, int xsegments=1, int ysegments=1, bool normals=true, unsigned short numTexCoordSets=1, Real uTile=1.0f, Real vTile=1.0f, const Vector3 &upVector=Vector3::UNIT_Y, const Quaternion &orientation=Quaternion::IDENTITY, HardwareBuffer::Usage vertexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool vertexShadowBuffer=true, bool indexShadowBuffer=true, int ySegmentsToKeep=-1)

| Creates a plane, which because of it's texture coordinates looks like a curved surface, useful for skies in a skybox. More...

MeshPtr

createCurvedPlane (const String &name, const String &groupName, const Plane &plane, Real width, Real height, Real bow=0.5f, int xsegments=1, int ysegments=1, bool normals=false, unsigned short numTexCoordSets=1, Real uTile=1.0f, Real vTile=1.0f, const Vector3 &upVector=Vector3::UNIT_Y, HardwareBuffer::Usage vertexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool vertexShadowBuffer=true, bool indexShadowBuffer=true)

| Creates a genuinely curved plane, by default majoring on the x/y axes facing positive Z. More...
MeshPtr | createManual (const String &name, const String &groupName, ManualResourceLoader *loader=0)
| Creates a new Mesh specifically for manual definition rather than loading from an object file. More...
ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *params=0, HardwareBuffer::Usage vertexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool vertexBufferShadowed=true, bool indexBufferShadowed=true)
| Create a new mesh, or retrieve an existing one with the same name if it already exists. More...
virtual ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
| Create a new resource, or retrieve an existing one with the same name if it already exists. More...

MeshPtr

createPlane (const String &name, const String &groupName, const Plane &plane, Real width, Real height, int xsegments=1, int ysegments=1, bool normals=true, unsigned short numTexCoordSets=1, Real uTile=1.0f, Real vTile=1.0f, const Vector3 &upVector=Vector3::UNIT_Y, HardwareBuffer::Usage vertexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool vertexShadowBuffer=true, bool indexShadowBuffer=true)

| Creates a basic plane, by default majoring on the x/y axes facing positive Z. More...
virtual ResourcePtr | createResource (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
| Creates a new blank resource, but does not immediately load it. More...
void | destroyAllResourcePools ()
| destroy all pools More...
void | destroyResourcePool (ResourcePool *pool)
| Destroy a resource pool. More...
void | destroyResourcePool (const String &name)
| Destroy a resource pool. More...
Real | getBoundsPaddingFactor (void)
| Gets the factor by which the bounding box of an entity is padded. More...
virtual ResourcePtr | getByHandle (ResourceHandle handle)
| Retrieves a pointer to a resource by handle, or null if the resource does not exist. More...
MeshPtr | getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Get a resource by name. More...
MeshSerializerListener * | getListener ()
| Gets the listener used to control mesh loading through the serializer. More...
virtual Real | getLoadingOrder (void) const
| Gets the relative loading order of resources of this type. More...
virtual size_t | getMemoryBudget (void) const
| Get the limit on the amount of memory this resource handler may use. More...
virtual size_t | getMemoryUsage (void) const
| Gets the current memory usage, in bytes. More...
bool | getPrepareAllMeshesForShadowVolumes (void)
| Retrieves whether all Meshes should prepare themselves for shadow volumes. More...
virtual ResourcePtr | getResourceByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Retrieves a pointer to a resource by name, or null if the resource does not exist. More...
ResourceMapIterator | getResourceIterator (void)
| Returns an iterator over all resources in this manager. More...
ResourcePool * | getResourcePool (const String &name)
| Create a resource pool, or reuse one that already exists. More...
const String & | getResourceType (void) const
| Gets a string identifying the type of resource this manager handles. More...
virtual const StringVector & | getScriptPatterns (void) const
| Gets the file patterns which should be used to find scripts for this ResourceManager. More...
virtual bool | getVerbose (void)
| Gets whether this manager and its resources habitually produce log output. More...
MeshPtr | load (const String &filename, const String &groupName, HardwareBuffer::Usage vertexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool vertexBufferShadowed=true, bool indexBufferShadowed=true)
| Loads a mesh from a file, making it immediately available for use. More...
virtual ResourcePtr | load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
| Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters). More...
void | loadResource (Resource *res)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
virtual void | parseScript (DataStreamPtr &stream, const String &groupName)
| Parse the definition of a set of resources from a script file. More...
MeshPtr | prepare (const String &filename, const String &groupName, HardwareBuffer::Usage vertexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool vertexBufferShadowed=true, bool indexBufferShadowed=true)
| Prepares a mesh for loading from a file. More...
virtual ResourcePtr | prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
| Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters). More...
virtual void | prepareResource (Resource *resource)
| Called when a resource wishes to load. More...
virtual void | reloadAll (bool reloadableOnly=true)
| Caused all currently loaded resources to be reloaded. More...
virtual void | reloadUnreferencedResources (bool reloadableOnly=true)
| Caused all currently loaded but not referenced by any other object resources to be reloaded. More...
virtual void | remove (ResourcePtr &r)
| Remove a single resource. More...
virtual void | remove (const String &name)
| Remove a single resource by name. More...
virtual void | remove (ResourceHandle handle)
| Remove a single resource by handle. More...
virtual void | removeAll (void)
| Removes all resources. More...
virtual void | removeUnreferencedResources (bool reloadableOnly=true)
| Remove all resources which are not referenced by any other object. More...
virtual bool | resourceExists (const String &name)
| Returns whether the named resource exists in this manager. More...
virtual bool | resourceExists (ResourceHandle handle)
| Returns whether a resource with the given handle exists in this manager. More...
void | setBoundsPaddingFactor (Real paddingFactor)
| Sets the factor by which the bounding box of an entity is padded. More...
void | setListener (MeshSerializerListener *listener)
| Sets the listener used to control mesh loading through the serializer. More...
virtual void | setMemoryBudget (size_t bytes)
| Set a limit on the amount of memory this resource handler may use. More...
void | setPrepareAllMeshesForShadowVolumes (bool enable)
| Tells the mesh manager that all future meshes should prepare themselves for shadow volumes on loading. More...
virtual void | setVerbose (bool v)
| Sets whether this manager and its resources habitually produce log output. More...
virtual void | unload (const String &name)
| Unloads a single resource by name. More...
virtual void | unload (ResourceHandle handle)
| Unloads a single resource by handle. More...
virtual void | unloadAll (bool reloadableOnly=true)
| Unloads all resources. More...
virtual void | unloadUnreferencedResources (bool reloadableOnly=true)
| Unload all resources which are not referenced by any other object. More...

## Static Public Member Functions

static MeshManager & | getSingleton (void)
| Override standard Singleton retrieval. More...
static MeshManager * | getSingletonPtr (void)
| Override standard Singleton retrieval. More...

## Public Attributes

| OGRE_AUTO_MUTEX

## Protected Types

typedef map< Resource *, MeshBuildParams >::type | MeshBuildParamsMap
| Map from resource pointer to parameter set. More...
enum | MeshBuildType { MBT_PLANE, MBT_CURVED_ILLUSION_PLANE, MBT_CURVED_PLANE }
| Enum identifying the types of manual mesh built by this manager. More...
typedef map< String, ResourcePool * >::type | ResourcePoolMap

## Protected Member Functions

virtual void | addImpl (ResourcePtr &res)
| Add a newly created resource to the manager (note weak reference) More...
virtual void | checkUsage (void)
| Checks memory usage and pages out if required. More...
Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams)
| Create a new resource instance compatible with this manager (no custom parameters are populated at this point). More...
void | createPrefabCube (void)
void | createPrefabPlane (void)
void | createPrefabSphere (void)
ResourceHandle | getNextHandle (void)
| Allocates the next handle. More...
void | loadManualCurvedIllusionPlane (Mesh *pMesh, MeshBuildParams &params)
| Utility method for manual loading a curved illusion plane. More...
void | loadManualCurvedPlane (Mesh *pMesh, MeshBuildParams &params)
| Utility method for manual loading a curved plane. More...
void | loadManualPlane (Mesh *pMesh, MeshBuildParams &params)
| Utility method for manual loading a plane. More...
virtual void | removeImpl (ResourcePtr &res)
| Remove a resource from this manager; remove it from the lists. More...
void | tesselate2DMesh (SubMesh *pSub, unsigned short meshWidth, unsigned short meshHeight, bool doubleSided=false, HardwareBuffer::Usage indexBufferUsage=HardwareBuffer::HBU_STATIC_WRITE_ONLY, bool indexSysMem=false)
| Utility method for tessellating 2D meshes. More...

## Protected Attributes

Real | mBoundsPaddingFactor
MeshSerializerListener * | mListener
Real | mLoadOrder
| Loading order relative to other managers, higher is later. More...
size_t | mMemoryBudget
AtomicScalar< size_t > | mMemoryUsage
MeshBuildParamsMap | mMeshBuildParams
AtomicScalar< ResourceHandle > | mNextHandle
| In bytes. More...
bool | mPrepAllMeshesForShadowVolumes
ResourcePoolMap | mResourcePoolMap
ResourceMap | mResources
ResourceHandleMap | mResourcesByHandle
ResourceWithGroupMap | mResourcesWithGroup
String | mResourceType
| String identifying the resource type this manager handles. More...
StringVector | mScriptPatterns
| Patterns to use to look for scripts if supported (e.g. *.overlay) More...
bool | mVerbose
| In bytes. More...

## Static Protected Attributes

static MeshManager * | msSingleton

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

Definition at line 58 of file OgreMeshManager.h.

## Member Typedef Documentation

## MeshBuildParamsMap

typedef map<Resource*, MeshBuildParams>::type Ogre::MeshManager::MeshBuildParamsMap

protected

Map from resource pointer to parameter set.

Definition at line 485 of file OgreMeshManager.h.

## ResourceCreateOrRetrieveResult

typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult

inherited

Definition at line 152 of file OgreResourceManager.h.

## ResourceHandleMap

typedef map<ResourceHandle, ResourcePtr>::type Ogre::ResourceManager::ResourceHandleMap

inherited

Definition at line 543 of file OgreResourceManager.h.

## ResourceMap

typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap

inherited

Definition at line 541 of file OgreResourceManager.h.

## ResourceMapIterator

typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator

inherited

Definition at line 564 of file OgreResourceManager.h.

## ResourcePoolMap

typedef map<String, ResourcePool*>::type Ogre::ResourceManager::ResourcePoolMap

protected inherited

Definition at line 575 of file OgreResourceManager.h.

## ResourceWithGroupMap

typedef HashMap< String, ResourceMap > Ogre::ResourceManager::ResourceWithGroupMap

inherited

Definition at line 542 of file OgreResourceManager.h.

## Member Enumeration Documentation

## MeshBuildType

enum Ogre::MeshManager::MeshBuildType

protected

Enum identifying the types of manual mesh built by this manager.

Enumerator
MBT_PLANE |
MBT_CURVED_ILLUSION_PLANE |
MBT_CURVED_PLANE |

Definition at line 456 of file OgreMeshManager.h.

## Constructor & Destructor Documentation

## MeshManager()

Ogre::MeshManager::MeshManager | ( |  | ) |

## ~MeshManager()

Ogre::MeshManager::~MeshManager | ( |  | ) |

## Member Function Documentation

## _initialise()

void Ogre::MeshManager::_initialise | ( | void |  | ) |

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

## _notifyResourceLoaded()

virtual void Ogre::ResourceManager::_notifyResourceLoaded | ( | Resource * | res | ) |

virtual inherited

Notify this manager that a resource which it manages has been loaded.

## _notifyResourceTouched()

virtual void Ogre::ResourceManager::_notifyResourceTouched | ( | Resource * | res | ) |

virtual inherited

Notify this manager that a resource which it manages has been 'touched', i.e.

used.

## _notifyResourceUnloaded()

virtual void Ogre::ResourceManager::_notifyResourceUnloaded | ( | Resource * | res | ) |

virtual inherited

Notify this manager that a resource which it manages has been unloaded.

## addImpl()

virtual void Ogre::ResourceManager::addImpl | ( | ResourcePtr & | res | ) |

protected virtual inherited

Add a newly created resource to the manager (note weak reference)

## checkUsage()

virtual void Ogre::ResourceManager::checkUsage | ( | void |  | ) |

protected virtual inherited

Checks memory usage and pages out if required.

This is automatically done after a new resource is loaded.

## create()

MeshPtr Ogre::MeshManager::create | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  |

Create a new mesh.

See also
  ResourceManager::createResource

## createBezierPatch()

PatchMeshPtr Ogre::MeshManager::createBezierPatch | ( | const String & | name,
|  | const String & | groupName,
|  | void * | controlPointBuffer,
|  | VertexDeclaration * | declaration,
|  | size_t | width,
|  | size_t | height,
|  | size_t | uMaxSubdivisionLevel = `PatchSurface::AUTO_LEVEL`,
|  | size_t | vMaxSubdivisionLevel = `PatchSurface::AUTO_LEVEL`,
|  | PatchSurface::VisibleSide | visibleSide = `PatchSurface::VS_FRONT`,
|  | HardwareBuffer::Usage | vbUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | ibUsage = `HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY`,
|  | bool | vbUseShadow = `true`,
|  | bool | ibUseShadow = `true`
| ) |  |

Creates a Bezier patch based on an array of control vertices.

Parameters

  name | The name to give the newly created mesh.
  groupName | The name of the resource group to assign the mesh to
  controlPointBuffer | A pointer to a buffer containing the vertex data which defines control points of the curves rather than actual vertices. Note that you are expected to provide not just position information, but potentially normals and texture coordinates too. The format of the buffer is defined in the VertexDeclaration parameter
  declaration | VertexDeclaration describing the contents of the buffer. Note this declaration must only draw on buffer source 0!
  width | Specifies the width of the patch in control points. Note this parameter must greater than or equal to 3.
  height | Specifies the height of the patch in control points. Note this parameter must greater than or equal to 3.
  uMaxSubdivisionLevel,vMaxSubdivisionLevel | If you want to manually set the top level of subdivision, do it here, otherwise let the system decide.
  visibleSide | Determines which side of the patch (or both) triangles are generated for.
  vbUsage | Vertex buffer usage flags. Recommend the default since vertex buffer should be static.
  ibUsage | Index buffer usage flags. Recommend the default since index buffer should be dynamic to change levels but not readable.
  vbUseShadow | Flag to determine if a shadow buffer is generated for the vertex buffer. See HardwareBuffer for full details.
  ibUseShadow | Flag to determine if a shadow buffer is generated for the index buffer. See HardwareBuffer for full details.

## createCurvedIllusionPlane()

MeshPtr Ogre::MeshManager::createCurvedIllusionPlane | ( | const String & | name,
|  | const String & | groupName,
|  | const Plane & | plane,
|  | Real | width,
|  | Real | height,
|  | Real | curvature,
|  | int | xsegments = `1`,
|  | int | ysegments = `1`,
|  | bool | normals = `true`,
|  | unsigned short | numTexCoordSets = `1`,
|  | Real | uTile = `1.0f`,
|  | Real | vTile = `1.0f`,
|  | const Vector3 & | upVector = `Vector3::UNIT_Y`,
|  | const Quaternion & | orientation = `Quaternion::IDENTITY`,
|  | HardwareBuffer::Usage | vertexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | vertexShadowBuffer = `true`,
|  | bool | indexShadowBuffer = `true`,
|  | int | ySegmentsToKeep = `-1`
| ) |  |

Creates a plane, which because of it's texture coordinates looks like a curved surface, useful for skies in a skybox.

Parameters

  name | The name to give the resulting mesh
  groupName | The name of the resource group to assign the mesh to
  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
  curvature | The curvature of the plane. Good values are between 2 and 65. Higher values are more curved leading to a smoother effect, lower values are less curved meaning more distortion at the horizons but a better distance effect.
  xsegments | The number of segments to the plane in the x direction
  ysegments | The number of segments 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.
  orientation | The orientation of the overall sphere that's used to create the illusion
  vertexBufferUsage | The usage flag with which the vertex buffer for this plane will be created
  indexBufferUsage | The usage flag with which the index buffer for this plane will be created
  vertexShadowBuffer | If this flag is set to true, the vertex buffer will be created with a system memory shadow buffer, allowing you to read it back more efficiently than if it is in hardware
  indexShadowBuffer | If this flag is set to true, the index buffer will be created with a system memory shadow buffer, allowing you to read it back more efficiently than if it is in hardware
  ySegmentsToKeep | The number of segments from the top of the dome downwards to keep. -1 keeps all of them. This can save fillrate if you cannot see much of the sky lower down.

## createCurvedPlane()

MeshPtr Ogre::MeshManager::createCurvedPlane | ( | const String & | name,
|  | const String & | groupName,
|  | const Plane & | plane,
|  | Real | width,
|  | Real | height,
|  | Real | bow = `0.5f`,
|  | int | xsegments = `1`,
|  | int | ysegments = `1`,
|  | bool | normals = `false`,
|  | unsigned short | numTexCoordSets = `1`,
|  | Real | uTile = `1.0f`,
|  | Real | vTile = `1.0f`,
|  | const Vector3 & | upVector = `Vector3::UNIT_Y`,
|  | HardwareBuffer::Usage | vertexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | vertexShadowBuffer = `true`,
|  | bool | indexShadowBuffer = `true`
| ) |  |

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

Parameters

  name | The name to give the resulting mesh
  groupName | The name of the resource group to assign the mesh to
  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 considered the depth.)
  xsegments | The number of segments to the plane in the x direction
  ysegments | The number of segments 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.
  vertexBufferUsage | The usage flag with which the vertex buffer for this plane will be created
  indexBufferUsage | The usage flag with which the index buffer for this plane will be created
  vertexShadowBuffer | If this flag is set to true, the vertex buffer will be created with a system memory shadow buffer, allowing you to read it back more efficiently than if it is in hardware
  indexShadowBuffer | If this flag is set to true, the index buffer will be created with a system memory shadow buffer, allowing you to read it back more efficiently than if it is in hardware

## createImpl()

Resource* Ogre::MeshManager::createImpl | ( | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual,
|  | ManualResourceLoader * | loader,
|  | const NameValuePairList * | createParams
| ) |  |

protected virtual

Create a new resource instance compatible with this manager (no custom parameters are populated at this point).

Remarks
  Subclasses must override this method and create a subclass of Resource.

Parameters

  name | The unique name of the resource
  group | The name of the resource group to attach this new resource to
  isManual | Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required.
  loader | Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended.
  createParams | If any parameters are required to create an instance, they should be supplied here as name / value pairs. These do not need to be set on the instance (handled elsewhere), just used if required to differentiate which concrete class is created.

Implements Ogre::ResourceManager.

## createManual()

MeshPtr Ogre::MeshManager::createManual | ( | const String & | name,
|  | const String & | groupName,
|  | ManualResourceLoader * | loader = `0`
| ) |  |

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::_setBounds and Mesh::_setBoundingRadius in order to define the bounds of your mesh. In previous versions of OGRE you could call Mesh::_updateBounds, but OGRE's support of write-only vertex buffers makes this no longer appropriate.

Parameters

  name | The name to give the new mesh
  groupName | The name of the resource group to assign the mesh to
  loader | ManualResourceLoader which will be called to load this mesh when the time comes. It is recommended that you populate this field in order that the mesh can be rebuilt should the need arise

## createOrRetrieve() [1/2]

ResourceCreateOrRetrieveResult Ogre::MeshManager::createOrRetrieve | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | params = `0`,
|  | HardwareBuffer::Usage | vertexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | vertexBufferShadowed = `true`,
|  | bool | indexBufferShadowed = `true`
| ) |  |

Create a new mesh, or retrieve an existing one with the same name if it already exists.

Parameters

  vertexBufferUsage | The usage flags with which the vertex buffer(s) will be created
  indexBufferUsage | The usage flags with which the index buffer(s) created for this mesh will be created with.
  vertexBufferShadowed | If true, the vertex buffers will be shadowed by system memory copies for faster read access
  indexBufferShadowed | If true, the index buffers will be shadowed by system memory copies for faster read access

See also
  ResourceManager::createOrRetrieve

## createOrRetrieve() [2/2]

virtual ResourceCreateOrRetrieveResult Ogre::ResourceManager::createOrRetrieve | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  |

virtual inherited

Create a new resource, or retrieve an existing one with the same name if it already exists.

Remarks
  This method performs the same task as calling getByName() followed by create() if that returns null. The advantage is that it does it in one call so there are no race conditions if using multiple threads that could cause getByName() to return null, but create() to fail because another thread created a resource in between.

See also
  ResourceManager::createResource
  ResourceManager::getResourceByName

Returns
  A pair, the first element being the pointer, and the second being an indicator specifying whether the resource was newly created.

## createPlane()

MeshPtr Ogre::MeshManager::createPlane | ( | const String & | name,
|  | const String & | groupName,
|  | const Plane & | plane,
|  | Real | width,
|  | Real | height,
|  | int | xsegments = `1`,
|  | int | ysegments = `1`,
|  | bool | normals = `true`,
|  | unsigned short | numTexCoordSets = `1`,
|  | Real | uTile = `1.0f`,
|  | Real | vTile = `1.0f`,
|  | const Vector3 & | upVector = `Vector3::UNIT_Y`,
|  | HardwareBuffer::Usage | vertexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | vertexShadowBuffer = `true`,
|  | bool | indexShadowBuffer = `true`
| ) |  |

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

Parameters

  name | The name to give the resulting mesh
  groupName | The name of the resource group to assign the mesh to
  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 segments to the plane in the x direction
  ysegments | The number of segments 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 texture coordinates.
  vertexBufferUsage | The usage flag with which the vertex buffer for this plane will be created
  indexBufferUsage | The usage flag with which the index buffer for this plane will be created
  vertexShadowBuffer | If this flag is set to true, the vertex buffer will be created with a system memory shadow buffer, allowing you to read it back more efficiently than if it is in hardware
  indexShadowBuffer | If this flag is set to true, the index buffer will be created with a system memory shadow buffer, allowing you to read it back more efficiently than if it is in hardware

## createPrefabCube()

void Ogre::MeshManager::createPrefabCube | ( | void |  | ) |

protected

## createPrefabPlane()

void Ogre::MeshManager::createPrefabPlane | ( | void |  | ) |

protected

## createPrefabSphere()

void Ogre::MeshManager::createPrefabSphere | ( | void |  | ) |

protected

## createResource()

virtual ResourcePtr Ogre::ResourceManager::createResource | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  |

virtual inherited

Creates a new blank resource, but does not immediately load it.

Remarks
  Resource managers handle disparate types of resources, so if you want to get at the detailed interface of this resource, you'll have to cast the result to the subclass you know you're creating.

Parameters

  name | The unique name of the resource
  group | The name of the resource group to attach this new resource to
  isManual | Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required.
  loader | Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended.
  createParams | If any parameters are required to create an instance, they should be supplied here as name / value pairs

## destroyAllResourcePools()

void Ogre::ResourceManager::destroyAllResourcePools | ( |  | ) |

inherited

destroy all pools

## destroyResourcePool() [1/2]

void Ogre::ResourceManager::destroyResourcePool | ( | ResourcePool * | pool | ) |

inherited

Destroy a resource pool.

## destroyResourcePool() [2/2]

void Ogre::ResourceManager::destroyResourcePool | ( | const String & | name | ) |

inherited

Destroy a resource pool.

## getBoundsPaddingFactor()

Real Ogre::MeshManager::getBoundsPaddingFactor | ( | void |  | ) |

Gets the factor by which the bounding box of an entity is padded.

Default is 0.01

## getByHandle()

virtual ResourcePtr Ogre::ResourceManager::getByHandle | ( | ResourceHandle | handle | ) |

virtual inherited

Retrieves a pointer to a resource by handle, or null if the resource does not exist.

## getByName()

MeshPtr Ogre::MeshManager::getByName | ( | const String & | name,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
| ) |  |

Get a resource by name.

See also
  ResourceManager::getResourceByName

## getListener()

MeshSerializerListener* Ogre::MeshManager::getListener | ( |  | ) |

Gets the listener used to control mesh loading through the serializer.

## getLoadingOrder()

virtual Real Ogre::ResourceManager::getLoadingOrder | ( | void |  | ) | const

virtual inherited

Gets the relative loading order of resources of this type.

Remarks
  There are dependencies between some kinds of resource in terms of loading order, and this value enumerates that. Higher values load later during bulk loading tasks.

Implements Ogre::ScriptLoader.

Definition at line 461 of file OgreResourceManager.h.

## getMemoryBudget()

virtual size_t Ogre::ResourceManager::getMemoryBudget | ( | void |  | ) | const

virtual inherited

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

## getMemoryUsage()

virtual size_t Ogre::ResourceManager::getMemoryUsage | ( | void |  | ) | const

virtual inherited

Gets the current memory usage, in bytes.

Definition at line 185 of file OgreResourceManager.h.

References Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME.

## getNextHandle()

ResourceHandle Ogre::ResourceManager::getNextHandle | ( | void |  | ) |

protected inherited

Allocates the next handle.

## getPrepareAllMeshesForShadowVolumes()

bool Ogre::MeshManager::getPrepareAllMeshesForShadowVolumes | ( | void |  | ) |

Retrieves whether all Meshes should prepare themselves for shadow volumes.

## getResourceByName()

virtual ResourcePtr Ogre::ResourceManager::getResourceByName | ( | const String & | name,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
| ) |  |

virtual inherited

Retrieves a pointer to a resource by name, or null if the resource does not exist.

## getResourceIterator()

ResourceMapIterator Ogre::ResourceManager::getResourceIterator | ( | void |  | ) |

inherited

Returns an iterator over all resources in this manager.

Note
  Use of this iterator is NOT thread safe!

Definition at line 569 of file OgreResourceManager.h.

## getResourcePool()

ResourcePool* Ogre::ResourceManager::getResourcePool | ( | const String & | name | ) |

inherited

Create a resource pool, or reuse one that already exists.

## getResourceType()

const String& Ogre::ResourceManager::getResourceType | ( | void |  | ) | const

inherited

Gets a string identifying the type of resource this manager handles.

Definition at line 464 of file OgreResourceManager.h.

## getScriptPatterns()

virtual const StringVector& Ogre::ResourceManager::getScriptPatterns | ( | void |  | ) | const

virtual inherited

Gets the file patterns which should be used to find scripts for this ResourceManager.

Remarks
  Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

  This method lets you determine the file pattern which will be used to identify scripts intended for this manager.

Returns
  A list of file patterns, in the order they should be searched in.

See also
  isScriptingSupported, parseScript

Implements Ogre::ScriptLoader.

Definition at line 437 of file OgreResourceManager.h.

## getSingleton()

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

## getSingletonPtr()

static MeshManager* Ogre::MeshManager::getSingletonPtr | ( | 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.

## getVerbose()

virtual bool Ogre::ResourceManager::getVerbose | ( | void |  | ) |

virtual inherited

Gets whether this manager and its resources habitually produce log output.

Definition at line 470 of file OgreResourceManager.h.

## load() [1/2]

MeshPtr Ogre::MeshManager::load | ( | const String & | filename,
|  | const String & | groupName,
|  | HardwareBuffer::Usage | vertexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | vertexBufferShadowed = `true`,
|  | bool | indexBufferShadowed = `true`
| ) |  |

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

Note
  If the model has already been created (prepared or 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).

Parameters

  filename | The name of the .mesh file
  groupName | The name of the resource group to assign the mesh to
  vertexBufferUsage | The usage flags with which the vertex buffer(s) will be created
  indexBufferUsage | The usage flags with which the index buffer(s) created for this mesh will be created with.
  vertexBufferShadowed | If true, the vertex buffers will be shadowed by system memory copies for faster read access
  indexBufferShadowed | If true, the index buffers will be shadowed by system memory copies for faster read access

## load() [2/2]

virtual ResourcePtr Ogre::ResourceManager::load | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  |

virtual inherited

Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters).

Parameters

  name | The name of the Resource
  group | The resource group to which this resource will belong
  isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter
  loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter
  loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource.
  backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread

## loadManualCurvedIllusionPlane()

void Ogre::MeshManager::loadManualCurvedIllusionPlane | ( | Mesh * | pMesh,
|  | MeshBuildParams & | params
| ) |  |

protected

Utility method for manual loading a curved illusion plane.

## loadManualCurvedPlane()

void Ogre::MeshManager::loadManualCurvedPlane | ( | Mesh * | pMesh,
|  | MeshBuildParams & | params
| ) |  |

protected

Utility method for manual loading a curved plane.

## loadManualPlane()

void Ogre::MeshManager::loadManualPlane | ( | Mesh * | pMesh,
|  | MeshBuildParams & | params
| ) |  |

protected

Utility method for manual loading a plane.

## loadResource()

void Ogre::MeshManager::loadResource | ( | Resource * | res | ) |

virtual

See also
  ManualResourceLoader::loadResource

Implements Ogre::ManualResourceLoader.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## parseScript()

virtual void Ogre::ResourceManager::parseScript | ( | DataStreamPtr & | stream,
|  | const String & | groupName
| ) |  |

virtual inherited

Parse the definition of a set of resources from a script file.

Remarks
  Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

Parameters

  stream | Weak reference to a data stream which is the source of the script
  groupName | The name of the resource group that resources which are parsed are to become a member of. If this group is loaded or unloaded, then the resources discovered in this script will be loaded / unloaded with it.

Implements Ogre::ScriptLoader.

Reimplemented in Ogre::MaterialManager, Ogre::CompositorManager, and Ogre::FontManager.

Definition at line 452 of file OgreResourceManager.h.

## prepare() [1/2]

MeshPtr Ogre::MeshManager::prepare | ( | const String & | filename,
|  | const String & | groupName,
|  | HardwareBuffer::Usage | vertexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | vertexBufferShadowed = `true`,
|  | bool | indexBufferShadowed = `true`
| ) |  |

Prepares a mesh for loading from a file.

This does the IO in advance of the call to load().

Note
  If the model has already been created (prepared or 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).

Parameters

  filename | The name of the .mesh file
  groupName | The name of the resource group to assign the mesh to
  vertexBufferUsage | The usage flags with which the vertex buffer(s) will be created
  indexBufferUsage | The usage flags with which the index buffer(s) created for this mesh will be created with.
  vertexBufferShadowed | If true, the vertex buffers will be shadowed by system memory copies for faster read access
  indexBufferShadowed | If true, the index buffers will be shadowed by system memory copies for faster read access

## prepare() [2/2]

virtual ResourcePtr Ogre::ResourceManager::prepare | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  |

virtual inherited

Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters).

Parameters

  name | The name of the Resource
  group | The resource group to which this resource will belong
  isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter
  loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter
  loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource.
  backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread

## prepareResource()

virtual void Ogre::ManualResourceLoader::prepareResource | ( | Resource * | resource | ) |

virtual inherited

Called when a resource wishes to load.

Note that this could get called in a background thread even in just a semithreaded ogre (OGRE_THREAD_SUPPORT==2). Thus, you must not access the rendersystem from this callback. Do that stuff in loadResource.

Parameters

  resource | The resource which wishes to load

Definition at line 526 of file OgreResource.h.

## reloadAll()

virtual void Ogre::ResourceManager::reloadAll | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Caused all currently loaded resources to be reloaded.

Remarks
  All resources currently being held in this manager which are also marked as currently loaded will be unloaded, then loaded again.

Parameters

  reloadableOnly | If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also
  Resource::isReloadable for resource is reloadable.

## reloadUnreferencedResources()

virtual void Ogre::ResourceManager::reloadUnreferencedResources | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Caused all currently loaded but not referenced by any other object resources to be reloaded.

Remarks
  This method behaves like reloadAll, except that it only reloads resources which are not in use, i.e. not referenced by other objects.

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of reloadAll allows you avoid fail in those situations.

Parameters

  reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded.

## remove() [1/3]

virtual void Ogre::ResourceManager::remove | ( | ResourcePtr & | r | ) |

virtual inherited

Remove a single resource.

Remarks
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

## remove() [2/3]

virtual void Ogre::ResourceManager::remove | ( | const String & | name | ) |

virtual inherited

Remove a single resource by name.

Remarks
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

## remove() [3/3]

virtual void Ogre::ResourceManager::remove | ( | ResourceHandle | handle | ) |

virtual inherited

Remove a single resource by handle.

Remarks
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

## removeAll()

virtual void Ogre::ResourceManager::removeAll | ( | void |  | ) |

virtual inherited

Removes all resources.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to these resources, they will persist until they have been finished with; however to all intents and purposes the resources no longer exist and will get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

Reimplemented in Ogre::CompositorManager.

## removeImpl()

virtual void Ogre::ResourceManager::removeImpl | ( | ResourcePtr & | res | ) |

protected virtual inherited

Remove a resource from this manager; remove it from the lists.

## removeUnreferencedResources()

virtual void Ogre::ResourceManager::removeUnreferencedResources | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Remove all resources which are not referenced by any other object.

Remarks
  This method behaves like removeAll, except that it only removes resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, remove or reload that resource will cause dangerous pointer access. Use this function instead of removeAll allows you avoid fail in those situations.

Parameters

  reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded.

## resourceExists() [1/2]

virtual bool Ogre::ResourceManager::resourceExists | ( | const String & | name | ) |

virtual inherited

Returns whether the named resource exists in this manager.

Definition at line 357 of file OgreResourceManager.h.

References Ogre::SharedPtr< T >::isNull().

## resourceExists() [2/2]

virtual bool Ogre::ResourceManager::resourceExists | ( | ResourceHandle | handle | ) |

virtual inherited

Returns whether a resource with the given handle exists in this manager.

Definition at line 362 of file OgreResourceManager.h.

References Ogre::SharedPtr< T >::isNull().

## setBoundsPaddingFactor()

void Ogre::MeshManager::setBoundsPaddingFactor | ( | Real | paddingFactor | ) |

Sets the factor by which the bounding box of an entity is padded.

## setListener()

void Ogre::MeshManager::setListener | ( | MeshSerializerListener * | listener | ) |

Sets the listener used to control mesh loading through the serializer.

## setMemoryBudget()

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

## setPrepareAllMeshesForShadowVolumes()

void Ogre::MeshManager::setPrepareAllMeshesForShadowVolumes | ( | bool | enable | ) |

Tells the mesh manager that all future meshes should prepare themselves for shadow volumes on loading.

## setVerbose()

virtual void Ogre::ResourceManager::setVerbose | ( | bool | v | ) |

virtual inherited

Sets whether this manager and its resources habitually produce log output.

Definition at line 467 of file OgreResourceManager.h.

## tesselate2DMesh()

void Ogre::MeshManager::tesselate2DMesh | ( | SubMesh * | pSub,
|  | unsigned short | meshWidth,
|  | unsigned short | meshHeight,
|  | bool | doubleSided = `false`,
|  | HardwareBuffer::Usage | indexBufferUsage = `HardwareBuffer::HBU_STATIC_WRITE_ONLY`,
|  | bool | indexSysMem = `false`
| ) |  |

protected

Utility method for tessellating 2D meshes.

## unload() [1/2]

virtual void Ogre::ResourceManager::unload | ( | const String & | name | ) |

virtual inherited

Unloads a single resource by name.

Remarks
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also
  ResourceGroupManager for unloading of resource groups.

## unload() [2/2]

virtual void Ogre::ResourceManager::unload | ( | ResourceHandle | handle | ) |

virtual inherited

Unloads a single resource by handle.

Remarks
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also
  ResourceGroupManager for unloading of resource groups.

## unloadAll()

virtual void Ogre::ResourceManager::unloadAll | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Unloads all resources.

Remarks
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also
  ResourceGroupManager for unloading of resource groups.

Parameters

  reloadableOnly | If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also
  Resource::isReloadable for resource is reloadable.

## unloadUnreferencedResources()

virtual void Ogre::ResourceManager::unloadUnreferencedResources | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Unload all resources which are not referenced by any other object.

Remarks
  This method behaves like unloadAll, except that it only unloads resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of unloadAll allows you avoid fail in those situations.

Parameters

  reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded.

## Member Data Documentation

## mBoundsPaddingFactor

Real Ogre::MeshManager::mBoundsPaddingFactor

protected

Definition at line 498 of file OgreMeshManager.h.

## mListener

MeshSerializerListener* Ogre::MeshManager::mListener

protected

Definition at line 501 of file OgreMeshManager.h.

## mLoadOrder

Real Ogre::ResourceManager::mLoadOrder

protected inherited

Loading order relative to other managers, higher is later.

Definition at line 559 of file OgreResourceManager.h.

## mMemoryBudget

size_t Ogre::ResourceManager::mMemoryBudget

protected inherited

Definition at line 548 of file OgreResourceManager.h.

## mMemoryUsage

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage

protected inherited

Definition at line 550 of file OgreResourceManager.h.

## mMeshBuildParams

MeshBuildParamsMap Ogre::MeshManager::mMeshBuildParams

protected

Definition at line 486 of file OgreMeshManager.h.

## mNextHandle

AtomicScalar<ResourceHandle> Ogre::ResourceManager::mNextHandle

protected inherited

In bytes.

Definition at line 549 of file OgreResourceManager.h.

## mPrepAllMeshesForShadowVolumes

bool Ogre::MeshManager::mPrepAllMeshesForShadowVolumes

protected

Definition at line 495 of file OgreMeshManager.h.

## mResourcePoolMap

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap

protected inherited

Definition at line 576 of file OgreResourceManager.h.

## mResources

ResourceMap Ogre::ResourceManager::mResources

protected inherited

Definition at line 546 of file OgreResourceManager.h.

## mResourcesByHandle

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle

protected inherited

Definition at line 545 of file OgreResourceManager.h.

## mResourcesWithGroup

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup

protected inherited

Definition at line 547 of file OgreResourceManager.h.

## mResourceType

String Ogre::ResourceManager::mResourceType

protected inherited

String identifying the resource type this manager handles.

Definition at line 561 of file OgreResourceManager.h.

## mScriptPatterns

StringVector Ogre::ResourceManager::mScriptPatterns

protected inherited

Patterns to use to look for scripts if supported (e.g. *.overlay)

Definition at line 557 of file OgreResourceManager.h.

## msSingleton

MeshManager * Ogre::Singleton< MeshManager >::msSingleton

static protected inherited

Definition at line 75 of file OgreSingleton.h.

## mVerbose

bool Ogre::ResourceManager::mVerbose

protected inherited

In bytes.

Definition at line 552 of file OgreResourceManager.h.

## OGRE_AUTO_MUTEX

Ogre::ResourceManager::OGRE_AUTO_MUTEX

inherited

Definition at line 125 of file OgreResourceManager.h.

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

- OgreMeshManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.