OgreMeshManager.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __MeshManager_H__
29 #define __MeshManager_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreResourceManager.h"
34 #include "OgreSingleton.h"
35 #include "OgreVector3.h"
36 #include "OgreHardwareBuffer.h"
37 #include "OgreMesh.h"
38 #include "OgrePatchMesh.h"
39 #include "OgreHeaderPrefix.h"
40 
41 namespace Ogre {
42 
43  class MeshSerializerListener;
44 
58  class _OgreExport MeshManager: public ResourceManager, public Singleton<MeshManager>,
60  {
61  public:
62  MeshManager();
63  ~MeshManager();
64 
66  void _initialise(void);
67 
70  MeshPtr getByName(const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME);
71 
72 
75  MeshPtr create (const String& name, const String& group,
76  bool isManual = false, ManualResourceLoader* loader = 0,
77  const NameValuePairList* createParams = 0);
78 
91  ResourceCreateOrRetrieveResult createOrRetrieve(
92  const String& name,
93  const String& group,
94  bool isManual=false, ManualResourceLoader* loader=0,
95  const NameValuePairList* params=0,
98  bool vertexBufferShadowed = true, bool indexBufferShadowed = true);
99 
121  MeshPtr prepare( const String& filename, const String& groupName,
124  bool vertexBufferShadowed = true, bool indexBufferShadowed = true);
125 
147  MeshPtr load( const String& filename, const String& groupName,
150  bool vertexBufferShadowed = true, bool indexBufferShadowed = true);
151 
152 
166  MeshPtr createManual( const String& name, const String& groupName,
167  ManualResourceLoader* loader = 0);
168 
208  MeshPtr createPlane(
209  const String& name, const String& groupName, const Plane& plane,
210  Real width, Real height,
211  int xsegments = 1, int ysegments = 1,
212  bool normals = true, unsigned short numTexCoordSets = 1,
213  Real uTile = 1.0f, Real vTile = 1.0f, const Vector3& upVector = Vector3::UNIT_Y,
216  bool vertexShadowBuffer = true, bool indexShadowBuffer = true);
217 
218 
269  MeshPtr createCurvedIllusionPlane(
270  const String& name, const String& groupName, const Plane& plane,
271  Real width, Real height, Real curvature,
272  int xsegments = 1, int ysegments = 1,
273  bool normals = true, unsigned short numTexCoordSets = 1,
274  Real uTile = 1.0f, Real vTile = 1.0f, const Vector3& upVector = Vector3::UNIT_Y,
275  const Quaternion& orientation = Quaternion::IDENTITY,
278  bool vertexShadowBuffer = true, bool indexShadowBuffer = true,
279  int ySegmentsToKeep = -1);
280 
322  MeshPtr createCurvedPlane(
323  const String& name, const String& groupName, const Plane& plane,
324  Real width, Real height, Real bow = 0.5f,
325  int xsegments = 1, int ysegments = 1,
326  bool normals = false, unsigned short numTexCoordSets = 1,
327  Real uTile = 1.0f, Real vTile = 1.0f, const Vector3& upVector = Vector3::UNIT_Y,
330  bool vertexShadowBuffer = true, bool indexShadowBuffer = true);
331 
368  PatchMeshPtr createBezierPatch(
369  const String& name, const String& groupName, void* controlPointBuffer,
370  VertexDeclaration *declaration, size_t width, size_t height,
371  size_t uMaxSubdivisionLevel = PatchSurface::AUTO_LEVEL,
372  size_t vMaxSubdivisionLevel = PatchSurface::AUTO_LEVEL,
376  bool vbUseShadow = true, bool ibUseShadow = true);
377 
381  void setPrepareAllMeshesForShadowVolumes(bool enable);
383  bool getPrepareAllMeshesForShadowVolumes(void);
384 
400  static MeshManager& getSingleton(void);
416  static MeshManager* getSingletonPtr(void);
417 
421  Real getBoundsPaddingFactor(void);
422 
425  void setBoundsPaddingFactor(Real paddingFactor);
426 
429  void setListener(MeshSerializerListener *listener);
430 
433  MeshSerializerListener *getListener();
434 
436  void loadResource(Resource* res);
437 
438  protected:
440  Resource* createImpl(const String& name, ResourceHandle handle,
441  const String& group, bool isManual, ManualResourceLoader* loader,
442  const NameValuePairList* createParams);
443 
446  void tesselate2DMesh(SubMesh* pSub, unsigned short meshWidth, unsigned short meshHeight,
447  bool doubleSided = false,
449  bool indexSysMem = false);
450 
451  void createPrefabPlane(void);
452  void createPrefabCube(void);
453  void createPrefabSphere(void);
454 
457  {
460  MBT_CURVED_PLANE
461  };
464  {
472  bool normals;
473  unsigned short numTexCoordSets;
483  };
487 
489  void loadManualPlane(Mesh* pMesh, MeshBuildParams& params);
491  void loadManualCurvedPlane(Mesh* pMesh, MeshBuildParams& params);
493  void loadManualCurvedIllusionPlane(Mesh* pMesh, MeshBuildParams& params);
494 
496 
497  //the factor by which the bounding box of an entity is padded
499 
500  // The listener to pass to serializers
502  };
503 
507 } //namespace
508 
509 #include "OgreHeaderSuffix.h"
510 
511 #endif
OgreHeaderSuffix.h
Ogre::MeshManager::MBT_PLANE
Definition: OgreMeshManager.h:458
Ogre::Vector3::UNIT_Y
static const Vector3 UNIT_Y
Definition: OgreVector3.h:802
Ogre::ResourceHandle
unsigned long long int ResourceHandle
Definition: OgreResource.h:41
Ogre::MeshManager::MeshBuildParams::vertexBufferUsage
HardwareBuffer::Usage vertexBufferUsage
Definition: OgreMeshManager.h:478
Ogre::MeshManager::MeshBuildParams::orientation
Quaternion orientation
Definition: OgreMeshManager.h:477
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::Plane
Defines a plane in 3D space.
Definition: OgrePlane.h:61
Ogre::map
Definition: OgrePrerequisites.h:533
OgreSingleton.h
OgreMesh.h
Ogre::MeshManager::mPrepAllMeshesForShadowVolumes
bool mPrepAllMeshesForShadowVolumes
Definition: OgreMeshManager.h:495
Ogre::MeshManager::mBoundsPaddingFactor
Real mBoundsPaddingFactor
Definition: OgreMeshManager.h:498
Ogre::MeshManager::MeshBuildParams::xTile
Real xTile
Definition: OgreMeshManager.h:474
Ogre::MeshManager::MeshBuildParams::numTexCoordSets
unsigned short numTexCoordSets
Definition: OgreMeshManager.h:473
Ogre::MeshManager::MeshBuildType
MeshBuildType
Enum identifying the types of manual mesh built by this manager.
Definition: OgreMeshManager.h:456
Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
Definition: OgreResourceGroupManager.h:270
Ogre::MeshSerializerListener
Definition: OgreMeshSerializer.h:192
Ogre::MeshManager::MBT_CURVED_ILLUSION_PLANE
Definition: OgreMeshManager.h:459
Ogre::MeshManager::MeshBuildParams::plane
Plane plane
Definition: OgreMeshManager.h:466
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::MeshManager::MeshBuildParams::xsegments
int xsegments
Definition: OgreMeshManager.h:470
Ogre::MeshManager::MeshBuildParams::type
MeshBuildType type
Definition: OgreMeshManager.h:465
Ogre::PatchSurface::VisibleSide
VisibleSide
Definition: OgrePatchSurface.h:71
Ogre::HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY
Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.
Definition: OgreHardwareBuffer.h:114
Ogre::NameValuePairList
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
Ogre::PatchSurface::VS_FRONT
The side from which u goes right and v goes up (as in texture coords)
Definition: OgrePatchSurface.h:73
Ogre::MeshManager::MeshBuildParams::vertexShadowBuffer
bool vertexShadowBuffer
Definition: OgreMeshManager.h:480
Ogre::MeshManager::MeshBuildParams::indexBufferUsage
HardwareBuffer::Usage indexBufferUsage
Definition: OgreMeshManager.h:479
Ogre::MeshManager::MeshBuildParams::upVector
Vector3 upVector
Definition: OgreMeshManager.h:476
Ogre::Quaternion
Implementation of a Quaternion, i.e.
Definition: OgreQuaternion.h:57
Ogre::HardwareBuffer::HBU_STATIC_WRITE_ONLY
Combination of HBU_STATIC and HBU_WRITE_ONLY.
Definition: OgreHardwareBuffer.h:108
Ogre::PatchSurface::AUTO_LEVEL
Definition: OgrePatchSurface.h:68
OgrePatchMesh.h
OgreHeaderPrefix.h
Ogre::MeshManager::MeshBuildParamsMap
map< Resource *, MeshBuildParams >::type MeshBuildParamsMap
Map from resource pointer to parameter set.
Definition: OgreMeshManager.h:485
OgrePrerequisites.h
Ogre::VertexDeclaration
This class declares the format of a set of vertex inputs, which can be issued to the rendering API th...
Definition: OgreHardwareVertexBuffer.h:337
Ogre::SubMesh
Defines a part of a complete mesh.
Definition: OgreSubMesh.h:62
Ogre::MeshManager::MeshBuildParams::ysegments
int ysegments
Definition: OgreMeshManager.h:471
Ogre::Singleton
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:64
Ogre::MeshManager::MeshBuildParams::indexShadowBuffer
bool indexShadowBuffer
Definition: OgreMeshManager.h:481
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::ResourceManager
Defines a generic resource handler.
Definition: OgreResourceManager.h:122
Ogre::MeshManager::mMeshBuildParams
MeshBuildParamsMap mMeshBuildParams
Definition: OgreMeshManager.h:486
Ogre::MeshManager::MeshBuildParams::normals
bool normals
Definition: OgreMeshManager.h:472
Ogre::SharedPtr< Mesh >
Ogre::MeshManager::MeshBuildParams::height
Real height
Definition: OgreMeshManager.h:468
Ogre::Resource
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:79
Ogre::MeshManager::MeshBuildParams
Saved parameters used to (re)build a manual mesh built by this class.
Definition: OgreMeshManager.h:463
Ogre::ResourceManager::ResourceCreateOrRetrieveResult
std::pair< ResourcePtr, bool > ResourceCreateOrRetrieveResult
Definition: OgreResourceManager.h:152
Ogre::MeshManager::MeshBuildParams::width
Real width
Definition: OgreMeshManager.h:467
Ogre::MeshManager::MeshBuildParams::ySegmentsToKeep
int ySegmentsToKeep
Definition: OgreMeshManager.h:482
Ogre::MeshManager
Handles the management of mesh resources.
Definition: OgreMeshManager.h:58
Ogre::HardwareBuffer::Usage
Usage
Enums describing buffer usage; not mutually exclusive.
Definition: OgreHardwareBuffer.h:79
Ogre::Mesh
Resource holding data about 3D mesh.
Definition: OgreMesh.h:93
Ogre::Quaternion::IDENTITY
static const Quaternion IDENTITY
Definition: OgreQuaternion.h:301
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::MeshManager::mListener
MeshSerializerListener * mListener
Definition: OgreMeshManager.h:501
OgreHardwareBuffer.h
Ogre::ManualResourceLoader
Interface describing a manual resource loader.
Definition: OgreResource.h:514
Ogre::MeshManager::MeshBuildParams::curvature
Real curvature
Definition: OgreMeshManager.h:469
OgreVector3.h
OgreResourceManager.h
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:51
Ogre::MeshManager::MeshBuildParams::yTile
Real yTile
Definition: OgreMeshManager.h:475

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