vrfModelSetManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vlpi/entityType.h>
#include <vrfGuiCore/sharedModelSet.h>
#include <vrfGuiCore/entityMapperKey.h>
#include <readerWriter/propertyUtils.h>
#include <vrfutil/rwVisualMetaData.h>
#include <vrfutil/rwColor.h>
#include <vrfutil/simulationObjectCategoryInformation.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtReadSettingsLock.h>
#include <matrix/3dBoundingVolume.h>
#include <vrftasks/vrfObjectMessageTypeTemplate.h>

#include <QtCore/QString>

#include <string>
#include <map>
#include <boost/function.hpp>
#include <boost/signals2.hpp>

class DtModelSet;
class DtModelSetEntry;
class DtString;
class DtRwNLengthStringVector;
class DtSimulationObjectGroupModelSetEntry;
class DtScenarioExplorer;
class DtVrfObjectParameters;
class DtComponentSystemDescriptor;
class DtComponentSystemDescriptorList;
class DtMtlParameterDb;

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DtEntityMapperKey;

   class DT_DLL_VRFGUICORE DtVrfModelSetManager : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfModelSetManager(makVrv::DtDe&);
      virtual ~DtVrfModelSetManager() override;

      static DtVrfModelSetManager& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtVrfModelSetManager* messager);

   public:
      virtual void setVariableBindings(const DtRwVariableBindings*);

      virtual void setSearchPaths(const DtReaderWriter::SearchPaths&);

      virtual bool load(const std::string&, bool reset = true, bool signal = true);

      virtual bool taskWillNotAbandonPlan(const DtEntityType& key, const DtSimTaskMessageType& taskType) const;

      virtual QString parameterTranslation(const DtString& name) const;

      virtual bool loadFromDirectory(const std::string& dataDirectory, const std::string& guiDirectory,
         const std::string& platformsDirectory, bool reset = true, bool signal = true, bool preloadParameters = false);

      virtual DtModelSetEntry* modelSetEntry(const DtEntityMapperKey& key) const;

      virtual DtRwColor getDefaultColor(const DtEntityType&) const;

      virtual bool canHoldSubordinates(const DtEntityMapperKey& key) const;

      virtual std::vector<DtFilename> searchPaths() const;

      virtual std::vector<DtEntityType> subordinateObjects(const DtEntityMapperKey&) const;

      virtual bool isRandomized(const DtEntityMapperKey&) const;

      virtual bool hasComponentDescriptor(const DtEntityMapperKey&, const DtString& type);

      virtual void setSimulationModelSets(const std::vector<DtSimulationModelSet*>& sets);
      virtual std::vector<DtSimulationModelSet*> simulationModelSets() const;

      virtual DtModelSetEntry* exactModelSetEntry(const DtEntityMapperKey& key) const;

      virtual void getSupportPoints(const DtEntityType& et,
         DtVector& left, DtVector& right, DtVector& other);

      virtual Dt3dBoundingVolume getBoundingVolume(const DtEntityMapperKey& et);

      virtual DtEntityType nameToType(const DtString&) const;

      virtual DtFilename iconForList(const DtEntityType&, const DtString& list) const;

      virtual bool isFavorite(const DtEntityMapperKey& key, int force) const;

      virtual std::set<DtString> categories() const;

      virtual DtModelSetEntry* findByLabel(const DtString&) const;

      virtual DtModelSetEntry* addModelSetEntry(const DtString& label, const DtEntityMapperKey&,
         const DtRwNLengthStringVector& cats);

      virtual std::vector<DtString> taskGroupsForTask(const DtEntityType& key, const DtSimTaskMessageType&) const;

      virtual void addSimulationObjectGroupModelSetEntry(DtSimulationObjectGroupModelSetEntry* entry);

      virtual DtSimulationObjectGroupModelSetEntry findSimulationObjectGroup(const std::string& sogName) const;

      virtual DtEntityType nextAvailableSimulationObjectGroupObjectType() const;

      virtual void removeModelSetEntry(const DtEntityMapperKey& e);

      virtual std::string nameFor(const DtEntityMapperKey&) const;

      virtual std::string keywordsFor(const DtEntityMapperKey&) const;

      virtual bool canEmbedIntoTerrain(const DtEntityMapperKey&) const;

      virtual bool canEmbark(const DtEntityMapperKey&) const;

      virtual bool canAttachTo(const DtEntityMapperKey&) const;

      virtual bool canEmbarkUpon(const DtEntityMapperKey&) const;

      virtual bool organized(const DtEntityMapperKey&) const;

      virtual int displayObjectImage(const DtEntityMapperKey&) const;

      virtual std::string additionalKeywords(const DtEntityMapperKey&) const;
      virtual void setAdditionalKeywords(const DtEntityMapperKey&, const std::string&, bool replace = false);

      virtual void statePropertiesForPlatform(const DtString&, DtRwProperties&) const;

      virtual void parameterPropertiesForPlatform(const DtString&, DtRwProperties&) const;
      
      virtual void statePropertiesFor(const DtEntityType&, DtRwProperties&) const;
      
      virtual void parameterPropertiesFor(const DtEntityType&, DtRwProperties&);

      template <class T>
      boost::optional<T> parameterPropertyFor(const DtEntityMapperKey& e, 
         const std::string& propertyName) const
      {
         DtRwProperties props("");

         DtSharedModelSet::WriteSettingsLock settings(makVrv::DtSharedSettingsManager::instance(myDe));
         settings->parameterPropertiesFor(DtEntityMapperKey(e), props);

         return findPropertyValue<T>(props, propertyName.c_str());
      }

      virtual DtString defaultDescriptionFor(const DtEntityType&) const;
      virtual DtString defaultDescriptionFor(const DtVrfObjectParameters*) const;

      virtual DtString systemDescriptionFor(const DtVrfObjectParameters*, const DtString& systemCategory) const;

      typedef boost::function<DtString (const DtVrfObjectParameters*)> DefaultDescriptionFunciton;
      virtual void setDefaultDescriptionProvider(const DtString& parameterType, DefaultDescriptionFunciton);

      virtual DtString defaultDescriptionFunction(const DtVrfObjectParameters*) const;

      virtual void setModelSet(DtModelSet*);

      virtual void setFavorite(const DtEntityMapperKey& key, bool b);

      virtual DtModelSet* loadFavoritesFor(const std::string&);

      virtual void mergeFavoritesInto(DtModelSet* favorite, DtModelSet* modelSet);

      virtual void mergeFavorites(DtModelSet* favorites);

      virtual DtModelSetEntry* favoriteFor(DtModelSetEntry*) const;

      virtual DtModelSet* modelSet();

      virtual DtModelSet modelSet() const;

      virtual DtRwVisualMetaData visualMetaData(const DtEntityType&);

      void setAutoSave(bool b)
      {
         myAutoSave = b;
      }

      bool autoSave() const
      {
         return myAutoSave;
      }

      virtual DtSharedModelSet::EquipmentTypeMap baseEquipment(const DtEntityType&);

      virtual bool load(const DtScenarioExplorer&, bool = true);

      virtual void initializeCountries();

      virtual void setTags(const DtSimulationObjectCategoryInformation&);
      const DtSimulationObjectCategoryInformation& tags() const
      {
         return myTags;
      }

      DtMtlParameterDb* parameterDatabase() const
      {
         return myParameterDatabase;
      }

      boost::signals2::signal<void ()> signal_tagsSet;

   protected:
      virtual void clearModelSets();

      virtual DtString systemDescriptionFor(const DtComponentSystemDescriptorList&, const DtString& systemCategory) const;
      virtual DtString systemDescriptionFor(const DtComponentSystemDescriptor*, const DtString& systemCategory) const;

      virtual void loadParameterDatabase();

   public:
      boost::signals2::signal<void ()> signal_modelSetChanged;

   protected:
      makVrv::DtDe&   myDe;
      bool           myAutoSave;

      typedef std::map<std::string, DtModelSet*> Favorites;
      Favorites myFavorites;

      DtModelSet* myModelSet;

      typedef std::map<std::string, DefaultDescriptionFunciton> DefaultDescriptionFuncitons;
      DefaultDescriptionFuncitons myDefaultDescriptionFunctions;
      makVrv::DtSignalConnectionManager myConnectionManager;
      DtSimulationObjectCategoryInformation myTags;
      DtMtlParameterDb* myParameterDatabase = nullptr;
   };
}