Interface Manipulation (interfaceManipulation)

The Interface Manipulation example demonstrates the following:

• How to create a dialog at start-up that gives the option of using VR-Forces GUI in alternate modes
• How to add menus and menu items to the GUI
• How to add a toolbar and buttons to the GUI
• How to create a simple scenario player option that limits user capabilities to simply loading and observing scenarios
• How to create a simple scenario viewer option that limits user capabilities to simply observing simulation activity occuring over the network
• How to add a command line argument, such that, if specified, the user does not need to choose the UI to use from the start up dialog. This is done via the initializeCommandLineArguments function

The Interface Manipulation example creates a starting dialog that allows different options for the GUI to be entered into. One is the normal VRF GUI but with a new toobar, one is a "Simple Scenario Player" that allows the user to load terrains or scenarios and observe them - but not interact with them. The other option created by this example is a "Simple Scenario Viewer" that allows the user only to observe simulation activity, but not to interact with it in any way.

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

#include <QPushButton>

namespace makVrv
{
   class DtDe;
}

class myButtonWidget
   : public QPushButton
{
   Q_OBJECT

public:
   myButtonWidget( makVrv::DtDe& de, const QString & text, QWidget* parent = 0);

   virtual ~myButtonWidget();

   public slots:
      void slot_onClicked();

protected:
   makVrv::DtDe& myDe;
};

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

//\file interfaceManipulationPluginInit.cxx

//This file defines the generic DT_DLL_VRF_PLUGIN_EXPORT_MACRO.  Use that macro when
//you want to export symbols.  Also, in your CMakeLists.txt file, make sure to
//define the VRFPLUGIN_EXPORTS define to tell the compiler to define the macro as an
//export
#include <vrfGuiCore/vrfGuiExportPlugin.h>

#include <vrvCore/DtToolbarConfiguration.h>
#include <vrvCore/DtToolbarPath.h>
#include <vrvCoreQt/DtQApplicationProvider.h>

#include <vrfGuiCore/vrfGuiCommandLineParser.h>

#include <vrfGuiCore/vrfContextMenuManagerSignaler.h>
#include <vrfGuiCore/objectSettingsManager.h>
#include <vrfGuiCore/layoutManager.h>
#include <vrfGuiCore/vrfObjectManipulationManager.h>
#include <vrfGuiCore/vrfGuiSettingsManager.h>
#include <vrfGuiCoreQt/vrfScenarioManager.h>
#include <vrfGuiCoreQt/vrfContextMenuManager.h>
#include <vrfGuiCoreQt/sessionStartupDialog.h>
#include <vrfGuiCoreQt/entityMenu.h>

#include <vrvCore/DtDe.h>
#include <vrvCore/DtDriverManager.h>
#include <vrvCore/DtInputDriver.h>
#include <vrvCore/DtVrvApplication.h>
#include <vrvUtil/DtDeInitializer.h>

#include <QtWidgets/QApplication>
#include <QtWidgets/QDialog>
#include <QtWidgets/QLayout>
#include <QtWidgets/QPushButton>
#include <QtWidgets/QLabel>
#include <QtWidgets/QComboBox>

#include <boost/bind.hpp>

//new
#include <vrvCoreQt/DtToolbar.h>
#include <vrvCoreQt/DtWidgetBuilder.h>
#include <QtWidgets/QToolBar>
#include <vrvCoreQt/DtQtToolbarAssembler.h>
#include <vlpi/entityType.h>
#include "interfaceManipulationPlugin.h"

// Command line argument that specifies the ui type
DtCmdLine::ValueArg<int>* theUiType;

// Toolbar for holding new pushbuttons
class newToolbarClass : public makVrv::DtToolbar
{
public:
   newToolbarClass (makVrv::DtDe& de);
   virtual ~newToolbarClass();
   virtual QToolBar* createToolbar(makVrv::DtDe&, QWidget* parent);
};
newToolbarClass::newToolbarClass(makVrv::DtDe& de)
   : makVrv::DtToolbar(de, std::string("NewToolbar") )
{
}
newToolbarClass::~newToolbarClass()
{
}
QToolBar* newToolbarClass::createToolbar(makVrv::DtDe&, QWidget* parent)
{
   QToolBar* tb = new QToolBar("NewToolbar", parent);
   tb->setWindowTitle("New Toolbar");
   return tb;
}
//  Push button for creating route
myButtonWidget::myButtonWidget(makVrv::DtDe& de,
   const QString & text, QWidget* parent /* = 0 */)
   : QPushButton(text, parent)
   , myDe(de)
{
   connect(
      this, SIGNAL(clicked()),
      this, SLOT(slot_onClicked()) );
}
myButtonWidget::~myButtonWidget(){};

