Encumbered Flight (addSetEncumbranceGui)

Table of Contents

• How to Run the Example
  • Usage
• Classes
• Plugin Entry Points

This example adds a new Set that is sent from the GUI and received and processed by the addSetEncumbranceSim example.

The effect of these plugins it so allow manual setting of the cargo weight of a rotary wing aircraft to alter its flight behaviors and fuel consumption. This is simillar to the addSetGui example. Please check this example for a detailed explanation of adding a set. The larger architecture of GUI and Menus in the VR Forces Front End is described in VR-Vantage Architecture Walkthrough - The GUI Layer and GUI Architecture.

How to Run the Example

This example demonstrates how to add a new kind of set data request (set heading and ordered speed).

Usage

In the Launcher, click the Plug-ins button to bring up the Plug-ins Selection dialog. Enable the EncumberedFlight plugin.

To view the new behavior:

1. Start VR-Forces GUI and SIM.
2. Create a new scenario - e.g. EntityLevel SMS on Ground_DB II terrain.
3. Create two CH-47 Chinook rotary wing aircraft nearby each other.
4. Right click on the first Chinook and select Set → Position → Encumbrance...
5. Set the Encumberance in the pop-up box to 10000 kg and click the OK button.
6. Create plans for both Chinooks and task them to fly to altitude of 5000 m.
7. Switch the observer view to Out-the-Window
8. Orient the view so that it is a perspective with both helicopters visible.
9. Run the scenario
10. Observe that the encumbered helicopter rises in altitude more slowly than the unencumbered helicopter.

Classes

DtSetEncumbranceMenuItem	The menu item that will register the dialog to be shown when this set is requested.
DtSetEncumbranceDialog	The Qt widget that generates the dialog box used to enter the encumerance information.
DtSetEncumbranceRequest	The subclass of DtSetDataRequest that is used to communicate the new set request between the front-end and the back-end.

Plugin Entry Points

/*******************************************************************************
** Copyright (c) 2016 VT MAK, Inc.
** All rights reserved.
*******************************************************************************/

//\file addSetEncumbrancePlugin.cxx
//\brief Contains plugin function

//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 <vrfGuiCoreQt/vrfScenarioManager.h>

#include "DtSetEncumbranceMenuItem.h"
#include "../addSetEncumbranceSim/setEncumbranceRequest.h"

#include <vrfGuiTaskSetQt/setMenu.h>
#include <vrfGuiCore/guiThreadVrfRemoteController.h>
#include <vrfGuiConstants/vrfMenuIds.h>

#include <vrvCore/DtDe.h>
#include <vrvCoreQt/DtQtMenuAssembler.h>

using namespace vrfAddSetEncumbranceExample;
using namespace makVrf;

void DtSetMenuConfigurationLoaded(makVrv::DtDe* de)
{
   //[insert menu item string into set menu]
   //Inserts the DtSetEncumbranceMenuItem object name as the menu item into a specific point of the Set Menu with the masterModeMenuConfiguration
   //The set entry is placed after the menu entry corresponding to the "DtVrfSetResponsibilityAction" object
   DtVrfScenarioManager::instance(*de).initialSetMenuConfiguration().addMenuItemAfter(DtSetEncumbranceMenuItemIdName, DtVrfSetLocationActionId);
   //[insert menu item string into set menu]
}

bool initDeModule(makVrv::DtDe* de)
{
   DtSetMenu& setMenu = makVrf::DtSetMenu::instance(*de);

   //[register menu item with set menu]
   //Registers the DtSSetSpeedAndHeadingMenuItem object with the makVrf::DtSetMenu assembler
   setMenu.registerMenuItem(new DtSetEncumbranceMenuItem(*de));
   //[register menu item with set menu assembler]

   //Registers the set creator in the back-end, linking it with the front-end by the common string DtSetEncumbranceString
   DtGuiThreadVrfRemoteController::instance(*de).addSetCreatorFcn(
      DtSetEncumbranceType, DtSetEncumbranceRequest::creator);

   //Register callback to be notified when initial set menu configuration has changed.  This will always allow the plugin
   //to correctly add in the new set command
   DtScenarioSignaler::instance(*de).signal_setMenuConfigurationLoaded.connect
      (boost::bind(&DtSetMenuConfigurationLoaded, de));

   return true;
}

void DtPluginInformation(DtVrfPluginInformation& info)
{
   info.pluginName = "Add Set Encumbrance Gui";
   info.pluginVersion = "1.00";
   info.pluginDescription = "Front-end plugin addition to add new Set Encumbrance... command";
   info.pluginCreator = "VT MAK";
   info.pluginCreatorEmail = "sales@mak.com";
   info.pluginContactWebPage = "www.mak.com";
   info.pluginContactMailingAddress = "10 Fawcett Street, Suite 204, Cambridge, MA 02138 USA";
   info.pluginContactPhone = "(617) 876 8085";
}