CIvfFog Class Reference

#include <ivf/IvfFog.h>

Inheritance diagram for CIvfFog:

CIvfBase CIvfRefCountBase CIvfRTTIBase List of all members.

Public Types

enum  TFogType { FT_LINEAR, FT_EXP, FT_EXP2 }

Public Member Functions

 IvfClassInfo ("CIvfFog", CIvfBase)
void enable ()
void disable ()
bool isEnabled ()
void setType (TFogType type)
TFogType getType ()
void setLimits (double start, double end)
void setStart (double start)
void setEnd (double end)
void getLimits (double &start, double &end)
double getStart ()
double getEnd ()
void setDensity (double density)
double getDensity ()
void setColor (float red, float green, float blue, float alpha)
void getColor (float &red, float &green, float &blue, float &alpha)

Static Public Member Functions

static CIvfFoggetInstance ()

Friends

class CIvfSingletonDestroyer< CIvfFog >

Detailed Description

Fog singleton class

The CIvfFog singleton encapsulates OpenGL fog handling. An instance of the CIvfFog class is retrieved using the getInstance() method. See the following code:

 CIvfFogPtr fog = CIvfFog::getInstance();
 fog->enable();
 fog->setType(CIvfFog::FT_LINEAR);
 fog->setLimits(5.0, 20.0);
 ...

Author:
Jonas Lindemann

Definition at line 50 of file IvfFog.h.


Member Function Documentation

void CIvfFog::disable  ) 
 

Disable fog

void CIvfFog::enable  ) 
 

Enable fog

void CIvfFog::getColor float &  red,
float &  green,
float &  blue,
float &  alpha
 

Returns fog color

double CIvfFog::getDensity  ) 
 

Return fog density

double CIvfFog::getEnd  ) 
 

Return eye distance to fog end

static CIvfFog* CIvfFog::getInstance  )  [static]
 

Returns the blending singleton

void CIvfFog::getLimits double &  start,
double &  end
 

Return fog limits

double CIvfFog::getStart  ) 
 

Return eye distance to fog start

TFogType CIvfFog::getType  ) 
 

Return fog type

bool CIvfFog::isEnabled  ) 
 

Returns true if fog is enabled

void CIvfFog::setColor float  red,
float  green,
float  blue,
float  alpha
 

Sets fog color

void CIvfFog::setDensity double  density  ) 
 

Set fog density

void CIvfFog::setEnd double  end  ) 
 

Sets eye distance to fog end

void CIvfFog::setLimits double  start,
double  end
 

Set fog limits

Sets the limits used for FT_LINEAR fog type.

param start eye distance to fog starting param end eye distance to fog end

void CIvfFog::setStart double  start  ) 
 

Sets eye distance to fog start

void CIvfFog::setType TFogType  type  ) 
 

Set fog type

param type FT_LINEAR, FT_EXP or FT_EXP2 see also OpenGL documentation


The documentation for this class was generated from the following file:
Generated on Fri Sep 1 15:36:51 2006 for Interactive Visualisation Framework - Ivf++ by  doxygen 1.4.6-NO