4.10.18 Snow Mesh Object

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

Snow is a particle system that emulates snow. 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 CS_LOAD_PLUGIN()):

• Type plugin: `crystalspace.mesh.object.snow'
• Loader plugin: `crystalspace.mesh.loader.snow'
• Factory loader plugin: `crystalspace.mesh.loader.factory.snow'

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

• MeshObject
  • Implements `iMeshObject'
  • Implements `iParticleState'
  • Implements `iSnowState'
• MeshObjectFactory
  • Implements `iMeshObjectFactory'
• MeshObjectFactory
  • Implements `iMeshObjectType'

Factory State Interface

This plugin has no factory state interface.

Factory Loader

The snow mesh factory loader has no parameters.

Object State Interface

`iSnowState' is the SCF interface that you can use to set/get settings for a snow object. The definition of this interface can be found in `CS/include/imesh/snow.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 snow 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 snow (width and height).

box

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

Box that will contain the snow particles. Give two 3D coordinates here.

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

Speed of the snow.

<swirl>swirlValue</swirl>

Swirl.

<lighting>yes/no</lighting>

Disable or enable lighting for the snow particles.

<number>nrParticles</number>

Number of particles to use.

This document was generated using texi2html 1.76.