void myButtonWidget::slot_onClicked()
{
   DtWarn("Button clicked\n");
   makVrf::DtVrfObjectManipulationManager::instance(myDe).createObject(
      DtEntityType(17, 0, 0, 2, 0, 0, 0), 1);
}
class MyButtonWidgetBuilder : public makVrv::DtWidgetBuilder
{
public:
   MyButtonWidgetBuilder(makVrv::DtDe& de);
   virtual ~MyButtonWidgetBuilder();
   virtual QWidget* create(makVrv::DtDe& de, QWidget* parent,
      const Qt::WindowFlags& flags = 0);
};
//......................................................................
MyButtonWidgetBuilder::MyButtonWidgetBuilder(makVrv::DtDe& de)
   : DtWidgetBuilder()
{
}

MyButtonWidgetBuilder::~MyButtonWidgetBuilder()
{
}

QWidget* MyButtonWidgetBuilder::create( makVrv::DtDe& de, QWidget* parent, 
   const Qt::WindowFlags& flags)
{
   return new myButtonWidget(de, "Create Route", parent);
}


void setupNewToolbar(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   makVrv::DtToolbar * tb = new newToolbarClass(de);
   makVrv::DtQtToolbarAssembler::instance(de).registerToolbar(tb);

   app.masterModeToolbarConfiguration().addToolbarPath(
      makVrv::DtToolbarPath::toolbar("NewToolbar").item("DtRangeRingsItem"));

   MyButtonWidgetBuilder* bwb = new MyButtonWidgetBuilder(de);
   makVrv::DtQtToolbarAssembler::instance(de).registerWidgetBuilder(
      "CreateRouteButton", bwb);
   app.masterModeToolbarConfiguration().addToolbarPath(
      makVrv::DtToolbarPath::toolbar("NewToolbar").widget("CreateRouteButton"));

}
void sessionStartupDialogLoadOnlyMode(makVrf::DtSessionStartupDialog* d)
{
   d->setAllowNewScenarioOnLocal(false);
}

// Add new command line argument where the user can specify their argument for the ui type
void initializeCommandLineArguments(makVrf::DtVrfGuiCommandLineParser* parse)
{
   theUiType = new ValueArg<int>("", "uiType",
         "Type of UI to use (0 - Normal, 1 - Simple Scenario, 2 - Scenario Viewer, 3 - Map Area Only",false,-1,"int");

   parse->addAdditionalCommandLineArgument(theUiType);
}

//Finalize setup of items that can only be done after initialization
void postInitDeModule(makVrv::DtDe& de)
{
   makVrf::DtLayoutManager::instance(de).setSaveLayouts(false);

   if (theUiType->getValue() > 0)
   {
      //Disable the terrain context menu
      de.driverManager().inputDriver().setTerrainContextEnabled(false);

      makVrf::DtVrfScenarioManager::instance(de).setAllowEditingOnScenarioJoin(false);

      if (theUiType->getValue() == 3)
      {
         bool oldAutoSave = makVrf::DtVrfGuiSettingsManager::instance(de).autoSave();

         makVrf::DtVrfGuiSettingsManager::instance(de).setAutoSave(false);
         makVrf::DtVrfGuiSettingsManager::instance(de).setDoNotShowSessionStartupDialog(true);
         makVrf::DtVrfGuiSettingsManager::instance(de).setAutoSave(oldAutoSave);
      }
   }
}

void createSimpleScenarioPlayer(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   //When the session startup dialog is created, manipulate to only allow the load scenario options
   makVrf::DtVrfScenarioManager::instance(de).signal_sessionStartupBoxCreated.connect
      (boost::bind(&sessionStartupDialogLoadOnlyMode, _1));

   //Disable all context menus
   makVrf::DtVrfContextMenuManager::instance(de).setEnabled(false);

   makVrv::DtMenuConfiguration simplePlayer;

   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtFileMenu").item("DtOpenTerrainItem"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtFileMenu").item("DtLoadScenarioMenuItem"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtFileMenu").item("DtCloseScenarioMenuItem"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtFileMenu").separator("DtScenarioSeparator"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtFileMenu").item("DtExitItem"));

   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtViewMenu").item("DtFullScreenItem"));

   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtSimulationMenu"));

   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtSimulationMenu").item("DtRewindScenarioMenuItem"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtSimulationMenu").item("DtPlayScenarioMenuItem"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtSimulationMenu").item("DtPauseScenarioMenuItem"));
   app.masterModeMenuConfiguration() = simplePlayer;

   //Clear out all toolbars except for observer settings
   makVrv::DtToolbarConfiguration toolbars;

   toolbars.addToolbarPath(makVrv::DtToolbarPath::row("Top_Row").toolbar("DtObserverSettingsToolbar"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").widget("DtObserverSelectionWidget"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").widget("DtObserverModeSelectionWidget"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").separator("DtObserverSettingsToolbarSeparator"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").widget("DtSetModelSetToolButton")); 
   // New
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").item("DtRangeRingsItem")); 

   app.masterModeToolbarConfiguration() = toolbars;

   //Clear out page collections so there are no dock widgets
   app.masterModePageConfiguration() = makVrv::DtPageConfiguration();
}

