Handles the management of mesh resources. More...
#include <OgreMeshManager.h>
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... | |
virtual ResourcePtr | create (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... | |
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 xTile=1.0f, Real yTile=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... | |
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... | |
virtual ResourcePtr | getByName (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... | |
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... | |
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... | |
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 ¶ms) |
Utility method for manual loading a curved illusion plane. More... | |
void | loadManualCurvedPlane (Mesh *pMesh, MeshBuildParams ¶ms) |
Utility method for manual loading a curved plane. More... | |
void | loadManualPlane (Mesh *pMesh, MeshBuildParams ¶ms) |
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 |
ResourceHandle | mNextHandle |
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 |
Static Protected Attributes | |
static MeshManager * | msSingleton |
Handles the management of mesh resources.
Definition at line 57 of file OgreMeshManager.h.
|
protected |
Map from resource pointer to parameter set.
Definition at line 473 of file OgreMeshManager.h.
|
inherited |
Definition at line 104 of file OgreResourceManager.h.
|
inherited |
Definition at line 495 of file OgreResourceManager.h.
|
inherited |
Definition at line 493 of file OgreResourceManager.h.
|
inherited |
Definition at line 516 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 527 of file OgreResourceManager.h.
|
inherited |
Definition at line 494 of file OgreResourceManager.h.
|
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 444 of file OgreMeshManager.h.
Ogre::MeshManager::MeshManager | ( | ) |
Ogre::MeshManager::~MeshManager | ( | ) |
void Ogre::MeshManager::_initialise | ( | void | ) |
Initialises the manager, only to be called by OGRE internally.
|
virtualinherited |
Notify this manager that a resource which it manages has been loaded.
|
virtualinherited |
Notify this manager that a resource which it manages has been 'touched', i.e.
used.
|
virtualinherited |
Notify this manager that a resource which it manages has been unloaded.
|
protectedvirtualinherited |
Add a newly created resource to the manager (note weak reference)
|
protectedvirtualinherited |
Checks memory usage and pages out if required.
|
virtualinherited |
Creates a new blank resource, but does not immediately load it.
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 |
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.
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. |
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.
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. |
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 | xTile = 1.0f , |
||
Real | yTile = 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.
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 |
|
protectedvirtual |
Create a new resource instance compatible with this manager (no custom parameters are populated at this point).
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.
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.
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 |
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.
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 |
|
virtualinherited |
Create a new resource, or retrieve an existing one with the same name if it already exists.
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.
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 |
|
protected |
|
protected |
|
protected |
|
inherited |
destroy all pools
|
inherited |
Destroy a resource pool.
|
inherited |
Destroy a resource pool.
Real Ogre::MeshManager::getBoundsPaddingFactor | ( | void | ) |
Gets the factor by which the bounding box of an entity is padded.
Default is 0.01
|
virtualinherited |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
virtualinherited |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
MeshSerializerListener* Ogre::MeshManager::getListener | ( | ) |
Gets the listener used to control mesh loading through the serializer.
|
inlinevirtualinherited |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
Definition at line 413 of file OgreResourceManager.h.
|
virtualinherited |
Get the limit on the amount of memory this resource handler may use.
|
inlinevirtualinherited |
Gets the current memory usage, in bytes.
Definition at line 137 of file OgreResourceManager.h.
|
protectedinherited |
Allocates the next handle.
bool Ogre::MeshManager::getPrepareAllMeshesForShadowVolumes | ( | void | ) |
Retrieves whether all Meshes should prepare themselves for shadow volumes.
|
inlineinherited |
Returns an iterator over all resources in this manager.
Definition at line 521 of file OgreResourceManager.h.
|
inherited |
Create a resource pool, or reuse one that already exists.
|
inlineinherited |
Gets a string identifying the type of resource this manager handles.
Definition at line 416 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
Definition at line 389 of file OgreResourceManager.h.
|
static |
Override standard Singleton retrieval.
|
static |
Override standard Singleton retrieval.
|
inlinevirtualinherited |
Gets whether this manager and its resources habitually produce log output.
Definition at line 422 of file OgreResourceManager.h.
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.
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 |
|
virtualinherited |
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).
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 |
|
protected |
Utility method for manual loading a curved illusion plane.
|
protected |
Utility method for manual loading a curved plane.
|
protected |
Utility method for manual loading a plane.
|
virtual |
Implements Ogre::ManualResourceLoader.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Parse the definition of a set of resources from a script file.
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 404 of file OgreResourceManager.h.
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().
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 |
|
virtualinherited |
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).
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 |
|
inlinevirtualinherited |
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.
resource | The resource which wishes to load |
Definition at line 525 of file OgreResource.h.
|
virtualinherited |
Caused all currently loaded resources to be reloaded.
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. |
|
virtualinherited |
Caused all currently loaded but not referenced by any other object resources to be reloaded.
reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded. |
|
virtualinherited |
Remove a single resource.
|
virtualinherited |
Remove a single resource by name.
|
virtualinherited |
Remove a single resource by handle.
|
virtualinherited |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
protectedvirtualinherited |
Remove a resource from this manager; remove it from the lists.
|
virtualinherited |
Remove all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded. |
|
inlinevirtualinherited |
Returns whether the named resource exists in this manager.
Definition at line 309 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Returns whether a resource with the given handle exists in this manager.
Definition at line 314 of file OgreResourceManager.h.
void Ogre::MeshManager::setBoundsPaddingFactor | ( | Real | paddingFactor | ) |
Sets the factor by which the bounding box of an entity is padded.
void Ogre::MeshManager::setListener | ( | MeshSerializerListener * | listener | ) |
Sets the listener used to control mesh loading through the serializer.
|
virtualinherited |
Set a limit on the amount of memory this resource handler may use.
void Ogre::MeshManager::setPrepareAllMeshesForShadowVolumes | ( | bool | enable | ) |
Tells the mesh manager that all future meshes should prepare themselves for shadow volumes on loading.
|
inlinevirtualinherited |
Sets whether this manager and its resources habitually produce log output.
Definition at line 419 of file OgreResourceManager.h.
|
protected |
Utility method for tessellating 2D meshes.
|
virtualinherited |
Unloads a single resource by name.
|
virtualinherited |
Unloads a single resource by handle.
|
virtualinherited |
Unloads all resources.
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. |
|
virtualinherited |
Unload all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded. |
|
protected |
Definition at line 486 of file OgreMeshManager.h.
|
protected |
Definition at line 489 of file OgreMeshManager.h.
|
protectedinherited |
Loading order relative to other managers, higher is later.
Definition at line 511 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 501 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 502 of file OgreResourceManager.h.
|
protected |
Definition at line 474 of file OgreMeshManager.h.
|
protectedinherited |
Definition at line 500 of file OgreResourceManager.h.
|
protected |
Definition at line 483 of file OgreMeshManager.h.
|
protectedinherited |
Definition at line 528 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 498 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 497 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 499 of file OgreResourceManager.h.
|
protectedinherited |
String identifying the resource type this manager handles.
Definition at line 513 of file OgreResourceManager.h.
|
protectedinherited |
Patterns to use to look for scripts if supported (e.g. *.overlay)
Definition at line 509 of file OgreResourceManager.h.
|
staticprotectedinherited |
Definition at line 75 of file OgreSingleton.h.
|
protectedinherited |
Definition at line 504 of file OgreResourceManager.h.