CrystalSpace

Public API Reference

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

iSnowState Struct Reference

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

#include <snow.h>

Inheritance diagram for iSnowState:

iBase List of all members.

Public Methods

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

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

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

virtual void GetDropSize (float &dropwidth, float &dropheight) const=0
 Get the size of the snow flakes. More...

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

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

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

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

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

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

virtual void SetSwirl (float swirl)=0
 Set swirl. More...

virtual float GetSwirl () const=0
 Get swirl. More...


Detailed Description

This interface describes the API for the snow mesh object.

Definition at line 32 of file snow.h.


Member Function Documentation

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

Get box.

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

Get the size of the snow flakes.

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

Get fall speed.

virtual bool iSnowState::GetLighting   const [pure virtual]
 

See if lighting is enabled.

virtual int iSnowState::GetParticleCount   const [pure virtual]
 

Get the number of particles used.

virtual float iSnowState::GetSwirl   const [pure virtual]
 

Get swirl.

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

Set box.

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

Set the size of the drops.

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

Set fall speed.

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

Enable or disable lighting.

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

Set the number of particles to use.

virtual void iSnowState::SetSwirl float    swirl [pure virtual]
 

Set swirl.


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