TerrainGridControl.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#pragma once
 
#include <agxTerrain/export.h>
#include <agx/Vec3.h>
#include <agxTerrain/TerrainMaterial.h>
 
namespace agxTerrain
{
  class Terrain;
 
  AGX_DECLARE_POINTER_TYPES(TerrainGridControl);
  AGX_DECLARE_VECTOR_TYPES(TerrainGridControl);
 
  class AGXTERRAIN_EXPORT TerrainGridControl : public agx::Referenced
  {
  public:
    TerrainGridControl(Terrain* terrain);
 
    TerrainGridControl();
 
    float getOccupancy(const agx::Vec2i& terrainIndex, int z) const;
 
    float getOccupancy(const agx::Vec3i& voxelIndex) const;
 
    float getMass(const agx::Vec2i& terrainIndex, int z) const;
 
    float getMass(const agx::Vec3i& voxelIndex) const;
 
    float getTotalMass( const agx::Vec3i& voxelIndex ) const;
 
    float getCompaction(const agx::Vec2i& terrainIndex, int z) const;
 
    float getCompaction(const agx::Vec3i& terrainIndex) const;
 
    float getSurfaceOccupancy(const agx::Vec2i& terrainIndex) const;
 
    float getSurfaceCompaction(const agx::Vec2i& terrainIndex) const;
 
    void setSurfaceCompaction(
      const agx::Vec2i& terrainIndex, float compaction, bool compressOccupancy = false, bool compressToBottom = false);
 
    void setSurfaceCompactionToDepth(const agx::Vec2i& terrainIndex, float compaction, float depth);
 
    void setCompaction(const agx::Vec2i& terrainIndex, int z, float compaction, bool compressOccupancy = false);
 
    void setCompaction(const agx::Vec3i& terrainIndex, float compaction, bool compressOccupancy = false);
 
    void setTerrainMaterial(const agx::Vec2i& terrainIndex, int z, TerrainMaterial* terrainMaterial);
    void setTerrainMaterial(const agx::Vec3i& terrainIndex, TerrainMaterial* terrainMaterial);
    float addSolidOccupancyInColumn(
      const agx::Vec2i& terrainIndex, float mass, float compaction, bool shouldAvalanche = true);
 
    void addSolidOccupancyInColumns(agx::HashTable<agx::Vec2i, std::pair<float, float>> table, bool shouldAvalanche = true);
 
    float removeSolidOccupancyInColumn(const agx::Vec2i& terrainIndex, float occupancy, bool shouldAvalanche = true);
 
    float addSolidOccupancyLayerInColum(const agx::Vec2i& terrainIndex, agx::Real layerHeight, float compaction, bool shouldAvalanche = true);
 
    float addSolidOccupancyInColumnToHeight(const agx::Vec2i& terrainIndex, agx::Real height, float compaction, bool shouldAvalanche = true);
 
    float removeFluidOccupancy(const agx::Vec3i& terrainIndex, float fluidOccupancy);
 
    agx::Real getLocalAngleOfRepose(const agx::Vec3i& voxelIndex) const;
 
    agx::Real getSurfaceAngleOfRepose(const agx::Vec2i& terrainIndex) const;
 
    bool applySurfaceForce(const agx::Vec2i& terrainIndex, agx::Real surfaceForce, agx::Real contactTime=-1);
 
    bool applySurfaceStress(const agx::Vec2i& terrainIndex, agx::Real surfaceStress, agx::Real contactTime = -1);
 
    bool isIndexValid(const agx::Vec3i& voxelIndex) const;
 
    agx::Real getCurrentStressInTerrainIndex(const agx::Vec3i& terrainIndex) const;
 
    agx::Real getLocalPreconsolidationStress(const agx::Vec3i& terrainIndex) const;
 
    agx::Real getSurfacePreconsolidationStress(const agx::Vec2i& terrainIndex) const;
 
    agx::Vec3 getGridElementPositionWorld(const agx::Vec3i& terrainIndex) const;
 
    agx::Real getSurfaceHardnessMultiplier(const agx::Vec2i& terrainIndex) const;
 
    agx::Real getLocalHardnessMultiplier(const agx::Vec3i& voxelIndex) const;
 
    int findSurfaceIndex(const agx::Vec2i& terrainIndex) const;
 
    int findIndexFromSurfaceDepth(const agx::Vec2i& terrainIndex, agx::Real depth) const;
 
    int getLowestAllowableDepthIndex() const;
 
    agx::Real convertOccupancyToMassKg(float occupancy) const;
 
    agx::Real convertFluidMassKgToOccupancy(float mass) const;
 
  public:
    DOXYGEN_START_INTERNAL_BLOCK()
    AGXTERRAIN_STORE_RESTORE_INTERFACE;
    DOXYGEN_END_INTERNAL_BLOCK()
 
  protected:
    agx::Vec3i convertSurfaceTerrainIndex(const agx::Vec2i& terrainIndex) const;
 
    virtual ~TerrainGridControl();
 
  private:
    Terrain* m_terrain;
  };
}