TerrainWaterField.h

浏览该文件的文档.

#pragma once
#include <memory>
#include "common/Result.h"
 
namespace eve::procgen {
class Heightmap;
struct TerrainSedimentSettings;
struct TerrainThermalSettings;
 
enum class TerrainWaterChannel { Depth, VelocityX, VelocityZ, FluxRight, FluxLeft, FluxBottom, FluxTop };
 
struct TerrainWaterSettings {
    float spacingX = 1, spacingZ = 1, heightScale = 1, waterScale = 1;
    float dt = 0.05F, precipitation = 0.000004F, evaporation = 0.000004F;
    float flowAcceleration = -0.00049F;  
};
 
struct TerrainWaterSample {
    float depth = 0, velocityX = 0, velocityZ = 0;
    float fluxRight = 0, fluxLeft = 0, fluxBottom = 0, fluxTop = 0;
};
 
struct TerrainWaterFlowMapSettings {
    float dropletVolume = 0.3F;
    float absorptionRate = 0.05F;
    int smoothIterations = 1;
};
 
[[nodiscard]] EVENGINE_API_DOMAINS Result<int> generateTerrainWaterFlowMap(Heightmap& target, const Heightmap& source,
                                                                           const TerrainWaterFlowMapSettings& settings);
 
[[nodiscard]] EVENGINE_API_DOMAINS Result<int> generateTerrainVelocityFlowMap(Heightmap&       target,
                                                                              const Heightmap& source, int iterations);
 
class EVENGINE_API_DOMAINS TerrainWaterField {
public:
    TerrainWaterField();
    ~TerrainWaterField();
    TerrainWaterField(TerrainWaterField&&) noexcept;
    TerrainWaterField& operator=(TerrainWaterField&&) noexcept;
    TerrainWaterField(const TerrainWaterField&) = delete;
    TerrainWaterField& operator=(const TerrainWaterField&) = delete;
 
    [[nodiscard]] Result<int> reset(int width, int height, float depth = 0);
    [[nodiscard]] Result<int> advance(const Heightmap& terrain, const TerrainWaterSettings& settings);
    [[nodiscard]] Result<int> advanceHydraulic(Heightmap& heights, Heightmap& sediment,
                                               const TerrainWaterSettings&    water,
                                               const TerrainSedimentSettings& reaction,
                                               const TerrainThermalSettings& thermal, int iterations);
    [[nodiscard]] Result<TerrainWaterSample> sample(int x, int z) const;
    [[nodiscard]] Result<int> exportChannel(Heightmap& target, TerrainWaterChannel channel) const;
    int getWidth() const noexcept;
    int getHeight() const noexcept;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
}  // namespace eve::procgen