TerrainToolCollection.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/Shovel.h>
#include <agxTerrain/AggregateContactGenerator.h>
#include <agxTerrain/ShovelAggregateContactUtils.h>
#include <agxTerrain/TerrainFrictionModels.h>
#include <agxTerrain/DeformController.h>
 
#include <agxStream/Serializable.h>
 
namespace agxTerrain
{
  namespace deprecated
  {
    AGX_DECLARE_POINTER_TYPES(TerrainToolCollection);
    AGX_DECLARE_VECTOR_TYPES(TerrainToolCollection);
 
    class AGXTERRAIN_EXPORT TerrainToolCollection : public agx::Referenced, public agxStream::Serializable
    {
    public:
 
      // --- DEPRECATED --- //
 
      AGX_DEPRECATED(2.40.0.0)
      TerrainToolCollection(Terrain* terrain, Shovel* shovel);
 
      AGX_DEPRECATED(2.40.0.0)
      Terrain* getTerrain() const;
 
      AGX_DEPRECATED(2.40.0.0)
      Shovel* getShovel() const;
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getActiveZone)
      PrimaryActiveZone* getActiveZone() const;
 
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getSoilParticleAggregate)
      SoilParticleAggregate* getSoilParticleAggregate() const;
 
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getAggregateContactGenerator)
      AggregateContactGenerator* getAggregateContactGenerator() const;
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getDeformController)
      DeformController* getDeformController() const;
 
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getPenetrationResistance)
      SoilPenetrationResistance* getPenetrationResistance() const;
 
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getVoxelCollisionGeometries)
      const agxCollide::GeometryRefVector& getVoxelCollisionGeometries() const;
 
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getParentFrame)
      agx::Frame* getParentFrame() const;
 
      AGX_DEPRECATED(2.40.0.0)
      agx::Bool initialized() const;
 
      AGX_DEPRECATED(2.40.0.0)
      agx::Bool shouldUpdate();
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::setEnableShovelTerrainGeometryContacts)
      void setEnableShovelTerrainGeometryContacts(bool enable);
 
      AGX_DEPRECATED_FOR(2.40.0.0, AdvancedShovelSettings::setUseZeroAggregateVelocity)
      void setZeroAggregateVelocity(bool enable);
 
 
      /*
      \deprecated
      Set whenever custom friction models should be used in the
      shovel <-> aggregate contacts.
      \param enable - True if custom friction models should be used. (Default: true)
      */
      AGX_DEPRECATED_FOR(2.40.0.0, AdvancedShovelSettings::setUseCustomFrictionModel)
      void setUseCustomFrictionModel(bool enable);
 
      AGX_DEPRECATED_FOR(2.40.0.0, AdvancedShovelSettings::getUseCustomFrictionModel)
      bool getUseCustomFricionModel() const;
 
 
 
      AGX_DEPRECATED(2.40.0.0)
      bool shovelEnableHasChanged() const;
 
      AGX_DEPRECATED(2.40.0.0)
      void clearActiveZoneWedges() const;
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getWedgeAggregate)
      const agx::RigidBody* getWedgeAggregate(Shovel::ExcavationMode excavationMode) const;
 
      AGX_DEPRECATED_FOR(2.40.0.0, Shovel::getAggregateTerrainContactDepth)
      agx::Real getAggregateTerrainContactDepth(Shovel::ExcavationMode excavationMode) const;
 
      AGX_DEPRECATED_FOR(2.40.0.0, PrimaryActiveZone::updateInnerShape)
      void recomputeInnerShape();
 
 
      DOXYGEN_START_INTERNAL_BLOCK()
 
      // --- USED FOR RESTORE FROM OLD ARCHIVES --- //
 
      Terrain* getRestoredTerrain() const;
 
      Shovel* getRestoredShovel() const;
 
      ShovelAggregateContactMaterialContainer* getRestoredShovelTerrainContactMaterialContainer();
 
      bool getRestoredEnable();
 
      agx::Bool getRestoredSetZeroAggregateVelocity() const;
 
      AGXSTREAM_DECLARE_SERIALIZABLE(agxTerrain::deprecated::TerrainToolCollection);
 
      DOXYGEN_END_INTERNAL_BLOCK()
 
    protected:
      TerrainToolCollection();
 
      virtual ~TerrainToolCollection();
 
      enum StateFlags : agx::UInt32
      {
        ENABLED = 1 << 0,
        SHOVEL_ENABLED = 1 << 1,
        SET_ZERO_AGGREGATE_VELOCITY = 1 << 2
      };
      using Flags = agx::BitState<StateFlags, agx::UInt32>;
 
    private:
      Terrain* m_terrain;
      ShovelRef                                  m_shovel;
      ShovelAggregateContactMaterialContainerRef m_shovelAggregateCMContainer;
      Flags                                      m_flags;
    };
  }
}