include/vrvCore/DtBaseConnection.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvUtil/DtRandomNumberGenerator.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/templateUtil.h>
#include <vrvUtil/DtUnicode.h>

#include <boost/unordered_map.hpp>

#include <string>
#include <map>

namespace makVrv
{
   class DtSharedSettingsManager;
   class DtAgentManagerInterface;
   class DtElementChanges;
   class DtElementAttribute;
   class DtBlinkingObjectManager;
   class DtTemporaryAgentManager;

   class DT_DLL_VRVCORE DtBaseConnection
   {

   public:
      DtBaseConnection(DtSharedSettingsManager&, DtAgentManagerInterface&);

      virtual ~DtBaseConnection();

      virtual void clearInstances();

      DtSharedSettingsManager& settingsManager();

      virtual DtAgentManagerInterface& sceneInterface();

      const DtSharedSettingsManager& settingsManager() const;

      void reportElementCreated(DtElementID id, DtElementID parentId, unsigned int type);

      //The attribute passed in should not be used again.
      void reportElementAttribute(DtElementID id, DtElementAttribute* attribute);

      void reportElementDestroyed(DtElementID id);

      const DtElementChanges& currentElementChanges() const;

      DtElementChanges* takeElementChanges();

      DtTemporaryAgentManager& temporaryEffects();

      DtBlinkingObjectManager& blinkManager();

      DtRandomNumberGenerator& randomNumberGenerator();

      virtual const std::string& tag()
      {
         const static std::string tagStr = "";
         return tagStr;
      }

      const DtUnicode& emptyString() const;

      virtual DtVirtualBaseClass* findInstance(const std::string& instanceName);

      inline bool destroyingInstances() const
      {
         return myDestroyingInstanceFlag;
      }

      virtual void registerInstance(const std::string& instanceName, 
         DtVirtualBaseClass* instance);


   protected:

      //Hold on to the shared simulation manager.
      DtSharedSettingsManager& mySettingsManagerCache;

      //The random number generator for the local simulation.
      DtRandomNumberGenerator myRandomNumberGenerator;

      //Thread specific Variables.  This variables are used by the second thread.
      //They should not be used in any functions in the main thread while the
      //secondary thread is running.
      DtAgentManagerInterface& mySceneInterface;

      //Internal working element changes
      DtElementChanges* myWorkingElementChanges;

      //Manager for temporary global effects.
      DtTemporaryAgentManager* myTemporaryEffects;

      DtBlinkingObjectManager* myBlinkManager;

      DtUnicode myEmptyString;

      typedef boost::unordered_map<std::string,DtVirtualBaseClass*> InstanceMap;

      //Stores a pointer to simulation specific instances.
      InstanceMap myInstances;

      //Flag to store if the connection is destroying the instances in it's 
      //DTOR
      bool myDestroyingInstanceFlag;
   };
}