DtTickable.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <vlutil/vlTime.h>


namespace makVrv
{
   class DtTickableManagerInterface;

   class DT_DLL_VRVCORE DtTickable
   {
   public:
      enum TickableListState
      {
         TickableNotOnList,
         TickableOnMainList,
         TickableOnThreadSafeList,
      };

   public:

      virtual bool needsUpdate( DtTime tNow );

     virtual bool updateIfNeeded(DtTime tNow);

      virtual void update( DtTime tNow ) = 0;

      virtual ~DtTickable();

      virtual void setTickableEnabled( bool enabled );

      virtual void setIsThreadSafe(bool safe);
      virtual bool isThreadSafe() const;

      virtual void setTickableListState(TickableListState safeList);
      virtual TickableListState tickableListState() const;

      virtual void setUpdatePeriod( unsigned int period );
      virtual unsigned int updatePeriod() const;
     
      virtual bool adaptiveTickLodEnabled() const;

   protected:
      DtTickable( DtTickableManagerInterface* manager );

      DtTickable() = delete;

      virtual void slot_managerAboutToBeDeleted();
      
   protected:
      DtTickableManagerInterface* myManager;

   protected:
      DtSignalConnectionManager myConnections;
      unsigned int myFrameCounter;
      unsigned int myFrameToUpdate;
      unsigned int myUpdatePeriod;
      unsigned int myTickableIndex;
      // NOTE: Several derived updater classes also have a myLastUpdateTime 
      // member variable with its own initializer
      // Double check whether you are modifying the child or the parent!
      // Ideally all the children myLastUpdateTime should go away
      DtTime myLastUpdateTime;
      bool myIsThreadSafe;
      TickableListState myTickableListState;
   };
}