BioGen.h

Go to the documentation of this file.

// BioGen.h

/*
Interfaces to the various biome generators:
    - cBioGenConstant
    - cBioGenCheckerboard
    - cBioGenDistortedVoronoi
*/





#pragma once

#include "ComposableGenerator.h"
#include "../Noise/Noise.h"
#include "../VoronoiMap.h"





class cBioGenConstant :
    public cBiomeGen
{
public:
    cBioGenConstant(void) : m_Biome(biPlains) {}

protected:

    EMCSBiome m_Biome;

    // cBiomeGen overrides:
    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;
} ;





class cBioGenCache :
    public cBiomeGen
{
    typedef cBiomeGen super;

public:

    cBioGenCache(cBiomeGenPtr a_BioGenToCache, size_t a_CacheSize);
    virtual ~cBioGenCache() override = default;


protected:

    cBiomeGenPtr m_BioGenToCache;

    struct sCacheData
    {
        cChunkCoords m_Coords;
        cChunkDef::BiomeMap m_BiomeMap;

        sCacheData():
            m_Coords(0x7fffffff, 0x7fffffff)
        {
        }
    } ;

    // To avoid moving large amounts of data for the MRU behavior, we MRU-ize indices to an array of the actual data
    size_t                  m_CacheSize;
    std::vector<size_t>     m_CacheOrder;  // MRU-ized order, indices into m_CacheData array
    std::vector<sCacheData> m_CacheData;   // m_CacheData[m_CacheOrder[0]] is the most recently used

    // Cache statistics
    size_t m_NumHits;
    size_t m_NumMisses;
    size_t m_TotalChain;  // Number of cache items walked to get to a hit (only added for hits)

    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;
} ;





class cBioGenMulticache :
    public cBiomeGen
{

    typedef cBiomeGen super;

public:
    /* Creates a new multicache - a cache that divides the caching into several sub-caches based on the chunk coords.
    This allows us to use shorter cache depths with faster lookups for more covered area. (#381)
    a_SubCacheSize defines the size of each sub-cache
    a_NumSubCaches defines how many sub-caches are used for the multicache. */
    cBioGenMulticache(cBiomeGenPtr a_BioGenToCache, size_t a_SubCacheSize, size_t a_NumSubCaches);

protected:
    typedef std::vector<cBiomeGenPtr> cBiomeGenPtrs;


    size_t m_NumSubCaches;

    cBiomeGenPtrs m_Caches;


    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;
};





class cBiomeGenList :
    public cBiomeGen
{
    typedef cBiomeGen super;

protected:
    // List of biomes that the generator is allowed to generate:
    typedef std::vector<EMCSBiome> EMCSBiomes;
    EMCSBiomes m_Biomes;
    int        m_BiomesCount;  // Pulled out of m_Biomes for faster access

    void InitializeBiomes(const AString & a_Biomes);
} ;





class cBioGenCheckerboard :
    public cBiomeGenList
{
    typedef cBiomeGenList super;

protected:
    int m_BiomeSize;

    // cBiomeGen overrides:
    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;
} ;





class cBioGenVoronoi :
    public cBiomeGenList
{
    typedef cBiomeGenList super;

public:
    cBioGenVoronoi(int a_Seed) :
        m_Voronoi(a_Seed)
    {
    }

protected:
    cVoronoiMap m_Voronoi;

    // cBiomeGen overrides:
    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;

    EMCSBiome VoronoiBiome(int a_BlockX, int a_BlockZ);
} ;





class cBioGenDistortedVoronoi :
    public cBiomeGenList
{
    typedef cBiomeGenList super;

public:
    cBioGenDistortedVoronoi(int a_Seed) :
        m_Noise(a_Seed),
        m_Voronoi(a_Seed),
        m_CellSize(0)
    {
    }

protected:
    cNoise m_Noise;

    cVoronoiMap m_Voronoi;

    int m_CellSize;

    // cBiomeGen overrides:
    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;

    void Distort(int a_BlockX, int a_BlockZ, int & a_DistortedX, int & a_DistortedZ);
} ;





class cBioGenMultiStepMap :
    public cBiomeGen
{
    typedef cBiomeGen super;

public:
    cBioGenMultiStepMap(int a_Seed);

protected:
    // Noises used for composing the perlin-noise:
    cNoise m_Noise1;
    cNoise m_Noise2;
    cNoise m_Noise3;
    cNoise m_Noise4;
    cNoise m_Noise5;
    cNoise m_Noise6;

    int    m_Seed;
    int    m_OceanCellSize;
    int    m_MushroomIslandSize;
    int    m_RiverCellSize;
    double m_RiverWidthThreshold;
    float  m_LandBiomesSize;

    typedef int    IntMap[17 * 17];  // x + 17 * z, expected trimmed into [0..255] range
    typedef double DblMap[17 * 17];  // x + 17 * z, expected trimmed into [0..1] range

    // cBiomeGen overrides:
    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;

    void DecideOceanLandMushroom(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap);

    void AddRivers(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap);

    void ApplyTemperatureHumidity(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap);

    void Distort(int a_BlockX, int a_BlockZ, int & a_DistortedX, int & a_DistortedZ, int a_CellSize);

    void BuildTemperatureHumidityMaps(cChunkCoords a_ChunkCoords, IntMap & a_TemperatureMap, IntMap & a_HumidityMap);

    void DecideLandBiomes(cChunkDef::BiomeMap & a_BiomeMap, const IntMap & a_TemperatureMap, const IntMap & a_HumidityMap);

    void FreezeWaterBiomes(cChunkDef::BiomeMap & a_BiomeMap, const IntMap & a_TemperatureMap);
} ;





class cBioGenTwoLevel :
    public cBiomeGen
{
    typedef cBiomeGen super;

public:
    cBioGenTwoLevel(int a_Seed);

protected:
    cVoronoiMap m_VoronoiLarge;

    cVoronoiMap m_VoronoiSmall;

    // The noises used for the distortion:
    cNoise m_Noise1;
    cNoise m_Noise2;
    cNoise m_Noise3;
    cNoise m_Noise4;
    cNoise m_Noise5;
    cNoise m_Noise6;

    // Frequencies and amplitudes for the distortion noises:
    float m_FreqX1, m_AmpX1;
    float m_FreqX2, m_AmpX2;
    float m_FreqX3, m_AmpX3;
    float m_FreqZ1, m_AmpZ1;
    float m_FreqZ2, m_AmpZ2;
    float m_FreqZ3, m_AmpZ3;


    // cBiomeGen overrides:
    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void InitializeBiomeGen(cIniFile & a_IniFile) override;

    EMCSBiome SelectBiome(int a_BiomeGroup, size_t a_BiomeIdx, int a_DistLevel);
} ;