Jet  v1.3.3
Classes | Public Member Functions | Static Public Member Functions | List of all members
jet::ParticleEmitterSet3 Class Referencefinal

3-D particle-based emitter set. More...

#include <jet/particle_emitter_set3.h>

Inheritance diagram for jet::ParticleEmitterSet3:
jet::ParticleEmitter3

Classes

class  Builder
 Front-end to create ParticleEmitterSet3 objects step by step. More...
 

Public Member Functions

 ParticleEmitterSet3 ()
 Constructs an emitter. More...
 
 ParticleEmitterSet3 (const std::vector< ParticleEmitter3Ptr > &emitters)
 Constructs an emitter with sub-emitters. More...
 
virtual ~ParticleEmitterSet3 ()
 Destructor. More...
 
void addEmitter (const ParticleEmitter3Ptr &emitter)
 Adds sub-emitter. More...
 
- Public Member Functions inherited from jet::ParticleEmitter3
 ParticleEmitter3 ()
 Default constructor. More...
 
virtual ~ParticleEmitter3 ()
 Destructor. More...
 
void update (double currentTimeInSeconds, double timeIntervalInSeconds)
 
const ParticleSystemData3Ptrtarget () const
 Returns the target particle system to emit. More...
 
void setTarget (const ParticleSystemData3Ptr &particles)
 Sets the target particle system to emit. More...
 
bool isEnabled () const
 Returns true if the emitter is enabled. More...
 
void setIsEnabled (bool enabled)
 Sets true/false to enable/disable the emitter. More...
 
void setOnBeginUpdateCallback (const OnBeginUpdateCallback &callback)
 Sets the callback function to be called when ParticleEmitter3::update function is invoked. More...
 

Static Public Member Functions

static Builder builder ()
 Returns builder fox ParticleEmitterSet3. More...
 

Additional Inherited Members

- Public Types inherited from jet::ParticleEmitter3
typedef std::function< void(ParticleEmitter3 *, double, double)> OnBeginUpdateCallback
 Callback function type for update calls. More...
 

Detailed Description

3-D particle-based emitter set.

Constructor & Destructor Documentation

◆ ParticleEmitterSet3() [1/2]

jet::ParticleEmitterSet3::ParticleEmitterSet3 ( )

Constructs an emitter.

◆ ParticleEmitterSet3() [2/2]

jet::ParticleEmitterSet3::ParticleEmitterSet3 ( const std::vector< ParticleEmitter3Ptr > &  emitters)
explicit

Constructs an emitter with sub-emitters.

◆ ~ParticleEmitterSet3()

virtual jet::ParticleEmitterSet3::~ParticleEmitterSet3 ( )
virtual

Destructor.

Member Function Documentation

◆ addEmitter()

void jet::ParticleEmitterSet3::addEmitter ( const ParticleEmitter3Ptr emitter)

Adds sub-emitter.

◆ builder()

static Builder jet::ParticleEmitterSet3::builder ( )
static

Returns builder fox ParticleEmitterSet3.


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