4.10.16 Fountain Mesh Object

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

A fountain is a particle system that emulates a fountain of water drops. 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.fountain'
• Loader plugin: `crystalspace.mesh.loader.fountain'
• Factory loader plugin: `crystalspace.mesh.loader.factory.fountain'

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

• MeshObject
  • Implements `iMeshObject'
  • Implements `iParticleState'
  • Implements `iFountainState'
• 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

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

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

Origin of the fountain. Usually this is (0,0,0) and the engine is responsible for setting the correct position of the fountain. This works better for hierarchical transformations.

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

Acceleration of the particles (x, y, and z acceleration).

<speed>speedValue</speed>

Speed of the particles.

<opening>openingValue</opening>

Opening of the fountain sprinkler.

<azimuth>azimuthValue</azimuth>

Azimuth.

<elevation>elevationValue</elevation>

Elevation.

<falltime>falltimeValue</falltime>

Falltime.

<lighting>yes/no</lighting>

Disable or enable lighting for the fountain particles.

<number>nrParticles</number>

Number of particles to use.

This document was generated using texi2html 1.76.