![]() |
Public API Reference |
![]() |
iSimpleFormerState exposes implementation specific methods for the SimpleTerraformer plugin More...
#include <ivaria/simpleformer.h>
Public Member Functions | |
virtual float * | GetFloatMap ()=0 |
Gets the processed heightmap data. | |
virtual bool | SetFloatMap (csStringID type, iImage *map, float scale=1.0, float offset=0.0)=0 |
Set a generic additional float map to be used. | |
virtual void | SetHeightmap (iImage *heightmap)=0 |
Set a heightmap to be used. | |
virtual void | SetHeightmap (float *data, unsigned int width, unsigned int height)=0 |
Set a heightmap to be used. | |
virtual bool | SetIntegerMap (csStringID type, iImage *map, int scale=1, int offset=0)=0 |
Set a generic additional integer map to be used. | |
virtual void | SetMaterialScale (csVector2 scale)=0 |
Sets the materials scale. | |
virtual void | SetOffset (csVector3 scale)=0 |
Set a offset to be applied to the heightmap region (X, Z) and height (Y) | |
virtual void | SetScale (csVector3 scale)=0 |
Set a scaling factor to be applied to the heightmap region (X, Z) and height (Y) |
iSimpleFormerState exposes implementation specific methods for the SimpleTerraformer plugin
Definition at line 37 of file simpleformer.h.
virtual float* iSimpleFormerState::GetFloatMap | ( | ) | [pure virtual] |
Gets the processed heightmap data.
virtual bool iSimpleFormerState::SetFloatMap | ( | csStringID | type, |
iImage * | map, | ||
float | scale = 1.0 , |
||
float | offset = 0.0 |
||
) | [pure virtual] |
Set a generic additional float map to be used.
type | The ID for this map. To get values of this you need to fetch the stringset with tag 'crystalspace.shared.stringset' and 'Request()' an ID from that. |
map | The image from which this map will be made. If this is an indexed image then the integer index will be casted to float, diviced by 256 and then scaled+offset. If this is a 24-bit image then the three color components are averaged resulting in a value between 0 and 1 too. |
scale | The scale to apply to the map. |
offset | The offset to apply to the map. |
virtual void iSimpleFormerState::SetHeightmap | ( | iImage * | heightmap | ) | [pure virtual] |
Set a heightmap to be used.
The heightmap will by default be covering a region from -1..1 along X and Z, and areas outside this will return a height of 0
virtual void iSimpleFormerState::SetHeightmap | ( | float * | data, |
unsigned int | width, | ||
unsigned int | height | ||
) | [pure virtual] |
Set a heightmap to be used.
The heightmap will by default be covering a region from -1..1 along X and Z, and areas outside this will return a height of 0
virtual bool iSimpleFormerState::SetIntegerMap | ( | csStringID | type, |
iImage * | map, | ||
int | scale = 1 , |
||
int | offset = 0 |
||
) | [pure virtual] |
Set a generic additional integer map to be used.
type | is the ID for this map. To get values of this you need to fetch the stringset with tag 'crystalspace.shared.stringset' and 'Request()' an ID from that. |
map | is the image from which this map will be made. This must be an indexed (palette) image. |
scale | The scale to apply to the map. |
offset | The offset to apply to the map. |
virtual void iSimpleFormerState::SetMaterialScale | ( | csVector2 | scale | ) | [pure virtual] |
Sets the materials scale.
scale | is the amount to scale the material. |
virtual void iSimpleFormerState::SetOffset | ( | csVector3 | scale | ) | [pure virtual] |
Set a offset to be applied to the heightmap region (X, Z) and height (Y)
virtual void iSimpleFormerState::SetScale | ( | csVector3 | scale | ) | [pure virtual] |
Set a scaling factor to be applied to the heightmap region (X, Z) and height (Y)