OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreInstanceBatch.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-2014 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 __InstanceBatch_H__
29 #define __InstanceBatch_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreRenderOperation.h"
33 #include "OgreRenderable.h"
34 #include "OgreMovableObject.h"
35 #include "OgreMesh.h"
36 #include "OgreHeaderPrefix.h"
37 
38 namespace Ogre
39 {
89  {
90  public:
93  protected:
96 
98 
100 
103 
104  //InstancedEntities are all allocated at build time and kept as "unused"
105  //when they're requested, they're removed from there when requested,
106  //and put back again when they're no longer needed
107  //Note each InstancedEntity has a unique ID ranging from [0; mInstancesPerBatch)
110 
115 
120  bool mBoundsUpdated; //Set to false by derived classes that need it
122 
123  unsigned short mMaterialLodIndex;
124 
125  bool mDirtyAnimation; //Set to false at start of each _updateRenderQueue
126 
129 
133  mutable const Camera *mCachedCamera;
134 
137 
142 
143  virtual void setupVertices( const SubMesh* baseSubMesh ) = 0;
144  virtual void setupIndices( const SubMesh* baseSubMesh ) = 0;
145  virtual void createAllInstancedEntities(void);
146  virtual void deleteAllInstancedEntities(void);
147  virtual void deleteUnusedInstancedEntities(void);
149  virtual InstancedEntity* generateInstancedEntity(size_t num);
150 
155  void makeMatrixCameraRelative3x4( float *mat3x4, size_t numFloats );
156 
158  virtual bool checkSubMeshCompatibility( const SubMesh* baseSubMesh );
159 
160  void updateVisibility(void);
161 
163  void defragmentBatchNoCull( InstancedEntityVec &usedEntities, CustomParamsVec &usedParams );
164 
170  void defragmentBatchDoCull( InstancedEntityVec &usedEntities, CustomParamsVec &usedParams );
171 
172  public:
173  InstanceBatch( InstanceManager *creator, MeshPtr &meshReference, const MaterialPtr &material,
174  size_t instancesPerBatch, const Mesh::IndexMap *indexToBoneMap,
175  const String &batchName );
176  virtual ~InstanceBatch();
177 
178  MeshPtr& _getMeshRef() { return mMeshReference; }
179 
182  void _setInstancesPerBatch( size_t instancesPerBatch );
183 
184  const Mesh::IndexMap* _getIndexToBoneMap() const { return mIndexToBoneMap; }
185 
192  bool _supportsSkeletalAnimation() const { return mTechnSupportsSkeletal; }
193 
195  void _updateBounds(void);
196 
207  virtual size_t calculateMaxNumInstances( const SubMesh *baseSubMesh, uint16 flags ) const = 0;
208 
222  virtual RenderOperation build( const SubMesh* baseSubMesh );
223 
236  virtual void buildFrom( const SubMesh *baseSubMesh, const RenderOperation &renderOperation );
237 
238  const Ogre::MeshPtr& _getMeshReference(void) const { return mMeshReference; }
239 
243  bool isBatchFull(void) const { return mUnusedEntities.empty(); }
244 
247  bool isBatchUnused(void) const { return mUnusedEntities.size() == mInstancedEntities.size(); }
248 
252  void getInstancedEntitiesInUse( InstancedEntityVec &outEntities, CustomParamsVec &outParams );
253 
267  void _defragmentBatch( bool optimizeCulling, InstancedEntityVec &usedEntities,
268  CustomParamsVec &usedParams );
269 
275  void _defragmentBatchDiscard(void);
276 
280  virtual void _boundsDirty(void);
281 
295  virtual void setStaticAndUpdate( bool bStatic ) {}
296 
299  virtual bool isStatic() const { return false; }
300 
307  InstancedEntity* createInstancedEntity();
308 
315  void removeInstancedEntity( InstancedEntity *instancedEntity );
316 
320  virtual bool useBoneWorldMatrices() const { return true; }
321 
323  void _markTransformSharingDirty() { mTransformSharingDirty = true; }
324 
326  void _setCustomParam( InstancedEntity *instancedEntity, unsigned char idx, const Vector4 &newParam );
327 
329  const Vector4& _getCustomParam( InstancedEntity *instancedEntity, unsigned char idx );
330 
331  //Renderable overloads
333  const MaterialPtr& getMaterial(void) const { return mMaterial; }
335  void getRenderOperation( RenderOperation& op ) { op = mRenderOperation; }
336 
338  Real getSquaredViewDepth( const Camera* cam ) const;
340  const LightList& getLights( void ) const;
342  Technique* getTechnique(void) const;
343 
345  const String& getMovableType(void) const;
347  void _notifyCurrentCamera( Camera* cam );
349  const AxisAlignedBox& getBoundingBox(void) const;
351  Real getBoundingRadius(void) const;
352 
353  virtual void _updateRenderQueue(RenderQueue* queue);
354  void visitRenderables( Renderable::Visitor* visitor, bool debugRenderables = false );
355 
356  // resolve ambiguity of get/setUserAny due to inheriting from Renderable and MovableObject
359  };
360 } // namespace Ogre
361 
362 #include "OgreHeaderSuffix.h"
363 
364 #endif // __InstanceBatch_H__
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
const MaterialPtr & getMaterial(void) const
Mesh::IndexMap const * mIndexToBoneMap
virtual bool useBoneWorldMatrices() const
Tells whether world bone matrices need to be calculated.
float Real
Software floating point type.
vector< unsigned short >::type IndexMap
Definition: OgreMesh.h:108
bool isBatchFull(void) const
#define _OgreExport
Definition: OgrePlatform.h:260
unsigned short mMaterialLodIndex
virtual void setStaticAndUpdate(bool bStatic)
Tells this batch to stop updating animations, positions, rotations, and display all it's active insta...
A 3D box aligned with the x/y/z axes.
AxisAlignedBox mFullBoundingBox
This bbox contains all (visible) instanced entities.
bool mTechnSupportsSkeletal
False if a technique doesn't support skeletal animation.
Real mCachedCameraDist
Cached distance to last camera for getSquaredViewDepth.
bool mRemoveOwnVertexData
When true remove the memory of the VertexData we've created because no one else will.
CustomParamsVec mCustomParams
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:53
const Ogre::MeshPtr & _getMeshReference(void) const
bool mRemoveOwnIndexData
When true remove the memory of the IndexData we've created because no one else will.
Abstract class defining a movable object in a scene.
InstancedEntityVec mInstancedEntities
Abstract class defining the interface all renderable objects must implement.
void getRenderOperation(RenderOperation &op)
bool _supportsSkeletalAnimation() const
Returns true if this technique supports skeletal animation.
InstanceManager * mCreator
bool mTransformSharingDirty
Tells that the list of entity instances with shared transforms has changed.
virtual bool isStatic() const
Returns true if this batch was set as static.
const Mesh::IndexMap * _getIndexToBoneMap() const
const Camera * mCachedCamera
The camera for which the cached distance is valid.
Visitor object that can be used to iterate over a collection of Renderable instances abstractly...
Defines a part of a complete mesh.
Definition: OgreSubMesh.h:62
InstanceBatch forms part of the new Instancing system This is an abstract class that must be derived ...
bool isBatchUnused(void) const
Returns true if it no instanced entity has been requested or all of them have been removed...
'New' rendering operation using vertex buffers.
Class to manage the scene object rendering queue.
This is the main starting point for the new instancing system.
RenderOperation mRenderOperation
_StringBase String
void _markTransformSharingDirty()
Tells that the list of entity instances with shared transforms has changed.
vector< Vector4 >::type CustomParamsVec
unsigned short uint16
Definition: OgrePlatform.h:345
4-dimensional homogeneous vector.
Definition: OgreVector4.h:45
vector< InstancedEntity * >::type InstancedEntityVec
virtual OGRE_DEPRECATED void setUserAny(const Any &anything)
virtual OGRE_DEPRECATED const Any & getUserAny(void) const
InstancedEntityVec mUnusedEntities