TerrainWorldWorkspace.h

浏览该文件的文档.

#pragma once
 
#include <cstdint>
#include <memory>
#include <string>
 
#include "common/Result.h"
 
namespace eve::procgen {
class Heightmap;
class PointSet;
class TerrainDetailLayer;
class TerrainBiomePreset;
class TerrainSplatmap;
class TerrainSpawnPlan;
struct TerrainDetailSettings;
struct TerrainObjectPlacementSettings;
struct TerrainProbePlacementSettings;
struct TerrainStampSettings;
struct TerrainTreePlacementSettings;
enum class TerrainDetailMode;
enum class TerrainObjectOperationMode : std::uint8_t;
enum class TerrainProbeOperationMode : std::uint8_t;
enum class TerrainTreeOperationMode : std::uint8_t;
enum class TerrainWorldRunStatus { Idle, Pending, Completed, Cancelled, Failed };
 
struct TerrainWorldCreationSettings {
    int tilesX = 1, tilesZ = 1;
    float tileSize = 1024, tileHeight = 1000;
    float centerX = 0, centerZ = 0;
    int heightmapResolution = 1025;
    int controlTextureResolution = 1024;
    int detailResolution = 1024;
    int treeResolution = 1024;
    int objectResolution = 1024;
    int splatLayers = 1, defaultSplatLayer = 0;
    int defaultDetailDensity = 0;
    bool worldMap = false;
    std::string namePrefix = "Terrain";
    std::string nameSuffix;
};
 
struct TerrainWorldClearSettings {
    bool details = true;
    bool trees = true;
    bool objects = true;
    bool probes = true;
    std::uint64_t sourceNamespace = 0;
};
 
class EVENGINE_API_DOMAINS TerrainWorldWorkspace {
public:
    struct Impl;
    TerrainWorldWorkspace();
    ~TerrainWorldWorkspace();
    TerrainWorldWorkspace(TerrainWorldWorkspace&&) noexcept;
    TerrainWorldWorkspace& operator=(TerrainWorldWorkspace&&) noexcept;
    TerrainWorldWorkspace(const TerrainWorldWorkspace&) = delete;
    TerrainWorldWorkspace& operator=(const TerrainWorldWorkspace&) = delete;
    [[nodiscard]] Result<int> create(const TerrainWorldCreationSettings& settings);
    [[nodiscard]] Result<int> stamp(const Heightmap& stamp, const TerrainStampSettings& settings,
                                    const Heightmap& localMask, const Heightmap& globalMask);
    [[nodiscard]] Result<int> paintSplat(const Heightmap& paint, int targetLayer,
                                         const TerrainStampSettings& operation);
    [[nodiscard]] Result<int> applyDetail(const Heightmap& fitness, const TerrainDetailSettings& settings,
                                          const TerrainStampSettings& operation,
                                          TerrainDetailMode mode, std::int32_t seed);
    [[nodiscard]] Result<int> applyTrees(const Heightmap& fitness, const TerrainTreePlacementSettings& settings,
                                         const TerrainStampSettings& operation, TerrainTreeOperationMode mode);
    [[nodiscard]] Result<int> applyObjects(const Heightmap& fitness,
                                           const TerrainObjectPlacementSettings& settings,
                                           const TerrainStampSettings& operation,
                                           TerrainObjectOperationMode mode);
    [[nodiscard]] Result<int> applyProbes(const Heightmap& fitness,
                                          const TerrainProbePlacementSettings& settings,
                                          const TerrainStampSettings& operation,
                                          TerrainProbeOperationMode mode);
    [[nodiscard]] Result<int> spawn(const TerrainSpawnPlan& plan);
    [[nodiscard]] Result<int> spawnBiome(const TerrainBiomePreset& preset);
    [[nodiscard]] Result<int> spawnStamper(const TerrainBiomePreset& preset);
    [[nodiscard]] Result<TerrainWorldRunStatus> beginSpawn(const TerrainSpawnPlan& plan);
    [[nodiscard]] Result<TerrainWorldRunStatus> beginSpawnBiome(const TerrainBiomePreset& preset);
    [[nodiscard]] Result<TerrainWorldRunStatus> beginSpawnStamper(const TerrainBiomePreset& preset);
    [[nodiscard]] Result<TerrainWorldRunStatus> stepSpawn(int maxRules);
    [[nodiscard]] Result<TerrainWorldRunStatus> cancelSpawn();
    [[nodiscard]] TerrainWorldRunStatus getSpawnStatus() const noexcept;
    [[nodiscard]] int getSpawnCompletedRules() const noexcept;
    [[nodiscard]] Result<int> flatten();
    [[nodiscard]] Result<int> setHeightWorldUnits(float heightWorldUnits, float worldHeightSpan);
    [[nodiscard]] Result<int> clearSpawns(const TerrainWorldClearSettings& settings);
    [[nodiscard]] Result<int> copyHeightmap(int index, Heightmap& output) const;
    [[nodiscard]] Result<int> copySplatmap(int index, TerrainSplatmap& output) const;
    [[nodiscard]] Result<int> copyDetail(int index, TerrainDetailLayer& output) const;
    [[nodiscard]] Result<int> copyTrees(int index, PointSet& output) const;
    [[nodiscard]] Result<int> copyObjects(int index, PointSet& output) const;
    [[nodiscard]] Result<int> copyProbes(int index, PointSet& output) const;
    [[nodiscard]] Result<std::string> getTileName(int index) const;
    [[nodiscard]] Result<double> getTileOriginX(int index) const;
    [[nodiscard]] Result<double> getTileOriginZ(int index) const;
    [[nodiscard]] Result<int> undo();
    [[nodiscard]] Result<int> redo();
    [[nodiscard]] int getTileCount() const noexcept;
    [[nodiscard]] int getLastChangedSamples() const noexcept;
    [[nodiscard]] int getLastAffectedTiles() const noexcept;
    [[nodiscard]] int getOperationCount() const noexcept;
    [[nodiscard]] int getAppliedCount() const noexcept;
private:
    std::unique_ptr<Impl> impl_;
};
}  // namespace eve::procgen