Public API Reference

                 

---

iTerrBigState Struct Reference

This class associates a file created using the terrbig conversion to the terrbig object. More...

#include <terrbig.h>

Inheritance diagram for iTerrBigState:

List of all members.

Public Methods
virtual bool	LoadHeightMapFile (const char *hm)=0
	Memory maps the file on disk and associates it with the terrain. More...
virtual void	SetScaleFactor (const csVector3 &scale)=0
	Sets the scale factor on the map x = horz, y = vert, z = height. More...
virtual void	SetErrorTolerance (float tolerance)=0
	Sets the error tolerance. More...
virtual bool	ConvertImageToMapFile (iFile *image, iImageIO *imageio, const char *hm)=0
	Converts an image to a height map file usable by LoadHeighMapFile() and saves it into hm. More...
virtual bool	ConvertArrayToMapFile (float *data, int width, const char *hm)=0
	Same as ConvertImageToMapFile but works from a raw floating point array the incoming float should be size width * width. More...
virtual void	SetMaterialsList (iMaterialWrapper **matlist, unsigned int nMaterials)=0
	Set the materials list, copies the passed in list. More...

---

Detailed Description

This class associates a file created using the terrbig conversion to the terrbig object.

Definition at line 34 of file terrbig.h.

---

Member Function Documentation

virtual bool iTerrBigState::ConvertArrayToMapFile (  float *    data, int    width, const char *    hm )  [pure virtual]

Same as ConvertImageToMapFile but works from a raw floating point array the incoming float should be size width * width. Width should be a value 2^n+1

virtual bool iTerrBigState::ConvertImageToMapFile (  iFile *    image, iImageIO *    imageio, const char *    hm )  [pure virtual]

Converts an image to a height map file usable by LoadHeighMapFile() and saves it into hm. It will also load the file.

virtual bool iTerrBigState::LoadHeightMapFile (  const char *    hm )  [pure virtual]

Memory maps the file on disk and associates it with the terrain.

virtual void iTerrBigState::SetErrorTolerance (  float    tolerance )  [pure virtual]

Sets the error tolerance. This should be in pixels, meaning a tolerance of 1 will allow gaps in the hieghtmap of 1 pixel, a tolerance of 0 means the heightmap will perform no LOD

virtual void iTerrBigState::SetMaterialsList (  iMaterialWrapper **    matlist, unsigned int    nMaterials )  [pure virtual]

Set the materials list, copies the passed in list.

virtual void iTerrBigState::SetScaleFactor (  const csVector3 &    scale )  [pure virtual]

Sets the scale factor on the map x = horz, y = vert, z = height.

---

The documentation for this struct was generated from the following file:

• terrbig.h

---