KatanaEngine::Particle Class Reference

A single component of a particle system. More...

#include <Particle.h>

Inheritance diagram for KatanaEngine::Particle:

Public Member Functions
virtual float	GetInterpolationValue ()
	A value representing the percentage of the particle's lifespan. More...
virtual void	SetLifespan (const float seconds)
	Sets the lifespan of the particle in seconds. More...
virtual void	SetTemplate (ParticleTemplate *pTemplate)
	Sets template responsible for updating the particle. More...
virtual void	SetPosition (const Vector2 position)
	Sets the particle's position. More...
virtual Vector2 &	GetPosition ()
	Gets the position of the particle. More...
virtual void	SetAlpha (const float alpha)
	Sets the particle's alpha value (opacity). More...
virtual float	GetAlpha () const
	Gets the alpha value (opacity) of the particle. More...
virtual void	SetScale (const Vector2 scale)
	Sets the particle's scale. More...
virtual Vector2	GetScale () const
	Gets the scale of the particle. More...
virtual void	SetRotation (const float rotation)
	Sets the particle's rotation. More...
virtual float	GetRotation () const
	Gets the rotation of the particle. More...
virtual uint32_t	GetIndex () const
	Gets the index of the particle. More...

Friends
class	ParticleTemplate
class	ParticleManager
class	Emitter

Detailed Description

A single component of a particle system.

Member Function Documentation

GetAlpha()

virtual float KatanaEngine::Particle::GetAlpha ( ) const

inlinevirtual

Gets the alpha value (opacity) of the particle.

Returns

Returns the particle's alpha value.

GetIndex()

virtual uint32_t KatanaEngine::Particle::GetIndex ( ) const

inlinevirtual

Gets the index of the particle.

Returns

Returns the particle's index.

GetInterpolationValue()

float KatanaEngine::Particle::GetInterpolationValue ( )

virtual

A value representing the percentage of the particle's lifespan.

Returns

Returns the interpolated lifespan value.

GetPosition()

virtual Vector2& KatanaEngine::Particle::GetPosition ( )

inlinevirtual

Gets the position of the particle.

Returns

Returns the particle's position.

GetRotation()

virtual float KatanaEngine::Particle::GetRotation ( ) const

inlinevirtual

Gets the rotation of the particle.

Returns

Returns the particle's rotation.

GetScale()

virtual Vector2 KatanaEngine::Particle::GetScale ( ) const

inlinevirtual

Gets the scale of the particle.

Returns

Returns the particle's scale.

SetAlpha()

virtual void KatanaEngine::Particle::SetAlpha ( const float  alpha )

inlinevirtual

Sets the particle's alpha value (opacity).

Parameters

alpha

The alpha value.

SetLifespan()

virtual void KatanaEngine::Particle::SetLifespan ( const float  seconds )

inlinevirtual

Sets the lifespan of the particle in seconds.

Parameters

seconds

The time in seconds that the particle will live.

SetPosition()

virtual void KatanaEngine::Particle::SetPosition ( const Vector2  position )

inlinevirtual

Sets the particle's position.

Parameters

position

The particle's new position.

SetRotation()

virtual void KatanaEngine::Particle::SetRotation ( const float  rotation )

inlinevirtual

Sets the particle's rotation.

Parameters

rotation

The rotation value.

SetScale()

virtual void KatanaEngine::Particle::SetScale ( const Vector2  scale )

inlinevirtual

Sets the particle's scale.

Parameters

scale

The scale value.

SetTemplate()

virtual void KatanaEngine::Particle::SetTemplate ( ParticleTemplate *  pTemplate )

inlinevirtual

Sets template responsible for updating the particle.

Parameters

pTemplate

The template that updates and initializes the particle.

---

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

• KatanaEngine/Particle.h
• KatanaEngine/Particle.cpp