include/vrvCore/DtDriver.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtDriver.h,v $ $Revision: 1.43 $ $State: Exp $
******************************************************************************/


#pragma once
#include <vrvCore/vrvCore.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtConfiguration.h>
#include <vrvCore/DtElementChanges.h>
#include <vrvCore/DtElementEntry.h>

#include <string>
#include <list>

namespace makVrv
{
   class DtAgentManager;
   class DtAgentManagerInterface;
   class DtDeRecord;
   

   class DT_DLL_VRVCORE DtDriver
   {

   public:

      friend class DtDriverManager;
      
      DtDriver(DtAgentManager& agentManager, const std::string& instanceName);

      virtual ~DtDriver();

      virtual void realizeConfiguration(const DtConfiguration& configuration);

      virtual DtConfiguration createConfiguration() const;

      DtAgentManager& agentManager();

      virtual DtAgentManagerInterface& sceneInterface();

      inline bool started() const
      {
         return myStartedFlag;
      }

      virtual const std::string& className() const = 0;

      virtual const std::string& instanceName() const;

      virtual bool autoStart() const;

      virtual void setAutoStart(bool autoStart);

      virtual bool isWindowDependent() const;

      virtual void setIsWindowDependent(bool dep);

      virtual void setIsUserControllable(bool);

      virtual bool isUserControllable() const;

      virtual void setIsPersistent(bool per);

      virtual bool isPersistent() const;

      virtual bool isOnDriverSelectionList() const;

      virtual void setOnDriverSelectionList(bool);

      bool objectFromAgentManager(const DtUniqueID& id) const;

   protected:

      void applyChangesAndDelete(DtElementChanges* changes);

      void reportElementCreated(DtElementID id, DtElementID parentId,
         DtElementEntry::ElementType type);
      
      void reportElementAttribute(DtElementID id, DtElementAttribute* attribute);

      void reportElementDestroyed(DtElementID id);

      void start();

      void stop();

      bool tick();

      virtual bool onStart() = 0;

      virtual bool onStop() = 0;

      virtual bool onTick() = 0;

      virtual void slot_displayEngineAdded(const DtDeRecord& igRecord);

      virtual void setInstanceName(const std::string& name);

      virtual void installAccessories();

      virtual void uninstallAccessories();
      
   protected:

      DtAgentManager& myAgentManager;
      bool myStartedFlag;
      std::string myName;
      DtConfiguration myConfiguration;

      bool myPersistentFlag;
      bool myUserControllableFlag;
      bool myRequestStateDiffPendingFlag;  
      DtElementChanges myChanges;

   };


   class DT_DLL_VRVCORE DtDriverCreator
   {
   public:

      DtDriverCreator();

      virtual ~DtDriverCreator();

      virtual const std::string& extension() const = 0;

      virtual DtDriver* create(DtAgentManager& agentManager, 
         const std::string& instanceName) const = 0;
   };

}