CrystalSpace

Public API Reference

iParticleBuiltinEffectorLinear Struct Reference
[Mesh plugins]

Linear interpolation of various parameters based on particle lifetime. More...

#include <imesh/particles.h>

Inheritance diagram for iParticleBuiltinEffectorLinear:

List of all members.

Public Member Functions

virtual size_t AddParameterSet (const csParticleParameterSet &param, float endTTL)=0
 Add a parameter set to the list of parameters to interpolate between.
virtual int GetMask () const =0
 Get the current mask used to interpolate the parameters.
virtual void GetParameterSet (size_t index, csParticleParameterSet &param, float &endTTL) const =0
 Get parameter set and time.
virtual size_t GetParameterSetCount () const =0
 Get number of parameter set entries.
virtual void SetMask (int mask)=0
 Set the mask to influence which parameters we will interpolate.
virtual void SetParameterSet (size_t index, const csParticleParameterSet &param)=0
 Overwrite the parameter set of an already existing entry.

Detailed Description

Linear interpolation of various parameters based on particle lifetime.

The age of particle P is defined as max(0, maxAge - P.TTL)

The first values are regarded as having time 0, independently of what they are set to have.

Definition at line 854 of file particles.h.


Member Function Documentation

virtual size_t iParticleBuiltinEffectorLinear::AddParameterSet ( const csParticleParameterSet param,
float  endTTL 
) [pure virtual]

Add a parameter set to the list of parameters to interpolate between.

Returns:
Index of new parameter
virtual int iParticleBuiltinEffectorLinear::GetMask (  )  const [pure virtual]

Get the current mask used to interpolate the parameters.

virtual void iParticleBuiltinEffectorLinear::GetParameterSet ( size_t  index,
csParticleParameterSet param,
float &  endTTL 
) const [pure virtual]

Get parameter set and time.

virtual size_t iParticleBuiltinEffectorLinear::GetParameterSetCount (  )  const [pure virtual]

Get number of parameter set entries.

virtual void iParticleBuiltinEffectorLinear::SetMask ( int  mask  )  [pure virtual]

Set the mask to influence which parameters we will interpolate.

By default this will be set to CS_PARTICLE_MASK_ALL.

virtual void iParticleBuiltinEffectorLinear::SetParameterSet ( size_t  index,
const csParticleParameterSet param 
) [pure virtual]

Overwrite the parameter set of an already existing entry.


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

Generated for Crystal Space 1.4.1 by doxygen 1.7.1