OgreInstancedEntity.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 __InstancedEntity_H__
29 #define __InstancedEntity_H__
30 
31 #include "OgreMovableObject.h"
32 #include "OgreNode.h"
33 #include "OgreHeaderPrefix.h"
34 
35 namespace Ogre
36 {
78  {
79  friend class InstanceBatch;
80  friend class InstanceBatchShader;
81  friend class InstanceBatchHW;
82  friend class InstanceBatchHW_VTF;
83  friend class BaseInstanceBatchVTF;
84  protected:
85  uint16 mInstanceId; //Note it may change after defragmenting!
86  bool mInUse;
88 
91  Matrix4 *mBoneMatrices; //Local space
92  Matrix4 *mBoneWorldMatrices; //World space
94 
95  InstancedEntity* mSharedTransformEntity; //When not null, another InstancedEntity controls the skeleton
96 
100 
104 
106  // Parameters used for local transformation offset information
107  // The
109 
127 
128 
130  size_t getTransforms( Matrix4 *xform ) const;
132  size_t getTransforms3x4( float *xform ) const;
133 
135  bool findVisible( Camera *camera ) const;
136 
138  void createSkeletonInstance();
139  void destroySkeletonInstance();
140 
143  void stopSharingTransformAsSlave( bool notifyMaster );
144 
146  void unlinkTransform( bool notifyMaster=true );
147 
149  void notifyUnlink( const InstancedEntity *slave );
150 
152  inline void markTransformDirty();
153 
156 
157  public:
158  InstancedEntity( InstanceBatch *batchOwner, uint32 instanceID, InstancedEntity* sharedTransformEntity = NULL);
159  virtual ~InstancedEntity();
160 
179  bool shareTransformWith( InstancedEntity *slave );
180 
188  void stopSharingTransform();
189 
190  InstanceBatch* _getOwner() const { return mBatchOwner; }
191 
192  const String& getMovableType(void) const;
193 
194  const AxisAlignedBox& getBoundingBox(void) const;
195  Real getBoundingRadius(void) const;
196 
199  Real getSquaredViewDepth( const Camera* cam ) const;
200 
202  void _notifyMoved(void);
203  void _notifyAttached( Node* parent, bool isTagPoint = false );
204 
206  void _updateRenderQueue( RenderQueue* queue ) {}
207  void visitRenderables( Renderable::Visitor* visitor, bool debugRenderables = false ) {}
208 
210  bool hasSkeleton(void) const { return mSkeletonInstance != 0; }
212  SkeletonInstance* getSkeleton(void) const { return mSkeletonInstance; }
213 
215  AnimationState* getAnimationState(const String& name) const;
217  AnimationStateSet* getAllAnimationStates(void) const;
218 
224  virtual bool _updateAnimation(void);
225 
227  void setTransformLookupNumber(uint16 num) { mTransformLookupNumber = num;}
228 
230  const Vector3& getPosition() const { return mPosition; }
232  void setPosition(const Vector3& position, bool doUpdate = true);
233 
235  const Quaternion& getOrientation() const { return mOrientation; }
237  void setOrientation(const Quaternion& orientation, bool doUpdate = true);
238 
240  const Vector3& getScale() const { return mScale; }
242  void setScale(const Vector3& scale, bool doUpdate = true);
243 
245  Real getMaxScaleCoef() const;
246 
248  void updateTransforms();
249 
251  bool isInUse() const { return mInUse; }
253  void setInUse(bool used);
254 
256  virtual const Matrix4& _getParentNodeFullTransform(void) const {
257  assert((!mNeedTransformUpdate || !mUseLocalTransform) && "Transform data should be updated at this point");
258  return mUseLocalTransform ? mFullLocalTransform :
259  mParentNode ? mParentNode->_getFullTransform() : Matrix4::IDENTITY;
260  }
261 
263  const Vector3& _getDerivedPosition() const {
264  assert((!mNeedTransformUpdate || !mUseLocalTransform) && "Transform data should be updated at this point");
265  return mUseLocalTransform ? mDerivedLocalPosition :
266  mParentNode ? mParentNode->_getDerivedPosition() : Vector3::ZERO;
267  }
268 
270  virtual bool isInScene(void) const
271  {
272  //We assume that the instanced entity is in the scene if it is in use
273  //It is in the scene whether it has a parent node or not
274  return mInUse;
275  }
276 
288  void setCustomParam( unsigned char idx, const Vector4 &newParam );
289  const Vector4& getCustomParam( unsigned char idx );
290  };
291 }
292 
293 #include "OgreHeaderSuffix.h"
294 
295 #endif

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Oct 23 2013 06:57:24