CrystalSpace

Public API Reference

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

iRainState Struct Reference

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

#include <rain.h>

Inheritance diagram for iRainState:

iBase List of all members.

Public Methods

virtual void SetParticleCount (int num)=0
 Set the number of particles to use.

virtual int GetParticleCount () const=0
 Get the number of particles used.

virtual void SetDropSize (float dropwidth, float dropheight)=0
 Set the size of the drops.

virtual void GetDropSize (float &dropwidth, float &dropheight) const=0
 Get the size of the rain drops.

virtual void SetBox (const csVector3 &minbox, const csVector3 &maxbox)=0
 Set box.

virtual void GetBox (csVector3 &minbox, csVector3 &maxbox) const=0
 Get box.

virtual void SetLighting (bool l)=0
 Enable or disable lighting.

virtual bool GetLighting () const=0
 See if lighting is enabled.

virtual void SetFallSpeed (const csVector3 &fspeed)=0
 Set fall speed.

virtual const csVector3GetFallSpeed () const=0
 Get fall speed.

virtual void SetCollisionDetection (bool cd)=0
 Enable/Disable Collision Detection for drops.

virtual bool GetCollisionDetection () const=0
 Get CD flag.

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.


Detailed Description

This interface describes the API for the rain mesh object.

Definition at line 32 of file rain.h.


Member Function Documentation

virtual void iRainState::GetBox csVector3   minbox,
csVector3   maxbox
const [pure virtual]
 

Get box.

virtual bool iRainState::GetCollisionDetection   [pure virtual]
 

Get CD flag.

virtual const csColor& iRainState::GetColor   [pure virtual]
 

Get particle color.

virtual void iRainState::GetDropSize float &    dropwidth,
float &    dropheight
const [pure virtual]
 

Get the size of the rain drops.

virtual const csVector3& iRainState::GetFallSpeed   [pure virtual]
 

Get fall speed.

virtual bool iRainState::GetLighting   [pure virtual]
 

See if lighting is enabled.

virtual iMaterialWrapper* iRainState::GetMaterialWrapper   [pure virtual]
 

Get material of particle system.

virtual uint iRainState::GetMixMode   [pure virtual]
 

Get mix mode.

virtual int iRainState::GetParticleCount   [pure virtual]
 

Get the number of particles used.

virtual void iRainState::SetBox const csVector3   minbox,
const csVector3   maxbox
[pure virtual]
 

Set box.

virtual void iRainState::SetCollisionDetection bool    cd [pure virtual]
 

Enable/Disable Collision Detection for drops.

virtual void iRainState::SetColor const csColor   color [pure virtual]
 

Set particle color.

virtual void iRainState::SetDropSize float    dropwidth,
float    dropheight
[pure virtual]
 

Set the size of the drops.

virtual void iRainState::SetFallSpeed const csVector3   fspeed [pure virtual]
 

Set fall speed.

virtual void iRainState::SetLighting bool    l [pure virtual]
 

Enable or disable lighting.

virtual void iRainState::SetMaterialWrapper iMaterialWrapper   material [pure virtual]
 

Set material of particle system.

virtual void iRainState::SetMixMode uint    mode [pure virtual]
 

Set mix mode.

virtual void iRainState::SetParticleCount int    num [pure virtual]
 

Set the number of particles to use.


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