irrlicht/include/IParticleGravityAffector.h

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef IRR_I_PARTICLE_GRAVITY_AFFECTOR_H_INCLUDED
#define IRR_I_PARTICLE_GRAVITY_AFFECTOR_H_INCLUDED

#include "IParticleAffector.h"

namespace irr
{
namespace scene
{

//! A particle affector which applies gravity to particles.
class IParticleGravityAffector : public IParticleAffector
{
public:

	//! Set the time in milliseconds when the gravity force is totally lost
	/** At that point the particle does not move any more. */
	virtual void setTimeForceLost( f32 timeForceLost ) = 0;

	//! Set the direction and force of gravity in all 3 dimensions.
	virtual void setGravity( const core::vector3df& gravity ) = 0;

	//! Get the time in milliseconds when the gravity force is totally lost
	virtual f32 getTimeForceLost() const = 0;

	//! Get the direction and force of gravity.
	virtual const core::vector3df& getGravity() const = 0;

	//! Get emitter type
	virtual E_PARTICLE_AFFECTOR_TYPE getType() const IRR_OVERRIDE { return EPAT_GRAVITY; }
};

} // end namespace scene
} // end namespace irr

#endif // IRR_I_PARTICLE_GRAVITY_AFFECTOR_H_INCLUDED