simulationObjectEditorApplication.h

Go to the documentation of this file.

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


#pragma once

#include "simulationObjectEditorImpl/simulationObjectEditorImplDefines.h"
#include "vrfGuiCore/vrfGuiApplication.h"
#include "vrfGuiCore/entityMapperKey.h"
#include <vrvCoreQt/DtQtMenuAssembler.h>
#include <vrvCore/DtDe.h>

#include "vrfobjparam/componentDescriptorFactory.h"
#include "vrfobjparam/vrfObjectParameterFactory.h"
#include "vrfobjparam/vrfStateRepositoryUserExtensionFactory.h"

#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <matrix/vlVector.h>

#include <QtCore/QString>

class DtSimulationModelSetLoader;
class DtBehaviorUi;
class DtBehaviorCanvas;
class DtUiElement;
class DtSimulationObjectEditorAppEventController;
class DtSimulationObjectEditorWindow;
class DtDisplayWidget;
class DtComponentSystemDefinition;
class DtReaderWriterClassDocDB;

const char SMS_FILE[] = "smsFile";
const char OPD_EDITOR_LOCATION[] = "opdEditorLocation";
const char VRF_LAUNCHER_LOCATION[] = "vrfLauncherLocation";
const char VISUAL_TERRAIN[] = "visualTerrain";
const char FILE_DIALOG_PRIORITY[] = "fileDialogPriority";
const char SNAP_TO_GRID[] = "snapToGrid";
const char APP_DATA_DIR[] = "appDataDir";
const char DATA_DIR[] = "dataDir";
const char VRF_LAYOUT_SETTINGS_FILE[] = "layoutSettingsFile";
const char PARTIAL_LOAD[] = "partialLoad";

namespace makVrv
{
   class DtDe;
   class DtDeMainWindowProvider;
}

class DT_DLL_simulationObjectEditorimpl DtGuiOnlyMenuAssembler : public makVrv::DtQtMenuAssembler
{
public:
   DtGuiOnlyMenuAssembler(makVrv::DtDe&);

   virtual ~DtGuiOnlyMenuAssembler() override;

protected:
   virtual QMenuBar* menuBar() override;
   virtual QWidget* menuWindow() override;
};

class DT_DLL_simulationObjectEditorimpl DtGuiOnlyMenuAssemblerCreator : public makVrv::DtMenuAssemblerCreator
{
public:

   DtGuiOnlyMenuAssemblerCreator()
   {
   }

   virtual ~DtGuiOnlyMenuAssemblerCreator() override {
   }

   virtual makVrv::DtMenuAssembler* create(makVrv::DtDe& de) override;

};

class DT_DLL_simulationObjectEditorimpl DtGuiOnlyDe : public makVrv::DtDe
{
public:
   DtGuiOnlyDe();

   virtual ~DtGuiOnlyDe() override;

   void setPerformedUpgradeCheck(bool b)
   {
      myPerformedUpgradeCheck = b;
   }

protected:
   virtual InitializationResult initialize() { return initialize(false, false); };
   virtual InitializationResult initialize(bool abortOnFailure, bool useLicenseErrorDialog) override;
   virtual void postInitialize() override;

   virtual void setDeInitializer(const makVrv::DtDeInitializer& initializer) override;

   virtual void tick(double) override;

protected:
   bool myPerformedUpgradeCheck = false;
};

class DT_DLL_simulationObjectEditorimpl DtParameterAlteringApplication : public makVrf::DtVrfGuiApplication
{
public:

   DtParameterAlteringApplication(makVrv::DtVrvApplicationConfiguration& config);

   virtual ~DtParameterAlteringApplication() override;

   virtual void initialize( int argc, char** argv) override;

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

   virtual void setStartupValue(const std::string& key, const std::string& value);

   static DtParameterAlteringApplication* app(makVrv::DtDe&);

   virtual void run() override;

   virtual void setMainWindowCreatorFunction(makVrv::DtDeMainWindowProvider*);

   virtual void preInitialize(int argc, char** argv) override;

public:

