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-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __ParticleSystemRenderer_H__
    00029 #define __ParticleSystemRenderer_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreStringInterface.h"
    00033 #include "OgreFactoryObj.h"
    00034 #include "OgreRenderQueue.h"
    00035 #include "OgreCommon.h"
    00036 #include "OgreRenderable.h"
    00037
    00038 namespace Ogre {
    00039
    00049     class _OgreExport ParticleSystemRenderer : public StringInterface, public FXAlloc
    00050     {
    00051     public:
    00053         ParticleSystemRenderer() {}
    00055         virtual ~ParticleSystemRenderer() {}
    00056
    00058         virtual const String& getType(void) const = 0;
    00059
    00065         virtual void _updateRenderQueue(RenderQueue* queue,
    00066             list<Particle*>::type& currentParticles, bool cullIndividually) = 0;
    00067
    00069         virtual void _setMaterial(MaterialPtr& mat) = 0;
    00071         virtual void _notifyCurrentCamera(Camera* cam) = 0;
    00073         virtual void _notifyAttached(Node* parent, bool isTagPoint = false) = 0;
    00075         virtual void _notifyParticleRotated(void) {}
    00077         virtual void _notifyParticleResized(void) {}
    00079         virtual void _notifyParticleQuota(size_t quota) = 0;
    00081         virtual void _notifyDefaultDimensions(Real width, Real height) = 0;
    00083         virtual void _notifyParticleEmitted(Particle* particle) {}
    00085         virtual void _notifyParticleExpired(Particle* particle) {}
    00087         virtual void _notifyParticleMoved(list<Particle*>::type& currentParticles) {}
    00089         virtual void _notifyParticleCleared(list<Particle*>::type& currentParticles) {}
    00097         virtual ParticleVisualData* _createVisualData(void) { return 0; }
    00105         virtual void _destroyVisualData(ParticleVisualData* vis) { assert (vis == 0); }
    00106
    00110         virtual void setRenderQueueGroup(uint8 queueID) = 0;
    00111
    00114         virtual void setKeepParticlesInLocalSpace(bool keepLocal) = 0;
    00115
    00117         virtual SortMode _getSortMode(void) const = 0;
    00118
    00123         virtual void visitRenderables(Renderable::Visitor* visitor,
    00124             bool debugRenderables = false) = 0;
    00125
    00126     };
    00127
    00129     class _OgreExport ParticleSystemRendererFactory : public FactoryObj<ParticleSystemRenderer>, public FXAlloc
    00130     {
    00131     public:
    00132         // No methods, must just override all methods inherited from FactoryObj
    00133     };
    00137 }
    00138
    00139 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52