OGRE: OgreParticleAffector.h Source File - OGRE Documentation

# OgreParticleAffector.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 __ParticleAffector_H__
    00029 #define __ParticleAffector_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreString.h"
    00033 #include "OgreStringInterface.h"
    00034
    00035
    00036 namespace Ogre {
    00037
    00063     class _OgreExport ParticleAffector : public StringInterface, public FXAlloc
    00064     {
    00065     protected:
    00067         String mType;
    00068
    00077         void addBaseParameters(void) { /* actually do nothing - for future possible use */ }
    00078
    00079         ParticleSystem* mParent;
    00080     public:
    00081         ParticleAffector(ParticleSystem* parent): mParent(parent) {}
    00082
    00084         virtual ~ParticleAffector();
    00085
    00094         virtual void _initParticle(Particle* pParticle)
    00095                 {
    00096                     /* by default do nothing */
    00097                     (void)pParticle;
    00098                 }
    00099
    00110         virtual void _affectParticles(ParticleSystem* pSystem, Real timeElapsed) = 0;
    00111
    00117         const String &getType(void) const { return mType; }
    00118
    00119     };
    00123 }
    00124
    00125
    00126 #endif
    00127

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