CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

iParticleState Struct Reference

This interface describes the API for the particle mesh object. More...

#include <imesh/partsys.h>

Inheritance diagram for iParticleState:

iBase List of all members.

Public Member Functions

virtual void SetMaterialWrapper (iMaterialWrapper *material)=0
 Set material of particle system.
virtual iMaterialWrapperGetMaterialWrapper () const =0
 Get material of particle system.
virtual void SetMixMode (uint mode)=0
 Set mix mode.
virtual uint GetMixMode () const =0
 Get mix mode.
virtual void SetColor (const csColor &color)=0
 Set particle color.
virtual const csColorGetColor () const =0
 Get particle color.
virtual void SetAlpha (float alpha)=0
 Set the alpha of particles.
virtual float GetAlpha () const =0
 Get the probable alpha of the particles.
virtual void SetChangeColor (const csColor &color)=0
 Set change color.
virtual void UnsetChangeColor ()=0
 Unset change color.
virtual bool GetChangeColor (csColor &col) const =0
 see if change color is enabled, and get a copy if so.
virtual void SetChangeSize (float factor)=0
 Set change size of all particles, by factor per second.
virtual void UnsetChangeSize ()=0
 Unset change of size.
virtual bool GetChangeSize (float &factor) const =0
 see if change size is enabled, and get the value if so.
virtual void SetChangeRotation (float angle)=0
 Change rotation of all particles, by angle in radians per second.
virtual void UnsetChangeRotation ()=0
 Stop change of rotation.
virtual bool GetChangeRotation (float &angle) const =0
 see if change rotation is enabled, and get the angle if so.
virtual void SetChangeAlpha (float factor)=0
 Change alpha of all particles, by factor per second.
virtual void UnsetChangeAlpha ()=0
 Stop change of alpha.
virtual bool GetChangeAlpha (float &factor) const =0
 see if change alpha is enabled, and get the value if so.
virtual void SetSelfDestruct (csTicks t)=0
 Set selfdestruct mode on, and msec to live.
virtual void UnSetSelfDestruct ()=0
 System will no longer self destruct.

Detailed Description

This interface describes the API for the particle mesh object.

Definition at line 32 of file partsys.h.


Member Function Documentation

virtual float iParticleState::GetAlpha  )  const [pure virtual]
 

Get the probable alpha of the particles.

virtual bool iParticleState::GetChangeAlpha float &  factor  )  const [pure virtual]
 

see if change alpha is enabled, and get the value if so.

virtual bool iParticleState::GetChangeColor csColor col  )  const [pure virtual]
 

see if change color is enabled, and get a copy if so.

virtual bool iParticleState::GetChangeRotation float &  angle  )  const [pure virtual]
 

see if change rotation is enabled, and get the angle if so.

virtual bool iParticleState::GetChangeSize float &  factor  )  const [pure virtual]
 

see if change size is enabled, and get the value if so.

virtual const csColor& iParticleState::GetColor  )  const [pure virtual]
 

Get particle color.

virtual iMaterialWrapper* iParticleState::GetMaterialWrapper  )  const [pure virtual]
 

Get material of particle system.

virtual uint iParticleState::GetMixMode  )  const [pure virtual]
 

Get mix mode.

virtual void iParticleState::SetAlpha float  alpha  )  [pure virtual]
 

Set the alpha of particles.

virtual void iParticleState::SetChangeAlpha float  factor  )  [pure virtual]
 

Change alpha of all particles, by factor per second.

virtual void iParticleState::SetChangeColor const csColor color  )  [pure virtual]
 

Set change color.

virtual void iParticleState::SetChangeRotation float  angle  )  [pure virtual]
 

Change rotation of all particles, by angle in radians per second.

virtual void iParticleState::SetChangeSize float  factor  )  [pure virtual]
 

Set change size of all particles, by factor per second.

virtual void iParticleState::SetColor const csColor color  )  [pure virtual]
 

Set particle color.

virtual void iParticleState::SetMaterialWrapper iMaterialWrapper material  )  [pure virtual]
 

Set material of particle system.

virtual void iParticleState::SetMixMode uint  mode  )  [pure virtual]
 

Set mix mode.

virtual void iParticleState::SetSelfDestruct csTicks  t  )  [pure virtual]
 

Set selfdestruct mode on, and msec to live.

virtual void iParticleState::UnsetChangeAlpha  )  [pure virtual]
 

Stop change of alpha.

virtual void iParticleState::UnsetChangeColor  )  [pure virtual]
 

Unset change color.

virtual void iParticleState::UnsetChangeRotation  )  [pure virtual]
 

Stop change of rotation.

virtual void iParticleState::UnsetChangeSize  )  [pure virtual]
 

Unset change of size.

virtual void iParticleState::UnSetSelfDestruct  )  [pure virtual]
 

System will no longer self destruct.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1