OgreBillboardChain.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 // Thanks to Vincent Cantin (karmaGfa) for the original implementation of this
30 // class, although it has now been mostly rewritten
31 
32 #ifndef _BillboardChain_H__
33 #define _BillboardChain_H__
34 
35 #include "OgrePrerequisites.h"
36 
37 #include "OgreMovableObject.h"
38 #include "OgreRenderable.h"
40 #include "OgreHeaderPrefix.h"
41 
42 namespace Ogre {
43 
77  class _OgreExport BillboardChain : public MovableObject, public Renderable
78  {
79 
80  public:
81 
84  class _OgreExport Element
85  {
86 
87  public:
88 
89  Element();
90 
91  Element(const Vector3 &position,
92  Real width,
93  Real texCoord,
94  const ColourValue &colour,
95  const Quaternion &orientation);
96 
102 
105  };
107 
116  BillboardChain(const String& name, size_t maxElements = 20, size_t numberOfChains = 1,
117  bool useTextureCoords = true, bool useColours = true, bool dynamic = true);
119  virtual ~BillboardChain();
120 
123  virtual void setMaxChainElements(size_t maxElements);
126  virtual size_t getMaxChainElements(void) const { return mMaxElementsPerChain; }
130  virtual void setNumberOfChains(size_t numChains);
134  virtual size_t getNumberOfChains(void) const { return mChainCount; }
135 
142  virtual void setUseTextureCoords(bool use);
146  virtual bool getUseTextureCoords(void) const { return mUseTexCoords; }
147 
152  {
156  TCD_V
157  };
162  virtual void setTextureCoordDirection(TexCoordDirection dir);
166  virtual TexCoordDirection getTextureCoordDirection(void) { return mTexCoordDir; }
167 
173  virtual void setOtherTextureCoordRange(Real start, Real end);
177  virtual const Real* getOtherTextureCoordRange(void) const { return mOtherTexCoordRange; }
178 
185  virtual void setUseVertexColours(bool use);
189  virtual bool getUseVertexColours(void) const { return mUseVertexColour; }
190 
194  virtual void setDynamic(bool dyn);
195 
199  virtual bool getDynamic(void) const { return mDynamic; }
200 
209  virtual void addChainElement(size_t chainIndex,
210  const Element& billboardChainElement);
214  virtual void removeChainElement(size_t chainIndex);
221  virtual void updateChainElement(size_t chainIndex, size_t elementIndex,
222  const Element& billboardChainElement);
228  virtual const Element& getChainElement(size_t chainIndex, size_t elementIndex) const;
229 
231  virtual size_t getNumChainElements(size_t chainIndex) const;
232 
234  virtual void clearChain(size_t chainIndex);
236  virtual void clearAllChains(void);
237 
254  void setFaceCamera( bool faceCamera, const Vector3 &normalVector=Vector3::UNIT_X );
255 
257  virtual const String& getMaterialName(void) const { return mMaterialName; }
259  virtual void setMaterialName( const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
260 
261 
262  // Overridden members follow
263  Real getSquaredViewDepth(const Camera* cam) const;
264  Real getBoundingRadius(void) const;
265  const AxisAlignedBox& getBoundingBox(void) const;
266  const MaterialPtr& getMaterial(void) const;
267  const String& getMovableType(void) const;
268  void _updateRenderQueue(RenderQueue *);
269  void getRenderOperation(RenderOperation &);
270  virtual bool preRender(SceneManager* sm, RenderSystem* rsys);
271  void getWorldTransforms(Matrix4 *) const;
272  const LightList& getLights(void) const;
274  void visitRenderables(Renderable::Visitor* visitor,
275  bool debugRenderables = false);
276 
277 
278 
279  protected:
280 
284  size_t mChainCount;
290  bool mDynamic;
300  mutable bool mBoundsDirty;
308  mutable Real mRadius;
315  Real mOtherTexCoordRange[2];
324 
325 
328 
337  {
339  size_t start;
341  size_t head;
343  size_t tail;
344  };
347 
349  virtual void setupChainContainers(void);
351  virtual void setupVertexDeclaration(void);
353  virtual void setupBuffers(void);
355  virtual void updateVertexBuffer(Camera* cam);
357  virtual void updateIndexBuffer(void);
358  virtual void updateBoundingBox(void) const;
359 
361  static const size_t SEGMENT_EMPTY;
362  };
363 
364 
366  class _OgreExport BillboardChainFactory : public MovableObjectFactory
367  {
368  protected:
369  MovableObject* createInstanceImpl( const String& name, const NameValuePairList* params);
370  public:
373 
375 
376  const String& getType(void) const;
377  void destroyInstance( MovableObject* obj);
378 
379  };
380 
384 } // namespace
385 
386 #include "OgreHeaderSuffix.h"
387 
388 #endif
389 
390 
OgreHeaderSuffix.h
Ogre::HashedVector< Light * >
Ogre::BillboardChain::mChainElementList
ElementList mChainElementList
The list holding the chain elements.
Definition: OgreBillboardChain.h:327
Ogre::BillboardChain::mChainCount
size_t mChainCount
Number of chains.
Definition: OgreBillboardChain.h:284
Ogre::RenderSystem
Defines the functionality of a 3D API.
Definition: OgreRenderSystem.h:125
Ogre::BillboardChain::mFaceCamera
bool mFaceCamera
When true, the billboards always face the camera.
Definition: OgreBillboardChain.h:319
Ogre::BillboardChain::ElementList
vector< Element >::type ElementList
Definition: OgreBillboardChain.h:106
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::BillboardChain::mMaterial
MaterialPtr mMaterial
Definition: OgreBillboardChain.h:311
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::BillboardChain::mUseVertexColour
bool mUseVertexColour
Use vertex colour?
Definition: OgreBillboardChain.h:288
Ogre::BillboardChain::TexCoordDirection
TexCoordDirection
The direction in which texture coordinates from elements of the chain are used.
Definition: OgreBillboardChain.h:151
Ogre::BillboardChain::ChainSegment::start
size_t start
The start of this chains subset of the buffer.
Definition: OgreBillboardChain.h:339
Ogre::BillboardChain::mBoundsDirty
bool mBoundsDirty
Do the bounds need redefining?
Definition: OgreBillboardChain.h:300
Ogre::BillboardChain::mIndexData
IndexData * mIndexData
Index data (to allow multiple unconnected chains)
Definition: OgreBillboardChain.h:294
Ogre::BillboardChain::ChainSegment
Simple struct defining a chain segment by referencing a subset of the preallocated buffer (which will...
Definition: OgreBillboardChain.h:336
Ogre::BillboardChain::ChainSegment::head
size_t head
The 'head' of the chain, relative to start.
Definition: OgreBillboardChain.h:341
Ogre::BillboardChain::Element::colour
ColourValue colour
Definition: OgreBillboardChain.h:101
Ogre::MovableObject
Abstract class defining a movable object in a scene.
Definition: OgreMovableObject.h:60
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::BillboardChain::mBuffersNeedRecreating
bool mBuffersNeedRecreating
Do the buffers need recreating?
Definition: OgreBillboardChain.h:298
Ogre::BillboardChain::mVertexData
VertexData * mVertexData
Vertex data.
Definition: OgreBillboardChain.h:292
Ogre::BillboardChain::Element::position
Vector3 position
Definition: OgreBillboardChain.h:97
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::MovableObjectFactory
Interface definition for a factory class which produces a certain kind of MovableObject,...
Definition: OgreMovableObject.h:578
Ogre::BillboardChain::mMaxElementsPerChain
size_t mMaxElementsPerChain
Maximum length of each chain.
Definition: OgreBillboardChain.h:282
Ogre::Vector3::UNIT_X
static const Vector3 UNIT_X
Definition: OgreVector3.h:801
OgreResourceGroupManager.h
Ogre::BillboardChain::getDynamic
virtual bool getDynamic(void) const
Gets whether or not the buffers created for this object are suitable for dynamic alteration.
Definition: OgreBillboardChain.h:199
Ogre::NameValuePairList
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
Ogre::VertexData
Summary class collecting together vertex source information.
Definition: OgreVertexIndexData.h:49
Ogre::BillboardChain::mVertexDeclDirty
bool mVertexDeclDirty
Is the vertex declaration dirty?
Definition: OgreBillboardChain.h:296
Ogre::Quaternion
Implementation of a Quaternion, i.e.
Definition: OgreQuaternion.h:57
OgreHeaderPrefix.h
Ogre::Matrix4
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:78
Ogre::SceneManager
Manages the organisation and rendering of a 'scene' i.e.
Definition: OgreSceneManager.h:143
OgrePrerequisites.h
Ogre::BillboardChain::mNormalBase
Vector3 mNormalBase
Used when mFaceCamera == false; determines the billboard's "normal".
Definition: OgreBillboardChain.h:323
Ogre::BillboardChain::mUseTexCoords
bool mUseTexCoords
Use texture coords?
Definition: OgreBillboardChain.h:286
Ogre::BillboardChain::Element::orientation
Quaternion orientation
Only used when mFaceCamera == false.
Definition: OgreBillboardChain.h:104
Ogre::AxisAlignedBox
A 3D box aligned with the x/y/z axes.
Definition: OgreAxisAlignedBox.h:54
Ogre::BillboardChain::mRadius
Real mRadius
Bounding radius.
Definition: OgreBillboardChain.h:308
Ogre::BillboardChain::Element
Contains the data of an element of the BillboardChain.
Definition: OgreBillboardChain.h:84
Ogre::BillboardChain::mVertexContentDirty
bool mVertexContentDirty
Is the vertex buffer dirty?
Definition: OgreBillboardChain.h:304
Ogre::BillboardChainFactory::BillboardChainFactory
BillboardChainFactory()
Definition: OgreBillboardChain.h:371
Ogre::BillboardChain::SEGMENT_EMPTY
static const size_t SEGMENT_EMPTY
Chain segment has no elements.
Definition: OgreBillboardChain.h:361
Ogre::BillboardChain::mChainSegmentList
ChainSegmentList mChainSegmentList
Definition: OgreBillboardChain.h:346
Ogre::SharedPtr< Material >
OgreRenderable.h
OgreMovableObject.h
Ogre::BillboardChainFactory
Factory object for creating BillboardChain instances.
Definition: OgreBillboardChain.h:366
Ogre::BillboardChain::getUseTextureCoords
virtual bool getUseTextureCoords(void) const
Gets whether texture coordinate information should be included in the final buffers generated.
Definition: OgreBillboardChain.h:146
Ogre::ColourValue
Class representing colour.
Definition: OgreColourValue.h:57
Ogre::Renderable::Visitor
Visitor object that can be used to iterate over a collection of Renderable instances abstractly.
Definition: OgreRenderable.h:377
Ogre::BillboardChain::ChainSegmentList
vector< ChainSegment >::type ChainSegmentList
Definition: OgreBillboardChain.h:345
Ogre::BillboardChain::mDynamic
bool mDynamic
Dynamic use?
Definition: OgreBillboardChain.h:290
Ogre::BillboardChain::Element::texCoord
Real texCoord
U or V texture coord depending on options.
Definition: OgreBillboardChain.h:100
Ogre::Renderable
Abstract class defining the interface all renderable objects must implement.
Definition: OgreRenderable.h:63
Ogre::BillboardChain::mMaterialName
String mMaterialName
Material.
Definition: OgreBillboardChain.h:310
Ogre::BillboardChain::ChainSegment::tail
size_t tail
The 'tail' of the chain, relative to start.
Definition: OgreBillboardChain.h:343
Ogre::BillboardChain::mAABB
AxisAlignedBox mAABB
AABB.
Definition: OgreBillboardChain.h:306
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::BillboardChain::mTexCoordDir
TexCoordDirection mTexCoordDir
Texture coord direction.
Definition: OgreBillboardChain.h:313
Ogre::BillboardChain
Allows the rendering of a chain of connected billboards.
Definition: OgreBillboardChain.h:77
Ogre::BillboardChain::getUseVertexColours
virtual bool getUseVertexColours(void) const
Gets whether vertex colour information should be included in the final buffers generated.
Definition: OgreBillboardChain.h:189
Ogre::BillboardChain::TCD_U
@ TCD_U
Tex coord in elements is treated as the 'u' texture coordinate.
Definition: OgreBillboardChain.h:154
Ogre::vector
Definition: OgrePrerequisites.h:491
Ogre::BillboardChain::getNumberOfChains
virtual size_t getNumberOfChains(void) const
Get the number of chain segments (this class can render multiple chains at once using the same materi...
Definition: OgreBillboardChain.h:134
Ogre::BillboardChain::getMaxChainElements
virtual size_t getMaxChainElements(void) const
Get the maximum number of chain elements per chain.
Definition: OgreBillboardChain.h:126
Ogre::IndexData
Summary class collecting together index data source information.
Definition: OgreVertexIndexData.h:242
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:51
Ogre::BillboardChainFactory::~BillboardChainFactory
~BillboardChainFactory()
Definition: OgreBillboardChain.h:372
Ogre::RenderOperation
'New' rendering operation using vertex buffers.
Definition: OgreRenderOperation.h:45
Ogre::BillboardChain::getMaterialName
virtual const String & getMaterialName(void) const
Get the material name in use.
Definition: OgreBillboardChain.h:257
Ogre::BillboardChainFactory::FACTORY_TYPE_NAME
static String FACTORY_TYPE_NAME
Definition: OgreBillboardChain.h:374
Ogre::BillboardChain::mIndexContentDirty
bool mIndexContentDirty
Is the index buffer dirty?
Definition: OgreBillboardChain.h:302
Ogre::RenderQueue
Class to manage the scene object rendering queue.
Definition: OgreRenderQueue.h:92
Ogre::BillboardChain::mVertexCameraUsed
Camera * mVertexCameraUsed
Camera last used to build the vertex buffer.
Definition: OgreBillboardChain.h:317
Ogre::BillboardChain::getOtherTextureCoordRange
virtual const Real * getOtherTextureCoordRange(void) const
Get the range of the texture coordinates generated across the width of the chain elements.
Definition: OgreBillboardChain.h:177
Ogre::BillboardChain::getTextureCoordDirection
virtual TexCoordDirection getTextureCoordDirection(void)
Gets the direction in which texture coords specified on each element are deemed to run.
Definition: OgreBillboardChain.h:166
Ogre::BillboardChain::Element::width
Real width
Definition: OgreBillboardChain.h:98

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 Tue Apr 13 2021 08:53:15