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:
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 
272  float operator()(Billboard* bill) const;
273  };
274 
277  {
280 
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 
355  const Vector3& position,
356  const ColourValue& colour = ColourValue::White );
357 
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 
500 
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 
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 
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 
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:
863  public:
866 
868 
869  const String& getType(void) const;
871 
872  };
876 } // namespace Ogre
877 
878 #include "OgreHeaderSuffix.h"
879 
880 #endif // __BillboardSet_H__
#define _OgreExport
Definition: OgrePlatform.h:257
A 3D box aligned with the x/y/z axes.
Factory object for creating BillboardSet instances.
void destroyInstance(MovableObject *obj)
Destroy an instance of the object.
const String & getType(void) const
Get the type of the object to be created.
MovableObject * createInstanceImpl(const String &name, const NameValuePairList *params)
Internal implementation of create method - must be overridden.
A collection of billboards (faces which are always facing the given direction) with the same (default...
bool getAutoUpdate(void) const
Return the auto update state of this billboard set.
Real mDefaultHeight
Default height of each billboard.
void genVertices(const Vector3 *const offsets, const Billboard &pBillboard)
Internal method for generating vertex data.
virtual void clear()
Empties this set of all billboards.
Vector3 mCommonUpVector
Common up-vector for billboards of type BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON.
virtual void _notifyBillboardRotated(void)
Internal callback used by Billboards to notify their parent that they have been rotated.
virtual void setMaterial(const MaterialPtr &material)
Sets the name of the material to be used for this billboard set.
void genVertOffsets(Real inleft, Real inright, Real intop, Real inbottom, Real width, Real height, const Vector3 &x, const Vector3 &y, Vector3 *pDestVec)
Internal method generates vertex offsets.
Vector3 mCommonDirection
Common direction for billboards of type BBT_ORIENTED_COMMON and BBT_PERPENDICULAR_COMMON.
virtual void _updateBounds(void)
Update the bounds of the billboardset.
virtual SortMode _getSortMode(void) const
Gets the sort mode of this billboard set.
virtual void setUseAccurateFacing(bool acc)
Sets whether or not billboards should use an 'accurate' facing model based on the vector from each bi...
virtual ~BillboardSet()
virtual void setBillboardType(BillboardType bbt)
Sets the type of billboard to render.
Camera * mCurrentCamera
Current camera.
AxisAlignedBox mAABB
Bounds of all billboards in this set.
virtual void increasePool(size_t size)
Internal method for increasing pool size.
virtual void setCullIndividually(bool cullIndividual)
Sets whether culling tests billboards in this individually as well as in a group.
bool mAutoExtendPool
Flag indicating whether to autoextend pool.
virtual bool getSortingEnabled(void) const
Returns true if sorting of billboards is enabled based on their distance from the camera.
virtual bool isPointRenderingEnabled(void) const
Returns whether point rendering is enabled.
virtual void _notifyCurrentCamera(Camera *cam)
Overridden from MovableObject.
BillboardType mBillboardType
The type of billboard to render.
virtual const Vector3 & getCommonUpVector(void) const
Gets the common up-vector for all billboards (BBT_PERPENDICULAR_SELF and BBT_PERPENDICULAR_COMMON)
virtual void getRenderOperation(RenderOperation &op)
Overridden from MovableObject.
BillboardOrigin mOriginType
Origin of each billboard.
void injectBillboard(const Billboard &bb)
Define a billboard.
virtual void setSortingEnabled(bool sortenable)
Enables sorting for this BillboardSet.
VertexData * mVertexData
The vertex position data for all billboards in this set.
bool billboardVisible(Camera *cam, const Billboard &bill)
Internal method for culling individual billboards.
virtual void removeBillboard(Billboard *pBill)
Removes a billboard from the set.
Real mBoundingRadius
Bounding radius.
virtual void setPointRenderingEnabled(bool enabled)
Set whether or not the BillboardSet will use point rendering rather than manually generated quads.
TextureCoordSets mTextureCoords
uint32 getTypeFlags(void) const
Override to return specific type flag.
FreeBillboardList mFreeBillboards
Free billboard queue.
HardwareVertexBufferSharedPtr mMainBuf
Shortcut to main buffer (positions, colours, texture coords)
virtual void setDefaultWidth(Real width)
See setDefaultDimensions - this sets 1 component individually.
float * mLockPtr
Locked pointer to buffer.
vector< Billboard * >::type BillboardPool
virtual void removeBillboard(unsigned int index)
Removes the billboard at the supplied index.
virtual bool getAutoextend(void) const
Returns true if the billboard pool automatically extends.
Vector3 mCamDir
Camera direction in billboard space.
virtual bool getUseAccurateFacing(void) const
Gets whether or not billboards use an 'accurate' facing model based on the vector from each billboard...
virtual Ogre::FloatRect const * getTextureCoords(uint16 *oNumCoords)
getTextureCoords() returns the current texture coordinate rects in effect.
bool mSortingEnabled
Flag indicating whether the billboards has to be sorted.
bool mAllDefaultSize
True if no billboards in this set have been resized - greater efficiency.
virtual const String & getMaterialName(void) const
Sets the name of the material to be used for this billboard set.
virtual void setDefaultHeight(Real height)
See setDefaultDimensions - this sets 1 component individually.
virtual void setTextureCoords(Ogre::FloatRect const *coords, uint16 numCoords)
BillboardSet can use custom texture coordinates for various billboards.
bool mBuffersCreated
Flag indicating whether the HW buffers have been created.
virtual void setPoolSize(size_t size)
Adjusts the size of the pool of billboards available in this set.
void beginBillboards(size_t numBillboards=0)
Begin injection of billboard data; applicable when constructing the BillboardSet for external data us...
IndexData * mIndexData
The vertex index data for all billboards in this set (1 set only)
ActiveBillboardList mActiveBillboards
Active billboard list.
virtual void setTextureStacksAndSlices(uchar stacks, uchar slices)
setTextureStacksAndSlices() will generate texture coordinate rects as if the texture for the billboar...
void setBounds(const AxisAlignedBox &box, Real radius)
Set the bounds of the BillboardSet.
vector< Ogre::FloatRect >::type TextureCoordSets
BillboardRotationType mRotationType
Rotation type of each billboard.
virtual void setBillboardsInWorldSpace(bool ws)
Sets whether billboards should be treated as being in world space.
virtual int getNumBillboards(void) const
Returns the number of active billboards which currently make up this set.
virtual void setMaterialName(const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
Sets the name of the material to be used for this billboard set.
virtual unsigned int getPoolSize(void) const
Returns the current size of the billboard pool.
virtual const AxisAlignedBox & getBoundingBox(void) const
Overridden from MovableObject.
Real getSquaredViewDepth(const Camera *cam) const
Overridden, see Renderable.
void visitRenderables(Renderable::Visitor *visitor, bool debugRenderables=false)
Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject ...
void genBillboardAxes(Vector3 *pX, Vector3 *pY, const Billboard *pBill=0)
Internal method for generating billboard corners.
virtual const String & getMovableType(void) const
Overridden from MovableObject.
MaterialPtr mMaterial
Pointer to the material to use.
virtual Billboard * getBillboard(unsigned int index) const
Returns a pointer to the billboard at the supplied index.
void getParametricOffsets(Real &left, Real &right, Real &top, Real &bottom)
Internal method, generates parametric offsets based on origin.
virtual void setAutoextend(bool autoextend)
Tells the set whether to allow automatic extension of the pool of billboards.
void endBillboards(void)
Finish defining billboards.
bool mExternalData
Is external billboard data in use?
void notifyBillboardDataChanged(void)
When billboard set is not auto updating its GPU buffer, the user is responsible to inform it about an...
virtual void setBillboardRotationType(BillboardRotationType rotationType)
Sets billboard rotation type.
virtual Real getDefaultHeight(void) const
See setDefaultDimensions - this gets 1 component individually.
void _createBuffers(void)
Internal method creates vertex and index buffers.
bool mCullIndividual
Flag indicating whether each billboard should be culled separately (default: false)
Real mDefaultWidth
Default width of each billboard.
bool mBillboardDataChanged
True if the billboard data changed. Will cause vertex buffer update.
virtual void setCommonDirection(const Vector3 &vec)
Use this to specify the common direction given to billboards of type BBT_ORIENTED_COMMON or BBT_PERPE...
size_t mPoolSize
The number of billboard in the pool.
bool mAutoUpdate
Tell if vertex buffer should be update automatically.
virtual BillboardRotationType getBillboardRotationType(void) const
Sets billboard rotation type.
const LightList & getLights(void) const
Gets a list of lights, ordered relative to how close they are to this renderable.
BillboardSet()
Private constructor (instances cannot be created directly).
virtual void _notifyBillboardResized(void)
Internal callback used by Billboards to notify their parent that they have been resized.
void _destroyBuffers(void)
Internal method destroys vertex and index buffers.
virtual void setDefaultDimensions(Real width, Real height)
Sets the default dimensions of the billboards in this set.
virtual bool getCullIndividually(void) const
Returns whether or not billboards in this are tested individually for culling.
static RadixSort< ActiveBillboardList, Billboard *, float > mRadixSorter
virtual const MaterialPtr & getMaterial(void) const
Overridden from MovableObject.
Vector3 mCamX
Camera axes in billboard space.
String mMaterialName
Name of the material to use.
virtual void _updateRenderQueue(RenderQueue *queue)
Overridden from MovableObject.
virtual BillboardOrigin getBillboardOrigin(void) const
Gets the point which acts as the origin point for all billboards in this set.
list< Billboard * >::type FreeBillboardList
virtual const Vector3 & getCommonDirection(void) const
Gets the common direction for all billboards (BBT_ORIENTED_COMMON)
Billboard * createBillboard(const Vector3 &position, const ColourValue &colour=ColourValue::White)
Creates a new billboard and adds it to this set.
Billboard * createBillboard(Real x, Real y, Real z, const ColourValue &colour=ColourValue::White)
Creates a new billboard and adds it to this set.
virtual void setCommonUpVector(const Vector3 &vec)
Use this to specify the common up-vector given to billboards of type BBT_PERPENDICULAR_SELF or BBT_PE...
virtual void getWorldTransforms(Matrix4 *xform) const
Overridden from MovableObject.
unsigned short mNumVisibleBillboards
Number of visible billboards (will be == getNumBillboards if mCullIndividual == false)
virtual BillboardType getBillboardType(void) const
Returns the billboard type in use.
BillboardPool mBillboardPool
Pool of billboard instances for use and reuse in the active billboard list.
virtual void setBillboardOrigin(BillboardOrigin origin)
Sets the point which acts as the origin point for all billboards in this set.
virtual Real getBoundingRadius(void) const
Overridden from MovableObject.
Vector3 mCamPos
Camera position in billboard space.
BillboardSet(const String &name, unsigned int poolSize=20, bool externalDataSource=false)
Usual constructor - this is called by the SceneManager.
bool mPointRendering
Use point rendering?
virtual void _sortBillboards(Camera *cam)
Sort the billboard set.
virtual Real getDefaultWidth(void) const
See setDefaultDimensions - this gets 1 component individually.
bool mAccurateFacing
Use 'true' billboard to cam position facing, rather than camera direcion.
void setAutoUpdate(bool autoUpdate)
Set the auto update state of this billboard set.
list< Billboard * >::type ActiveBillboardList
Quaternion mCamQ
Camera orientation in billboard space.
A billboard is a primitive which always faces the camera in every frame.
Definition: OgreBillboard.h:68
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Class representing colour.
static const ColourValue White
Shared pointer implementation used to share vertex buffers.
Summary class collecting together index data source information.
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:79
Interface definition for a factory class which produces a certain kind of MovableObject,...
Abstract class defining a movable object in a scene.
Implementation of a Quaternion, i.e.
Class for performing a radix sort (fast comparison-less sort based on byte value) on various standard...
Definition: OgreRadixSort.h:89
'New' rendering operation using vertex buffers.
Class to manage the scene object rendering queue.
Visitor object that can be used to iterate over a collection of Renderable instances abstractly.
Abstract class defining the interface all renderable objects must implement.
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
Standard 3-dimensional vector.
Definition: OgreVector3.h:52
Summary class collecting together vertex source information.
BillboardOrigin
Enum covering what exactly a billboard's position means (center, top-left etc).
BillboardRotationType
The rotation type of billboard.
BillboardType
The type of billboard to use.
@ BBO_TOP_RIGHT
@ BBO_TOP_LEFT
@ BBO_CENTER_LEFT
@ BBO_CENTER_RIGHT
@ BBO_BOTTOM_LEFT
@ BBO_BOTTOM_CENTER
@ BBO_BOTTOM_RIGHT
@ BBO_TOP_CENTER
@ BBR_VERTEX
Rotate the billboard's vertices around their facing direction.
@ BBR_TEXCOORD
Rotate the billboard's texture coordinates.
@ BBT_PERPENDICULAR_COMMON
Billboards are perpendicular to a shared direction vector (used as Z axis, the facing direction) and ...
@ BBT_POINT
Standard point billboard (default), always faces the camera completely and is always upright.
@ BBT_PERPENDICULAR_SELF
Billboards are perpendicular to their own direction vector (their own Z axis, the facing direction) a...
@ BBT_ORIENTED_SELF
Billboards are oriented around their own direction vector (their own Y axis) and only rotate around t...
@ BBT_ORIENTED_COMMON
Billboards are oriented around a shared direction vector (used as Y axis) and only rotate around this...
SortMode
Sort mode for billboard-set and particle-system.
Definition: OgreCommon.h:287
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
unsigned char uchar
In order to avoid finger-aches :)
float Real
Software floating point type.
unsigned short uint16
Definition: OgrePlatform.h:360
unsigned int uint32
Definition: OgrePlatform.h:359
_StringBase String
float operator()(Billboard *bill) const
float operator()(Billboard *bill) const

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