4.10.21 Spiral Mesh Object

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

Spiral is a particle system for a special spiral effect. This is an experimental particle system which is currently not fully operational. 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.spiral'
• Loader plugin: `crystalspace.mesh.loader.spiral'
• Factory loader plugin: `crystalspace.mesh.loader.factory.spiral'

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

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

`iSpiralState' is the SCF interface that you can use to set/get settings for an spiral object. The definition of this interface can be found in `CS/include/imesh/spiral.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 and the source of the spiral.

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.

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

Source of the spiral (3D coordinate).

<number>nrParticles</number>

Number of particles to use.

<particlesize w="" h="" />

Size of the particles in the spiral.

<particletime>particleTime</particleTime>

Time to live of particles, in msec.

<radialspeed>radialSpeed</radialSpeed>

Particle radial speed in spiral.

<rotationspeed>rotationSpeed</rotationSpeed>

Particle rotation speed in spiral.

<climbspeed>climbSpeed</climbSpeed>

Particle climb speed in spiral.

This document was generated using texi2html 1.76.