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-2012 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 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