OGRE: OgreParticleSystemRenderer.h Source File - OGRE Documentation

# OgreParticleSystemRenderer.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004 (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2006 Torus Knot Software Ltd
    00008 Also see acknowledgements in Readme.html
    00009
    00010 This program is free software; you can redistribute it and/or modify it under
    00011 the terms of the GNU Lesser General Public License as published by the Free Software
    00012 Foundation; either version 2 of the License, or (at your option) any later
    00013 version.
    00014
    00015 This program is distributed in the hope that it will be useful, but WITHOUT
    00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
    00018
    00019 You should have received a copy of the GNU Lesser General Public License along with
    00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
    00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
    00022 http://www.gnu.org/copyleft/lesser.txt.
    00023
    00024 You may alternatively use this source under the terms of a specific version of
    00025 the OGRE Unrestricted License provided you have obtained such a license from
    00026 Torus Knot Software Ltd.
    00027 -----------------------------------------------------------------------------
    00028 */
    00029 #ifndef __ParticleSystemRenderer_H__
    00030 #define __ParticleSystemRenderer_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033 #include "OgreStringInterface.h"
    00034 #include "OgreFactoryObj.h"
    00035 #include "OgreRenderQueue.h"
    00036 #include "OgreCommon.h"
    00037 #include "OgreRenderable.h"
    00038
    00039 namespace Ogre {
    00040
    00044     class _OgreExport ParticleSystemRenderer : public StringInterface, public FXAlloc
    00045     {
    00046     public:
    00048         ParticleSystemRenderer() {}
    00050         virtual ~ParticleSystemRenderer() {}
    00051
    00053         virtual const String& getType(void) const = 0;
    00054
    00060         virtual void _updateRenderQueue(RenderQueue* queue,
    00061             std::list<Particle*>& currentParticles, bool cullIndividually) = 0;
    00062
    00064         virtual void _setMaterial(MaterialPtr& mat) = 0;
    00066         virtual void _notifyCurrentCamera(Camera* cam) = 0;
    00068         virtual void _notifyAttached(Node* parent, bool isTagPoint = false) = 0;
    00070         virtual void _notifyParticleRotated(void) {}
    00072         virtual void _notifyParticleResized(void) {}
    00074         virtual void _notifyParticleQuota(size_t quota) = 0;
    00076         virtual void _notifyDefaultDimensions(Real width, Real height) = 0;
    00078         virtual void _notifyParticleEmitted(Particle* particle) {}
    00080         virtual void _notifyParticleExpired(Particle* particle) {}
    00082         virtual void _notifyParticleMoved(std::list<Particle*>& currentParticles) {}
    00084         virtual void _notifyParticleCleared(std::list<Particle*>& currentParticles) {}
    00092         virtual ParticleVisualData* _createVisualData(void) { return 0; }
    00100         virtual void _destroyVisualData(ParticleVisualData* vis) { assert (vis == 0); }
    00101
    00105         virtual void setRenderQueueGroup(uint8 queueID) = 0;
    00106
    00109         virtual void setKeepParticlesInLocalSpace(bool keepLocal) = 0;
    00110
    00112         virtual SortMode _getSortMode(void) const = 0;
    00113
    00118         virtual void visitRenderables(Renderable::Visitor* visitor,
    00119             bool debugRenderables = false) = 0;
    00120
    00121     };
    00122
    00124     class _OgreExport ParticleSystemRendererFactory : public FactoryObj<ParticleSystemRenderer>, public FXAlloc
    00125     {
    00126     public:
    00127         // No methods, must just override all methods inherited from FactoryObj
    00128     };
    00129
    00130 }
    00131
    00132 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:19 2009