OgreBillboardSet.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 
29 #ifndef __BillboardSet_H__
30 #define __BillboardSet_H__
31 
32 #include "OgrePrerequisites.h"
33 
34 #include "OgreMovableObject.h"
35 #include "OgreRenderable.h"
36 #include "OgreRadixSort.h"
37 #include "OgreCommon.h"
39 #include "OgreHeaderPrefix.h"
40 
41 namespace Ogre {
55  {
65  };
68  {
73  };
76  {
87  };
88 
111  {
112  protected:
115  BillboardSet();
116 
121 
126 
131 
136 
139 
142 
145 
148 
151 
155 
165 
174 
180 
186  float* mLockPtr;
190  Vector3 mVOffset[4];
194  Real mLeftOff, mRightOff, mTopOff, mBottomOff;
196  Vector3 mCamX, mCamY;
203 
206 
209 
212 
215 
220 
222  inline bool billboardVisible(Camera* cam, const Billboard& bill);
223 
225  unsigned short mNumVisibleBillboards;
226 
228  virtual void increasePool(size_t size);
229 
230 
231  //-----------------------------------------------------------------------
232  // The internal methods which follow are here to allow maximum flexibility as to
233  // when various components of the calculation are done. Depending on whether the
234  // billboards are of fixed size and whether they are point or oriented type will
235  // determine how much calculation has to be done per-billboard. NOT a one-size fits all approach.
236  //-----------------------------------------------------------------------
241  void genBillboardAxes(Vector3* pX, Vector3 *pY, const Billboard* pBill = 0);
242 
245  void getParametricOffsets(Real& left, Real& right, Real& top, Real& bottom);
246 
251  void genVertices(const Vector3* const offsets, const Billboard& pBillboard);
252 
260  void genVertOffsets(Real inleft, Real inright, Real intop, Real inbottom,
261  Real width, Real height,
262  const Vector3& x, const Vector3& y, Vector3* pDestVec);
263 
264 
267  {
270 
271  SortByDirectionFunctor(const Vector3& dir);
272  float operator()(Billboard* bill) const;
273  };
274 
277  {
280 
281  SortByDistanceFunctor(const Vector3& pos);
282  float operator()(Billboard* bill) const;
283  };
284 
286 
289 
290 
291 
292  private:
296  size_t mPoolSize;
303 
306  void _createBuffers(void);
309  void _destroyBuffers(void);
310 
311  public:
312 
332  BillboardSet( const String& name, unsigned int poolSize = 20,
333  bool externalDataSource = false);
334 
335  virtual ~BillboardSet();
336 
354  Billboard* createBillboard(
355  const Vector3& position,
356  const ColourValue& colour = ColourValue::White );
357 
379  Billboard* createBillboard(
380  Real x, Real y, Real z,
381  const ColourValue& colour = ColourValue::White );
382 
385  virtual int getNumBillboards(void) const;
386 
402  virtual void setAutoextend(bool autoextend);
403 
408  virtual bool getAutoextend(void) const;
409 
413  virtual void setSortingEnabled(bool sortenable);
414 
419  virtual bool getSortingEnabled(void) const;
420 
431  virtual void setPoolSize(size_t size);
432 
439  virtual unsigned int getPoolSize(void) const;
440 
441 
444  virtual void clear();
445 
457  virtual Billboard* getBillboard(unsigned int index) const;
458 
463  virtual void removeBillboard(unsigned int index);
464 
469  virtual void removeBillboard(Billboard* pBill);
470 
482  virtual void setBillboardOrigin(BillboardOrigin origin);
483 
488  virtual BillboardOrigin getBillboardOrigin(void) const;
489 
499  virtual void setBillboardRotationType(BillboardRotationType rotationType);
500 
505  virtual BillboardRotationType getBillboardRotationType(void) const;
506 
517  virtual void setDefaultDimensions(Real width, Real height);
518 
520  virtual void setDefaultWidth(Real width);
522  virtual Real getDefaultWidth(void) const;
524  virtual void setDefaultHeight(Real height);
526  virtual Real getDefaultHeight(void) const;
527 
532  virtual void setMaterialName( const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
533 
537  virtual const String& getMaterialName(void) const;
538 
543  virtual void _notifyCurrentCamera(Camera* cam);
544 
550  void beginBillboards(size_t numBillboards = 0);
552  void injectBillboard(const Billboard& bb);
554  void endBillboards(void);
560  void setBounds(const AxisAlignedBox& box, Real radius);
561 
562 
567  virtual const AxisAlignedBox& getBoundingBox(void) const;
568 
573  virtual Real getBoundingRadius(void) const;
578  virtual void _updateRenderQueue(RenderQueue* queue);
579 
584  virtual const MaterialPtr& getMaterial(void) const;
585 
590  virtual void setMaterial( const MaterialPtr& material );
591 
596  virtual void getRenderOperation(RenderOperation& op);
597 
602  virtual void getWorldTransforms(Matrix4* xform) const;
603 
606  virtual void _notifyBillboardResized(void);
607 
610  virtual void _notifyBillboardRotated(void);
611 
613  virtual bool getCullIndividually(void) const;
634  virtual void setCullIndividually(bool cullIndividual);
635 
656  virtual void setBillboardType(BillboardType bbt);
657 
659  virtual BillboardType getBillboardType(void) const;
660 
675  virtual void setCommonDirection(const Vector3& vec);
676 
678  virtual const Vector3& getCommonDirection(void) const;
679 
694  virtual void setCommonUpVector(const Vector3& vec);
695 
697  virtual const Vector3& getCommonUpVector(void) const;
698 
712  virtual void setUseAccurateFacing(bool acc) { mAccurateFacing = acc; }
717  virtual bool getUseAccurateFacing(void) const { return mAccurateFacing; }
718 
720  virtual const String& getMovableType(void) const;
721 
723  Real getSquaredViewDepth(const Camera* cam) const;
724 
726  virtual void _updateBounds(void);
728  const LightList& getLights(void) const;
729 
731  void visitRenderables(Renderable::Visitor* visitor,
732  bool debugRenderables = false);
733 
735  virtual void _sortBillboards( Camera* cam);
736 
738  virtual SortMode _getSortMode(void) const;
739 
745  virtual void setBillboardsInWorldSpace(bool ws) { mWorldSpace = ws; }
746 
774  virtual void setTextureCoords( Ogre::FloatRect const * coords, uint16 numCoords );
775 
789  virtual void setTextureStacksAndSlices( uchar stacks, uchar slices );
790 
797  virtual Ogre::FloatRect const * getTextureCoords( uint16 * oNumCoords );
798 
827  virtual void setPointRenderingEnabled(bool enabled);
828 
830  virtual bool isPointRenderingEnabled(void) const
831  { return mPointRendering; }
832 
834  uint32 getTypeFlags(void) const;
835 
845  void setAutoUpdate(bool autoUpdate);
846 
848  bool getAutoUpdate(void) const { return mAutoUpdate; }
849 
854  void notifyBillboardDataChanged(void) { mBillboardDataChanged = true; }
855 
856  };
857 
860  {
861  protected:
862  MovableObject* createInstanceImpl( const String& name, const NameValuePairList* params);
863  public:
866 
868 
869  const String& getType(void) const;
870  void destroyInstance( MovableObject* obj);
871 
872  };
876 } // namespace Ogre
877 
878 #include "OgreHeaderSuffix.h"
879 
880 #endif // __BillboardSet_H__

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 16 2013 14:35:41