DtNavigationLightController.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtNavigationFeature.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <vlutil/vlTime.h>

namespace makVrv
{
   class DtArticulatedModelAgent;

   class DT_DLL_VRVCORE DtNavigationLightController : public DtNavigationFeature
   {
   public:

      friend class DtNavigationLightControllerCreator;

      enum NavigationLightExhibitCondition
      {
         NavigationLightExhibitConditionAlways = 1,
         NavigationLightExhibitConditionDay = 2,
         NavigationLightExhibitConditionFog = 3,
         NavigationLightExhibitConditionNight = 4
      };

      typedef std::vector<float> SignalSequence;

      typedef std::vector<int> ColorSequence;

      virtual ~DtNavigationLightController();

      virtual void attach( DtBuoyOrBeaconFacade& buoyOrBeacon );
 
      virtual void update( DtTime simTime, bool daylight, bool foggy );



      virtual void setColors( const ColorSequence& sequence );
      virtual const ColorSequence& colors() const;

      //@(
      virtual void setSignalSequence( const SignalSequence& sequence );
      virtual const SignalSequence& signalSequence() const;

      //@(
      virtual void setExhibitCondition( NavigationLightExhibitCondition condition );
      virtual NavigationLightExhibitCondition exhibitCondition() const;



      virtual void setOnOffState( bool state );
      virtual bool onOffState() const;




      virtual void setTimer( DtTime nextStateTime );
      virtual DtTime timer() const;




      virtual void setSequenceCursor( int cursor );
      virtual int sequenceCursor() const;




      virtual void setLightColorSwitchNumber( int switchNum );
      virtual int lightColorSwitchNumber() const;




      virtual void setLightSwitchNumber( int switchNum );
      virtual int lightSwitchNumber() const;





      virtual void setEnabled( bool enabled );
      virtual bool enabled() const;

      // If a light height is specfied (!= 0.) then that height (and the object
      // it's attached to's height of attach point) will be used to position
      // the object (and hence the light height)
      virtual void setHeight( float height );
      virtual float height() const;

      std::string myParameterValues;
      void setParameterValues(const std::string& values )
      {
         myParameterValues = values;
      }
      std::string parameterValues() const
      {
         return myParameterValues;
      }

   protected:

      DtNavigationLightController( DtUniqueID elementId );

      DtNavigationLightController();

      DtNavigationLightController( const DtNavigationLightController& orig );

      const DtNavigationLightController& operator=( 
         const DtNavigationLightController& rhs );

      void checkEnabledState( bool daylight, bool foggy );

   protected:
      ColorSequence myColors;
      int myColorCursor;
      bool myOnOffState;
      DtTime myTimer;
      SignalSequence mySignalSequence;
      int mySequenceCursor;
      int myLightColorSwitchNumber;
      int myLightSwitchNumber;
      NavigationLightExhibitCondition myExhibitCondition;
      float myHeight;
      bool myEnabled;
   };

   class DT_DLL_VRVCORE DtNavigationLightControllerCreator 
      : public DtVirtualBaseClass
   {

   public:
      static DtNavigationLightControllerCreator& instance( DtDe& de );

      static void registerInstance( DtDe& de, 
         DtNavigationLightControllerCreator* anInstance );     

      virtual DtNavigationLightController* create( DtUniqueID elementId );
   };
}