DtTritonWaterClampingUpdater.h

Go to the documentation of this file.

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


#pragma once
#include <vrvTriton/vrvTriton.h>

#include <vrvCore/DtWaterClampingUpdater.h>
#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>
#include <vrvUtil/DtSignalConnectionManager.h>

namespace makVrv
{
   class DtRk4MotionModel;
   class DtTritonManager;
   class DtObserverObject;
   class DtCoordinateConverter;

   class DT_DLL_VRVTRITON DtTritonWaterClampingUpdater : 
      public DtWaterClampingUpdater
   { 

   public:

      DtTritonWaterClampingUpdater(DtDe& de, DtUniqueID id );

      virtual ~DtTritonWaterClampingUpdater();

      virtual bool clampToWater(DtTime tNow);

      virtual void setPaused(bool isPaused);

      virtual void setLOD(float lodDistance);

      virtual void setWaterlineOriginOffset(float offset);

      // changes or to 'restore' a sinking ship.
      virtual void resetMotionModel( double seaLevel );

   protected:
      virtual double altitudeAt(const DtVector& pos);

      virtual void addAltitude(DtVector& pos, float altitudeToAdd );

      virtual DtVector moveToAltitude(const DtVector& pos, double alt);

      virtual DtTaitBryan computeMotionOrientation();

      virtual bool isFullyImmersed();

      virtual void adjustSinkingSpeedScale( const DtVector& inputPosition, 
         const DtVector& currentPosition );

      virtual void smoothMotionAndSeaLevel(double percent, 
         DtVector& outputPos, DtTaitBryan &outputOri);

      //handle sea level change signals
      virtual void slot_oceanLayerSeaLevelChanged(double sealevel);
      
      //helper method to set the water line alitude based on the offset and sealevel
      virtual void updateWaterLineAltitude(double sealevel);

      //Initialize the extents of the motion model based on the scene object
      virtual bool initializeExtents(double sealevel);

      // Using the cull type, determines if the entity should suppress its buoyancy
      // calculation because it is out of view of any observer
      virtual bool checkCull( DtObserverObject* const observer, const DtVector& eyeToShip ) const;

      virtual void slot_coordinateSystemChanged();

   protected:

      static const double theMotionTimeout;
      static const double theSmoothTime;
      static const double theFullyLodScaler;

      DtRk4MotionModel* myMotionModel;
      DtTime myLastTickTime;
      bool myExtentsSet;
      bool myIsPaused;
      double myLastSinkingDiff;
      bool mySmallObject;
      DtTritonManager& myTritonManager;
      DtVector myLastMotionPos;
      DtTaitBryan myLastMotionOri;
      DtVector myLastOutputPos;
      DtVector myLastAltitudeAdjustedPos;
      float myWaterlineAltitude;
      DtVector myLastInputPosition;
      DtVector mySeaLevelPosition;
      bool mySeaLevelPositionDirty;
      DtTime myLastLODTickTime;
      float mySeaLevelClampDistance;
      bool myLodedOut;
      DtSignalConnectionManager myConnections;
      bool myCoordinateSystemChanged;

      DtCoordinateConverter* myCoordinateConverter = nullptr;

   }; 
}