VR-Forces GUI Examples

Table of Contents

• Plug-in Examples
• VR-Vantage Examples

VR-Forces comes with a number of code examples.

These examples can be useful as starting points for extending the VR-Forces front-end. See also Simulation Engine (back-end) and Other Examples.

Plug-in Examples

Plug-in examples are dynamically linked libraries that are loaded using the GUI menu "Settings->Plugins" dialog.

Add State Property (addStatePropertyGui)	Adds new state properties which are published to the network. Also details how to add items to the entity info dialog. Related to back-end example Add State Property
Add Entity Info Page (addEntityInfoPage)	Add a new page to the Entity Information dialog
Add Script Variable	Add a new scripted variable type to be available to a scripted task, set, or reactive task Add Scripted Variable
Add Set Encumbrance (Front-End) (addSetEncumbranceGui)	Add a new set encumbrance request command. Related to back-end example Add Set Encumbrance
Add Set (Front-End) (addSetGui)	Add a new set data request command. Related to back-end example Add Set
Add Task Example	Add a new task command. Related to back-end example Add Set
Add Simulation Command (addSimCommandGui)	Add a new simulation command. Related to back-end example Add Command
Add Conditional (addConditionalGui)	Add a new conditional statement. Related to back-end example Add Condition
Custom Control Object (customControlObject)	Add a new custom control object with custom parameters and dialog.
Scenario Import/Export (csvScenarioImporterExporterGui)	Add a new scenario import/export format for use with VR-Forces.
Display Metrics (displayMetrics)	The Display Metrics example demonstrates how to add a button to the toolbar which will display a new dialog containing scenario metrics.
Entity List (entityList)	Add a new panel that displays all existing entities and their current task.
Create Local Object in GUI (guiLocalCreateObject)	Creates objects in the GUI without publishing them on the network.
GUI Object Data Interface (guiObjectDataInterface)	Demonstrates how to easily retrieve simulation data for published objects.
GUI Send Interaction (guiSendInteraction)	Demonstrates how to access the VR-Link DtExerciseConnection from the VRF GUI application, how to add a plug-in, and how to add a menu item.
GUI Thread VRF Remote Controller (guiThreadVrfRemoteController)	Demonstrates how to control a back-end from the GUI thread.
Interface Content (interfaceContentGui)	Send an interface content message. Related to back-end example Interface Content .
Interface Manipulation (interfaceManipulation)	Demonstrates how to change the GUI menus and options available to the user, including how to add a toolbar and button.
Menu Manipulation (menuManipulation)	Manipulates the menu, changing it from the system default.
Meta Data Script Encrypt/Decrypt (metaDataEncryptDecrypt)	Example of how to encrypt meta data language scripts.
Modify Set (modifySet)	Overrides the existing set dialog.
Modify Task (modifyTask)	Overrides the existing task dialog.
Network Callback Manager (networkCallbackManager)	How to receive callbacks for VR-Forces and VR-Link published content.
Object Filtering (objectFilter)	How to filter objects on the map display.
Range Line (rangeLine)	Shows how to manipulate visual definitions and create a new visualizer in code.
spotReportManipulation	Manipulates the selection of spot reports.
Unit Status (unitStatus)	Add a new toolbar to the window.

/note The following examples do not come pre-built in the Linux installer:

• addConditionalGui
• addSetGui
• addSimCommandGui
• interfaceContentGui.

In order to do build them to be used with VR-Forces, you must use the make command as follows:

make install

This should generate the files needed to use the plugins in Linux.

VR-Vantage Examples

The VR-Forces front-end is based on the VR-Vantage toolkit and so the VR-Vantage examples are also included with VR-Forces. VR-Vantage uses a different plug-in system and are activated via a different mechansim. For details please see the VR-Vantage section of the How to Build documentation.

• exampleAccessory - Shows how to create an accessory to extend a driver.
• exampleConfiguration - A stand along application that shows how to create a display configuration.
• exampleCoordinateDisplay - Shows how to add a new coordinate system and integrate it with the applications coordinate display settings.
• exampleCreateObserver - This example shows how to create an observer.
• exampleCustom - Create a new stand-alone application
• exampleDialogByAddition - This tutorial shows how to extend an existing dialog-page to add new functionality by deriving from the existing Page class and simply adding new widgets to it.
• exampleDialogByDerivation - This tutorial shows how to extend an existing dialog-page to add new functionality by deriving from the existing GUI and logic classes.
• exampleDialogPage - This example shows how to add a dialog box and dialog box page to the GUI, and how to manage persistent settings.
• exampleDisplayUnits - Shows how to use convert values and display them using the application's display units settings.
• exampleDistributedDraw - Creates a driver that that controls a distributed draw object.
• exampleKeyMap - This example shows how to register a function with the Key Map Manager, and bind it to a key event in a key map.
• exampleSymbolFacade1 - This example demonstrates how to add symbols to the scene in a PVD application.
• exampleSymbolFacade2 - This example shows how to extend exampleSymbolFacade1
• exampleSymbolFacade3 - This example shows how to extend exampleSymbolFacade2 for rotating symbols
• exampleSymbolFacade4 - This example shows how to extend exampleSymbolFacade2 for hiding symbols
• exampleSymbolFacade5 - This example shows how to extend exampleSymbolFacade2 for deleting symbols