CubbyFlow::GridEmitterSet3 Class Reference

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

#include <Core/Emitter/GridEmitterSet3.hpp>

Inheritance diagram for CubbyFlow::GridEmitterSet3:

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

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

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

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

Detailed Description

3-D grid-based emitter set.

Constructor & Destructor Documentation

GridEmitterSet3() [1/4]

CubbyFlow::GridEmitterSet3::GridEmitterSet3 ( )

default

Constructs an emitter.

GridEmitterSet3() [2/4]

CubbyFlow::GridEmitterSet3::GridEmitterSet3 ( const std::vector< GridEmitter3Ptr > &  emitters )

explicit

Constructs an emitter with sub-emitters.

GridEmitterSet3() [3/4]

CubbyFlow::GridEmitterSet3::GridEmitterSet3 ( const GridEmitterSet3 &  )

default

Default copy constructor.

GridEmitterSet3() [4/4]

CubbyFlow::GridEmitterSet3::GridEmitterSet3 ( GridEmitterSet3 &&  )

defaultnoexcept

Default move constructor.

~GridEmitterSet3()

CubbyFlow::GridEmitterSet3::~GridEmitterSet3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

AddEmitter()

void CubbyFlow::GridEmitterSet3::AddEmitter

(

const GridEmitter3Ptr &

emitter

)

Adds sub-emitter.

GetBuilder()

static Builder CubbyFlow::GridEmitterSet3::GetBuilder ( )

static

Returns builder fox GridEmitterSet3.

operator=() [1/2]

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

default

Default copy assignment operator.

operator=() [2/2]

GridEmitterSet3& CubbyFlow::GridEmitterSet3::operator= ( GridEmitterSet3 &&  )

defaultnoexcept

Default move assignment operator.

---

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

• Core/Emitter/GridEmitterSet3.hpp