DtEntityKinStateVisualizer.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/DtSceneObjectVisualizer.h>
#include <vrvCore/DtGroundClampingUpdater.h>
#include <vrvCore/DtEntityStateListener.h>
#include <vrvCore/DtUniqueID.h>

#include <makArchives/DtEntitySettingsRecord.h>

#include <matrix/vlVector.h>
class DtTaitBryan;

using namespace makArchives;

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

   class DT_DLL_VRVCORE DtEntityKinStateVisualizer :
      public DtSceneObjectVisualizer
   {
   public:
      DtEntityKinStateVisualizer(DtBaseConnection& simulation, 
         DtStateListener& listener, int modelSet);

      virtual ~DtEntityKinStateVisualizer();

      DtEntityKinStateVisualizer() = delete;

      DtEntityKinStateVisualizer(const DtEntityKinStateVisualizer&) = delete;

      DtEntityKinStateVisualizer& operator=(const DtEntityKinStateVisualizer&) = delete;

   public:
      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 DtDeadReckonUpdaterAgent* findDeadReckoner();

      virtual void setEmbarked(const DtUniqueID& id);

      virtual void setVisualizerDefinition(const DtVisualizerDefinition& visDef);

      virtual void setSmoothingEnabled(bool enabled);

      virtual void setSmoothingPeriod(float scale);

      virtual void setFrozen(bool isFrozen);


      virtual void implementVisibility(bool visible);

      virtual void readEntityDisplaySettings();

      virtual void getEntityStateSettings();

      virtual void setGroundClampingCullingEnabled(bool enabled);

      virtual void setGroundClampingScale(float scale);

      virtual void setGroundClamping(bool enabled);

      virtual void setGroundClampingMode(
         DtGroundClampingUpdater::GroundClampingMode mode);

      virtual void setPossibleGroundClampingModes(
         DtGroundClampingUpdater::GroundClampingMode possibleModes);

      virtual DtGroundClampingUpdater::GroundClampingMode groundClampingMode();

      virtual void orientationClampingChanged(bool enabled);

      virtual void lifeformsUprightChanged(bool enabled);

      virtual void setBuoyancyEnabled( bool enabled );

      virtual void setBuoyancyLod( float lodDistance );

      virtual void setWaterlineOriginOffset( float offset );

      virtual void setWaterClampingPossible( bool enabled );

      virtual void setIsAmphibious( bool amphibious );

      virtual bool isAmphibious() const;

      virtual void setDamageState(DtEntityStateListener::DamageState damageState);

      virtual bool destroyed() const;

      virtual void resetSpatialAttributes();

      DtEntityStateListener& entityStateListener();

      virtual const DtStateVisualizer::TypeInfo& typeInfo() const;

      static const DtStateVisualizer::TypeInfo& theTypeInfo();

      virtual void setElementID(const DtElementID& id);

      virtual std::string displayUnitCollectionName() const;

   protected:

      virtual void createModelAgents();
      virtual void destroyModelAgents();
      virtual void setModelDefinitionForAgents();

      virtual void startDeadReckoning();
      virtual void startEmbarked();
      virtual void startGroundClamping();
      virtual void startWaterClamping();
      
      virtual void endEmbarked();
      virtual void endGroundClamping();
      virtual void endWaterClamping();

      virtual void buildSurfaceClampingUpdater();
      virtual void buildGroundClampingUpdater();

      virtual void connectClampingUpdaters();
      virtual void slot_buoyancyDefaultLODDistanceChanged( float distance );
      virtual void slot_buoyancyMinimumCullDistanceChanged( float distance );
      virtual void slot_buoyancyCullTypeChanged( 
         DtEntitySettingsRecord::BuoyancyCullType cullType );
      virtual void slot_parentSet(DtElement* parent);
      virtual void slot_resetSmoother();

   protected:

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

      bool myEmbarkedFlag;
      DtUniqueID myEmbarkedParentID;

      bool myGroundClampingEnabled;
      float myGroundClampingScale;
      bool myGroundClampingCullingEnabled;
      bool myBuoyancyEnabled;
      float myBuoyancyLod;
      float myWaterlineOriginOffset;
      float myBuoyancyMinimumCullDistance;
      DtEntitySettingsRecord::BuoyancyCullType myBuoyancyCullType;
      bool myWaterClampingPossible;
      bool myIsDestroyed;
      bool myDrAlgorithmSet;

      bool mySmoothingEnabled;
      float mySmoothingPeriod;

      std::string myMotionModel;

      std::string myDisplayUnitCollectionName;

      DtGroundClampingUpdater::GroundClampingMode myGroundClampingMode;
      DtGroundClampingUpdater::GroundClampingMode myPossibleGroundClampingModes;
      bool myDRPos;
      bool myDRVel;
      bool myDROri;
      bool myIsAmphibious;
      bool myUseDefaultBuoyancyLOD;

      DtEntityStateListener&  myEntityListener;
   };


   typedef DtStateVisualizerCreatorTemplate<DtEntityKinStateVisualizer>
      DtEntityKinStateVisualizerCreator;
}