CrystalSpace

Public API Reference

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

csProcFire Class Reference

Fire. More...

#include <prfire.h>

Inheritance diagram for csProcFire:

csProcTexture iFireTexture csObject iBase iObject iBase List of all members.

Public Methods

 csProcFire (int w=128, int h=128)
 Create a new texture. More...

virtual bool PrepareAnim ()
 Prepare the animation for use. More...

virtual void Animate (csTicks current_time)
 Draw the next frame. More...

void SetSingleFlame (bool enable, int halfflame)
 set single flame mode with halfflamewidth or disable single flame. More...

bool GetSingleFlame () const
 is the flame in singleflame(true) or in leftright tiling mode? More...

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

virtual int GetPossibleBurn ()
 Get possible burn. More...

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

virtual int GetAdditionalBurn ()
 Get additional burn. More...

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

virtual int GetContinuedBurn ()
 Get continued burn. More...

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

virtual int GetSmoothing ()
 Get smoothing factor. More...

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

virtual int GetExtinguish ()
 Get burning down param. More...

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

virtual bool GetSingleFlameMode ()
 Get single flame mode. More...

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

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

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

virtual int GetPostSmoothing ()
 Get post smoothing value. More...

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


Detailed Description

Fire.

Definition at line 34 of file prfire.h.


Constructor & Destructor Documentation

csProcFire::csProcFire int    w = 128,
int    h = 128
 

Create a new texture.


Member Function Documentation

virtual void csProcFire::Animate csTicks    current_time [virtual]
 

Draw the next frame.

Implements csProcTexture.

virtual int csProcFire::GetAdditionalBurn   [virtual]
 

Get additional burn.

Implements iFireTexture.

virtual int csProcFire::GetContinuedBurn   [virtual]
 

Get continued burn.

Implements iFireTexture.

virtual int csProcFire::GetExtinguish   [virtual]
 

Get burning down param.

Implements iFireTexture.

virtual int csProcFire::GetHalfBase   [virtual]
 

Get 1/2 size of flame base.

Implements iFireTexture.

virtual int csProcFire::GetPossibleBurn   [virtual]
 

Get possible burn.

Implements iFireTexture.

virtual int csProcFire::GetPostSmoothing   [virtual]
 

Get post smoothing value.

Implements iFireTexture.

bool csProcFire::GetSingleFlame   const [inline]
 

is the flame in singleflame(true) or in leftright tiling mode?

Definition at line 93 of file prfire.h.

virtual bool csProcFire::GetSingleFlameMode   [virtual]
 

Get single flame mode.

Implements iFireTexture.

virtual int csProcFire::GetSmoothing   [virtual]
 

Get smoothing factor.

Implements iFireTexture.

virtual bool csProcFire::PrepareAnim   [virtual]
 

Prepare the animation for use.

This needs to be done after the texture has been prepared.

Reimplemented from csProcTexture.

virtual void csProcFire::SetAdditionalBurn int    addburn [virtual]
 

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

Implements iFireTexture.

virtual void csProcFire::SetContinuedBurn int    contburn [virtual]
 

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

Implements iFireTexture.

virtual void csProcFire::SetExtinguish int    extinguish [virtual]
 

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

Implements iFireTexture.

virtual void csProcFire::SetHalfBase int    halfbase [virtual]
 

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

Implements iFireTexture.

virtual void csProcFire::SetPalette const csGradient    gradient [virtual]
 

Set the colors used by the flame.

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

Implements iFireTexture.

virtual void csProcFire::SetPossibleBurn int    possburn [virtual]
 

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

Implements iFireTexture.

virtual void csProcFire::SetPostSmoothing int    amount [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.

Implements iFireTexture.

void csProcFire::SetSingleFlame bool    enable,
int    halfflame
[inline]
 

set single flame mode with halfflamewidth or disable single flame.

Definition at line 90 of file prfire.h.

virtual void csProcFire::SetSingleFlameMode bool    enable [virtual]
 

Set single flame mode.

Implements iFireTexture.

virtual void csProcFire::SetSmoothing int    smoothing [virtual]
 

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

Implements iFireTexture.


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