Terrain.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_TERRAIN_H_
#define DVD_TERRAIN_H_
 
#include "TileRing.h"
#include "TerrainDescriptor.h"
#include "Geometry/Shapes/Headers/Object3D.h"
#include "Core/Math/BoundingVolumes/Headers/BoundingBox.h"
#include "Environment/Terrain/Quadtree/Headers/Quadtree.h"
#include "Rendering/Lighting/ShadowMapping/Headers/ShadowMap.h"
#include "Platform/Video/Buffers/VertexBuffer/Headers/VertexBuffer.h"
 
namespace Divide {
 
template <typename T>
T TER_COORD(T x, T y, T width) noexcept {
    return x + width * y;
}
 
enum class TerrainTextureChannel : U8 {
    TEXTURE_RED_CHANNEL = 0,
    TEXTURE_GREEN_CHANNEL = 1,
    TEXTURE_BLUE_CHANNEL = 2,
    TEXTURE_ALPHA_CHANNEL = 3,
    COUNT
};
 
class Vegetation;
class VertexBuffer;
class TerrainChunk;
class ShaderProgram;
 
FWD_DECLARE_MANAGED_CLASS(Quad3D);
FWD_DECLARE_MANAGED_CLASS(GenericVertexData);
 
namespace Attorney
{
    class TerrainChunk;
}
 
struct TessellationParams
{
    PROPERTY_RW(vec2<F32>, WorldScale);
    PROPERTY_RW(vec2<F32>, SnapGridSize);
    PROPERTY_RW(U32, tessellatedTriangleWidth, 32u);
 
    static constexpr U8 VTX_PER_TILE_EDGE = 9; // overlap => -2
    static constexpr U8 PATCHES_PER_TILE_EDGE = VTX_PER_TILE_EDGE - 1;
    static constexpr U16 QUAD_LIST_INDEX_COUNT = (VTX_PER_TILE_EDGE - 1) * (VTX_PER_TILE_EDGE - 1) * 4;
 
    void fromDescriptor(const TerrainDescriptor& descriptor) noexcept;
};
 
DEFINE_3D_OBJECT_TYPE(Terrain, SceneNodeType::TYPE_TERRAIN)
{
    friend class Attorney::TerrainChunk;
 
   public:
       enum class WireframeMode : U8
       {
           NONE = 0,
           EDGES,
           NORMALS,
           LODS,
           TESS_LEVELS,
           BLEND_MAP,
           COUNT
       };
 
       enum class ParallaxMode : U8
       {
           NONE = 0,
           NORMAL,
           OCCLUSION
       };
 
       enum class TextureUsageType : U8
       {
           ALBEDO_ROUGHNESS = 0,
           NORMAL,
           DISPLACEMENT_AO,
           COUNT
       };
 
       struct Vert {
           vec3<F32> _position;
           vec3<F32> _normal;
           vec3<F32> _tangent;
       };
 
   public:
    explicit Terrain( const ResourceDescriptor<Terrain>& descriptor );
    bool unload() override;
 
    void toggleBoundingBoxes();
 
    [[nodiscard]] const vector<VertexBuffer::Vertex>& getVerts() const noexcept;
    [[nodiscard]] Vert      getVert(F32 x_clampf, F32 z_clampf, bool smooth) const;
    [[nodiscard]] Vert      getVertFromGlobal(F32 x, F32 z, bool smooth) const;
    [[nodiscard]] vec2<U16> getDimensions() const noexcept;
    [[nodiscard]] vec2<F32> getAltitudeRange() const noexcept;
 
    [[nodiscard]] const Quadtree& getQuadtree() const noexcept { return _terrainQuadtree; }
 
    void getVegetationStats(U32& maxGrassInstances, U32& maxTreeInstances) const;
 
    [[nodiscard]] const vector<TerrainChunk*>& terrainChunks() const noexcept { return _terrainChunks; }
    [[nodiscard]] const TerrainDescriptor& descriptor() const noexcept { return _descriptor; }
 
    void saveToXML(boost::property_tree::ptree& pt) const override;
    void loadFromXML(const boost::property_tree::ptree& pt)  override;
 
   protected:
     [[nodiscard]] Vert getVert(F32 x_clampf, F32 z_clampf) const;
     [[nodiscard]] Vert getSmoothVert(F32 x_clampf, F32 z_clampf) const;
 
     bool load( PlatformContext& context ) override;
     void postBuild( PlatformContext& context );
 
     void buildDrawCommands(SceneGraphNode* sgn, GenericDrawCommandContainer& cmdsOut) override;
 
     void prepareRender(SceneGraphNode* sgn,
                        RenderingComponent& rComp,
                        RenderPackage& pkg,
                        GFX::MemoryBarrierCommand& postDrawMemCmd,
                        RenderStagePass renderStagePass,
                        const CameraSnapshot& cameraSnapshot,
                        bool refreshData) override;
 
     void postLoad(SceneGraphNode* sgn) override;
 
     void onEditorChange(std::string_view field);
 
     [[nodiscard]] bool loadResources( PlatformContext& context );
     [[nodiscard]] void createVegetation( PlatformContext& context );
 
     PROPERTY_R(TessellationParams, tessParams);
 
   protected:
     friend class ResourceCache;
     bool postLoad() override;
 
   public:
     vector<VertexBuffer::Vertex> _physicsVerts;
 
   protected:
    Quadtree _terrainQuadtree;
    vector<TerrainChunk*> _terrainChunks;
    GenericVertexData_ptr _terrainBuffer = nullptr;
    vector<TileRing> _tileRings;
 
    bool _initialSetupDone = false;
 
    SceneGraphNode* _vegetationGrassNode = nullptr;
    TerrainDescriptor _descriptor;
    //0 - normal, 1 - wireframe, 2 - normals
    std::array<Handle<ShaderProgram>, to_base(WireframeMode::COUNT)> _terrainColourShader;
    std::array<Handle<ShaderProgram>, to_base(WireframeMode::COUNT)> _terrainPrePassShader;
 
    Handle<Vegetation> _vegetation = INVALID_HANDLE<Vegetation>;
};
 
inline size_t GetHash( Terrain* terrain ) noexcept
{
    return GetHash( terrain->descriptor() );
}
 
namespace Attorney {
class TerrainChunk {
private:
    static void registerTerrainChunk(Terrain& terrain, Divide::TerrainChunk* const chunk)
    {
        terrain._terrainChunks.push_back(chunk);
    }
 
    friend class Divide::TerrainChunk;
};
 
}  // namespace Attorney
}  // namespace Divide
 
#endif //DVD_TERRAIN_H_