OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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( IdType id, ObjectMemoryManager *objectMemoryManager, size_t maxElements = 20,
117  size_t numberOfChains = 1, bool useTextureCoords = true, bool useColours = true,
118  bool dynamic = true );
120  virtual ~BillboardChain();
121 
124  virtual void setMaxChainElements(size_t maxElements);
127  virtual size_t getMaxChainElements(void) const { return mMaxElementsPerChain; }
131  virtual void setNumberOfChains(size_t numChains);
135  virtual size_t getNumberOfChains(void) const { return mChainCount; }
136 
143  virtual void setUseTextureCoords(bool use);
147  virtual bool getUseTextureCoords(void) const { return mUseTexCoords; }
148 
153  {
157  TCD_V
158  };
163  virtual void setTextureCoordDirection(TexCoordDirection dir);
167  virtual TexCoordDirection getTextureCoordDirection(void) { return mTexCoordDir; }
168 
174  virtual void setOtherTextureCoordRange(Real start, Real end);
178  virtual const Real* getOtherTextureCoordRange(void) const { return mOtherTexCoordRange; }
179 
186  virtual void setUseVertexColours(bool use);
190  virtual bool getUseVertexColours(void) const { return mUseVertexColour; }
191 
195  virtual void setDynamic(bool dyn);
196 
200  virtual bool getDynamic(void) const { return mDynamic; }
201 
210  virtual void addChainElement(size_t chainIndex,
211  const Element& billboardChainElement);
215  virtual void removeChainElement(size_t chainIndex);
222  virtual void updateChainElement(size_t chainIndex, size_t elementIndex,
223  const Element& billboardChainElement);
229  virtual const Element& getChainElement(size_t chainIndex, size_t elementIndex) const;
230 
232  virtual size_t getNumChainElements(size_t chainIndex) const;
233 
235  virtual void clearChain(size_t chainIndex);
237  virtual void clearAllChains(void);
238 
255  void setFaceCamera( bool faceCamera, const Vector3 &normalVector=Vector3::UNIT_X );
256 
258  virtual const String& getMaterialName(void) const { return mMaterialName; }
260  virtual void setMaterialName( const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME );
261 
262 
263  // Overridden members follow
264  Real getSquaredViewDepth(const Camera* cam) const;
265  const AxisAlignedBox& getBoundingBox(void) const;
266  const MaterialPtr& getMaterial(void) const;
267  const String& getMovableType(void) const;
268  void _updateRenderQueue(RenderQueue *, Camera *camera, const Camera *lodCamera);
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 
367  {
368  protected:
369  virtual MovableObject* createInstanceImpl( IdType id, ObjectMemoryManager *objectMemoryManager,
370  const NameValuePairList* params = 0 );
371  public:
374 
376 
377  const String& getType(void) const;
378  void destroyInstance( MovableObject* obj);
379 
380  };
381 
385 } // namespace
386 
387 #include "OgreHeaderSuffix.h"
388 
389 #endif
390 
391 
size_t mMaxElementsPerChain
Maximum length of each chain.
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:82
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:79
VertexData * mVertexData
Vertex data.
float Real
Software floating point type.
bool mIndexContentDirty
Is the index buffer dirty?
#define _OgreExport
Definition: OgrePlatform.h:255
size_t start
The start of this chains subset of the buffer.
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:580
String mMaterialName
Material.
Vector3 mNormalBase
Used when mFaceCamera == false; determines the billboard's "normal".
Contains the data of an element of the BillboardChain.
Class representing colour.
vector< ChainSegment >::type ChainSegmentList
Manages the organisation and rendering of a 'scene' i.e.
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.
A 3D box aligned with the x/y/z axes.
IndexData * mIndexData
Index data (to allow multiple unconnected chains)
Real texCoord
U or V texture coord depending on options.
ChainSegmentList mChainSegmentList
virtual bool getUseVertexColours(void) const
Gets whether vertex colour information should be included in the final buffers generated.
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.
virtual size_t getMaxChainElements(void) const
Get the maximum number of chain elements per chain.
Wrap-around class that contains multiple ArrayMemoryManager, one per render queue.
Abstract class defining a movable object in a scene.
virtual const String & getMaterialName(void) const
Get the material name in use.
Camera * mVertexCameraUsed
Camera last used to build the vertex buffer.
bool mVertexContentDirty
Is the vertex buffer dirty?
Abstract class defining the interface all renderable objects must implement.
Implementation of a Quaternion, i.e.
virtual size_t getNumberOfChains(void) const
Get the number of chain segments (this class can render multiple chains at once using the same materi...
Allows the rendering of a chain of connected billboards.
size_t mChainCount
Number of chains.
size_t tail
The 'tail' of the chain, relative to start.
ElementList mChainElementList
The list holding the chain elements.
TexCoordDirection
The direction in which texture coordinates from elements of the chain are used.
AxisAlignedBox mAABB
AABB.
Real mRadius
Bounding radius.
vector< Element >::type ElementList
Ogre::uint32 IdType
Big projects with lots, lots of units for very long periods of time (MMORPGs?) may want to define thi...
Definition: OgreId.h:36
bool mBoundsDirty
Do the bounds need redefining?
Summary class collecting together index data source information.
Visitor object that can be used to iterate over a collection of Renderable instances abstractly...
Tex coord in elements is treated as the 'u' texture coordinate.
Quaternion orientation
Only used when mFaceCamera == false.
size_t head
The 'head' of the chain, relative to start.
bool mDynamic
Dynamic use?
Standard 3-dimensional vector.
Definition: OgreVector3.h:50
bool mUseTexCoords
Use texture coords?
bool mVertexDeclDirty
Is the vertex declaration dirty?
Summary class collecting together vertex source information.
'New' rendering operation using vertex buffers.
static const Vector3 UNIT_X
Definition: OgreVector3.h:808
Class to manage the scene object rendering queue.
bool mBuffersNeedRecreating
Do the buffers need recreating?
TexCoordDirection mTexCoordDir
Texture coord direction.
Factory object for creating BillboardChain instances.
_StringBase String
Definition: OgreCommon.h:53
static const size_t SEGMENT_EMPTY
Chain segment has no elements.
Defines the functionality of a 3D API.
bool mFaceCamera
When true, the billboards always face the camera.
virtual bool getUseTextureCoords(void) const
Gets whether texture coordinate information should be included in the final buffers generated...
virtual TexCoordDirection getTextureCoordDirection(void)
Gets the direction in which texture coords specified on each element are deemed to run...
Simple struct defining a chain segment by referencing a subset of the preallocated buffer (which will...
virtual bool getDynamic(void) const
Gets whether or not the buffers created for this object are suitable for dynamic alteration.
bool mUseVertexColour
Use vertex colour?