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

Fog Class Reference

Linear and exponention fog. More...

#include <Fog.h>

Inherits DynamicObject.

Inheritance diagram for Fog:

Inheritance graph
[legend]
Collaboration diagram for Fog:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Type { Linear, Exp, Exp2 }

Public Methods

 Fog ()
real getEnd ()
void apply (Color4 &c, real z)
real fogValue (real z)
void parseSymbol (Token &t, ObjectFile &file)
 Reads a single parameter sections inside the body of the object description. More...

void writeParams (ostream &stream)
 Writes all parameter sections inside the body of the object description. More...


Protected Methods

void createSymbols ()
 Creates all parameter symbols that are used within the body of the object description.


Protected Attributes

Color4 color
real start
real end
real density
Type type

Static Protected Attributes

const real End = 1.0e5

Detailed Description

Linear and exponention fog.


Member Function Documentation

void Fog::parseSymbol Token   t,
ObjectFile   file
[virtual]
 

Reads a single parameter sections inside the body of the object description.

Each object has a set of parameter names associated with it, called symbols. Symbols are declared inside the createSymbols method. The method parseSymbol expects the Token t to be such a symbol and reads the corresponding parameters. Unknown symbols are passed to its super class.

Parameters:
t  Token that is the current parameter symbol.
file  ObjectFile from which to read.
Precondition:
The file is opened for reading and is positioned just after the parameter name.
Postcondition:
The parameter section is read including the terminating semicolon (';').

Reimplemented from DynamicObject.

void Fog::writeParams ostream &    stream [virtual]
 

Writes all parameter sections inside the body of the object description.

This method writes all object parameters to ostream. Inhereting classes will always call super::writeParams().

Parameters:
stream  ostream to which to write.
Precondition:
stream is opened for writing.
Postcondition:
All object parameters are written.

Reimplemented from DynamicObject.


The documentation for this class was generated from the following files:
This documentation was generated using doxygen. If you have any comments or additions please mail me.