DtEntityWheelUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once
#include <vrvOsg/DtEntityWheelData.h>

#include <vrvCore/DtTickable.h>

#include <unordered_map>

namespace makVrv
{
   class DtOsgArticulatedModel;
   class DtCoordinateSystem;
   class DtSceneObject;
   class DtDeadReckonUpdater;

   struct DtAckermanSteeringVelocity
   {
   public:
      DtAckermanSteeringVelocity();
   public:
      double myFirstSetVelocity;
      double mySecondSetVelocity;
   };

   struct DtSkidSteeringSpeed
   {
   public:
      DtSkidSteeringSpeed();
   public:
      double myLeftSpeed;

      double myRightSpeed;

      double mySpeed;
   };

   class DT_DLL_VRVOSG DtEntityWheelUpdater : public DtTickable
   {
   public:
      DtEntityWheelUpdater(DtDe& de);

      virtual ~DtEntityWheelUpdater();

   private:
      DtEntityWheelUpdater() = delete;
      DtEntityWheelUpdater(const DtEntityWheelUpdater &) = delete;
      DtEntityWheelUpdater &operator=(const DtEntityWheelUpdater &) = delete;

   public:
      virtual void update(DtTime tNow);

      virtual void setWheelData(std::unordered_map<DtOsgArticulatedModel*, DtEntityWheelData>* wheelMap);

      static void setAutoResumeTimeout(double val);

      static double autoResumeTimeout();

   protected:

      virtual bool verifyAutoUpdate(DtTime tNow, DtOsgArticulatedModel* model, DtEntityWheelData& wheelData);

      virtual void updateWheels(DtTime tNow);

      virtual void updateWheels(DtTime tNow, DtOsgArticulatedModel* model, DtEntityWheelData& wheelData, bool vrvWheelRotationEnabled);

      virtual bool calculateVelocity( DtSceneObject* sceneObject, DtDeadReckonUpdater* updater, DtEntityWheelDataCommon& wheelDataCommon, DtTime tNow) const;

      virtual bool calculateHeading( DtSceneObject* sceneObject, DtDeadReckonUpdater* updater, DtEntityWheelDataCommon& wheelDataCommon, DtTime tNow) const;

      virtual float calculateDistanceBetweenWheelAxles(DtOsgArticulatedModel* model, int firstSet, int secondSet) const;

      virtual bool hasAckermanSteering(DtOsgArticulatedModel* model) const;

      virtual bool hasSkidSteering(DtOsgArticulatedModel* model) const;

      virtual bool hasArticulatedWheels(DtOsgArticulatedModel* model) const;

      virtual int numSetOfWheels(const DtEntityWheelData& wheelData) const;

      virtual DtAckermanSteeringVelocity calculateAckermanSteeringVelocity(DtTime tNow, DtOsgArticulatedModel* model, DtEntityWheelData& wheelData, double speed) const;

      virtual DtSkidSteeringSpeed calculateSkidSteeringSpeeds(DtTime tNow, DtOsgArticulatedModel* model, DtEntityWheelData& wheelData ) const;

      virtual bool hasTracks(DtOsgArticulatedModel* model) const;

      virtual float calculateTrackWidth(DtOsgArticulatedModel* model) const;

      virtual void printWheelDetails(DtOsgArticulatedModel* model, const DtVector& currVel, int partNum
         , double speed, double angVel) const;

      virtual void updateWheelsAckerman(DtTime tNow, DtOsgArticulatedModel* model, DtEntityWheelData& wheelData, bool vrvWheelRotationEnabled ) const;

      virtual void updateWheelsSkid(DtTime tNow, DtOsgArticulatedModel* model, DtEntityWheelData& wheelData, bool vrvWheelRotationEnabled, DtSkidSteeringSpeed skidSteeringSpeed) const;
      
      virtual bool isReversing( const DtVector& entityVelocity, const DtTaitBryan& entityHeading ) const;

      virtual void slot_coordinateSystemChanged();

      virtual void slot_sceneObjectToBeDeleted(DtOsgArticulatedModel* model);

      virtual void slot_sceneObjectUpdaterToBeDeleted(DtOsgArticulatedModel* model);

      virtual void findSceneObjectAndUpdater( DtOsgArticulatedModel* model, DtSceneObject*& sceneObject, DtDeadReckonUpdater*& updater );
      
      virtual bool doesModelNeedUpdating(DtOsgArticulatedModel* model);
   protected:
      struct DtPerModelWheelUpdaterCache
      {
         DtSceneObject* mySceneObject;
         DtDeadReckonUpdater* myDeadReckonUpdater;
         DtSignalConnectionManager myConnections;
         bool myAreWheelUpdatesFrozen;
      };

   protected:
      DtDe& myDe;
      // local clone of the system wide coordinate system.
      // for thread safety.
      DtCoordinateSystem* myCoordinateSystem;
      bool myShouldRotate;

      std::unordered_map<DtOsgArticulatedModel*, DtEntityWheelData>* myEntityWheelMap;
      std::unordered_map<DtOsgArticulatedModel*, DtPerModelWheelUpdaterCache> myPerModelWheelUpdaterCacheMap;

      static double theAutoResumeTimeout;
   };
}