void createSimpleScenarioViewer(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   //Do not show session startup dialog
   bool oldAutoSave = makVrf::DtVrfGuiSettingsManager::instance(de).autoSave();

   makVrf::DtVrfGuiSettingsManager::instance(de).setAutoSave(false);
   makVrf::DtVrfGuiSettingsManager::instance(de).setDoNotShowSessionStartupDialog(true);
   makVrf::DtVrfGuiSettingsManager::instance(de).setAutoSave(oldAutoSave);
      
   //Disable all context menus
   makVrf::DtVrfContextMenuManager::instance(de).setEnabled(false);
   makVrv::DtMenuConfiguration simplePlayer;

   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtFileMenu").item("DtExitItem"));
   simplePlayer.addMenuPath(makVrv::DtMenuPath::mainMenu("DtViewMenu").item("DtFullScreenItem"));

   //Clear out all toolbars except for observer settings
   makVrv::DtToolbarConfiguration toolbars;

   toolbars.addToolbarPath(makVrv::DtToolbarPath::row("Top_Row").toolbar("DtObserverSettingsToolbar"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").widget("DtObserverSelectionWidget"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").widget("DtObserverModeSelectionWidget"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").separator("DtObserverSettingsToolbarSeparator"));
   toolbars.addToolbarPath(makVrv::DtToolbarPath::toolbar("DtObserverSettingsToolbar").widget("DtSetModelSetToolButton")); 

   app.masterModeToolbarConfiguration() = toolbars;

   //Clear out the menus except exit and full screen
   app.masterModeMenuConfiguration() = simplePlayer;

   //Clear out page collections so there are no dock widgets
   app.masterModePageConfiguration() = makVrv::DtPageConfiguration();

   makVrf::DtVrfScenarioManager::instance(de).setAutoSave(oldAutoSave);
}

void showMapAreaOnly(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   makVrf::DtVrfContextMenuManager::instance(de).setEnabled(false);

   makVrv::DtMenuConfiguration simplePlayer;

   makVrv::DtToolbarConfiguration toolbars;

   app.masterModeToolbarConfiguration() = toolbars;

   app.masterModeMenuConfiguration() = simplePlayer;

   app.masterModePageConfiguration() = makVrv::DtPageConfiguration();

   makVrf::DtObjectSettingsManager::instance(de).removeAll();
}

void chooseInterface(makVrv::DtVrvApplication& app, makVrv::DtDe& de)
{
   //Create the qApplication if it has not already been created
   if (!qApp)
   {
      makVrv::DtQApplicationProvider& appProvider = makVrv::DtQApplicationProvider::instance(de);

      appProvider.qAppInstance();
   }

   if (!theUiType->isSet())
   {
      //Put up a dialog to allow the user to choose an interface type.  Default, Player or Viewer.  The choice
      //will then be used when the application is being initialized
      QDialog* dlg = new QDialog(0, Qt::Tool);
      QVBoxLayout* lay = new QVBoxLayout(dlg);

      dlg->setWindowTitle("Select User Interface");

      lay->setMargin(4);
      lay->setSpacing(4);

      QComboBox* combo = new QComboBox(dlg);

      lay->addWidget(combo);

      combo->addItem("Normal With New Toolbar");
      combo->addItem("Simple Scenario Player");
      combo->addItem("Simple Scenario Viewer");
      combo->addItem("Map Area Only");

      QSpacerItem* item = new QSpacerItem(0, 0, QSizePolicy::MinimumExpanding);

      QHBoxLayout* hLay = new QHBoxLayout;
      hLay->setMargin(0);
      hLay->setSpacing(0);

      lay->addLayout(hLay);

      hLay->addItem(item);

      QPushButton* ok = new QPushButton("&OK", dlg);
      QObject::connect(ok, SIGNAL(released()), dlg, SLOT(accept()));

      hLay->addWidget(ok);

      dlg->exec();

      theUiType->setValue(combo->currentIndex());

      delete dlg;
   }

   if (theUiType->getValue() == 0)
   {
      setupNewToolbar(app, de);
   }
   else if (theUiType->getValue() == 1)
   {
      createSimpleScenarioPlayer(app, de);
   }
   else if (theUiType->getValue() == 2)
   {
      createSimpleScenarioViewer(app, de);
   }
   else if (theUiType->getValue() == 3)
   {
      showMapAreaOnly(app, de);
   }
}

bool initDeModule(makVrv::DtDe* de)
{
   makVrv::DtVrvApplication* igApp = makVrv::DtVrvApplication::findFromDe(*de);
   if(igApp)
   {
      chooseInterface(*igApp, *de);
      return true;
   }
   else
   {
      return false;
   }
}

void DtPluginInformation(DtVrfPluginInformation& info)
{
   info.pluginName = "Interface Manipulation";
   info.pluginDescription = "This example shows how to manipulate the user interface.";
   info.pluginVersion = "1.00";
   info.pluginCreator = "MAK Technologies";
   info.pluginCreatorEmail = "sales@mak.com";
   info.pluginContactWebPage = "www.mak.com";
   info.pluginContactMailingAddress = "150 Cambridge Park Drive 3rd Floor - Cambridge, MA 02140 USA";
   info.pluginContactPhone = "(617) 876 8085";
}