castor3d::ParticleEmitter Class Reference

#include <ParticleEmitter.hpp>

Collaboration diagram for castor3d::ParticleEmitter:

Public Types
using	OnEmitFunction = castor::Function< void( Particle const & particle ) >
using	OnEmitSignal = castor::SignalT< OnEmitFunction >
using	OnEmitConnection = OnEmitSignal::connection

Public Member Functions
C3D_API	ParticleEmitter (castor3d::ParticleDeclaration const &decl)
virtual C3D_API	~ParticleEmitter () noexcept=default
C3D_API castor3d::Particle	emit (ParticleValues const &value) const
	Emits a particle with given values.

Public Attributes
OnEmitSignal	onEmit

Protected Attributes
castor3d::ParticleDeclaration const &	m_decl

Member Typedef Documentation

OnEmitConnection

using castor3d::ParticleEmitter::OnEmitConnection = OnEmitSignal::connection

OnEmitFunction

using castor3d::ParticleEmitter::OnEmitFunction = castor::Function< void( Particle const & particle ) >

OnEmitSignal

using castor3d::ParticleEmitter::OnEmitSignal = castor::SignalT< OnEmitFunction >

Constructor & Destructor Documentation

ParticleEmitter()

C3D_API castor3d::ParticleEmitter::ParticleEmitter ( castor3d::ParticleDeclaration const & decl )

explicit

~ParticleEmitter()

virtual C3D_API castor3d::ParticleEmitter::~ParticleEmitter ( )

virtualdefaultnoexcept

Member Function Documentation

emit()

C3D_API castor3d::Particle castor3d::ParticleEmitter::emit

(

ParticleValues const &

value

)

const

Emits a particle with given values.

Parameters

[in]

value

The particle values.

Member Data Documentation

m_decl

castor3d::ParticleDeclaration const& castor3d::ParticleEmitter::m_decl

protected

onEmit

OnEmitSignal castor3d::ParticleEmitter::onEmit

---

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

• Castor3D/Scene/ParticleSystem/ParticleEmitter.hpp