jpp::scene::IParticleAffector Class Reference

A particle affector modifies particles. More...

#include <jimcpp/core/engine/IParticleAffector.hpp>

Inheritance diagram for jpp::scene::IParticleAffector:

Collaboration diagram for jpp::scene::IParticleAffector:

Public Member Functions
	IParticleAffector ()
	constructor
virtual void	affect (u32 now, SParticle *particlearray, u32 count)=0
	Affects an array of particles.
virtual void	setEnabled (bool enabled)
	Sets whether or not the affector is currently enabled.
virtual bool	getEnabled () const
	Gets whether or not the affector is currently enabled.
virtual E_PARTICLE_AFFECTOR_TYPE	getType () const =0
	Get emitter type.
Public Member Functions inherited from jpp::io::IAttributeExchangingObject
virtual void	serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
	Writes attributes of the object.
virtual void	deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
	Reads attributes of the object.
Public Member Functions inherited from jpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
s32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Protected Attributes
bool	Enabled

Additional Inherited Members
Protected Member Functions inherited from jpp::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

A particle affector modifies particles.

Member Function Documentation

affect()

virtual void jpp::scene::IParticleAffector::affect ( u32  now, SParticle *  particlearray, u32  count  )

pure virtual

Affects an array of particles.

Parameters

now	Current time. (Same as ITimer::getTime() would return)
particlearray	Array of particles.
count	Amount of particles in array.

getType()

virtual E_PARTICLE_AFFECTOR_TYPE jpp::scene::IParticleAffector::getType ( ) const

pure virtual

Get emitter type.

Implemented in jpp::scene::IParticleAttractionAffector, jpp::scene::IParticleFadeOutAffector, jpp::scene::IParticleGravityAffector, and jpp::scene::IParticleRotationAffector.

---

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

• include/jimcpp/core/engine/IParticleAffector.hpp