DtEntity3dFacade.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtGroundClampingUpdater.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <matrix/vlVector.h>
#include <string>

class DtTaitBryan;

namespace makVrv
{
   class DtAgentManagerInterface;
   class DtArticulatedModelAgent;
   class DtDeadReckonUpdaterAgent;
   class DtGroundClampingUpdaterAgent;
   class DtWaterClampingUpdaterAgent;
   class DtWakeModelAgent;
   class DtWakeUpdaterAgent;
   class DtTidalStreamWakeModelAgent;
   class DtTidalStreamWakeUpdaterAgent;
   class DtSurfaceClampingUpdaterAgent;
   class DtSceneObjectAgent;
   class DtSharedSettingsManager;
   enum class DtModelSetId;

   class DT_DLL_VRVCORE DtEntity3dFacade
   {
   public:

      DtEntity3dFacade( DtAgentManagerInterface& sceneInterface, 
         DtSharedSettingsManager& settingsMgr, DtElementID id, 
         bool distribute = false );


      DtEntity3dFacade( DtAgentManagerInterface& sceneInterface, 
         DtSharedSettingsManager& settingsMgr, DtElementID id, DtModelSetId modelset,
         bool distribute = false );

      virtual ~DtEntity3dFacade();



      virtual void setUpdateTypes(bool deadReckon=true, bool groundClamp=true);

      virtual void setVisible(bool visible);

      virtual bool visible() const;

      virtual DtElementID elementId() const;

      virtual DtModelSetId modelSet() const;

      DtSceneObjectAgent& sceneObjectAgent();




      virtual void setPosition(const DtVector& position);

      virtual DtVector position() const;

      virtual void setVelocity(const DtVector32& velocity);

      virtual DtVector32 velocity() const;

      virtual void setAcceleration(const DtVector32& acceleration);

      virtual DtVector32 acceleration() const;

      virtual void setOrientation(const DtTaitBryan& orientation);

      virtual DtTaitBryan orientation() const;

      virtual void setAngularVelocity(const DtVector32& angularVelocity);

      virtual DtVector32 angularVelocity() const;




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

      virtual void setSmoothingEnabled(bool enabled);

      virtual void setSmoothingPeriod(float period);

      virtual void setGroundClampingMode(
         DtGroundClampingUpdater::GroundClampingMode mode);

      virtual void SetGroundClampingCullCylinderRadiusScale(float scale);

      virtual void setWaterClamping(bool isWaterClamping);

      virtual void setWaterClampingLod(double lodRange);

      virtual void setWaterlineOriginOffset( float offset );

      virtual void addWake();

      virtual void setWakeLODDistance( double distance );

      virtual DtWakeModelAgent* wake();

      virtual void addTidalStreamWake();

      virtual void addTidalStreamWake( double wakeLength, 
         double draft, double maxWaveAmplitude);

      virtual void addTidalStreamWake( const std::string& modelDefinitionName );

      virtual void removeTidalStreamWake();

      virtual void setTidalStreamWakeLod( double distance );

      virtual void setTidalStreamWakeCurrent( double speed, 
         double direction );



      virtual void setArticulatedModelDefinition(const std::string& modelName);

      virtual const std::string& articulatedModelDefinition() const;

      virtual void setModelScalingEnabled(bool enabled);

      virtual void setPartOrientation(int partNumber,
         const DtTaitBryan& orientation,const DtVector& angularVelocity);

      virtual void setPartTranslation(int partNumber,
         const DtVector& translation,const DtVector& velocity);

      virtual void setPartVisibility(int partNumber, bool onOff);

      virtual void setSwitchState( int switchToSet, int value );

      virtual void setLightpointMaxDistance( float distance );


      virtual DtArticulatedModelAgent* articulatedModelAgent();
      
   protected:

      void init();

      virtual void slot_globalBuoyancyChanged( bool enabled );
      
      // Called when the entity display settings default LOD changes and we are
      // using the default.  Unlike setBuyoyancyLODRange, this does NOT disconnect
      // us from that signal
      virtual void slot_buoyancyDefaultLODDistanceChanged( double distance );

      virtual void createWaterClampingUpdater();
      virtual void destroyWaterClampingUpdater();

   protected:
      DtSharedSettingsManager& mySharedSettingsManager;
      DtElementID myElementId;
      DtAgentManagerInterface& mySceneInterface;
      bool myDistributeFlag; // whether or not to distribute models to remote displays
      float myWaterlineOffset;
      bool myIsWaterClamping;
      double myWaterClampingLod;
      std::string myModelDefinitionName;

      DtModelSetId myModelSet;
      DtSceneObjectAgent* mySceneObjectAgent;
      DtArticulatedModelAgent* myModelAgent;      
      DtDeadReckonUpdaterAgent* myDeadReckonUpdaterAgent;
      DtGroundClampingUpdaterAgent* myGroundClampingUpdaterAgent;
      DtWaterClampingUpdaterAgent* myWaterClampingUpdaterAgent;
      DtSurfaceClampingUpdaterAgent* mySurfaceClampingUpdaterAgent;
      DtTidalStreamWakeModelAgent * myTidalStreamWakeModelAgent;
      DtTidalStreamWakeUpdaterAgent* myTidalStreamWakeUpdaterAgent;

      DtWakeModelAgent* myWakeModelAgent;
      DtWakeUpdaterAgent* myWakeUpdaterAgent;
      DtSignalConnectionManager myConnections;

      // The connection to the entity display settings default LOD distance is handled 
      // separately, so it can be disconnected if setWaterClampingLod() is called from the API
      boost::signalslib::connection myBuoyancyLODDistanceChangedConnection;
   }; 
}