nirt::scene::IParticleGravityAffector Class Reference

A particle affector which applies gravity to particles. More...

#include <nirtcpp/core/engine/IParticleGravityAffector.hpp>

Inheritance diagram for nirt::scene::IParticleGravityAffector:

Collaboration diagram for nirt::scene::IParticleGravityAffector:

Public Member Functions
virtual void	setTimeForceLost (f32 timeForceLost)=0
	Set the time in milliseconds when the gravity force is totally lost.
virtual void	setGravity (const core::vector3df &gravity)=0
	Set the direction and force of gravity in all 3 dimensions.
virtual f32	getTimeForceLost () const =0
	Get the time in milliseconds when the gravity force is totally lost.
virtual const core::vector3df &	getGravity () const =0
	Get the direction and force of gravity.
virtual E_PARTICLE_AFFECTOR_TYPE	getType () const override
	Get emitter type.
Public Member Functions inherited from nirt::scene::IParticleAffector
	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.
Public Member Functions inherited from nirt::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 nirt::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.

Additional Inherited Members
Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.
Protected Attributes inherited from nirt::scene::IParticleAffector
bool	Enabled

Detailed Description

A particle affector which applies gravity to particles.

Member Function Documentation

getType()

virtual E_PARTICLE_AFFECTOR_TYPE nirt::scene::IParticleGravityAffector::getType ( ) const

inlineoverridevirtual

Get emitter type.

Implements nirt::scene::IParticleAffector.

setTimeForceLost()

virtual void nirt::scene::IParticleGravityAffector::setTimeForceLost ( f32  timeForceLost )

pure virtual

Set the time in milliseconds when the gravity force is totally lost.

At that point the particle does not move any more.

---

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

• include/nirtcpp/core/engine/IParticleGravityAffector.hpp