KatanaEngine::Particle Class Reference

Instantiate a basic particle. More...

#include <Particle.h>

Inheritance diagram for KatanaEngine::Particle:

Public Member Functions
	Particle ()
virtual	~Particle ()
virtual bool	IsActive () const
	Gets whether the particle is active.
virtual Vector2	GetPosition () const
	Gets the position of the particle.
virtual Vector2	GetVelocity () const
	Gets the velocity of the particle.
virtual Color	GetColor () const
	Gets the color of the particle.
virtual float	GetScale () const
	Gets the scale of the particle.
virtual float	GetLifeSpan () const
	Gets the life span of the particle.
virtual float	GetLifeRemaining () const
	Gets the life remaining of the particle.
virtual void	SetPosition (const Vector2 position)
	Sets the position of the particle.
virtual void	SetVelocity (const Vector2 velocity)
	Sets the velocity of the particle.
virtual void	SetColor (const Color color)
	Sets the color of the particle.
virtual void	SetScale (const float scale)
	Sets the scale of the particle.
virtual void	SetLifeSpan (const float lifeSpan)
	Sets the life span of the particle.
virtual float	GetLifePercentage () const
virtual void	Initialize (Vector2 &position)
virtual void	Update (const GameTime &gameTime)

Detailed Description

Instantiate a basic particle.

Definition at line 23 of file Particle.h.

Constructor & Destructor Documentation

Particle()

KatanaEngine::Particle::Particle ( )

inline

Definition at line 28 of file Particle.h.

~Particle()

virtual KatanaEngine::Particle::~Particle ( )

inlinevirtual

Definition at line 29 of file Particle.h.

Member Function Documentation

GetColor()

virtual Color KatanaEngine::Particle::GetColor ( ) const

inlinevirtual

Gets the color of the particle.

Returns

Returns the color of the particle.

Definition at line 45 of file Particle.h.

GetLifePercentage()

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

inlinevirtual

Definition at line 81 of file Particle.h.

GetLifeRemaining()

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

inlinevirtual

Gets the life remaining of the particle.

Returns

Returns the life remaining of the particle.

Definition at line 57 of file Particle.h.

GetLifeSpan()

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

inlinevirtual

Gets the life span of the particle.

Returns

Returns the life span of the particle.

Definition at line 53 of file Particle.h.

GetPosition()

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

inlinevirtual

Gets the position of the particle.

Returns

Returns the position of the particle.

Definition at line 37 of file Particle.h.

GetScale()

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

inlinevirtual

Gets the scale of the particle.

Returns

Returns the scale of the particle.

Definition at line 49 of file Particle.h.

GetVelocity()

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

inlinevirtual

Gets the velocity of the particle.

Returns

Returns the velocity of the particle.

Definition at line 41 of file Particle.h.

Initialize()

virtual void KatanaEngine::Particle::Initialize ( Vector2 & position )

inlinevirtual

Implements KatanaEngine::IParticle.

Definition at line 83 of file Particle.h.

IsActive()

virtual bool KatanaEngine::Particle::IsActive ( ) const

inlinevirtual

Gets whether the particle is active.

Returns

Returns true if the particle is active.

Implements KatanaEngine::IParticle.

Definition at line 33 of file Particle.h.

SetColor()

virtual void KatanaEngine::Particle::SetColor ( const Color color )

inlinevirtual

Sets the color of the particle.

Parameters

color

The color to set.

Definition at line 69 of file Particle.h.

SetLifeSpan()

virtual void KatanaEngine::Particle::SetLifeSpan ( const float lifeSpan )

inlinevirtual

Sets the life span of the particle.

Parameters

lifeSpan

The life span to set.

Definition at line 77 of file Particle.h.

SetPosition()

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

inlinevirtual

Sets the position of the particle.

Parameters

position

The position to set.

Definition at line 61 of file Particle.h.

SetScale()

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

inlinevirtual

Sets the scale of the particle.

Parameters

scale

The scale to set.

Definition at line 73 of file Particle.h.

SetVelocity()

virtual void KatanaEngine::Particle::SetVelocity ( const Vector2 velocity )

inlinevirtual

Sets the velocity of the particle.

Parameters

velocity

The velocity to set.

Definition at line 65 of file Particle.h.

Update()

virtual void KatanaEngine::Particle::Update ( const GameTime & gameTime )

inlinevirtual

Implements KatanaEngine::IParticle.

Definition at line 88 of file Particle.h.

---

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

• doxy_src/KatanaEngine/Particle.h