Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/tools/ParticleInterface.h @ 10624

Last change on this file since 10624 was 10624, checked in by landauf, 8 years ago

merged branch core7 back to trunk

  • Property svn:eol-style set to native
File size: 3.5 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 "tools/ToolsPrereqs.h"
33
34#include "util/OgreForwardRefs.h"
35#include "tools/interfaces/TimeFactorListener.h"
36
37namespace orxonox
38{
39    class _ToolsExport ParticleInterface : public TimeFactorListener
40    {
41        public:
42            ParticleInterface(Ogre::SceneManager* scenemanager, const std::string& templateName, LODParticle::Value detaillevel);
43            virtual ~ParticleInterface();
44            void setConfigValues();
45
46            inline Ogre::ParticleSystem* getParticleSystem()
47                { return this->particleSystem_; }
48
49            Ogre::ParticleEmitter* createNewEmitter();
50            Ogre::ParticleEmitter* getEmitter(unsigned int emitterNr) const;
51            void removeEmitter(unsigned int emitterNr);
52            void removeAllEmitters();
53            unsigned int getNumEmitters() const;
54
55            Ogre::ParticleAffector* addAffector(const std::string& name);
56            Ogre::ParticleAffector* getAffector(unsigned int affectorNr);
57            void removeAffector(unsigned int affectorNr);
58            void removeAllAffectors();
59            unsigned int getNumAffectors() const;
60
61            inline float getSpeedFactor() const
62                { return this->speedFactor_; }
63            void setSpeedFactor(float factor);
64            bool getKeepParticlesInLocalSpace() const;
65            void setKeepParticlesInLocalSpace(bool keep);
66
67            void setEnabled(bool enable);
68            inline bool isEnabled() const
69                { return this->bEnabled_; }
70
71            void setVisible(bool visible);
72            inline bool isVisible() const
73                { return this->bVisible_; }
74
75            void setDetailLevel(unsigned int level);
76
77        protected:
78            virtual void changedTimeFactor(float factor_new, float factor_old);
79
80        private:
81            void updateVisibility();
82            void detailLevelChanged();
83
84            Ogre::ParticleSystem*     particleSystem_;
85            Ogre::SceneManager*       scenemanager_;
86            bool                      bVisible_;
87            bool                      bEnabled_;
88            bool                      bAllowedByLOD_;
89            unsigned int              detaillevel_;       //!< Detail level of this particle effect (0: off, 1: low, 2: normal, 3: high)
90            float                     speedFactor_;
91
92            // config values
93            unsigned int              globalDetailLevel_; //!< Global maximum detail level of particle effects (0: off, 1: low, 2: normal, 3: high)
94
95            static unsigned int       counter_s;
96    };
97}
98
99#endif /* _ParticleInterface_H__ */
Note: See TracBrowser for help on using the repository browser.