OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreParticleSystemRenderer.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 #ifndef __ParticleSystemRenderer_H__
29 #define __ParticleSystemRenderer_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreStringInterface.h"
33 #include "OgreFactoryObj.h"
34 #include "OgreRenderQueue.h"
35 #include "OgreCommon.h"
36 #include "OgreRenderable.h"
37 
38 namespace Ogre {
39 
50  {
51  public:
56 
58  virtual const String& getType(void) const = 0;
59 
65  virtual void _updateRenderQueue(RenderQueue* queue, Camera *camera,
66  const Camera *lodCamera, list<Particle*>::type& currentParticles,
67  bool cullIndividually) = 0;
68 
70  virtual void _setMaterial(MaterialPtr& mat) = 0;
72  virtual void _notifyCurrentCamera(Camera* cam) = 0;
74  virtual void _notifyAttached(Node* parent) = 0;
76  virtual void _notifyParticleRotated(void) {}
78  virtual void _notifyParticleResized(void) {}
80  virtual void _notifyParticleQuota(size_t quota) = 0;
82  virtual void _notifyDefaultDimensions(Real width, Real height) = 0;
84  virtual void _notifyParticleEmitted(Particle* particle) {}
86  virtual void _notifyParticleExpired(Particle* particle) {}
88  virtual void _notifyParticleMoved(list<Particle*>::type& currentParticles) {}
90  virtual void _notifyParticleCleared(list<Particle*>::type& currentParticles) {}
98  virtual ParticleVisualData* _createVisualData(void) { return 0; }
106  virtual void _destroyVisualData(ParticleVisualData* vis) { assert (vis == 0); }
107 
111  virtual void setRenderQueueGroup(uint8 queueID) = 0;
115  virtual void setRenderQueueGroupAndPriority(uint8 queueID, ushort priority) = 0;
116 
119  virtual void setKeepParticlesInLocalSpace(bool keepLocal) = 0;
120 
122  virtual SortMode _getSortMode(void) const = 0;
123 
128  virtual void visitRenderables(Renderable::Visitor* visitor,
129  bool debugRenderables = false) = 0;
130 
131  };
132 
134  class _OgreExport ParticleSystemRendererFactory : public FactoryObj<ParticleSystemRenderer>, public FXAlloc
135  {
136  public:
137  // No methods, must just override all methods inherited from FactoryObj
138  };
142 }
143 
144 #endif
unsigned char uint8
Definition: OgrePlatform.h:422
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:82
float Real
Software floating point type.
Abstract class defining the interface required to be implemented by classes which provide rendering c...
#define _OgreExport
Definition: OgrePlatform.h:255
virtual void _notifyParticleExpired(Particle *particle)
Optional callback notified when particle expired.
Abstract class definition of a factory object for ParticleSystemRenderer.
virtual void _notifyParticleResized(void)
Optional callback notified when particles are resized individually.
virtual void _notifyParticleEmitted(Particle *particle)
Optional callback notified when particle emitted.
virtual ParticleVisualData * _createVisualData(void)
Create a new ParticleVisualData instance for attachment to a particle.
virtual ~ParticleSystemRenderer()
Destructor.
Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
virtual void _notifyParticleMoved(list< Particle * >::type &currentParticles)
Optional callback notified when particles moved.
Class representing a single particle instance.
Definition: OgreParticle.h:60
SortMode
Sort mode for billboard-set and particle-system.
Definition: OgreCommon.h:231
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
virtual void _notifyParticleCleared(list< Particle * >::type &currentParticles)
Optional callback notified when particles cleared.
virtual void _destroyVisualData(ParticleVisualData *vis)
Destroy a ParticleVisualData instance.
Visitor object that can be used to iterate over a collection of Renderable instances abstractly...
unsigned short ushort
Class to manage the scene object rendering queue.
_StringBase String
Definition: OgreCommon.h:53
Abstract factory class.
Abstract class containing any additional data required to be associated with a particle to perform th...
Definition: OgreParticle.h:51
Class representing a general-purpose node an articulated scene graph.
Definition: OgreNode.h:58
virtual void _notifyParticleRotated(void)
Optional callback notified when particles are rotated.