OgreParticleSystemRenderer.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __ParticleSystemRenderer_H__
#define __ParticleSystemRenderer_H__
#include "OgrePrerequisites.h"
#include "OgreStringInterface.h"
#include "OgreFactoryObj.h"
#include "OgreRenderQueue.h"
#include "OgreCommon.h"
#include "OgreRenderable.h"
namespace Ogre {
class _OgreExport ParticleSystemRenderer : public StringInterface, public FXAlloc
{
public:
ParticleSystemRenderer() {}
virtual ~ParticleSystemRenderer() {}
virtual const String& getType(void) const = 0;
virtual void _updateRenderQueue(RenderQueue* queue,
list<Particle*>::type& currentParticles, bool cullIndividually) = 0;
virtual void _setMaterial(MaterialPtr& mat) = 0;
virtual void _notifyCurrentCamera(Camera* cam) = 0;
virtual void _notifyAttached(Node* parent, bool isTagPoint = false) = 0;
virtual void _notifyParticleRotated(void) {}
virtual void _notifyParticleResized(void) {}
virtual void _notifyParticleQuota(size_t quota) = 0;
virtual void _notifyDefaultDimensions(Real width, Real height) = 0;
virtual void _notifyParticleEmitted(Particle* particle) {}
virtual void _notifyParticleExpired(Particle* particle) {}
virtual void _notifyParticleMoved(list<Particle*>::type& currentParticles) {}
virtual void _notifyParticleCleared(list<Particle*>::type& currentParticles) {}
virtual ParticleVisualData* _createVisualData(void) { return 0; }
virtual void _destroyVisualData(ParticleVisualData* vis) { assert (vis == 0); }
virtual void setRenderQueueGroup(uint8 queueID) = 0;
virtual void setRenderQueueGroupAndPriority(uint8 queueID, ushort priority) = 0;
virtual void setKeepParticlesInLocalSpace(bool keepLocal) = 0;
virtual SortMode _getSortMode(void) const = 0;
virtual void visitRenderables(Renderable::Visitor* visitor,
bool debugRenderables = false) = 0;
};
class _OgreExport ParticleSystemRendererFactory : public FactoryObj<ParticleSystemRenderer>, public FXAlloc
{
public:
// No methods, must just override all methods inherited from FactoryObj
};
}
#endif
Ogre::ParticleSystemRenderer::_notifyParticleResized
virtual void _notifyParticleResized(void)
Optional callback notified when particles are resized individually.
Definition: OgreParticleSystemRenderer.h:77
OgreRenderQueue.h
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::list
Definition: OgrePrerequisites.h:505
Ogre::ParticleSystemRenderer::~ParticleSystemRenderer
virtual ~ParticleSystemRenderer()
Destructor.
Definition: OgreParticleSystemRenderer.h:55
Ogre::ParticleSystemRenderer::_notifyParticleExpired
virtual void _notifyParticleExpired(Particle *particle)
Optional callback notified when particle expired.
Definition: OgreParticleSystemRenderer.h:85
OgreRenderable.h
Ogre::ParticleSystemRenderer::_notifyParticleCleared
virtual void _notifyParticleCleared(list< Particle *>::type &currentParticles)
Optional callback notified when particles cleared.
Definition: OgreParticleSystemRenderer.h:89
Ogre::ParticleSystemRenderer::ParticleSystemRenderer
ParticleSystemRenderer()
Constructor.
Definition: OgreParticleSystemRenderer.h:53
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::RenderQueue
Class to manage the scene object rendering queue.
Definition: OgreRenderQueue.h:92
OgreCommon.h
Ogre::ParticleSystemRenderer::_notifyParticleMoved
virtual void _notifyParticleMoved(list< Particle *>::type &currentParticles)
Optional callback notified when particles moved.
Definition: OgreParticleSystemRenderer.h:87
Ogre::SortMode
SortMode
Sort mode for billboard-set and particle-system.
Definition: OgreCommon.h:286
Ogre::ParticleSystemRendererFactory
Abstract class definition of a factory object for ParticleSystemRenderer.
Definition: OgreParticleSystemRenderer.h:133
OgrePrerequisites.h
Ogre::ParticleSystemRenderer
Abstract class defining the interface required to be implemented by classes which provide rendering c...
Definition: OgreParticleSystemRenderer.h:49
Ogre::FactoryObj
Abstract factory class.
Definition: OgreFactoryObj.h:44
Ogre::Renderable::Visitor
Visitor object that can be used to iterate over a collection of Renderable instances abstractly...
Definition: OgreRenderable.h:377
Ogre::Node
Class representing a general-purpose node an articulated scene graph.
Definition: OgreNode.h:64
Ogre::uint8
unsigned char uint8
Definition: OgrePlatform.h:361
Ogre::StringInterface
Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
Definition: OgreStringInterface.h:163
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::ParticleVisualData
Abstract class containing any additional data required to be associated with a particle to perform th...
Definition: OgreParticle.h:52
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::ParticleSystemRenderer::_destroyVisualData
virtual void _destroyVisualData(ParticleVisualData *vis)
Destroy a ParticleVisualData instance.
Definition: OgreParticleSystemRenderer.h:105
OgreFactoryObj.h
Ogre::Particle
Class representing a single particle instance.
Definition: OgreParticle.h:61
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::SharedPtr< Material >
Ogre::ParticleSystemRenderer::_notifyParticleEmitted
virtual void _notifyParticleEmitted(Particle *particle)
Optional callback notified when particle emitted.
Definition: OgreParticleSystemRenderer.h:83
Ogre::ParticleSystemRenderer::_createVisualData
virtual ParticleVisualData * _createVisualData(void)
Create a new ParticleVisualData instance for attachment to a particle.
Definition: OgreParticleSystemRenderer.h:97
Ogre::ushort
unsigned short ushort
Definition: OgrePrerequisites.h:113
OgreStringInterface.h
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58
Ogre::ParticleSystemRenderer::_notifyParticleRotated
virtual void _notifyParticleRotated(void)
Optional callback notified when particles are rotated.
Definition: OgreParticleSystemRenderer.h:75

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.