DtEntityWakeVisualizer.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/DtEntityStateVisualizer.h>

namespace makVrv
{
   class DtWakeModelAgent;
   class DtWakeUpdaterAgent;
   class DtEntityStateListener;

   namespace EntityStateListener
   {
      enum class DamageState;
   }

   class DT_DLL_VRVCORE DtEntityWakeVisualizer : public DtEntityStateVisualizer
   {
   public:
      DtEntityWakeVisualizer( DtBaseConnection& simulation, DtStateListener& listener,
         DtSceneObjectAgent* sceneObject, DtModelSetId modelSet );

      virtual ~DtEntityWakeVisualizer();

      DtEntityWakeVisualizer() = delete;

      DtEntityWakeVisualizer( const DtEntityWakeVisualizer& ) = delete;

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

   public:

      virtual void initialize() override;

      virtual void setWakeEnabled(bool enabled);

      virtual void setSprayEnabled(bool enabled);

      virtual void setSternWaveEnabled(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 setDamageState(EntityStateListener::DamageState damageState);

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

      virtual void setIsFrozen(bool frozen);

      static const DtStateVisualizer::TypeInfo& theTypeInfo();

      virtual void setMaxRenderAngle( double angle );

      virtual void setSpeedRenderCuttof( double cutoff );

   protected:

      virtual void slot_oceanWakesEnabledChanged(bool enabled);

      virtual void slot_hullSprayEffectsChanged(bool enabled);
  
      virtual bool active() const;

      virtual void createModelAgents();

      virtual void destroyModelAgents();

      virtual void setModelDefinitionForAgents();

      virtual void connectToListenerSignals() override;

      virtual void setInitialValuesFromVisualizerDefinition() override;

      virtual void slot_embarkedStateChanged();

      virtual bool visible() const;

      virtual void updateWakeEffects();

      virtual bool areWakeEffectsEnabled() const;

      virtual void updateSprayEffects();

      virtual bool areSprayEffectsEnabled() const;

      virtual void slot_wakeDefaultLODDistanceChanged(double distance);

   protected:
      DtWakeModelAgent* myWakeModel;
      DtWakeUpdaterAgent* myWakeUpdater;   
      bool myDestroyed;      
      bool myEmbarked;
      bool myEffectEnabled;

      bool mySprayEnabled;
      bool mySternWaveEnabled;
      double myWakeOffset;
      bool myWakeOffsetSet;
      double myBowSprayOffset;
      bool myBowSprayOffsetSet;
      double myBowWaveOffset;
      bool myBowWaveOffsetSet;
      double mySternWaveOffset;
      bool mySternWaveOffsetSet;
      double myShipLength;
      double myBeamWidth;
      bool myPropWashEnabled;
      double myPropWashOffset;
      bool myPropWashOffsetSet;
      double myPropWashFadeTime;
      bool myPropWashFadeTimeSet;
      double myDraft;
      double myLODDistance;
      double mySprayVelocityScale;
      double myBowWaveScale;
      double myMaxBowWaveAmplitude;
      bool myMaxBowWaveAmplitudeSet;
      double myBowSize;
      double mySpraySizeScale;
      int myNumHullSprays;
      double myHullSprayStart;
      bool myHullSprayStartSet;
      double myHullSprayEnd;
      bool myHullSprayEndSet;
      double myHullSprayVerticalOffset;
      bool myHullSprayVerticalOffsetSet;
      double myHullSprayVelocityScale;
      double myHullSpraySizeScale;
      double myMaxRenderAngle;
      double mySpeedRenderCuttoff;
      bool myOceanWakesEnabledGlobalFlag;
      bool mySprayEffectsEnabledGlobalFlag;

      bool myIsAmphibious;

      // 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;

   };


   typedef DtStateVisualizerCreatorTemplate<DtEntityWakeVisualizer>
      DtEntityWakeVisualizerCreator;
}