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

### 4.9.18 Fire Mesh Object

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

A fire is a particle system that emulates a torch or flame. 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.fire'`
- Loader plugin: ``crystalspace.mesh.loader.fire'`
- Factory loader plugin: ``crystalspace.mesh.loader.factory.fire'`

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

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

#### Factory State Interface

This plugin has no factory state interface.

#### Factory Loader

The fire mesh factory loader has no parameters.

#### Object State Interface

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

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

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

`<originbox>`

      	<min x="" y="" z="" />
      	<min x="" y="" z="" />
      </originbox>

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

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

  Direction of the flame.

`<swirl>swirlValue</swirl>`

  Swirl.

`<colorscale>colorScaleValue</colorscale>`

  Value for color scale.

`<totaltime>totalTime</totaltime>`

  Total time.

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

  Disable or enable lighting for the fire particles.

`<number>nrParticles</number>`

  Number of particles to use.

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

This document was generated using texi2html 1.76.