DtEntityKinematicState.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/DtKinematicState.h>
#include <vrvCore/DtGroundClampingUpdater.h>
#include <makArchives/DtEntitySettingsRecord.h>

using namespace makArchives;

namespace makVrv
{
   class DtDeadReckonUpdaterAgent;
   class DtGroundClampingUpdaterAgent;
   class DtSurfaceClampingUpdaterAgent;
   class DtWaterClampingUpdaterAgent;
   class DtEmbarkationUpdaterAgent;
   class DtEntityStateListener;
   class DtElement;

   namespace EntityStateListener
   {
      enum class DamageState;
   }

   class DT_DLL_VRVCORE DtEntityKinematicState : public DtKinematicState
   {
   public:
      DtEntityKinematicState( DtStateListener& listener, DtAgentManagerInterface& sceneInterface, 
         DtSharedSettingsManager& settingsManager );

      virtual ~DtEntityKinematicState();

      DtEntityKinematicState() = delete;

      DtEntityKinematicState( const DtEntityKinematicState& ) = delete;

      DtEntityKinematicState& operator=( const DtEntityKinematicState& ) = delete;
   public:
      virtual void initialize() override;

      virtual void createUpdaters() override;
      virtual void destroyUpdaters() override;

      virtual void processKinematicStateDefinition( const DtVisualizerDefinition* visDef ) override;

      virtual void resetSpatialAttributes();

      virtual void setLocation( const DtVector&, double time );

      virtual void setOrientation( const DtTaitBryan&, double time );

      virtual void setVelocity( const DtVector32&, double time );

      virtual void setAngularVelocity( const DtVector32&, double time );

      virtual void setAcceleration( const DtVector32&, double time );

      virtual void setLocation( const DtVector& );

      virtual void setOrientation( const DtTaitBryan& );

      virtual void setVelocity( const DtVector32& );

      virtual void setAngularVelocity( const DtVector32& );

      virtual void setAcceleration( const DtVector32& );

      virtual void setDeadReckoning( bool position, bool velocity,
         bool orientation );

      virtual void setSmoothingEnabled( bool enabled );

      virtual void setSmoothingPeriod( float scale );

      virtual void setIsAmphibious( bool amphibious );

      virtual bool isAmphibious() const;

      virtual void setWaterClampingEnabled( bool enabled );

      virtual void setGlobalBuoyancyEnabled( bool enabled );

      virtual void setBuoyancyLod( float lodDistance );

      virtual void setWaterlineOriginOffset( float offset );

      virtual void setGroundClamping( bool enabled );

      virtual void setGroundClampingMode(
         DtGroundClampingUpdater::GroundClampingMode mode );

      virtual void setPossibleGroundClampingModes(
         DtGroundClampingUpdater::GroundClampingMode possibleModes );

      virtual void slot_setGroundClampingCullingEnabled( bool enabled );

      virtual void setGroundClampingScale( float scale );

      virtual void slot_lifeformsUprightChanged( bool enabled );

      virtual DtGroundClampingUpdater::GroundClampingMode groundClampingMode();

      virtual std::string motionModel() const;
      virtual void setMotionModel( const std::string& model );

      virtual void setFrozen( bool isFrozen, bool force = false );

      virtual void setDamageState( EntityStateListener::DamageState damageState );

      static const std::string& theClassName();
   protected:
      virtual void connectToListenerSignals() override;
      virtual void connectToSettingsSignals() override;

      virtual void addSceneObjectToUpdaters( DtModelSetId modelSet, DtSceneObjectAgent* sceneObjectAgent ) override;

      virtual void removeSceneObjectFromUpdaters( DtModelSetId modelSet, DtSceneObjectAgent* sceneObjectAgent ) override;

      // Always built via creator in constructor
      virtual void initializeDeadReckonUpdater();  
      virtual void buildSurfaceClampingUpdater(); 
      virtual void buildWaterClampingUpdater(); 
      virtual void buildGroundClampingUpdater();

      virtual void initializeUpdaterChain();
      virtual void connectUpdaters();
      virtual void removeSceneObjectsFromAllUpdaters();
      virtual void addAllSceneObjectsToCorrectChain();

      virtual void startEmbarked() override;
      virtual void endEmbarked() override;

      virtual void slot_resetSmoother();

      virtual void slot_buoyancyDefaultLODDistanceChanged( float distance );
      virtual void slot_buoyancyMinimumCullDistanceChanged( float distance );
      virtual void slot_buoyancyCullTypeChanged(
         makArchives::DtEntitySettingsRecord::BuoyancyCullType cullType );
      virtual void slot_orientationClampingChanged( bool enabled );
   protected:
      DtEntityStateListener& myEntityStateListener;

      DtDeadReckonUpdaterAgent*      myDeadReckonUpdaterAgent;
      DtGroundClampingUpdaterAgent*  myGroundClampingUpdaterAgent;
      DtEmbarkationUpdaterAgent*     myEmbarkationUpdaterAgent;
      DtSurfaceClampingUpdaterAgent* mySurfaceClampingUpdaterAgent;
      DtWaterClampingUpdaterAgent*   myWaterClampingUpdaterAgent;

      bool myDrAlgorithmSet;

      bool myIsDestroyed;

      bool myDRPos;
      bool myDRVel;
      bool myDROri;
      bool myIsAmphibious;
      bool myUseDefaultBuoyancyLOD;

      bool myDeadReckonIsThreadSafe;

      bool myGlobalGroundClampingEnabled;
      bool myGroundClampingCullingEnabled;
      bool myGlobalBuoyancyEnabled;
      bool myWaterClampingPossible;
      bool mySmoothingEnabled;
      bool myFrozen;
      float myGroundClampingScale;
      float myBuoyancyLod;
      float myWaterlineOriginOffset;
      float myBuoyancyMinimumCullDistance;
      float mySmoothingPeriod;
      DtEntitySettingsRecord::BuoyancyCullType myBuoyancyCullType;

      DtGroundClampingUpdater::GroundClampingMode myGroundClampingMode;
      DtGroundClampingUpdater::GroundClampingMode myPossibleGroundClampingModes;

      std::string myMotionModel;
   };

   using DtEntityKinematicStateCreator = DtKinematicStateCreatorTemplate< DtEntityKinematicState >;
}