DtGroundClampingUpdater.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/DtSceneObjectUpdater.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>

namespace makVrv 
{
   class DtIntersectionCache;
   class DtIntersectorsContainer;
   class DtCoordinateConverter;

   class DT_DLL_VRVCORE DtGroundClampingUpdater : public DtSceneObjectUpdater
   { 
      friend class DtSurfaceClampingUpdater;

   public:

      enum GroundClampingMode
      {
         ClampNone         = 0,
         ClampOrientation  = 1,
         ClampPosition     = 2,
         ClampUpright      = 4,
         ClampOrientationAndPosition = ClampOrientation | ClampPosition,
         ClampOrientationAndUpright = ClampOrientation | ClampUpright,
         ClampPositionAndUpright = ClampPosition | ClampUpright,
         ClampAll = ClampOrientation | ClampPosition | ClampUpright
      };

   public:

      DtGroundClampingUpdater(DtDe& de, DtUniqueID id );

      virtual ~DtGroundClampingUpdater();

      virtual void update( DtTime tNow );

      virtual void setEnabled(bool enabled);

      virtual void setMode(GroundClampingMode mode);

      bool isClamping() const;

      inline bool isClampingUp() const
      {
         return myMode & ClampUpright;
      }

      inline bool isClampingOrientation() const
      {
         return myMode & ClampOrientation;
      }

      inline bool isClampingPosition() const
      {
         return myMode & ClampPosition;
      }

      virtual void setCullCylinderRadiusScale(float scale);

      virtual void setClampAlways(bool enabled);

      virtual void setCheckForCulling(bool);

      virtual void doGroundClamp( DtTime tNow );

      virtual void setClampTimeThreshold(double);

   protected:

      static void computePerpendicularRotation( const DtVector& pos, 
         const DtVector& hitNormal, const DtTaitBryan& orientation, 
         DtTaitBryan& output );  

      bool computeGroundClampingHit(const DtVector& up,const DtVector& unclampedPosition, DtVector& hitLocation, DtVector& hitNormal);

      void computeIntersectionOrigin(const DtVector& up, const DtVector& unclampedPosition, DtVector& origin) const;

      bool needClampThisTick() const;

      bool targetIsMoving( const DtVector& newPos, const DtVector& lastPos ) const;

      bool targetIsTurning( const DtTaitBryan& newOri, const DtTaitBryan& lastOri ) const;      

      bool checkCulling(const DtVector& up) const;

      void clampToWater( DtTime tNow );

      virtual void setNextUpdaterWithoutManagerPlacement(DtSceneObjectUpdater* updater);

      virtual void slot_coordinateSystemChanged();

   protected:
      // handy helper func to determine the delta between circle angles, 
      static double angleDifference( double prev, double curr );

   protected:

      static const double theClampTimeThreshold;
      static const double theMaxCacheInterval;
      static const double theClampDistThreshold;
      static const double theClampOrientThreshold;
      static const double theIsectLength;    

      bool myHaveLastClampedPosition;
      bool myHaveLastClampedOrientation;
      DtVector myLastClampedPosition;
      DtTaitBryan myLastClampedOrientation;

      DtVector myUnclampedPosition;
      DtTaitBryan myUnclampedOrientation;

      DtVector myLastUnclampedPosition;
      DtTaitBryan myLastUnclampedOrientation;

      double myLastCacheUpdateTime;
      double myLastClampTime;

      float myCullCylinderScale;

      GroundClampingMode myMode;

      DtIntersectionCache* myIntersectionCache;

      bool myEnabledFlag;

      bool myClampAlwaysFlag;

      bool myClampCulledLastFrame;      

      bool myCheckForCull;

      double myClampTimeThreshold;
      bool myBecameEnabledThisTick;

      DtIntersectorsContainer* myIntersectors = nullptr;

      DtSignalConnectionManager myConnections;

      // local clone of the current system wide coordinate system converter.
      // for thread safety.
      DtCoordinateConverter* myCoordinateConverter = nullptr;
   }; 
}