ege::Particule Class Reference

#include <Particule.hpp>

Inheritance diagram for ege::Particule:

Public Member Functions
	Particule (ege::ParticuleEngine *_particuleEngine, const char *_particuleType=nullptr)
virtual	~Particule ()
virtual void	init ()
virtual void	UnInit ()
virtual void	update (float _delta)
virtual void	draw (const ege::Camera &_camera)
virtual bool	needRemove ()
const char *	getParticuleType ()
virtual void	onEnd ()

Protected Attributes
ege::ParticuleEngine *	m_particuleEngine
const char *	m_particuleType

Detailed Description

The particule class is an element with no control, when it will be created, it does not have any control, for example smoke or reactor generation ... or explosion particule ...

Constructor & Destructor Documentation

Particule()

ege::Particule::Particule	(	ege::ParticuleEngine *	_particuleEngine,
		const char *	_particuleType = nullptr
	)

Constructor.

Parameters

[in]	_particuleEngine	reference on the particule engine ...
[in]	_particuleType	Type of the particule (set nullptr if you did not want to use the respowner ...)

~Particule()

virtual ege::Particule::~Particule ( )

inlinevirtual

Destructor.

Member Function Documentation

draw()

virtual void ege::Particule::draw ( const ege::Camera &  _camera )

inlinevirtual

draw the current particule

getParticuleType()

const char* ege::Particule::getParticuleType ( )

inline

get the type of the particule

Returns

Type of the current particule

init()

virtual void ege::Particule::init ( )

inlinevirtual

init the particule

Reimplemented in ege::ParticuleSimple.

needRemove()

virtual bool ege::Particule::needRemove ( )

inlinevirtual

Check if the element might be removed.

Returns

true : The element might be removed

false : The element might be keeped

Reimplemented in ege::ParticuleSimple.

onEnd()

virtual void ege::Particule::onEnd ( )

inlinevirtual

When the particule arrive to his end of life, this function is called.

UnInit()

virtual void ege::Particule::UnInit ( )

inlinevirtual

Un-init the particule.

update()

virtual void ege::Particule::update ( float  _delta )

inlinevirtual

update the paticule properties

Parameters

[in]

_delta

Delta time from the previous call

Reimplemented in ege::ParticuleSimple.

---

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

• framework/atria-soft/ege/ege/Particule.hpp