![]() |
VR-Forces Developer's Guide
|
The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication.

Public Types | |
| enum | ObserverMode { PvdAndStealthMode = 0, PvdMode, StealthMode } |
| typedef std::map< std::string, std::string > | ObserverModeBindings |
Public Types inherited from makVrv::DtVrvApplication | |
| typedef boost::function< void(DtVrvApplicationConfiguration &, int argc, char **argv)> | ConfigurationTransform |
| typedef boost::function< void(DtDeInitializer &, DtDe &, DtVrvApplicationConfiguration &)> | ApplicationTransform |
Public Member Functions | |
| DtVrfGuiApplication (makVrv::DtVrvApplicationConfiguration &config) | |
| virtual | ~DtVrfGuiApplication () |
| virtual void | initialize (int argc, char **argv) |
| virtual void | preInitialize (int argc, char **argv) override |
| virtual void | assemble () override |
| virtual void | run () |
| virtual DtString | layoutSettingsFileClassName () const |
| virtual std::string | userScenarioDirectory () |
| void | setPluginApplication (const std::string &) |
| const std::string & | pluginApplication () const |
| virtual void | setLoadSystemPlugins (bool) |
| virtual bool | loadSystemPlugins () const |
| virtual makVrv::DtUnicode | applicationName () const |
| virtual void | writeGuiConfiguration () |
| virtual void | loadSavedGuiState () |
| virtual bool | getShowStartupScreen () const |
| virtual bool | usingAbsoluteTimeStamps () const |
| virtual std::string | restoreDefaultLayout (const DtString &layoutTemplate="Scenario_Creation") |
| virtual bool | usingAsynchIO () const |
| virtual makVrv::DtVrlinkDriver * | getVrlinkDriver () const |
| virtual DtSimulationAddress | frontEndSimulationAddress () const |
| virtual bool | vrlDriverHasBooleanValue (const std::string &, bool *hasValue=NULL) const |
| virtual bool | vrlDriverHasBooleanValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const |
| virtual int | vrlDriverHasIntegerValue (const std::string &, bool *hasValue=NULL) const |
| virtual int | vrlDriverHasIntegerValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const |
| virtual double | vrlDriverHasDoubleValue (const std::string &, bool *hasValue=NULL) const |
| virtual double | vrlDriverHasDoubleValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const |
| virtual std::string | vrlDriverHasStringValue (const std::string &, bool *hasValue=NULL) const |
| virtual std::string | vrlDriverHasStringValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const |
| void | setVrfSvnRevision (const std::string &s) |
| const std::string & | vrfSvnRevision () const |
| void | setVrvSvnRevision (const std::string &s) |
| const std::string & | vrvSvnRevision () const |
| virtual bool | terrainIsValid (int terrainPathOffset=0) |
| virtual std::string | language () const |
| virtual void | checkOrCreateModelDefinition (const std::string &definition, const std::string &filePath) |
| virtual void | addLoadVerifierFunction (const DtString &, DtVrfGuiPluginManagerExt::VerifierFunction f) |
Public Member Functions inherited from makVrv::DtVrvApplication | |
| DtVrvApplication () | |
| DtVrvApplication (const DtVrvApplicationConfiguration &appConfig) | |
| virtual | ~DtVrvApplication () |
| DtVrvApplicationConfiguration & | configuration () |
| DtPageConfiguration & | masterModePageConfiguration () |
| DtPageConfiguration & | slaveModePageConfiguration () |
| DtMenuConfiguration & | masterModeMenuConfiguration () |
| DtMenuConfiguration & | slaveModeMenuConfiguration () |
| DtToolbarConfiguration & | masterModeToolbarConfiguration () |
| DtToolbarConfiguration & | slaveModeToolbarConfiguration () |
| DtDe & | de () |
| virtual void | initialize () |
| virtual DtPluginManager & | pluginManager () |
| virtual void | slot_sceneTerrainLoaded (const DtUnicode &terrain) |
| virtual void | slot_sceneTerrainSaved (const std::string &terrain) |
| virtual void | slot_sceneToBeLoaded (const std::string &terrain) |
| virtual void | slot_sceneLoaded (const std::string &terrain) |
| virtual void | slot_sceneSaved (const std::string &terrain) |
| virtual std::list< std::string > & | getRecentTerrains () |
| virtual void | setShowStartupScreen (bool show) |
| virtual void | installCommandLineProcessor (DtVrvCommandLineProcessor *commandLineProcessor) |
| virtual void | installPrePluginTransform (const ApplicationTransform &transform, const std::string &id) |
| virtual void | installPostPluginTransform (const ApplicationTransform &transform, const std::string &id) |
| virtual void | installPostAssembleTransform (const ApplicationTransform &transform, const std::string &id) |
| virtual bool | loadRecentTerrains () |
Static Public Member Functions | |
| static bool | applicationIsTerminating (makVrv::DtDe &) |
| static DtVrfGuiApplication * | app (makVrv::DtDe &) |
| static makVrv::DtDe * | theDe () |
| static void | SetQtDesignerMode (bool) |
| static bool | QtDesignerMode () |
| static void | setNoSpotReportDefinitionLoading (bool val) |
| static bool | noSpotReportDefinitionLoading () |
| static void | setSpotReportElementDefinitionHierFilesOrDirs (const std::vector< std::string > &filesOrDirs) |
| static const std::vector < std::string > & | spotReportElementDefinitionHierFilesOrDirs () |
| static void | setSpotReportElementDefinitionLeafFilesOrDirs (const std::vector< std::string > &filesOrDirs) |
| static const std::vector < std::string > & | spotReportElementDefinitionLeafFilesOrDirs () |
| static void | setIgnoreLayoutGeometryOnInitialLoad (bool) |
| static bool | ignoreLayoutGeometryOnInitialLoad () |
| static void | setShowPerspective (const std::string &) |
| static void | setQtDesignerPluginSupport (bool) |
| static bool | qtDesignerPluginSupport () |
| static void | setGuiConfiguration (const std::string &) |
| static void | setObserverModeBindings (const ObserverModeBindings &modes) |
| static const ObserverModeBindings & | observerModeBindings () |
| static const std::vector < std::string > & | additionalPluginsToLoad () |
| static void | setAdditionalPluginsToLoad (const std::vector< std::string > &) |
| static bool | loadDefaultPlugins () |
| static void | setLoadDefaultPlugins (bool) |
| static bool | checkPluginVersions () |
| static void | setCheckPluginVersions (bool) |
| static const std::string & | transport () |
| static void | setTransport (const std::string &) |
| static const std::string & | loadScenario () |
| static void | setLoadScenario (const std::string &) |
| static const std::string & | useFileCommChannel () |
| static void | setUseFileCommChannel (const std::string &) |
| static void | setLayoutSettingsFile (const std::string &) |
| static std::string | layoutSettingsFile () |
| static const std::string & | loadSimulationObjectGroup () |
| static void | setLoadSimulationObjectGroup (const std::string &) |
| static void | setDefaultSimulationModelSet (const std::string &) |
| static const std::string & | defaultSimulationModelSet () |
| static ObserverMode | observerMode () |
| static void | setObserverMode (ObserverMode) |
| static void | setUserScenarioDirectory (const std::string &) |
| static void | setShouldLoadGuiSavedState (bool) |
| static bool | shouldLoadGuiSavedState () |
Static Public Member Functions inherited from makVrv::DtVrvApplication | |
| static DtVrvApplication * | get_last_instance () |
| static void | ShowErrorMessage (const std::string &message, DtException *ex=0) |
| static DtVrvApplication * | findFromDe (DtDe &) |
| static bool | parseDisplayEngineParameter (const std::string &argument, int &port, std::string &address, std::string &displayConfig) |
| static std::string | displayEngineParameterFormatting () |
| static void | setShowErrorMessageDialog (bool show) |
| static bool | showErrorMessageDialog () |
| static void | handleFileError (const std::string &filename, const std::string &fileType) |
| static void | bindViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap) |
| static bool | loadObserverStateRecords (const std::string &file, makArchives::DtObserverStateRecordsList &list) |
| static void | loadViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap) |
Public Attributes | |
| boost::signals2::signal< void(makVrv::DtDe &, makVrv::DtMenuConfiguration &)> | signal_preAssemble |
| boost::signals2::signal< void(makVrv::DtDe &, makVrv::DtMenuConfiguration &)> | signal_postAssemble |
| boost::signals2::signal< void(makVrv::DtDe &)> | signal_deInitialized |
| boost::signals2::signal< void()> | signal_preLoadPlugins |
| boost::signals2::signal< void()> | signal_postLoadPlugins |
| boost::signals2::signal< void()> | signal_preWriteGuiConfiguration |
| boost::signals2::signal< void()> | signal_postWriteGuiConfiguration |
| boost::signals2::signal< void(std::string)> | signal_terrainSaved |
| boost::signals2::signal< void(std::string)> | signal_simTerrainSaved |
| boost::signals2::signal< void()> | signal_defaultLayoutLoaded |
| boost::signals2::signal< void()> | signal_vrfApplicationInitialized |
| boost::signals2::signal< void()> | signal_dataDoesNotExist |
| boost::signals2::signal< void()> | signal_qtExtensionsPreInitialize |
| boost::signals2::signal< void()> | signal_qtExtensionsPostInitialize |
Protected Attributes | |
| DtVrfGuiPluginManager * | myVrfGuiPluginManager |
| std::string | myPluginApplication |
| std::string | myVrfSvnRevision |
| std::string | myVrvSvnRevision |
| bool | myLoadSystemPlugins |
| boost::signals2::scoped_connection | myDelayedAssembleConnection |
Protected Attributes inherited from makVrv::DtVrvApplication | |
| DtVrvApplicationConfiguration | myConfiguration |
| DtDeInitializer | myInitializer |
| DtVrvCommandLineProcessor * | myCommandLineProcessor |
| DtDe * | myDe |
| DtPluginManager * | myPluginManager |
| DtEventLoop * | myEventLoop |
| InitializerTransformList | myPrePluginTransforms |
| InitializerTransformList | myPostPluginTransforms |
| InitializerTransformList | myPostAssembleTransforms |
| DtSignalConnectionManager * | myConnections |
| bool | myIsSceneLoading |
| std::list< std::string > | myRecentTerrainsList |
Additional Inherited Members | |
Static Public Attributes inherited from makVrv::DtVrvApplication | |
| static const int | MAX_RECENT_TERRAIN_COUNT = 20 |
Protected Types inherited from makVrv::DtVrvApplication | |
| typedef std::list< std::pair < std::string, ApplicationTransform > > | InitializerTransformList |
| typedef std::map<std::string, std::string> makVrf::DtVrfGuiApplication::ObserverModeBindings |
| makVrf::DtVrfGuiApplication::DtVrfGuiApplication | ( | makVrv::DtVrvApplicationConfiguration & | config | ) |
Constructor to the VRFGUI application.
| config | Configuration to load |
|
virtual |
Destructor to the VRFGUI application.
|
static |
Will return true if the application is destructing.
Create the GUI, initialize the DtDe. Call before calling run(). Call preInitialize before this.
Reimplemented in DtSimulationObjectEditorApplication, and DtParameterAlteringApplication.
Pre-initialize Call before calling initialize().
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtParameterAlteringApplication.
|
overridevirtual |
No-op. delayedAssemble is called when de has been post initialized.
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtSimulationObjectEditorApplication, and DtParameterAlteringApplication.
|
virtual |
Runs the application. Signals deInitialized if application has started successfully.
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtParameterAlteringApplication.
|
static |
|
static |
|
static |
If this is running only as a Qt plugin.
|
static |
|
static |
Set whether to use appData directory to load spot report element definitions.
|
static |
|
static |
Sets the name of additional spot report elements definition hierarchy (.hier) files (or dirs with .hier files) to merge after the spot report element definitions are loaded.
|
static |
|
static |
Sets the name of additional spot report element definition hierarchy (.leaf) files (or dirs with .leaf files) to merge after the spot report element definitions are loaded.
|
static |
|
static |
Sets whether or not to ignore setting layout geometry on initial load regardless of what it is set at and to always start maximized.
|
static |
|
static |
Sets the initial perspective to show for ground truth. Current valid values are Friendly, Opposing, Neutral, None. This is the same as selecting the particular value from the pulldown in the spot report options dialog. This will show ground truth and spot reports for the given object.
|
static |
Sets whether or not to allow Qt designer plugin support from the applicaiton. Default is true. This must be set at initialization time.
|
static |
|
static |
Sets the gui configuration file to use. If the file does not exist then the default built in configuration will be used. Assumed to be in the settings directory unless a directory is specified.
|
static |
Sets the observer mode bindings to a different set of bindings.
| modes | Modes to set the observer to |
|
static |
Gets the current observer mode bindings that are set.
|
static |
Gets a list of additional plugins to be loaded or were loaded by loadPluginModules()
|
static |
Sets the list of additional plugins to be loaded by loadPluginModules()
| aVector | a std::vector of std::string with the name of the plugins |
|
static |
Gets whether the default plugins should be loaded or not.
|
static |
Sets whether the default plugins were loaded or not.
| value | of true or false |
|
static |
Gets whether to check the plugin versions or not.
|
static |
Sets whether to check the plugin versions or not.
| value | true or false |
|
static |
Gets the transport string.
|
static |
Sets the transport string.
| value | the transport |
|
static |
Gets the currently loaded scenario name. Will return an empty string if no scenario is loaded.
|
static |
Sets the currently loaded scenario name.
| value | the name of the scenario loaded |
|
static |
If empty use this file comm channel as a listener in the scenario manager class.
|
static |
|
static |
UI Layout settings file to use (base name at which default_ will be prepended and .uisx appended)
|
static |
|
virtual |
Returns the class name from the layout settings file.
|
static |
Gets the currently loaded simulation object group name. Will return an empty string if no simulation object group is loaded.
|
static |
Sets the currently loaded simulation object group name.
| value | the name of the simulation object group loaded |
|
static |
Sets the default simulation model set to use. Will override any setting within the session settings file.
|
static |
|
static |
Gets the current observer mode.
|
static |
Sets the current observer mode.
| value | The observer mode |
|
static |
Sets the user scenario directory. Use the application class method to return the actual directory as the de is needed for the path configuration to get a resolved user scenario path (if the given path is blank, which means default)
|
virtual |
| void makVrf::DtVrfGuiApplication::setPluginApplication | ( | const std::string & | ) |
Sets the plugin application name.
| value | string name |
| const std::string& makVrf::DtVrfGuiApplication::pluginApplication | ( | ) | const |
Gets the plugin application name.
|
static |
Set to false to not load gui saved state. This must be called before the application object initialized.
|
static |
|
virtual |
If set to false does not load any plugins from the plugins directory. Default is true.
|
virtual |
|
virtual |
Returns the application name as defined in the configuration.
|
virtual |
Override to send out pre/post write gui configuration signals.
Reimplemented from makVrv::DtVrvApplication.
|
virtual |
Override to not load if not loading gui saved state.
Reimplemented from makVrv::DtVrvApplication.
|
virtual |
Return false to now show Vantage version of the startup screen.
Reimplemented from makVrv::DtVrvApplication.
|
virtual |
Returns true if driver is using absolute time stamping.
|
virtual |
|
virtual |
Returns true if driver is using asynchronous io.
|
virtual |
Gets the communications driver.
|
virtual |
The front end simulation address of this front-end.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
inline |
|
inline |
|
inline |
|
inline |
Returns true if there is a valid terrain (patches, ocean layer, featuer layer)
|
virtual |
Language code application is using.
|
virtual |
Given a model definition name and a file path, create the model definition with the given file path. If the definition exists but the file name in the definition does not, replaces with the given file path.
|
virtual |
Before loading a plugin in the library, make this callback (by lowercase library name without the extension, so, vrfhla1516eplugin, for example) and return false if this plugin does not want to be loaded.
|
overrideprotectedvirtual |
Override to set up additional plugins to load. Based on what is returned if one were to call additionalPluginsToLoad() to see what would be loaded.
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtSimulationObjectEditorApplication.
|
protectedvirtual |
Reimplement this method to load additional plugin modules (read from the .xml files) after all core plugin modules. This way the plugins do not have to call individual init() methods in core plugin modules to make sure they get initialized first.
Reimplemented in DtParameterAlteringApplication.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Reimplemented in DtParameterAlteringApplication.
|
protectedvirtual |
Initializes the plugin manager.
|
protectedvirtual |
Called to load plugins and initilize for command line arguments only.
|
protectedvirtual |
Given the list, binds the observers (if they exist) to the visual mode.
| modes | ObserverModeBindings list |
|
protectedvirtual |
Creates and returns the plugin manager for VRF plugins. Will work with the configuration to determine which additional plugins to load. Will use the plugins directory as the source for reading in .xml files that will determine which additional plugins to load.
|
protectedvirtual |
Called during the post initialize process of the de, initialize some things before drivers get initialized.
Reimplemented in DtParameterAlteringApplication.
|
protectedvirtual |
Called to set up Gui configuration and settings based on current observer mode selection. Experimental as of 4.0.
|
protectedvirtual |
Sets up GUI for PVD mode only. Experimental as of 4.0.
|
protectedvirtual |
Sets up for Stealth only. Experimental as of 4.0.
|
protectedvirtual |
Updates the current GUI configuration with the current UI layout status.
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtParameterAlteringApplication.
|
protectedvirtual |
Initializes decoration sets with VRF specific items.
| boost::signals2::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> makVrf::DtVrfGuiApplication::signal_preAssemble |
| boost::signals2::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> makVrf::DtVrfGuiApplication::signal_postAssemble |
| boost::signals2::signal<void (makVrv::DtDe&)> makVrf::DtVrfGuiApplication::signal_deInitialized |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_preLoadPlugins |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_postLoadPlugins |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_preWriteGuiConfiguration |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_postWriteGuiConfiguration |
| boost::signals2::signal<void (std::string)> makVrf::DtVrfGuiApplication::signal_terrainSaved |
| boost::signals2::signal<void (std::string)> makVrf::DtVrfGuiApplication::signal_simTerrainSaved |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_defaultLayoutLoaded |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_vrfApplicationInitialized |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_dataDoesNotExist |
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_qtExtensionsPreInitialize |
Signals sent via the qt extension initialization.
| boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_qtExtensionsPostInitialize |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |