CubbyFlow::ParticleEmitterSet3 Class Reference

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

#include <Core/Emitter/ParticleEmitterSet3.hpp>

Inheritance diagram for CubbyFlow::ParticleEmitterSet3:

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

Public Member Functions
	ParticleEmitterSet3 ()=default
	Default constructor.
	ParticleEmitterSet3 (std::vector< ParticleEmitter3Ptr > emitters)
	Constructs an emitter with sub-emitters.
	ParticleEmitterSet3 (const ParticleEmitterSet3 &)=default
	Default copy constructor.
	ParticleEmitterSet3 (ParticleEmitterSet3 &&) noexcept=default
	Default move constructor.
	~ParticleEmitterSet3 () override=default
	Default virtual destructor.
ParticleEmitterSet3 &	operator= (const ParticleEmitterSet3 &)=default
	Default copy assignment operator.
ParticleEmitterSet3 &	operator= (ParticleEmitterSet3 &&) noexcept=default
	Default move assignment operator.
void	AddEmitter (const ParticleEmitter3Ptr &emitter)
	Adds sub-emitter.
Public Member Functions inherited from CubbyFlow::ParticleEmitter3
	ParticleEmitter3 ()=default
	Default constructor.
	ParticleEmitter3 (const ParticleEmitter3 &)=default
	Default copy constructor.
	ParticleEmitter3 (ParticleEmitter3 &&) noexcept=default
	Default move constructor.
virtual	~ParticleEmitter3 ()=default
	Default virtual destructor.
ParticleEmitter3 &	operator= (const ParticleEmitter3 &)=default
	Default copy assignment operator.
ParticleEmitter3 &	operator= (ParticleEmitter3 &&) noexcept=default
	Default move assignment operator.
void	Update (double currentTimeInSeconds, double timeIntervalInSeconds)
const ParticleSystemData3Ptr &	GetTarget () const
	Returns the target particle system to emit.
void	SetTarget (const ParticleSystemData3Ptr &particles)
	Sets the target particle system to emit.
bool	GetIsEnabled () const
	Returns true if the emitter is enabled.
void	SetIsEnabled (bool enabled)
	Sets true/false to enable/disable the emitter.
void	SetOnBeginUpdateCallback (const OnBeginUpdateCallback &callback)
	Sets the callback function to be called when ParticleEmitter3::Update function is invoked.

Static Public Member Functions
static Builder	GetBuilder ()
	Returns builder fox ParticleEmitterSet3.

Additional Inherited Members
Public Types inherited from CubbyFlow::ParticleEmitter3
using	OnBeginUpdateCallback = std::function< void(ParticleEmitter3 *, double, double)>
	Callback function type for update calls.

Detailed Description

3-D particle-based emitter set.

Constructor & Destructor Documentation

ParticleEmitterSet3() [1/4]

CubbyFlow::ParticleEmitterSet3::ParticleEmitterSet3 ( )

default

Default constructor.

ParticleEmitterSet3() [2/4]

CubbyFlow::ParticleEmitterSet3::ParticleEmitterSet3 ( std::vector< ParticleEmitter3Ptr >  emitters )

explicit

Constructs an emitter with sub-emitters.

ParticleEmitterSet3() [3/4]

CubbyFlow::ParticleEmitterSet3::ParticleEmitterSet3 ( const ParticleEmitterSet3 &  )

default

Default copy constructor.

ParticleEmitterSet3() [4/4]

CubbyFlow::ParticleEmitterSet3::ParticleEmitterSet3 ( ParticleEmitterSet3 &&  )

defaultnoexcept

Default move constructor.

~ParticleEmitterSet3()

CubbyFlow::ParticleEmitterSet3::~ParticleEmitterSet3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

AddEmitter()

void CubbyFlow::ParticleEmitterSet3::AddEmitter

(

const ParticleEmitter3Ptr &

emitter

)

Adds sub-emitter.

GetBuilder()

static Builder CubbyFlow::ParticleEmitterSet3::GetBuilder ( )

static

Returns builder fox ParticleEmitterSet3.

operator=() [1/2]

ParticleEmitterSet3 & CubbyFlow::ParticleEmitterSet3::operator= ( const ParticleEmitterSet3 &  )

default

Default copy assignment operator.

operator=() [2/2]

ParticleEmitterSet3 & CubbyFlow::ParticleEmitterSet3::operator= ( ParticleEmitterSet3 &&  )

defaultnoexcept

Default move assignment operator.

---

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

• Core/Emitter/ParticleEmitterSet3.hpp