ComposableGenerator.h

Go to the documentation of this file.

// ComposableGenerator.h

// Declares the cComposableGenerator class representing the chunk generator that takes the composition approach to generating chunks

/*
Generating works by composing several algorithms:
Biome, TerrainHeight, TerrainComposition, Ores, Structures and SmallFoliage
Each algorithm may be chosen from a pool of available algorithms in the same class and combined with others,
based on user's preferences in the world.ini.
See https://forum.cuberite.org/thread-409.html for details.
*/





#pragma once

#include "ChunkGenerator.h"
#include "ChunkDesc.h"





// Forward-declare the shared pointers to subgenerator classes:
class cBiomeGen;
class cTerrainShapeGen;
class cTerrainHeightGen;
class cTerrainCompositionGen;
class cFinishGen;
typedef std::shared_ptr<cBiomeGen>              cBiomeGenPtr;
typedef std::shared_ptr<cTerrainShapeGen>       cTerrainShapeGenPtr;
typedef std::shared_ptr<cTerrainHeightGen>      cTerrainHeightGenPtr;
typedef std::shared_ptr<cTerrainCompositionGen> cTerrainCompositionGenPtr;
typedef std::shared_ptr<cFinishGen>             cFinishGenPtr;





class cBiomeGen
{
public:
    virtual ~cBiomeGen() {}  // Force a virtual destructor in descendants

    virtual void GenBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) = 0;

    virtual void InitializeBiomeGen(cIniFile & a_IniFile) {}

    static cBiomeGenPtr CreateBiomeGen(
        cIniFile & a_IniFile,
        int a_Seed,
        bool & a_CacheOffByDefault
    );
} ;





class cTerrainShapeGen
{
public:
    virtual ~cTerrainShapeGen() {}  // Force a virtual destructor in descendants

    virtual void GenShape(cChunkCoords a_ChunkCoords, cChunkDesc::Shape & a_Shape) = 0;

    virtual void InitializeShapeGen(cIniFile & a_IniFile) {}

    static cTerrainShapeGenPtr CreateShapeGen(
        cIniFile & a_IniFile,
        cBiomeGenPtr a_BiomeGen,
        int a_Seed,
        bool & a_CacheOffByDefault
    );
} ;





class cTerrainHeightGen
{
public:
    virtual ~cTerrainHeightGen() {}  // Force a virtual destructor in descendants

    virtual void GenHeightMap(cChunkCoords a_ChunkCoords, cChunkDef::HeightMap & a_HeightMap) = 0;

    virtual void InitializeHeightGen(cIniFile & a_IniFile) {}

    virtual HEIGHTTYPE GetHeightAt(int a_BlockX, int a_BlockZ)
    {
        auto chunkCoords = cChunkDef::BlockToChunk({a_BlockX, 0, a_BlockZ});
        cChunkDef::HeightMap heightMap;
        GenHeightMap(chunkCoords, heightMap);
        return cChunkDef::GetHeight(heightMap, a_BlockX - chunkCoords.m_ChunkX * cChunkDef::Width, a_BlockZ - chunkCoords.m_ChunkZ * cChunkDef::Width);
    }

    static cTerrainHeightGenPtr CreateHeightGen(
        cIniFile & a_IniFile,
        cBiomeGenPtr a_BiomeGen,
        int a_Seed,
        bool & a_CacheOffByDefault
    );
} ;





class cTerrainCompositionGen
{
public:
    virtual ~cTerrainCompositionGen() {}  // Force a virtual destructor in descendants

    virtual void ComposeTerrain(cChunkDesc & a_ChunkDesc, const cChunkDesc::Shape & a_Shape) = 0;

    virtual void InitializeCompoGen(cIniFile & a_IniFile) {}

    static cTerrainCompositionGenPtr CreateCompositionGen(
        cIniFile & a_IniFile,
        cBiomeGenPtr a_BiomeGen,
        cTerrainShapeGenPtr a_ShapeGen,
        int a_Seed
    );
} ;





class cFinishGen
{
public:
    virtual ~cFinishGen() {}  // Force a virtual destructor in descendants

    virtual void GenFinish(cChunkDesc & a_ChunkDesc) = 0;
} ;

typedef std::list<cFinishGenPtr> cFinishGenList;





class cComposableGenerator :
    public cChunkGenerator
{
    typedef cChunkGenerator Super;

public:
    cComposableGenerator();

    // cChunkGenerator::cGenerator overrides:
    virtual void Initialize(cIniFile & a_IniFile) override;
    virtual void GenerateBiomes(cChunkCoords a_ChunkCoords, cChunkDef::BiomeMap & a_BiomeMap) override;
    virtual void Generate(cChunkDesc & a_ChunkDesc) override;

    static void InitializeGeneratorDefaults(cIniFile & a_IniFile, eDimension a_Dimension);


protected:

    // The generator's composition:
    cBiomeGenPtr m_BiomeGen;

    cTerrainShapeGenPtr m_ShapeGen;

    cTerrainCompositionGenPtr m_CompositionGen;

    cTerrainHeightGenPtr m_CompositedHeightCache;

    cFinishGenList m_FinishGens;


    void InitBiomeGen(cIniFile & a_IniFile);

    void InitShapeGen(cIniFile & a_IniFile);

    void InitCompositionGen(cIniFile & a_IniFile);

    void InitFinishGens(cIniFile & a_IniFile);
} ;