Defines a type of biome. Several biomes can coexist in the same world. Each biome has a density mask function that determines which biome will prevail at a given location. A biome also specifies a list of terrain materials and planting rules for instances.
More...
#include <Biome.h>
|
| | CBiome (CHeightLayer *heightLayer, CCornerTileSet *caveLayer, int maskType, double maskFreq, double maskStep, double maskLacunarity, int maskOctaves, double maskShift, double maskClampMin, double maskClampMax, double snowHeight, int caveFloorMaterial, int caveWallMaterial) |
| | Constructs a biome object. More...
|
| |
|
void | setMacroColor (unsigned char *colors) |
| |
|
virtual void | getColor (double x, double y, double z, unsigned char &r, unsigned char &g, unsigned char &b) |
| |
|
void | addPlantingRule (CPlantingRule rule) |
| | Adds a new PlantingRule object.
|
| |
| void | addMaterial (CMaterialLibrary *materialLibrary, int id) |
| |
|
double | getMaskValue (double x, double z) |
| | Retrieves the mask value for the specified point in the world map.
|
| |
| bool | getCaveProfile (double x, double z, double noiseHeight, double tileHeight, double tileHeightMin, double tileHeightMax, double displacement, double caveBottomDisplacement, double &height, double &caveBottom, double &caveTop) |
| | Retrieves cave profile for the biome. Returns true if the spot is exposed to open air. More...
|
| |
|
|
CHeightLayer * | heightLayer |
| | A HeightLayer object that specifies the height values for the biome.
|
| |
|
CCornerTileSet * | caveLayer |
| | A tileset to be used for underground features like caves.
|
| |
|
int | maskType |
| | Type of mask. Only 0 (Perlin) is currently supported.
|
| |
|
double | maskFreq |
| | Frequency of the mask signal.
|
| |
|
double | maskStep |
| | Increment in amplitude from one octave to the next for the mask signal.
|
| |
|
double | maskLacunarity |
| | Increment in frequency from one octave to the next for the mask signal.
|
| |
|
int | maskOctaves |
| | Number of octaves in the mask signal.
|
| |
|
double | maskShift |
| | Adds a global shift to the mask.
|
| |
|
double | maskClampMin |
| | Minimum value for the mask. Values below this point will be considered zero, and the remaining mask amplitude will be scaled to match this point.
|
| |
|
double | maskClampMax |
| | Maximum value for the mask. Values above this point will be considered one, and the remaining mask amplitude will be scaled to match this point.
|
| |
|
double | snowHeight |
| | Height at which snow stats to appear for the biome.
|
| |
|
int | caveFloorMaterial |
| | Material that will be applied to cave floors.
|
| |
|
int | caveWallMaterial |
| | Material that will be applied to cave walls.
|
| |
|
unsigned char * | macroColorMap |
| | Contains the values read from the macro color map.
|
| |
|
TVector< CPlantingRule > | plantingRules |
| | List of instance planting rules for the biome.
|
| |
|
TVector< int > | materials |
| | List of terrain materials that appear in the biome.
|
| |
Defines a type of biome. Several biomes can coexist in the same world. Each biome has a density mask function that determines which biome will prevail at a given location. A biome also specifies a list of terrain materials and planting rules for instances.
Definition at line 150 of file Biome.h.
| VoxelFarm::CBiome::CBiome |
( |
CHeightLayer * |
heightLayer, |
|
|
CCornerTileSet * |
caveLayer, |
|
|
int |
maskType, |
|
|
double |
maskFreq, |
|
|
double |
maskStep, |
|
|
double |
maskLacunarity, |
|
|
int |
maskOctaves, |
|
|
double |
maskShift, |
|
|
double |
maskClampMin, |
|
|
double |
maskClampMax, |
|
|
double |
snowHeight, |
|
|
int |
caveFloorMaterial, |
|
|
int |
caveWallMaterial |
|
) |
| |
Constructs a biome object.
- Parameters
-
| heightLayer | A HeightLayer object that specifies the height values for the biome |
| caveLayer | A tileset to be used for underground features like caves |
| maskType | Type of mask. Only 0 (Perlin) is currently supported. |
| maskFreq | Frequency of the mask signal |
| maskStep | Increment in amplitude from one octave to the next for the mask signal |
| maskLacunarity | Increment in frequency from one octave to the next for the mask signal |
| maskOctaves | Number of octaves in the mask signal |
| maskShift | Adds a global shift to the mask |
| maskClampMin | Minimum value for the mask. Values below this point will be considered zero, and the remaining mask amplitude will be scaled to match this point |
| maskClampMax | Maximum value for the mask. Values above this point will be considered one, and the remaining mask amplitude will be scaled to match this point |
| snowHeight | List of terrain materials that appear in the biome |
| caveFloorMaterial | Material that will be applied to cave floors |
| caveWallMaterial | Material that will be applied to cave walls |
| void VoxelFarm::CBiome::addMaterial |
( |
CMaterialLibrary * |
materialLibrary, |
|
|
int |
id |
|
) |
| |
Links the material ID to the biome. This makes the material appear in the biome wherever it matches the material placement rules.
| bool VoxelFarm::CBiome::getCaveProfile |
( |
double |
x, |
|
|
double |
z, |
|
|
double |
noiseHeight, |
|
|
double |
tileHeight, |
|
|
double |
tileHeightMin, |
|
|
double |
tileHeightMax, |
|
|
double |
displacement, |
|
|
double |
caveBottomDisplacement, |
|
|
double & |
height, |
|
|
double & |
caveBottom, |
|
|
double & |
caveTop |
|
) |
| |
Retrieves cave profile for the biome. Returns true if the spot is exposed to open air.
- Parameters
-
| x | World X coordinate |
| z | World Z coordinate |
| noiseHeight | Height of the noise component for the biome heightmap |
| tileHeight | Height of the tileset component for the biome heightmap |
| tileHeightMin | Filtered minimum height of the tilese component |
| tileHeightMax | Filtered maximum height of the tilese component |
| displacement | Material displacement at the point |
| caveBottomDisplacement | Cave ground displacement at the point |
| height | Returns the heigtmap value at the point |
| caveBottom | Returns the heigtmap value for the cave's bottom |
| caveTop | Returns the heigtmap value for the cave's top |
The documentation for this class was generated from the following file:
- VF_2.0.3.93_MT/SDK/Engine.CPP/Biome.h