CubbyFlow::ParticleEmitterSet2 Class Reference

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

#include <Core/Emitter/ParticleEmitterSet2.hpp>

Inheritance diagram for CubbyFlow::ParticleEmitterSet2:

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

Public Member Functions
	ParticleEmitterSet2 ()=default
	Default constructor.
	ParticleEmitterSet2 (std::vector< ParticleEmitter2Ptr > emitters)
	Constructs an emitter with sub-emitters.
	ParticleEmitterSet2 (const ParticleEmitterSet2 &)=default
	Default copy constructor.
	ParticleEmitterSet2 (ParticleEmitterSet2 &&) noexcept=default
	Default move constructor.
	~ParticleEmitterSet2 () override=default
	Default virtual destructor.
ParticleEmitterSet2 &	operator= (const ParticleEmitterSet2 &)=default
	Default copy assignment operator.
ParticleEmitterSet2 &	operator= (ParticleEmitterSet2 &&) noexcept=default
	Default move assignment operator.
void	AddEmitter (const ParticleEmitter2Ptr &emitter)
	Adds sub-emitter.
Public Member Functions inherited from CubbyFlow::ParticleEmitter2
	ParticleEmitter2 ()=default
	Default constructor.
	ParticleEmitter2 (const ParticleEmitter2 &)=default
	Default copy constructor.
	ParticleEmitter2 (ParticleEmitter2 &&) noexcept=default
	Default move constructor.
virtual	~ParticleEmitter2 ()=default
	Default virtual destructor.
ParticleEmitter2 &	operator= (const ParticleEmitter2 &)=default
	Default copy assignment operator.
ParticleEmitter2 &	operator= (ParticleEmitter2 &&) noexcept=default
	Default move assignment operator.
void	Update (double currentTimeInSeconds, double timeIntervalInSeconds)
const ParticleSystemData2Ptr &	GetTarget () const
	Returns the target particle system to emit.
void	SetTarget (const ParticleSystemData2Ptr &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 ParticleEmitter2::Update function is invoked.

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

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

Detailed Description

2-D particle-based emitter set.

Constructor & Destructor Documentation

ParticleEmitterSet2() [1/4]

CubbyFlow::ParticleEmitterSet2::ParticleEmitterSet2 ( )

default

Default constructor.

ParticleEmitterSet2() [2/4]

CubbyFlow::ParticleEmitterSet2::ParticleEmitterSet2 ( std::vector< ParticleEmitter2Ptr >  emitters )

explicit

Constructs an emitter with sub-emitters.

ParticleEmitterSet2() [3/4]

CubbyFlow::ParticleEmitterSet2::ParticleEmitterSet2 ( const ParticleEmitterSet2 &  )

default

Default copy constructor.

ParticleEmitterSet2() [4/4]

CubbyFlow::ParticleEmitterSet2::ParticleEmitterSet2 ( ParticleEmitterSet2 &&  )

defaultnoexcept

Default move constructor.

~ParticleEmitterSet2()

CubbyFlow::ParticleEmitterSet2::~ParticleEmitterSet2 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

AddEmitter()

void CubbyFlow::ParticleEmitterSet2::AddEmitter

(

const ParticleEmitter2Ptr &

emitter

)

Adds sub-emitter.

GetBuilder()

static Builder CubbyFlow::ParticleEmitterSet2::GetBuilder ( )

static

Returns builder fox ParticleEmitterSet2.

operator=() [1/2]

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

default

Default copy assignment operator.

operator=() [2/2]

ParticleEmitterSet2 & CubbyFlow::ParticleEmitterSet2::operator= ( ParticleEmitterSet2 &&  )

defaultnoexcept

Default move assignment operator.

---

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

• Core/Emitter/ParticleEmitterSet2.hpp