CubbyFlow::GridEmitterSet2 Class Reference

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

#include <Core/Emitter/GridEmitterSet2.hpp>

Inheritance diagram for CubbyFlow::GridEmitterSet2:

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

Public Member Functions
	GridEmitterSet2 ()=default
	Default constructor. More...
	GridEmitterSet2 (const std::vector< GridEmitter2Ptr > &emitters)
	Constructs an emitter with sub-emitters. More...
	GridEmitterSet2 (const GridEmitterSet2 &)=default
	Default copy constructor. More...
	GridEmitterSet2 (GridEmitterSet2 &&) noexcept=default
	Default move constructor. More...
	~GridEmitterSet2 () override=default
	Default virtual destructor. More...
GridEmitterSet2 &	operator= (const GridEmitterSet2 &)=default
	Default copy assignment operator. More...
GridEmitterSet2 &	operator= (GridEmitterSet2 &&) noexcept=default
	Default move assignment operator. More...
void	AddEmitter (const GridEmitter2Ptr &emitter)
	Adds sub-emitter. More...
Public Member Functions inherited from CubbyFlow::GridEmitter2
	GridEmitter2 ()=default
	Default constructor. More...
	GridEmitter2 (const GridEmitter2 &)=default
	Default copy constructor. More...
	GridEmitter2 (GridEmitter2 &&) noexcept=default
	Default move constructor. More...
virtual	~GridEmitter2 ()=default
	Default virtual destructor. More...
GridEmitter2 &	operator= (const GridEmitter2 &)=default
	Default copy assignment operator. More...
GridEmitter2 &	operator= (GridEmitter2 &&) noexcept=default
	Default copy assignment operator. More...
void	Update (double currentTimeInSeconds, double timeIntervalInSeconds)
bool	GetIsEnabled () 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 GridEmitter2::Update function is invoked. More...

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

Additional Inherited Members
Public Types inherited from CubbyFlow::GridEmitter2
using	OnBeginUpdateCallback = std::function< void(GridEmitter2 *, double, double)>
	Callback function type for update calls. More...
Protected Member Functions inherited from CubbyFlow::GridEmitter2
void	CallOnBeginUpdateCallback (double currentTimeInSeconds, double timeIntervalInSeconds)

Detailed Description

2-D grid-based emitter set.

Constructor & Destructor Documentation

GridEmitterSet2() [1/4]

CubbyFlow::GridEmitterSet2::GridEmitterSet2 ( )

default

Default constructor.

GridEmitterSet2() [2/4]

CubbyFlow::GridEmitterSet2::GridEmitterSet2 ( const std::vector< GridEmitter2Ptr > &  emitters )

explicit

Constructs an emitter with sub-emitters.

GridEmitterSet2() [3/4]

CubbyFlow::GridEmitterSet2::GridEmitterSet2 ( const GridEmitterSet2 &  )

default

Default copy constructor.

GridEmitterSet2() [4/4]

CubbyFlow::GridEmitterSet2::GridEmitterSet2 ( GridEmitterSet2 &&  )

defaultnoexcept

Default move constructor.

~GridEmitterSet2()

CubbyFlow::GridEmitterSet2::~GridEmitterSet2 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

AddEmitter()

void CubbyFlow::GridEmitterSet2::AddEmitter

(

const GridEmitter2Ptr &

emitter

)

Adds sub-emitter.

GetBuilder()

static Builder CubbyFlow::GridEmitterSet2::GetBuilder ( )

static

Returns builder fox GridEmitterSet2.

operator=() [1/2]

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

default

Default copy assignment operator.

operator=() [2/2]

GridEmitterSet2& CubbyFlow::GridEmitterSet2::operator= ( GridEmitterSet2 &&  )

defaultnoexcept

Default move assignment operator.

---

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

• Core/Emitter/GridEmitterSet2.hpp