CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iFireTexture Struct Reference
[3D]

Interface to the 'fire' procedural texture. More...

#include <ifire.h>

Inheritance diagram for iFireTexture:

iBase csProcFire List of all members.

Public Methods

virtual void SetPossibleBurn (int possburn)=0
 Set animation parameter: possible burn (0..) Try possburn 3=wood,90=oil,255=max.

virtual int GetPossibleBurn ()=0
 Get possible burn.

virtual void SetAdditionalBurn (int addburn)=0
 Set animation parameter: additional burn (0..) Try addburn=1..5 or so.

virtual int GetAdditionalBurn ()=0
 Get additional burn.

virtual void SetContinuedBurn (int contburn)=0
 Set animation parameter: continued burn (0..) Try 80.

virtual int GetContinuedBurn ()=0
 Get continued burn.

virtual void SetSmoothing (int smoothing)=0
 Set animation parameter: smoothing factor (0..) Try 2.

virtual int GetSmoothing ()=0
 Get smoothing factor.

virtual void SetExtinguish (int extinguish)=0
 Set animation parameter: burning down param Try 3*256/height.

virtual int GetExtinguish ()=0
 Get burning down param.

virtual void SetSingleFlameMode (bool enable)=0
 Set single flame mode.

virtual bool GetSingleFlameMode ()=0
 Get single flame mode.

virtual void SetHalfBase (int halfbase)=0
 Set animation parameter: 1/2 size of flame base, from middle bottom sideways.

virtual int GetHalfBase ()=0
 Get 1/2 size of flame base.

virtual void SetPostSmoothing (int amount)=0
 Set whether to smooth the whole image again after calculating an iteration.

virtual int GetPostSmoothing ()=0
 Get post smoothing value.

virtual void SetPalette (const csGradient gradient)=0
 Set the colors used by the flame.


Detailed Description

Interface to the 'fire' procedural texture.

Todo:
'GetPalette()' maybe.

Definition at line 41 of file ifire.h.


Member Function Documentation

virtual int iFireTexture::GetAdditionalBurn   [pure virtual]
 

Get additional burn.

Implemented in csProcFire.

virtual int iFireTexture::GetContinuedBurn   [pure virtual]
 

Get continued burn.

Implemented in csProcFire.

virtual int iFireTexture::GetExtinguish   [pure virtual]
 

Get burning down param.

Implemented in csProcFire.

virtual int iFireTexture::GetHalfBase   [pure virtual]
 

Get 1/2 size of flame base.

Implemented in csProcFire.

virtual int iFireTexture::GetPossibleBurn   [pure virtual]
 

Get possible burn.

Implemented in csProcFire.

virtual int iFireTexture::GetPostSmoothing   [pure virtual]
 

Get post smoothing value.

Implemented in csProcFire.

virtual bool iFireTexture::GetSingleFlameMode   [pure virtual]
 

Get single flame mode.

Implemented in csProcFire.

virtual int iFireTexture::GetSmoothing   [pure virtual]
 

Get smoothing factor.

Implemented in csProcFire.

virtual void iFireTexture::SetAdditionalBurn int    addburn [pure virtual]
 

Set animation parameter: additional burn (0..) Try addburn=1..5 or so.

Implemented in csProcFire.

virtual void iFireTexture::SetContinuedBurn int    contburn [pure virtual]
 

Set animation parameter: continued burn (0..) Try 80.

Implemented in csProcFire.

virtual void iFireTexture::SetExtinguish int    extinguish [pure virtual]
 

Set animation parameter: burning down param Try 3*256/height.

Implemented in csProcFire.

virtual void iFireTexture::SetHalfBase int    halfbase [pure virtual]
 

Set animation parameter: 1/2 size of flame base, from middle bottom sideways.

Implemented in csProcFire.

virtual void iFireTexture::SetPalette const csGradient    gradient [pure virtual]
 

Set the colors used by the flame.

Position 0 = darkest areas (background, actually), position 1 = brightest areas.

Implemented in csProcFire.

virtual void iFireTexture::SetPossibleBurn int    possburn [pure virtual]
 

Set animation parameter: possible burn (0..) Try possburn 3=wood,90=oil,255=max.

Implemented in csProcFire.

virtual void iFireTexture::SetPostSmoothing int    amount [pure virtual]
 

Set whether to smooth the whole image again after calculating an iteration.

Parameters:
amount  Size of the square used for averaging. 0 = disable smoothing.

Implemented in csProcFire.

virtual void iFireTexture::SetSingleFlameMode bool    enable [pure virtual]
 

Set single flame mode.

Implemented in csProcFire.

virtual void iFireTexture::SetSmoothing int    smoothing [pure virtual]
 

Set animation parameter: smoothing factor (0..) Try 2.

Implemented in csProcFire.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18