   virtual void addParameterType(const char* controllerName, const char* likeUi, DtSimObjectParametersCreatorFcn fcn = NULL) ;
   virtual void addController(const char* controllerName, const char* descriptorName, DtComponentDescriptorCreatorFcn fcn = NULL) ;
   virtual void addSensor(const char* sensorName, const char* descriptorName, DtComponentDescriptorCreatorFcn fcn = NULL) ;
   virtual void addActuator(const char* actuatorName, const char* descriptorName, DtComponentDescriptorCreatorFcn fcn = NULL) ;

   virtual void addUserExtentsion(const DtString& type, DtVrfSRUserExtensionCreatorFcn fcn) ;

   virtual DtReaderWriterClassDocDB* parameterDocDB() const;


protected:
   virtual void setupMenu() = 0;

   virtual void loadTranslationFiles(const std::string&) override;

   virtual void assemble() override;

   virtual void dePostInitialize() override;

   virtual void loadPluginModulesExt() override;

   virtual bool updateCurrentGuiConfiguration() override;

   virtual bool loadParameterDocDB(DtReaderWriterClassDocDB& parameterDocDB);

   virtual DtReaderWriterClassDocDB* createParameterDocDB() const;

protected:
   std::map<std::string, std::string> myStartupValues;
   std::map<DtString, DtVector>  myVisualPlacements;
   bool myUpdateGuiConfiguration;
   DtReaderWriterClassDocDB* myParameterDocDB;
};

class DT_DLL_simulationObjectEditorimpl DtSimulationObjectEditorApplication : public DtParameterAlteringApplication
{
public:

   DtSimulationObjectEditorApplication(makVrv::DtVrvApplicationConfiguration& config);

   virtual ~DtSimulationObjectEditorApplication() override;

   virtual void initialize( int argc, char** argv) override;

   static DtSimulationObjectEditorApplication* app(makVrv::DtDe&);

   virtual void setPerformUpgradeOn(const DtFilename&);
   const DtFilename& performUpgradeOn() const
   {
      return myPerformUpgradeOn;
   }
   virtual bool performUpgrade(const DtFilename&);

   virtual void setPerformSystemUpgradeOn(const DtFilename&);
   const DtFilename& performSystemUpgradeOn() const
   {
      return myPerformSystemUpgradeOn;
   }
   virtual bool performSystemUpgrade(const DtFilename&);

   virtual DtSimulationObjectEditorAppEventController* appEventController();

   virtual DtSimulationObjectEditorWindow* mainWindow();

   virtual void addVisualTypeMapping(const DtString&, const DtVector&);
   virtual DtVector visualPlacement(const DtString&);

   virtual DtDisplayWidget* editingWindow();

   virtual QString sematicText(int) const;

   //created so that we can dynamically add another menu item that relies on the display de
   virtual void assemble() override;

   virtual void setDarkMode(bool b);

protected:
   virtual void setupMenu() override;
   void initSemanticsTextMapping();

   virtual void loadPluginModules() override;

public:
   const std::map<int, QString>& sematicsTextMappings() const { return mySemanticsTextMapping; };

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

   boost::signals2::signal<void (DtBehaviorUi*)> signal_postBehaviorUiCreate;

   boost::signals2::signal<void (DtBehaviorCanvas*, std::set<makVrf::DtEntityMapperKey>, std::string)> signal_preBehaviorCanvasCreate;
   boost::signals2::signal<void (DtBehaviorCanvas*, std::vector<DtComponentSystemDefinition*>)> signal_preSystemBehaviorCanvasCreate;

   boost::signals2::signal<void (DtBehaviorCanvas*, QWidget*, std::set<makVrf::DtEntityMapperKey>, std::string)> signal_postBehaviorCanvasCreate;
   boost::signals2::signal<void (DtBehaviorCanvas*, QWidget*, std::vector<DtComponentSystemDefinition*>)> signal_postSystemBehaviorCanvasCreate;

   boost::signals2::signal<void (DtUiElement*)> signal_uiElementModified;

   boost::signals2::signal<void (makVrv::DtDe&)> signal_preDisplayWidgetCreation;
   boost::signals2::signal<void (makVrv::DtDe&)> signal_displayDeAboutToBeInitialized;

protected:
   DtSimulationObjectEditorAppEventController* myAppEventController;
   std::map<int, QString>  mySemanticsTextMapping;
   bool myDarkMode;
   DtFilename myPerformUpgradeOn;
   DtFilename myPerformSystemUpgradeOn;
};