lgrPlaybackInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/


#ifndef lgrPlaybackInterface_H_
#define lgrPlaybackInterface_H_

#include "lgrTimeInterface.h"
#include "virtualConstructor.h"

#include <vlutil/vlString.h>
#include "signalSlot.h"

namespace MAKLogger
{
   class DtLogger;
   class DtLgrPlaybackDriver;
   class DtLgrPlaybackCommandFactory;

   class DT_DLL_LGRCORE DtLgrPlaybackInterface : public virtual DtLgrTimeInterface
   {
   public:

      //Used to shorten code.
      typedef DtLgrPlaybackCommandFactory Factory;

      //Used to shorten code.
      typedef DtLgrPlaybackInterface ThisClass;

      static DtLgrPlaybackInterface* create(DtLogger&);

      static DtLgrPlaybackInterface* createNonThreadsafe(DtLogger& logger,
         const DtLgrPlaybackDriver& driver);

   protected:

      DtLgrPlaybackInterface(DtLogger& logger,const DtLgrPlaybackDriver& driver);

   public:

      virtual ~DtLgrPlaybackInterface();

   private:
      DtLgrPlaybackInterface(const DtLgrPlaybackInterface&);
      DtLgrPlaybackInterface& operator=(const DtLgrPlaybackInterface&);
   public:

      virtual void openFile(const DtString& filename) const;

      virtual void closeFile() const;

      virtual void saveFile() const;

      virtual void saveFileAs(const DtString& filename) const;

      virtual void revertFile() const;

      virtual void play() const;

      virtual void stop() const;

      virtual void pause() const;

      virtual void unpause() const;

      virtual void togglePlayPause() const;

      virtual void restart() const;

      virtual void jumpToTime(DtAbsoluteTime time) const;

      virtual void setPlaybackSpeed(double speedMultiplier, bool skipping) const;

      virtual void setSkippingPlaybackThreshold(double skippingThreshold) const;

      virtual void setStartStopTimes(DtAbsoluteTime startTime,
         DtAbsoluteTime stopTime) const;

      virtual void setLoopAtEnd(bool enable) const;

      virtual void setPlayOnLoad(bool playOnLoad) const;

      virtual void setBackupOnSave(bool backup) const;


      virtual bool isFileLoaded() const;

      virtual bool isFileSaved() const;

      virtual bool isPlaying() const;

      virtual bool isStopped() const;

      virtual bool isPaused() const;

      virtual bool loopAtEnd() const;

      virtual bool playOnLoad() const;

      virtual const DtString& filename() const;

      virtual double playbackSpeed() const;

      virtual bool skippingPlayback() const;

      virtual double skippingPlaybackThreshold() const;

      virtual bool isFileFormatCurrent() const;

      virtual bool isFileIncomplete() const;


      DtValueSignal<DtString> fileOpenedSignal;
      DtValueSignal<bool> playbackChangedSignal;
      DtValueSignal<double> playbackSpeedChangedSignal;
      DtValueSignal<bool> loopAtEndChangedSignal;
      DtValueSignal<bool> playOnLoadChangedSignal;
      DtValueSignal<bool> fileSaveChangedSignal;

      DtValueSignal<DtString> fileInvalidSignal;
      DtValueSignal<DtString> fileDoesNotExistSignal;

   protected:



      void fileOpened(DtResponse);

      void fileClosed(DtResponse);

      void fileChanged(DtResponse);

      void fileSaved(DtResponse);

      void playbackChanged(DtResponse);

      void playbackSpeedChanged(DtResponse);

      void skippingPlaybackChanged(DtResponse);

      void skippingPlaybackThresholdChanged(DtResponse);

      void fileInvalid(DtResponse);

      void fileDoesNotExist(DtResponse);

      void fileIncomplete(DtResponse);

      void loopAtEndChanged(DtResponse);

      void playOnLoadChanged(DtResponse);

      void fileFormatCurrent(DtResponse);

      void pausedChanged(DtResponse);


      void connectResponseHandlers();

      void connectResponse(DtLgrCommandId,
         void (DtLgrPlaybackInterface::*)(DtResponse));

   protected:

      bool myFileLoadedFlag;
      bool myPlayingFlag;
      bool myLoopAtEnd;
      bool myPlayOnLoadFlag;
      bool myFileSavedFlag;
      bool myFileFormatCurrentFlag;
      bool myPausedFlag;
      bool myFileIncompleteFlag;
      double myPlaybackSpeed;
      bool mySkippingPlayback;
      double mySkippingPlaybackThreshold;
      DtString myFilename;
      DtString myLastErrorMessage;
   };

}

#endif