dcpp::scene::IParticleAffector Class Reference

A particle affector modifies particles. More...

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

Inheritance diagram for dcpp::scene::IParticleAffector:

Collaboration diagram for dcpp::scene::IParticleAffector:

Public Member Functions
	IParticleAffector ()
	constructor
virtual void	affect (dcpp::uint32_kt now, SParticle *particlearray, dcpp::uint32_kt 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 dcpp::io::IAttributeExchangingObject
virtual void	serializeAttributes (dcpp::io::IAttributes *out, dcpp::io::SAttributeReadWriteOptions *options=0) const
	Writes attributes of the object.
virtual void	deserializeAttributes (dcpp::io::IAttributes *in, dcpp::io::SAttributeReadWriteOptions *options=0)
	Reads attributes of the object.
Public Member Functions inherited from dcpp::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.
dcpp::int32_kt	getReferenceCount () const
	Get the reference count.
const dcpp::char_kt *	getDebugName () const
	Returns the debug name of the object.

Protected Attributes
bool	Enabled

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

Detailed Description

A particle affector modifies particles.

Member Function Documentation

affect()

virtual void dcpp::scene::IParticleAffector::affect ( dcpp::uint32_kt  now, SParticle *  particlearray, dcpp::uint32_kt  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 dcpp::scene::IParticleAffector::getType ( ) const

pure virtual

Get emitter type.

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

---

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

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