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 
78  {
79 
80  public:
81 
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 
327  ElementList mChainElementList;
328 
337  {
339  size_t start;
341  size_t head;
343  size_t tail;
344  };
346  ChainSegmentList mChainSegmentList;
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 
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 
virtual bool getUseTextureCoords(void) const
Gets whether texture coordinate information should be included in the final buffers generated...
Real mRadius
Bounding radius.
size_t tail
The 'tail' of the chain, relative to start.
Abstract class defining the interface all renderable objects must implement.
bool mUseTexCoords
Use texture coords?
#define _OgreExport
Definition: OgrePlatform.h:257
static const size_t SEGMENT_EMPTY
Chain segment has no elements.
ChainSegmentList mChainSegmentList
Abstract class defining a movable object in a scene.
Summary class collecting together vertex source information.
Implementation of a Quaternion, i.e.
bool mVertexContentDirty
Is the vertex buffer dirty?
Simple struct defining a chain segment by referencing a subset of the preallocated buffer (which will...
virtual const String & getMaterialName(void) const
Get the material name in use.
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
virtual const Real * getOtherTextureCoordRange(void) const
Get the range of the texture coordinates generated across the width of the chain elements.
TexCoordDirection
The direction in which texture coordinates from elements of the chain are used.
Class representing colour.
float Real
Software floating point type.
static const Vector3 UNIT_X
Definition: OgreVector3.h:801
Class to manage the scene object rendering queue.
Summary class collecting together index data source information.
bool mDynamic
Dynamic use?
AxisAlignedBox mAABB
AABB.
TexCoordDirection mTexCoordDir
Texture coord direction.
String mMaterialName
Material.
vector< ChainSegment >::type ChainSegmentList
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:78
Standard 3-dimensional vector.
Definition: OgreVector3.h:51
Camera * mVertexCameraUsed
Camera last used to build the vertex buffer.
virtual TexCoordDirection getTextureCoordDirection(void)
Gets the direction in which texture coords specified on each element are deemed to run...
ElementList mChainElementList
The list holding the chain elements.
Real texCoord
U or V texture coord depending on options.
Visitor object that can be used to iterate over a collection of Renderable instances abstractly...
bool mIndexContentDirty
Is the index buffer dirty?
vector< Element >::type ElementList
Defines the functionality of a 3D API.
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
virtual bool getDynamic(void) const
Gets whether or not the buffers created for this object are suitable for dynamic alteration.
_StringBase String
size_t mChainCount
Number of chains.
bool mFaceCamera
When true, the billboards always face the camera.
size_t head
The 'head' of the chain, relative to start.
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
bool mUseVertexColour
Use vertex colour?
virtual size_t getMaxChainElements(void) const
Get the maximum number of chain elements per chain.
IndexData * mIndexData
Index data (to allow multiple unconnected chains)
bool mBoundsDirty
Do the bounds need redefining?
bool mBuffersNeedRecreating
Do the buffers need recreating?
VertexData * mVertexData
Vertex data.
size_t mMaxElementsPerChain
Maximum length of each chain.
virtual size_t getNumberOfChains(void) const
Get the number of chain segments (this class can render multiple chains at once using the same materi...
size_t start
The start of this chains subset of the buffer.
'New' rendering operation using vertex buffers.
Quaternion orientation
Only used when mFaceCamera == false.
Interface definition for a factory class which produces a certain kind of MovableObject, and can be registered with Root in order to allow all clients to produce new instances of this object, integrated with the standard Ogre processing.
Contains the data of an element of the BillboardChain.
virtual bool getUseVertexColours(void) const
Gets whether vertex colour information should be included in the final buffers generated.
A 3D box aligned with the x/y/z axes.
Manages the organisation and rendering of a 'scene' i.e.
Vector3 mNormalBase
Used when mFaceCamera == false; determines the billboard's "normal".
Tex coord in elements is treated as the 'u' texture coordinate.
bool mVertexDeclDirty
Is the vertex declaration dirty?
Allows the rendering of a chain of connected billboards.
Factory object for creating BillboardChain instances.

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 Sat Oct 25 2014 14:52:00