DtCigiWaterCraftEntity.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2017 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/


#pragma once

#include <vrvCigi/vrvCigi.h>

#include <vrvCigi/DtCigiEntity.h>

#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/signalslib.h>

#include <boost/signals/connection.hpp>


#include <makArchives/DtEntitySettingsRecord.h>

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

namespace makVrv
{
   class DtSurfaceClampingUpdaterAgent;
   class DtWaterClampingUpdaterAgent;
   class DtCigiWakeEntity;

   class DT_DLL_VRVCIGI DtCigiWatercraftEntity : public DtCigiEntity
   {
   public:
      DtCigiWatercraftEntity(DtCigiConnection& connection,
         DtAgentManagerInterface& sceneInterface, int entityId, int entityType);

      virtual ~DtCigiWatercraftEntity();

      virtual void init();

      virtual void uninit();

      virtual void restart();

      virtual void setPosition(const DtGeodeticCoord& pos, bool force=false);

      virtual void setOrientation(const DtTaitBryan& orientation, bool force=false);

      // Override to determine moving state when attached to a wake
      virtual void setLinearRate(const DtVector& rate, bool useWorldCoordinates, bool force=false);

      virtual void setWakeEntity( DtCigiWakeEntity* wakeEntity );

      virtual void startEmbarked();

      virtual void endEmbarked();

      virtual void startSinking();

      virtual void stopSinking();

      virtual bool isSinking() const;

      virtual void setWaterlineOriginOffset( float offset );

      virtual void setIsAmphibious( bool isAmphibious );
      virtual bool isAmphibious() const;

      virtual void setBuoyancyEnabled( bool enable );

      virtual void setBuoyancyLODDistance( double distance );

   protected:

      virtual void startDeadReckoning();

      virtual void endDeadReckoning();

      virtual void startBuoyancy();

      virtual void endBuoyancy();

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

      virtual void slot_buoyancyMinimumCullDistanceChanged( float distance );

      virtual void slot_buoyancyCullTypeChanged( 
         makArchives::DtEntitySettingsRecord::BuoyancyCullType type );
   
   protected:
      DtSurfaceClampingUpdaterAgent* mySurfaceClampingUpdaterAgent;
      DtWaterClampingUpdaterAgent* myWaterClampingUpdaterAgent;
      DtCigiWakeEntity* myWakeEntity;

      DtSignalConnectionManager myConnections;

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

      float myBuoyancyLodRange;
      float myBuoyancyMinimumCullDistance;
      float myWaterlineOriginOffset;

      bool myGlobalBuoyancyEnabled;

      bool myIsSinking;
      bool myIsMoving;
      bool myIsAmphibious;
      bool myIsBuoyant;
      bool myBuoyancyCullType;

      // True if setWaterlineOriginOffset has been called (only restore on restart if this is true)
      bool myWaterlineOriginOverridden;

      // True if set BuoyancyLODDistance has been called
      bool myBuoyancyLODDistanceOverridden;
   };

   typedef DtCigiObjectCreatorTemplate<DtCigiWatercraftEntity>
      DtCigiWatercraftEntityCreator;
}