orxonox::ParticleSpawner Class Reference

#include <src/orxonox/objects/worldentities/ParticleSpawner.h>

Inheritance diagram for orxonox::ParticleSpawner:

orxonox::ParticleEmitter orxonox::StaticEntity orxonox::WorldEntity orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxClass

List of all members.

Public Member Functions

void configure (float lifetime=0, float startdelay=0, float destroydelay=0, bool autodestroy=true)
void destroy ()
bool getAutoStart () const
bool getDestroyAfterLife () const
float getDestroydelay () const
float getLifetime () const
bool getLoop () const
float getStartdelay () const
 ParticleSpawner (BaseObject *creator)
virtual void processEvent (Event &event)
void setAutoStart (bool autostart)
void setDestroyAfterLife (bool destroy)
void setDestroydelay (float destroydelay)
void setLifetime (float lifetime)
void setLoop (bool loop)
void setStartdelay (float startdelay)
void spawn ()
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 XML loading and saving.
virtual ~ParticleSpawner ()

Private Member Functions

void destroyParticleSpawner ()
void fireParticleSpawner ()
void startParticleSpawner ()
void stopParticleSpawner ()

Private Attributes

bool bAutoDestroy_
bool bAutostart_
bool bForceDestroy_
bool bLoop_
bool bSuppressStart_
float destroydelay_
float lifetime_
float startdelay_
Timer< ParticleSpawnertimer_


Constructor & Destructor Documentation

orxonox::ParticleSpawner::ParticleSpawner ( BaseObject creator  ) 

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


Member Function Documentation

void orxonox::ParticleSpawner::configure ( float  lifetime = 0,
float  startdelay = 0,
float  destroydelay = 0,
bool  autodestroy = true 
)

void orxonox::ParticleSpawner::destroy (  )  [inline]

void orxonox::ParticleSpawner::destroyParticleSpawner (  )  [private]

Referenced by stopParticleSpawner().

void orxonox::ParticleSpawner::fireParticleSpawner (  )  [private]

bool orxonox::ParticleSpawner::getAutoStart (  )  const [inline]

Referenced by XMLPort().

bool orxonox::ParticleSpawner::getDestroyAfterLife (  )  const [inline]

Referenced by XMLPort().

float orxonox::ParticleSpawner::getDestroydelay (  )  const [inline]

Referenced by XMLPort().

float orxonox::ParticleSpawner::getLifetime (  )  const [inline]

Referenced by XMLPort().

bool orxonox::ParticleSpawner::getLoop (  )  const [inline]

Referenced by XMLPort().

float orxonox::ParticleSpawner::getStartdelay (  )  const [inline]

Referenced by XMLPort().

void orxonox::ParticleSpawner::processEvent ( Event event  )  [virtual]

Reimplemented from orxonox::BaseObject.

References ORXONOX_SET_EVENT, spawn(), and SUPER.

void orxonox::ParticleSpawner::setAutoStart ( bool  autostart  )  [inline]

Referenced by XMLPort().

void orxonox::ParticleSpawner::setDestroyAfterLife ( bool  destroy  )  [inline]

void orxonox::ParticleSpawner::setDestroydelay ( float  destroydelay  )  [inline]

Referenced by XMLPort().

void orxonox::ParticleSpawner::setLifetime ( float  lifetime  )  [inline]

void orxonox::ParticleSpawner::setLoop ( bool  loop  )  [inline]

Referenced by XMLPort().

void orxonox::ParticleSpawner::setStartdelay ( float  startdelay  )  [inline]

Referenced by XMLPort().

void orxonox::ParticleSpawner::spawn (  )  [inline]

Referenced by processEvent().

void orxonox::ParticleSpawner::startParticleSpawner (  )  [private]

void orxonox::ParticleSpawner::stopParticleSpawner (  )  [private]

void orxonox::ParticleSpawner::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
) [virtual]

XML loading and saving.

Parameters:
xmlelement The XML-element
loading Loading (true) or saving (false)
Returns:
The XML-element

Reimplemented from orxonox::ParticleEmitter.

References getAutoStart(), getDestroyAfterLife(), getDestroydelay(), getLifetime(), getLoop(), getStartdelay(), setAutoStart(), setDestroyAfterLife(), setDestroydelay(), setLifetime(), setLoop(), setStartdelay(), SUPER, and XMLPortParam.


Member Data Documentation

Referenced by ParticleSpawner().


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

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