include/vrvCore/DtOverlayGroupManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <boost/unordered_map.hpp>

#include <list>

namespace makVrv
{

   class DtBaseConnection;

   class DT_DLL_VRVCORE DtOverlayGroupManager : public DtVirtualBaseClass
   {
   public:

      enum OverlayGroupId
      {
         HiddenGroup = 0,
         DefaultGroup = 1,
         UnusedLowGroup = 2,
         GroupsGroup = 500000,
         UnusedHighGroup = 1000000,
      };

      typedef std::list<std::string> GroupRangeList;

   public:

      static DtOverlayGroupManager& instance( DtDe& de );

      static DtOverlayGroupManager& instance( DtBaseConnection& sim );

      static void copyInstance( DtBaseConnection& sim, DtDe& de );

      virtual ~DtOverlayGroupManager();

      inline void initializeDefaultGroupSets()
      {
         addOverlayGroupSet( "hoverGroupSet" );
         addOverlayGroupSet( "selectedGroupSet" );
         addOverlayGroupSet( "iconsGroupSet" );
         addOverlayGroupSet( "rangeInfoGroupSet" );
         addOverlayGroupSet( "entityInfoPinnedGroupSet" );
         addOverlayGroupSet( "symbolDecorationGroupSet" );
      }

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

      virtual void addOverlayGroupSetUnder( const std::string& name,
         const std::string& beforeName );

      virtual void addOverlayGroupSetAbove( const std::string& name,
         const std::string& afterName );

      virtual const GroupRangeList& overlayGroupSets() const;

      virtual GroupRangeList& overlayGroupSets();

      virtual unsigned int nextGroupId( const std::string& groupSetName );

   protected:

      template <typename ManagerClass>
      friend ManagerClass& defaultManagerInstanceFunction(DtDe&,bool);

      template <typename ManagerClass>
      friend void defaultManagerRegisterInstanceFunction(DtDe&,ManagerClass*);

      DtOverlayGroupManager();

      DtOverlayGroupManager( DtDe& de );

      DtOverlayGroupManager( const DtOverlayGroupManager& copy );

      virtual void initializeGroupIdGenerators();

   protected:

      class DtOverlayGroupIdGenerator
      {
      public:

         DtOverlayGroupIdGenerator( const std::string& name,
            unsigned int minId, unsigned int maxId );

         unsigned int nextGroupId();

      protected:

         std::string myGroupName;

         unsigned int myNextId;

         unsigned int myMinId;
         unsigned int myMaxId;

      };

   protected:

      typedef boost::unordered_map<std::string,DtOverlayGroupIdGenerator*>
         GroupIdGeneratorList;

      GroupIdGeneratorList myGroupIdGenerators;

      GroupRangeList myOverlayGroupRanges;

      DtDe* myOptionalDe;

      unsigned int myNextGroupId;

      bool myModificationsLockedFlag;

   };

}