[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

### 4.9.20 Rain Mesh Object

Written by Jorrit Tyberghein, jorrit.tyberghein@gmail.com.

Rain is a particle system that emulates rain. Also see the general particle system documentation which is valid for all particle systems. See section Particle Systems in General.

#### Basic Structure

The following SCF class names are used (for `csLoadPlugin`):

- Type plugin: ``crystalspace.mesh.object.rain'`
- Loader plugin: ``crystalspace.mesh.loader.rain'`
- Factory loader plugin: ``crystalspace.mesh.loader.factory.rain'`

Objects in this plugin implement the following SCF interfaces (get with `scfQueryInterface`):

- MeshObject
  - Implements ``iMeshObject'`
  - Implements ``iParticleState'`
  - Implements ``iRainState'`
- MeshObjectFactory
  - Implements ``iMeshObjectFactory'`
- MeshObjectFactory
  - Implements ``iMeshObjectType'`

#### Factory State Interface

This plugin has no factory state interface.

#### Factory Loader

The fountain mesh factory loader has no parameters.

#### Object State Interface

``iRainState'` is the SCF interface that you can use to set/get settings for a rain object. The definition of this interface can be found in ``CS/include/imesh/rain.h'` and that's also the include file you need to include in your applications to use this plugin. Using this interface you can access the number of particles, the size of the particles, and various other rain parameters.

In addition you can use ``iParticleState'`.

#### Object Loader

Also see the general documentation for particle systems for other recognized keywords. See section Particle Systems in General.

`<dropsize w="" h="" />`

  Size of the droplets for the rain (width and height).

`<box>`

      	<min x="" y="" z="" />
      	<max x="" y="" z="" />
      </box>

  Box that will contain the rain particles.

`<fallspeed x="" y="" z="" />`

  Speed of the rain.

`<lighting>yes/no</lighting>`

  Disable or enable lighting for the rain particles.

`<number>nrParticles</number>`

  Number of particles to use.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ]

This document was generated using texi2html 1.76.