DtOceanStateCommand.h

Go to the documentation of this file.

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




#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvCore/DtVrvCommand.h>

#include <vrvUtil/DtDouglasSeaScale.h>

namespace makVrv
{
   class DT_DLL_VRVCORE DtOceanStateCommand : public DtVrvCommand
   {
   public: 
      DtOceanStateCommand();
      virtual ~DtOceanStateCommand();
      
       // (0 - 2PI)
      virtual bool seaStateDirectionSet() const;
      virtual float seaStateDirection() const;
      virtual void setSeaStateDirection( float dir );

       //  (0 - 2PI)
      virtual bool swellStateDirectionSet() const;
      virtual float swellStateDirection() const;
      virtual void setSwellStateDirection( float dir );

       //  (0. - 1.)
      virtual bool choppinessSet() const;
      virtual float choppiness() const;
      virtual void setChoppiness( float amt );

       //  (m)
      virtual bool underwaterVisibilitySet() const;
      virtual float underwaterVisibility() const;
      virtual void setUnderwaterVisibility( float vis );

       //  (0. - 1.)
      virtual bool surfaceTransparencySet() const;
      virtual float surfaceTransparency() const;
      virtual void setSurfaceTransparency( float trans );

       // (m)
      virtual bool surgeDepthSet() const;
      virtual float surgeDepth() const;
      virtual void setSurgeDepth( float depth );

      //  (manual control)
      virtual bool windDrivenSeaStateSet() const;
      virtual bool windDrivenSeaState() const;
      virtual void setWindDrivenSeaState( bool state );

       //  (0-9)
      virtual bool seaStateSet() const;
      virtual DtDouglasSeaState::Scale seaState() const;
      virtual void setSeaState( int state );

       //  (0-9)
      virtual bool swellStateSet() const;
      virtual DtDouglasSwellState::Scale swellState() const;
      virtual void setSwellState( int state );

      virtual void execute(DtDe& de);

   protected: 
      DtDouglasSeaState::Scale netToDouglasSeaState( int netSeaState );
      DtDouglasSwellState::Scale netToDouglasSwellState( int netSwellState );

   protected:
      float mySeaStateDirection;
      float mySwellStateDirection;
      float myChoppiness;
      float myUnderwaterVisibility;
      float mySurfaceTransparency;
      float mySurgeDepth;
      bool myWindDrivenSeaState;
      DtDouglasSeaState::Scale mySeaState;
      DtDouglasSwellState::Scale mySwellState;

      bool mySeaStateDirectionSet;
      bool mySwellStateDirectionSet;
      bool myChoppinessSet;
      bool myUnderwaterVisibilitySet;
      bool mySurfaceTransparencySet;
      bool mySurgeDepthSet;
      bool myWindDrivenSeaStateSet;
      bool mySeaStateSet;
      bool mySwellStateSet;
   };

   class DT_DLL_VRVCORE DtOceanStateCommandCreator : public DtVrvCommandCreator
   {
   public:
      DtOceanStateCommandCreator(GlobalIdConvertFunc func): DtVrvCommandCreator(func) {}
      virtual ~DtOceanStateCommandCreator() {}

      virtual DtVrvCommand* create(vrvControlToolkit::DtVrvControl_v1* control);
   };
} //makVrv::