TerrainGenerationSession.h

浏览该文件的文档.

#pragma once
#include <memory>
#include <string>
#include "common/Result.h"
 
namespace eve::procgen {
class Heightmap;
struct TerrainStampSettings;
struct TerrainThermalSettings;
struct TerrainWaterSettings;
struct TerrainSedimentSettings;
enum class TerrainWaterChannel;
struct TerrainSmoothSettings;
struct TerrainRidgeSettings;
struct TerrainTerraceSettings;
struct TerrainHeightMixSettings;
enum class TerrainSessionAccess { Editable, Locked };
enum class TerrainSessionRunStatus { Idle, Pending, Completed, Cancelled, Failed };
class EVENGINE_API_DOMAINS TerrainGenerationSession {
public:
    TerrainGenerationSession();
    ~TerrainGenerationSession();
    TerrainGenerationSession(TerrainGenerationSession&&) noexcept;
    TerrainGenerationSession& operator=(TerrainGenerationSession&&) noexcept;
    TerrainGenerationSession(const TerrainGenerationSession&) = delete;
    TerrainGenerationSession& operator=(const TerrainGenerationSession&) = delete;
    [[nodiscard]] Result<int> reset(const Heightmap& baseline);
    [[nodiscard]] Result<int> stamp(const Heightmap& stamp, const TerrainStampSettings& settings,
                                    const Heightmap& localMask, const Heightmap& globalMask);
    [[nodiscard]] Result<int> contrast(const Heightmap& mask, float strength, float featureSize);
    [[nodiscard]] Result<int> smooth(const Heightmap& mask, const TerrainSmoothSettings& settings);
    [[nodiscard]] Result<int> ridges(const Heightmap& mask, const TerrainRidgeSettings& settings);
    [[nodiscard]] Result<int> terrace(const Heightmap& mask, const TerrainTerraceSettings& settings);
    [[nodiscard]] Result<int> power(const Heightmap& mask, float power);
    [[nodiscard]] Result<int> heightCurve(const Heightmap& mask, const Heightmap& curve, float minimum, float maximum);
    [[nodiscard]] Result<int> heightMix(const Heightmap& local, const Heightmap& global,
                                        const TerrainHeightMixSettings& settings);
    [[nodiscard]] Result<int> resetSimulation(float depth = 0);
    [[nodiscard]] Result<int> thermal(const TerrainThermalSettings& settings);
    [[nodiscard]] Result<int> hydraulic(const TerrainWaterSettings& water, const TerrainSedimentSettings& sediment,
                                        const TerrainThermalSettings& thermal, int iterations);
    [[nodiscard]] Result<int> copySediment(Heightmap& output) const;
    [[nodiscard]] Result<int> exportWater(Heightmap& output, TerrainWaterChannel channel) const;
    [[nodiscard]] Result<int> replay();
    [[nodiscard]] Result<TerrainSessionRunStatus> beginReplay();
    [[nodiscard]] Result<TerrainSessionRunStatus> stepReplay(int maxOperations);
    [[nodiscard]] Result<TerrainSessionRunStatus> cancelReplay();
    [[nodiscard]] TerrainSessionRunStatus getReplayStatus() const noexcept;
    [[nodiscard]] int getReplayCompletedOperations() const noexcept;
    [[nodiscard]] Result<int> undo();
    [[nodiscard]] Result<int> redo();
    [[nodiscard]] Result<int> setOperationEnabled(int index, bool enabled);
    [[nodiscard]] Result<bool> operationEnabled(int index) const;
    [[nodiscard]] Result<int> copyTerrain(Heightmap& output) const;
    [[nodiscard]] Result<void> setAccess(TerrainSessionAccess access);
    TerrainSessionAccess getAccess() const noexcept;
    int getOperationCount() const noexcept;
    int getAppliedCount() const noexcept;
    [[nodiscard]] Result<std::string> snapshotJson() const;
    [[nodiscard]] Result<void> restoreJson(const std::string& json);
 
private:
    struct Command;
    struct Impl;
    [[nodiscard]] Result<int> append(Command command);
    std::unique_ptr<Impl>     impl_;
    [[nodiscard]] Result<int> moveCursor(int delta);
};
}  // namespace eve::procgen