Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

TeGenerator Class Reference

#include <TeGenerator.h>

Inheritance diagram for TeGenerator:

TeFaultFormation TeLinearFilter List of all members.

Detailed Description

Abstract class meant to be a parent to all generators.

This abstract class defines interface for derived classes.

Generators can be used in two different ways with same results. One way is to use generate() method to gain result in single function call. The other way is to call genStep() several times and obtain the result in the near future. The fact that result is ready to use is identified by the TRUE value returned by this method. In case that task is not done yet this function returns FALSE.

Typical usage of some generator should look like this:


Public Member Functions

void reset ()
void setHMap (TeHeightMap *m)
virtual void setDefaults ()=0
virtual void generate ()=0
virtual SbBool genStep ()=0

Protected Member Functions

virtual void updateParams ()=0

Protected Attributes

TeHeightMaphmap
int stepNum
int step


Member Function Documentation

virtual void TeGenerator::generate  )  [pure virtual]
 

Pure virtual function, see derived classes for more information.

Implemented in TeFaultFormation, and TeLinearFilter.

virtual SbBool TeGenerator::genStep  )  [pure virtual]
 

Pure virtual function, see derived classes for more information.

Implemented in TeFaultFormation, and TeLinearFilter.

void TeGenerator::reset  ) 
 

Resets current step counter to zero.

virtual void TeGenerator::setDefaults  )  [pure virtual]
 

Pure virtual function, see derived classes for more information.

Implemented in TeFaultFormation, and TeLinearFilter.

void TeGenerator::setHMap TeHeightMap m  ) 
 

Sets hmap pointer.

Parameters:
m Pointer to a heightmap.

virtual void TeGenerator::updateParams  )  [protected, pure virtual]
 

Pure virtual function, see derived classes for more information.

Implemented in TeFaultFormation, and TeLinearFilter.


Member Data Documentation

TeHeightMap* TeGenerator::hmap [protected]
 

Pointer to the heightmap.

int TeGenerator::step [protected]
 

Current step counter.

int TeGenerator::stepNum [protected]
 

Number of steps required to complete task.


Generated on Sun May 8 16:45:06 2005 for TerrainEngine by Doxygen 1.4.1