iTerraFormer Struct Reference
TerraFormer objects are used to retrieve terrain data. More...
#include <ivaria/terraform.h>
Inheritance diagram for iTerraFormer:

Public Member Functions | |
virtual csPtr< iTerraSampler > | GetSampler (csBox2 region, unsigned int resolution)=0 |
Get a sampler region from the terraformer. | |
virtual bool | SampleFloat (csStringID type, float x, float z, float &value)=0 |
Sample float data at a given spot on the terrain. | |
virtual bool | SampleInteger (csStringID type, float x, float z, int &value)=0 |
Sample integer data at a given spot on the terrain. | |
virtual bool | SampleVector2 (csStringID type, float x, float z, csVector2 &value)=0 |
Sample csVector2 data at a given spot on the terrain. | |
virtual bool | SampleVector3 (csStringID type, float x, float z, csVector3 &value)=0 |
Sample csVector2 data at a given spot on the terrain. |
Detailed Description
TerraFormer objects are used to retrieve terrain data.All data is retrieved in blocks, from sampler regions.
Definition at line 38 of file terraform.h.
Member Function Documentation
|
Get a sampler region from the terraformer. The sampler region will be used for all actual data retrieval. |
|
Sample float data at a given spot on the terrain. Note that this should only be used when single heights are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise. |
|
Sample integer data at a given spot on the terrain. Note that this should only be used when single samples are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise. |
|
Sample csVector2 data at a given spot on the terrain. Note that this should only be used when single samples are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise. |
|
Sample csVector2 data at a given spot on the terrain. Note that this should only be used when single samples are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise. |
The documentation for this struct was generated from the following file:
- ivaria/terraform.h
Generated for Crystal Space by doxygen 1.4.4