CrystalSpace

Public API Reference

iParticleBuiltinEffectorLinColor Struct Reference
[Mesh plugins]

Simple linear interpolation of particle color based on particle lifetime. More...

#include <imesh/particles.h>

Inheritance diagram for iParticleBuiltinEffectorLinColor:

List of all members.

Public Member Functions

virtual size_t AddColor (const csColor4 &color, float endTTL)=0
 Add color to list of colors to interpolate between.
virtual void Clear ()=0
 Remove all entries.
virtual const csColor4GetColor (size_t index) const =0
 Get color.
virtual void GetColor (size_t index, csColor4 &color, float &endTTL) const =0
 Get color and time.
virtual size_t GetColorCount () const =0
 Get number of color entries.
virtual float GetEndTTL (size_t index) const =0
 Get TTL.
virtual void RemoveColor (size_t index)=0
 Remove a specific entry.
virtual void SetColor (size_t index, const csColor4 &color)=0
 Set the color of an already existing entry.
virtual void SetEndTTL (size_t index, float ttl)=0
 Set the TTL for an already existing entry.

Detailed Description

Simple linear interpolation of particle color based on particle lifetime.

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

The first color value is regarded as having time 0, independently of what it is set to have

Definition at line 784 of file particles.h.


Member Function Documentation

virtual size_t iParticleBuiltinEffectorLinColor::AddColor ( const csColor4 color,
float  endTTL 
) [pure virtual]

Add color to list of colors to interpolate between.

Returns:
Index of new color
virtual void iParticleBuiltinEffectorLinColor::Clear (  )  [pure virtual]

Remove all entries.

virtual const csColor4& iParticleBuiltinEffectorLinColor::GetColor ( size_t  index  )  const [pure virtual]

Get color.

virtual void iParticleBuiltinEffectorLinColor::GetColor ( size_t  index,
csColor4 color,
float &  endTTL 
) const [pure virtual]

Get color and time.

virtual size_t iParticleBuiltinEffectorLinColor::GetColorCount (  )  const [pure virtual]

Get number of color entries.

virtual float iParticleBuiltinEffectorLinColor::GetEndTTL ( size_t  index  )  const [pure virtual]

Get TTL.

virtual void iParticleBuiltinEffectorLinColor::RemoveColor ( size_t  index  )  [pure virtual]

Remove a specific entry.

virtual void iParticleBuiltinEffectorLinColor::SetColor ( size_t  index,
const csColor4 color 
) [pure virtual]

Set the color of an already existing entry.

virtual void iParticleBuiltinEffectorLinColor::SetEndTTL ( size_t  index,
float  ttl 
) [pure virtual]

Set the TTL for an already existing entry.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1