Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/tools/ParticleInterface.h @ 3290

Last change on this file since 3290 was 3280, checked in by rgrieder, 15 years ago

Merged most of the core4 revisions back to the trunk except for:

  • orxonox_cast
  • all the radical changes in the input library
  • Property svn:eol-style set to native
File size: 3.9 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _ParticleInterface_H__
30#define _ParticleInterface_H__
31
32#include "OrxonoxPrereqs.h"
33
34#include "util/OgreForwardRefs.h"
35#include "interfaces/TimeFactorListener.h"
36
37#define getAllEmitters() \
38  storeThisAsCurrentParticleInterface(); \
39  for (unsigned int i = 0; i < ParticleInterface::getCurrentParticleInterface()->getNumEmitters(); ++i) \
40    ParticleInterface::getCurrentParticleInterface()->getEmitter(i)
41
42namespace orxonox
43{
44    class _OrxonoxExport ParticleInterface : public TimeFactorListener
45    {
46        public:
47            ParticleInterface(Ogre::SceneManager* scenemanager, const std::string& templateName, LODParticle::Value detaillevel);
48            virtual ~ParticleInterface();
49
50            inline Ogre::ParticleSystem* getParticleSystem()
51                { return this->particleSystem_; }
52
53            Ogre::ParticleEmitter* createNewEmitter();
54            Ogre::ParticleEmitter* getEmitter(unsigned int emitterNr) const;
55            void removeEmitter(unsigned int emitterNr);
56            void removeAllEmitters();
57            unsigned int getNumEmitters() const;
58
59            Ogre::ParticleAffector* addAffector(const std::string& name);
60            Ogre::ParticleAffector* getAffector(unsigned int affectorNr);
61            void removeAffector(unsigned int affectorNr);
62            void removeAllAffectors();
63            unsigned int getNumAffectors() const;
64
65            inline float getSpeedFactor() const
66                { return this->speedFactor_; }
67            void setSpeedFactor(float factor);
68            bool getKeepParticlesInLocalSpace() const;
69            void setKeepParticlesInLocalSpace(bool keep);
70
71            void setEnabled(bool enable);
72            inline bool isEnabled() const
73                { return this->bEnabled_; }
74
75            void setVisible(bool visible);
76            inline bool isVisible() const
77                { return this->bVisible_; }
78
79            void detailLevelChanged(unsigned int newlevel);
80            void setDetailLevel(unsigned int level);
81
82            inline void storeThisAsCurrentParticleInterface()
83                { ParticleInterface::currentParticleInterface_s = this; }
84            inline static ParticleInterface* getCurrentParticleInterface()
85                { return ParticleInterface::currentParticleInterface_s; }
86
87        protected:
88            virtual void changedTimeFactor(float factor_new, float factor_old);
89
90        private:
91            void updateVisibility();
92
93            Ogre::ParticleSystem*     particleSystem_;
94            Ogre::SceneManager*       scenemanager_;
95            bool                      bVisible_;
96            bool                      bEnabled_;
97            bool                      bAllowedByLOD_;
98            unsigned int              detaillevel_;     //!< Detail level of this particle effect (0: off, 1: low, 2: normal, 3: high)
99            float                     speedFactor_;
100
101            static ParticleInterface* currentParticleInterface_s;
102            static unsigned int       counter_s;
103    };
104}
105
106#endif /* _ParticleInterface_H__ */
Note: See TracBrowser for help on using the repository browser.