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-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 #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,
66  list<Particle*>::type& currentParticles, bool cullIndividually) = 0;
67 
69  virtual void _setMaterial(MaterialPtr& mat) = 0;
71  virtual void _notifyCurrentCamera(Camera* cam) = 0;
73  virtual void _notifyAttached(Node* parent, bool isTagPoint = false) = 0;
75  virtual void _notifyParticleRotated(void) {}
77  virtual void _notifyParticleResized(void) {}
79  virtual void _notifyParticleQuota(size_t quota) = 0;
81  virtual void _notifyDefaultDimensions(Real width, Real height) = 0;
83  virtual void _notifyParticleEmitted(Particle* particle) {}
85  virtual void _notifyParticleExpired(Particle* particle) {}
87  virtual void _notifyParticleMoved(list<Particle*>::type& currentParticles) {}
89  virtual void _notifyParticleCleared(list<Particle*>::type& currentParticles) {}
97  virtual ParticleVisualData* _createVisualData(void) { return 0; }
105  virtual void _destroyVisualData(ParticleVisualData* vis) { assert (vis == 0); }
106 
110  virtual void setRenderQueueGroup(uint8 queueID) = 0;
114  virtual void setRenderQueueGroupAndPriority(uint8 queueID, ushort priority) = 0;
115 
118  virtual void setKeepParticlesInLocalSpace(bool keepLocal) = 0;
119 
121  virtual SortMode _getSortMode(void) const = 0;
122 
127  virtual void visitRenderables(Renderable::Visitor* visitor,
128  bool debugRenderables = false) = 0;
129 
130  };
131 
133  class _OgreExport ParticleSystemRendererFactory : public FactoryObj<ParticleSystemRenderer>, public FXAlloc
134  {
135  public:
136  // No methods, must just override all methods inherited from FactoryObj
137  };
141 }
142 
143 #endif

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 Wed Oct 23 2013 06:57:24