CrystalSpace

Public API Reference

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

iTerrainFactoryState Struct Reference

Allows the setting of a set of generic terrain parameters outside any specific algorithm. More...

#include <terrain.h>

Inheritance diagram for iTerrainFactoryState:

iBase List of all members.

Public Methods

virtual void SetScale (const csVector3 &scale)=0
 Set/Get the 3 axis scale of the terrain.

virtual bool SetHeightMap (const csArray< float > &data, int x, int y)=0
 Sets the heightmap for heightvalues Note x and y must be 2^n + 1 and usually they must be equal.

virtual bool SaveState (const char *filename)=0
 Save/Restore preprocessing information, the algorithm will do some preprocessing based on the material and height information this allows the process to be saved out to a file and cached for later reuse (maybe this should be the caching system) In some cases it may actually memorymap this file.


Detailed Description

Allows the setting of a set of generic terrain parameters outside any specific algorithm.

It is up to the algorithm to determine the best use of the information provided in the interface.

Definition at line 97 of file terrain.h.


Member Function Documentation

virtual bool iTerrainFactoryState::SaveState const char *    filename [pure virtual]
 

Save/Restore preprocessing information, the algorithm will do some preprocessing based on the material and height information this allows the process to be saved out to a file and cached for later reuse (maybe this should be the caching system) In some cases it may actually memorymap this file.

virtual bool iTerrainFactoryState::SetHeightMap const csArray< float > &    data,
int    x,
int    y
[pure virtual]
 

Sets the heightmap for heightvalues Note x and y must be 2^n + 1 and usually they must be equal.

virtual void iTerrainFactoryState::SetScale const csVector3   scale [pure virtual]
 

Set/Get the 3 axis scale of the terrain.


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