orxonox::ParticleInterface Class Reference

#include <src/orxonox/tools/ParticleInterface.h>

Inheritance diagram for orxonox::ParticleInterface:

orxonox::TimeFactorListener orxonox::OrxonoxClass

List of all members.

Public Member Functions

Ogre::ParticleAffector * addAffector (const std::string &name)
Ogre::ParticleEmitter * createNewEmitter ()
void detailLevelChanged (unsigned int newlevel)
Ogre::ParticleAffector * getAffector (unsigned int affectorNr)
Ogre::ParticleEmitter * getEmitter (unsigned int emitterNr) const
bool getKeepParticlesInLocalSpace () const
unsigned int getNumAffectors () const
unsigned int getNumEmitters () const
Ogre::ParticleSystem * getParticleSystem ()
float getSpeedFactor () const
bool isEnabled () const
bool isVisible () const
 ParticleInterface (Ogre::SceneManager *scenemanager, const std::string &templateName, LODParticle::Value detaillevel)
void removeAffector (unsigned int affectorNr)
void removeAllAffectors ()
void removeAllEmitters ()
void removeEmitter (unsigned int emitterNr)
void setDetailLevel (unsigned int level)
void setEnabled (bool enable)
void setKeepParticlesInLocalSpace (bool keep)
void setSpeedFactor (float factor)
void setVisible (bool visible)
void storeThisAsCurrentParticleInterface ()
virtual ~ParticleInterface ()

Static Public Member Functions

static ParticleInterfacegetCurrentParticleInterface ()

Protected Member Functions

virtual void changedTimeFactor (float factor_new, float factor_old)

Private Member Functions

void updateVisibility ()

Private Attributes

bool bAllowedByLOD_
bool bEnabled_
bool bVisible_
unsigned int detaillevel_
 Detail level of this particle effect (0: off, 1: low, 2: normal, 3: high).
Ogre::ParticleSystem * particleSystem_
Ogre::SceneManager * scenemanager_
float speedFactor_

Static Private Attributes

static unsigned int counter_s = 0
static ParticleInterfacecurrentParticleInterface_s = 0


Constructor & Destructor Documentation

orxonox::ParticleInterface::ParticleInterface ( Ogre::SceneManager *  scenemanager,
const std::string templateName,
LODParticle::Value  detaillevel 
)

orxonox::ParticleInterface::~ParticleInterface (  )  [virtual]

References particleSystem_, and scenemanager_.


Member Function Documentation

Ogre::ParticleAffector * orxonox::ParticleInterface::addAffector ( const std::string name  ) 

References particleSystem_.

void orxonox::ParticleInterface::changedTimeFactor ( float  factor_new,
float  factor_old 
) [protected, virtual]

Reimplemented from orxonox::TimeFactorListener.

References setSpeedFactor(), and speedFactor_.

Ogre::ParticleEmitter * orxonox::ParticleInterface::createNewEmitter (  ) 

References particleSystem_.

void orxonox::ParticleInterface::detailLevelChanged ( unsigned int  newlevel  ) 

Ogre::ParticleAffector * orxonox::ParticleInterface::getAffector ( unsigned int  affectorNr  ) 

References particleSystem_.

static ParticleInterface* orxonox::ParticleInterface::getCurrentParticleInterface (  )  [inline, static]

Ogre::ParticleEmitter * orxonox::ParticleInterface::getEmitter ( unsigned int  emitterNr  )  const

References particleSystem_.

bool orxonox::ParticleInterface::getKeepParticlesInLocalSpace (  )  const

References particleSystem_.

unsigned int orxonox::ParticleInterface::getNumAffectors (  )  const

References particleSystem_.

unsigned int orxonox::ParticleInterface::getNumEmitters (  )  const

References particleSystem_.

Ogre::ParticleSystem* orxonox::ParticleInterface::getParticleSystem (  )  [inline]

float orxonox::ParticleInterface::getSpeedFactor (  )  const [inline]

bool orxonox::ParticleInterface::isEnabled (  )  const [inline]

Referenced by updateVisibility().

bool orxonox::ParticleInterface::isVisible (  )  const [inline]

Referenced by updateVisibility().

void orxonox::ParticleInterface::removeAffector ( unsigned int  affectorNr  ) 

References particleSystem_.

void orxonox::ParticleInterface::removeAllAffectors (  ) 

References particleSystem_.

void orxonox::ParticleInterface::removeAllEmitters (  ) 

References particleSystem_.

void orxonox::ParticleInterface::removeEmitter ( unsigned int  emitterNr  ) 

References particleSystem_.

void orxonox::ParticleInterface::setDetailLevel ( unsigned int  level  ) 

void orxonox::ParticleInterface::setEnabled ( bool  enable  ) 

void orxonox::ParticleInterface::setKeepParticlesInLocalSpace ( bool  keep  ) 

void orxonox::ParticleInterface::setSpeedFactor ( float  factor  ) 

void orxonox::ParticleInterface::setVisible ( bool  visible  ) 

void orxonox::ParticleInterface::storeThisAsCurrentParticleInterface (  )  [inline]

void orxonox::ParticleInterface::updateVisibility (  )  [private]


Member Data Documentation

Referenced by ParticleInterface(), and setEnabled().

Referenced by ParticleInterface(), and setVisible().

unsigned int orxonox::ParticleInterface::counter_s = 0 [static, private]

Referenced by ParticleInterface().

Detail level of this particle effect (0: off, 1: low, 2: normal, 3: high).

Referenced by detailLevelChanged(), and setDetailLevel().

Ogre::ParticleSystem* orxonox::ParticleInterface::particleSystem_ [private]

Ogre::SceneManager* orxonox::ParticleInterface::scenemanager_ [private]


The documentation for this class was generated from the following files:

Generated on Tue Jul 28 16:22:52 2009 for Orxonox by  doxygen 1.5.6