OGRE: OgreParticle.h Source File - OGRE Documentation

# OgreParticle.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 __Particle_H__
    00029 #define __Particle_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreBillboard.h"
    00033
    00034 namespace Ogre {
    00035
    00051     class _OgreExport ParticleVisualData : public FXAlloc
    00052     {
    00053     public:
    00054         ParticleVisualData() {}
    00055         virtual ~ParticleVisualData() {}
    00056
    00057     };
    00058
    00060     class _OgreExport Particle : public FXAlloc
    00061     {
    00062     protected:
    00064         ParticleSystem* mParentSystem;
    00066         ParticleVisualData* mVisual;
    00067     public:
    00069         enum ParticleType
    00070         {
    00071             Visual,
    00072             Emitter
    00073         };
    00074
    00076         bool mOwnDimensions;
    00078         Real mWidth;
    00080         Real mHeight;
    00082         Radian rotation;
    00083         // Note the intentional public access to internal variables
    00084         // Accessing via get/set would be too costly for 000's of particles
    00086         Vector3 position;
    00088         Vector3 direction;
    00090         ColourValue colour;
    00092         Real timeToLive;
    00094         Real totalTimeToLive;
    00096         Radian rotationSpeed;
    00098         ParticleType particleType;
    00099
    00100         Particle()
    00101             : mParentSystem(0), mVisual(0), mOwnDimensions(false), rotation(0),
    00102             position(Vector3::ZERO), direction(Vector3::ZERO),
    00103             colour(ColourValue::White), timeToLive(10), totalTimeToLive(10),
    00104             rotationSpeed(0), particleType(Visual)
    00105         {
    00106         }
    00107
    00115         void setDimensions(Real width, Real height);
    00116
    00122         bool hasOwnDimensions(void) const { return mOwnDimensions; }
    00123
    00125         Real getOwnWidth(void) const { return mWidth; }
    00126
    00128         Real getOwnHeight(void) const { return mHeight; }
    00129
    00131         void setRotation(const Radian& rad);
    00132
    00133         const Radian& getRotation(void) const { return rotation; }
    00134
    00137         void _notifyOwner(ParticleSystem* owner);
    00138
    00141         void _notifyVisualData(ParticleVisualData* vis) { mVisual = vis; }
    00142
    00144         ParticleVisualData* getVisualData(void) const { return mVisual; }
    00145
    00147         void resetDimensions(void);
    00148     };
    00151 }
    00152
    00153 #endif
    00154

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