Particle Universe  1.2
Public Types | Static Public Member Functions | List of all members
ParticleUniverse::Hook< T > Class Template Reference

#include <ParticleUniverseHook.h>

Public Types

typedef vector< T * > HookList
 

Static Public Member Functions

static void _prepare (HookList *list, ParticleTechnique *technique)
 
static void _unprepare (HookList *list, ParticleTechnique *technique)
 
static void _notifyStart (HookList *list)
 
static void _notifyPause (HookList *list)
 
static void _notifyResume (HookList *list)
 
static void _notifyStop (HookList *list)
 
static void _preProcessParticles (HookList *list, ParticleTechnique *technique, Real timeElapsed)
 
static void _processParticle (HookList *list, ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed, bool firstParticle)
 
static void _postProcessParticles (HookList *list, ParticleTechnique *technique, Real timeElapsed)
 

Detailed Description

template<typename T>
class ParticleUniverse::Hook< T >

The Hook class is a template helper class that is used to call the hook functions of objects (Affectors, Externs, ...) registered at the ParticleSystem. This prevents that the same code is duplicated too much.

Member Typedef Documentation

template<typename T >
typedef vector<T*> ParticleUniverse::Hook< T >::HookList

Member Function Documentation

template<typename T >
static void ParticleUniverse::Hook< T >::_notifyPause ( HookList *  list)
inlinestatic

Templated version to notify objects that the ParticleSystem pauses

template<typename T >
static void ParticleUniverse::Hook< T >::_notifyResume ( HookList *  list)
inlinestatic

Templated version to notify objects that the ParticleSystem resumes

template<typename T >
static void ParticleUniverse::Hook< T >::_notifyStart ( HookList *  list)
inlinestatic

Templated version to notify objects that the ParticleSystem starts

template<typename T >
static void ParticleUniverse::Hook< T >::_notifyStop ( HookList *  list)
inlinestatic

Templated version to notify objects that the ParticleSystem stops

template<typename T >
static void ParticleUniverse::Hook< T >::_postProcessParticles ( HookList *  list,
ParticleTechnique *  technique,
Real  timeElapsed 
)
inlinestatic

Templated version of _postProcessParticles.

Remarks
_postProcessParticles allows actions after the individual particles are processed.
template<typename T >
static void ParticleUniverse::Hook< T >::_prepare ( HookList *  list,
ParticleTechnique *  technique 
)
inlinestatic

Templated version to prepare objects.

template<typename T >
static void ParticleUniverse::Hook< T >::_preProcessParticles ( HookList *  list,
ParticleTechnique *  technique,
Real  timeElapsed 
)
inlinestatic

Templated version of _preProcessParticles.

Remarks
_preProcessParticles allows actions before the individual particles are processed.
template<typename T >
static void ParticleUniverse::Hook< T >::_processParticle ( HookList *  list,
ParticleTechnique *  particleTechnique,
Particle *  particle,
Real  timeElapsed,
bool  firstParticle 
)
inlinestatic

Templated version to process a particle.

template<typename T >
static void ParticleUniverse::Hook< T >::_unprepare ( HookList *  list,
ParticleTechnique *  technique 
)
inlinestatic

Templated version to unprepare objects.

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