4.10.17 Haze Mesh Object

This mesh object represents a 'haze' which is a bit like volumetric light. For example you can show this way moody rays from church windows.

Basic Structure

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

• Type plugin: crystalspace.mesh.object.haze
• Loader plugin: crystalspace.mesh.loader.haze
• Factory loader plugin: crystalspace.mesh.loader.factory.haze

Objects in this plugin implement the following SCF interfaces, which you can retrieve with scfQueryInterface:

• MeshObject
  • Implements ‘iMeshObject’
  • Implements ‘iHazeState’
• MeshObjectFactory
  • Implements ‘iMeshObjectFactory’
  • Implements ‘iHazeFactoryState’
• MeshObjectType
  • Implements ‘iMeshObjectType’

Factory State Interface

Use the ‘iHazeFactoryState’ SCF interface to access settings for a haze factory. The definition of this interface can be found in ‘CS/include/imesh/haze.h’ and that is also the include file you need to include in your applications to use this plugin. Using this interface you can access the direction, origin, layers, scale and various other configuration parameters for a haze factory.

Factory Loader

The haze mesh factory loader has no parameters.

Object State Interface

‘iHazeState’ (residing in ‘CS/include/imesh/haze.h’) is an empty SCF interface.

Object Loader

<material> ... </material>

Material name.

<mixmode> ... </mixmode>

Color mixing mode.

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

Set the origin of the texture.

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

Set the direction of the texture.

<layer> ... </layer>

Layer of the haze mesh. Inside layer:

<scale> ... </scale>

Scale of the texture.

<hazebox> ... </hazebox>

Draws box shape. Inside hazebox:

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

First corner of the box.

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

Last corner if the box.

<layer> <scale></scale> <hazebox> <min x="" y="" z="" /> <max x="" y="" z="" /> </hazecone> </layer>

<hazecone p="" q="" number=""> ... </hazecone>

Draws cone shape. Give p - radius of the top, q - radius of the bottom and number of faces to create cone mesh. Inside hazecone:

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

Position of the cone's tip.

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

Position of the cone's bottom.

<layer> <scale></scale> <hazecone p="" q="" number=""> <min x="" y="" z="" /> <max x="" y="" z="" /> </hazecone> </layer>

This document was generated using texi2html 1.76.