DtCigiWakeEntity.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCigi/vrvCigi.h>

#include <vrvCigi/DtCigiBaseEntity.h>

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

#include <boost/signals2/connection.hpp>


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

namespace makVrv
{
   class DtWakeModelAgent;
   class DtWakeUpdaterAgent;
   class DtSceneObjectAgent;

   class DT_DLL_VRVCIGI DtCigiWakeEntity : public DtCigiBaseEntity
   {
   public:

      friend class DtCigiWatercraftEntity;

      DtCigiWakeEntity(DtCigiConnection& connection,
         DtAgentManagerInterface& sceneInterface, int entityId, int entityType);

      virtual ~DtCigiWakeEntity();

      virtual void uninit();

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

      virtual void setRelativePosition(const DtVector& pos);

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

      virtual void setRelativeOrientation(const DtTaitBryan& orient);

      virtual void setRelativeTo(DtCigiBaseEntity* parent);

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

      virtual void setSprayEnabled(bool enabled);

      virtual void setWakeOffset(double offset);

      virtual void setBowSprayOffset(double offset);

      virtual void setBowWaveOffset(double offset);

      virtual void setSternWaveOffset(double offset);

      virtual void setShipLength(double length);

      virtual void setBeamWidth(double width);

      virtual void setPropWashEnabled(bool b);

      virtual void setPropWashOffset(double offset);

      virtual void setPropWashFadeTime(double fadeTime);

      virtual void setDraft(double draft);

      virtual void setLODDistance(double distance);

      virtual void setSprayVelocityScale(double scale);

      virtual void setBowWaveScale(double scale);

      virtual void setMaxBowWaveAmplitude(double amplitude);

      virtual void setBowSize(double size);

      virtual void setSpraySizeScale(double scale);

      virtual void setNumHullSprays(int numSprays);

      virtual void setHullSpraySizeScale(double scale);

      virtual void setHullSprayStart(double offset);

      virtual void setHullSprayEnd(double offset);

      virtual void setHullSprayVelocityScale(double scale);

      virtual void setHullSprayVerticalOffset(double offset);

      virtual void setVisible( bool isVisible );

      virtual void setIsSinking( bool sinking );

   protected:
      virtual void addToParent( DtSceneObjectAgent* parent);
      virtual void removeFromParent( DtSceneObjectAgent* parent);

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

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

      virtual void slot_wakesEnabledChanged( bool enabled );

   protected:
      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 setLODDistance() is called from the API
      boost::signalslib::connection myWakeLODDistanceChangedConnection;

      bool myIsSinking;
      double myWakeLODRange;
   };

   typedef DtCigiObjectCreatorTemplate<DtCigiWakeEntity>DtCigiWakeEntityCreator;
}