![]() |
VR-Forces 4.6.1 Class Documentation
|
The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication. More...

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 |
| Type for a function object that transforms an app config in some way. | |
| typedef boost::function< void(DtDeInitializer &, DtDe &, DtVrvApplicationConfiguration &)> | ApplicationTransform |
| Type for a function object that transforms an DtDeInitializer, DtDe or DtVrvApplicationConfiguration in some way. | |
Public Member Functions | |
| DtVrfGuiApplication (makVrv::DtVrvApplicationConfiguration &config) | |
| Constructor to the VRFGUI application. | |
| virtual | ~DtVrfGuiApplication () |
| Destructor to the VRFGUI application. | |
| virtual void | initialize (int argc, char **argv) |
| Initializes the application with the given command line options. | |
| virtual void | assemble () |
| Assembles the application and signals the pre and post of the assembly process. | |
| virtual void | run () |
| Runs the application. Signals deInitialized if application has started successfully. | |
| virtual DtString | layoutSettingsFileClassName () const |
| Returns the class name from the layout settings file. | |
| void | setPluginApplication (const std::string &) |
| Sets the plugin application name. | |
| const std::string & | pluginApplication () const |
| Gets the plugin application name. | |
| virtual void | setLoadSystemPlugins (bool) |
| If set to false does not load any plugins from the plugins directory. Default is true. | |
| virtual bool | loadSystemPlugins () const |
| virtual makVrv::DtUnicode | applicationName () const |
| Returns the application name as defined in the configuration. | |
| virtual void | writeGuiConfiguration () |
| Override to send out pre/post write gui configuration signals. | |
| virtual void | loadSavedGuiState () |
| Override to not load if not loading gui saved state. | |
| virtual bool | getShowStartupScreen () const |
| Return false to now show Vantage version of the startup screen. | |
| virtual bool | usingAbsoluteTimeStamps () const |
| Returns true if driver is using absolute time stamping. | |
| virtual bool | usingAsynchIO () const |
| Returns true if driver is using asynchronous io. | |
| virtual DtSimulationAddress | frontEndSimulationAddress () const |
| The front end simulation address of this front-end. | |
| virtual bool | vrlDriverHasBooleanValue (const std::string &) const |
| virtual int | vrlDriverHasIntegerValue (const std::string &) const |
| virtual std::string | vrlDriverHasStringValue (const std::string &) 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) |
| Returns true if there is a valid terrain (patches, ocean layer, featuer layer) | |
Public Member Functions inherited from makVrv::DtVrvApplication | |
| DtVrvApplication () | |
| Constructor. | |
| DtVrvApplication (const DtVrvApplicationConfiguration &appConfig) | |
| virtual | ~DtVrvApplication () |
| Destructor. | |
| DtVrvApplicationConfiguration & | configuration () |
| DtVrvApplicationConfiguration accessor. | |
| DtPageConfiguration & | masterModePageConfiguration () |
| Get the page configuration which may be altered by plugins. | |
| DtPageConfiguration & | slaveModePageConfiguration () |
| DtMenuConfiguration & | masterModeMenuConfiguration () |
| Get the menu configuration which may be altered by plugins. | |
| DtMenuConfiguration & | slaveModeMenuConfiguration () |
| DtToolbarConfiguration & | masterModeToolbarConfiguration () |
| Get the toolbar configuration which may be altered by plugins. | |
| DtToolbarConfiguration & | slaveModeToolbarConfiguration () |
| DtDe & | de () |
| DtDe accessor. | |
| virtual DtPluginManager & | pluginManager () |
| Provide access to the plugin manager. | |
| virtual void | slot_sceneTerrainLoaded (const DtUnicode &terrain) |
| slots for the DtScene signals so the scenes/terrains can get added to the recent terrains list | |
| 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) |
| Add a configuration transformer that runs at command line processor level priority. | |
| virtual void | installPrePluginTransform (const ApplicationTransform &transform, const std::string &id) |
| Add a transformer that runs before plug-ins are loaded. | |
| virtual void | installPostPluginTransform (const ApplicationTransform &transform, const std::string &id) |
| Add a transformer that runs after plug-ins are loaded. | |
| virtual void | installPostAssembleTransform (const ApplicationTransform &transform, const std::string &id) |
| Add a transformer that runs after the application is assembled and before the DtDe is initialized. | |
Static Public Member Functions | |
| static bool | applicationIsTerminating (makVrv::DtDe &) |
| Will return true if the application is destructing. | |
| static DtVrfGuiApplication * | app (makVrv::DtDe &) |
| static makVrv::DtDe * | theDe () |
| static void | setIgnoreLayoutGeometryOnInitialLoad (bool) |
| Sets whether or not to use VLD memory tracking. Only enabled is USE_VLD_MEMORY_TRACKING is enabled. | |
| static bool | ignoreLayoutGeometryOnInitialLoad () |
| static void | setShowPerspective (const std::string &) |
| Sets the initial perspective to show for ground truth. | |
| static void | setQtDesignerPluginSupport (bool) |
| Sets whether or not to allow Qt designer plugin support from the applicaiton. Default is true. This must be set at initialization time. | |
| static bool | qtDesignerPluginSupport () |
| static void | setGuiConfiguration (const std::string &) |
| Sets the gui configuration file to use. | |
| static void | setObserverModeBindings (const ObserverModeBindings &modes) |
| Sets the observer mode bindings to a different set of bindings. | |
| static const ObserverModeBindings & | observerModeBindings () |
| Gets the current observer mode bindings that are set. | |
| static const std::vector < std::string > & | additionalPluginsToLoad () |
| Gets a list of additional plugins to be loaded or were loaded by loadPluginModules() | |
| static void | setAdditionalPluginsToLoad (const std::vector< std::string > &) |
| Sets the list of additional plugins to be loaded by loadPluginModules() | |
| static bool | loadDefaultPlugins () |
| Gets whether the default plugins should be loaded or not. | |
| static void | setLoadDefaultPlugins (bool) |
| Sets whether the default plugins were loaded or not. | |
| static bool | checkPluginVersions () |
| Gets whether to check the plugin versions or not. | |
| static void | setCheckPluginVersions (bool) |
| Sets whether to check the plugin versions or not. | |
| static const std::string & | transport () |
| Gets the transport string. | |
| static void | setTransport (const std::string &) |
| Sets the transport string. | |
| static const std::string & | loadScenario () |
| Gets the currently loaded scenario name. | |
| static void | setLoadScenario (const std::string &) |
| Sets the currently loaded scenario name. | |
| static const std::string & | useFileCommChannel () |
| If empty use this file comm channel as a listener in the scenario manager class. | |
| static void | setUseFileCommChannel (const std::string &) |
| static void | setLayoutSettingsFile (const std::string &) |
| UI Layout settings file to use (base name at which default_ will be prepended and .uisx appended) | |
| static std::string | layoutSettingsFile () |
| static const std::string & | loadSimulationObjectGroup () |
| Gets the currently loaded simulation object group name. | |
| static void | setLoadSimulationObjectGroup (const std::string &) |
| Sets the currently loaded simulation object group name. | |
| static void | setDefaultSimulationModelSet (const std::string &) |
| Sets the default simulation model set to use. Will override any setting within the session settings file. | |
| static const std::string & | defaultSimulationModelSet () |
| static ObserverMode | observerMode () |
| Gets the current observer mode. | |
| static void | setObserverMode (ObserverMode) |
| Sets the current observer mode. | |
| static void | setShouldLoadGuiSavedState (bool) |
| Set to false to not load gui saved state. | |
| static bool | shouldLoadGuiSavedState () |
Static Public Member Functions inherited from makVrv::DtVrvApplication | |
| static DtVrvApplication * | get_last_instance () |
| Returns the last DtVrvApplication created, regardless of DtDe. | |
| static void | ShowSplashScreen (const std::string &imageName) |
| Show a brief splash screen. | |
| static void | ShowErrorMessage (const std::string &message, DtException *ex=0) |
| Show a brief splash screen. | |
| static DtVrvApplication * | findFromDe (DtDe &) |
| If an IG is created by an application you can find the IG application which created/owns it. | |
| static bool | parseDisplayEngineParameter (const std::string &argument, int &port, std::string &address, std::string &displayConfig) |
| Parse a display engine command line argument. | |
| static std::string | displayEngineParameterFormatting () |
| Get the format of the display engine parameter. | |
| static void | handleFileError (const std::string &filename, const std::string &fileType) |
| Handle when a file specified on the command line can't be read. | |
| static void | bindViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap) |
| Places all views into the supplied observer view map and binds to the supplied observer view. | |
| static bool | loadObserverStateRecords (const std::string &file, makArchives::DtObserverStateRecordsList &list) |
| Loads up observer state records from filename into specified list. | |
| static void | loadViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap) |
| Places all views into the supplied observer view map. | |
Public Attributes | |
| boost::signal< void(makVrv::DtDe &, makVrv::DtMenuConfiguration &)> | signal_preAssemble |
| boost::signal< void(makVrv::DtDe &, makVrv::DtMenuConfiguration &)> | signal_postAssemble |
| boost::signal< void(makVrv::DtDe &)> | signal_deInitialized |
| boost::signal< void()> | signal_preLoadPlugins |
| boost::signal< void()> | signal_postLoadPlugins |
| boost::signal< void()> | signal_preWriteGuiConfiguration |
| boost::signal< void()> | signal_postWriteGuiConfiguration |
| boost::signal< void(std::string)> | signal_terrainSaved |
| boost::signal< void(std::string)> | signal_simTerrainSaved |
| boost::signal< void()> | signal_defaultLayoutLoaded |
| boost::signal< void()> | signal_qtExtensionsPreInitialize |
| Signals sent via the qt extension initialization. | |
| boost::signal< void()> | signal_qtExtensionsPostInitialize |
Protected Member Functions | |
| virtual void | loadPluginModules () |
| Override to set up additional plugins to load. | |
| virtual void | loadPluginModulesExt () |
| Reimplement this method to load additional plugin modules (read from the .xml files) after all core plugin modules. | |
| virtual void | initializePluginManager () |
| Initializes the plugin manager. | |
| virtual void | initializePluginsForCommandLineArguments (int argc, char **argv) |
| Called to load plugins and initilize for command line arguments only. | |
| virtual void | bindObserverModes (const ObserverModeBindings &modes) |
| Given the list, binds the observers (if they exist) to the visual mode. | |
| virtual DtVrfGuiPluginManager * | createPluginManager () |
| Creates and returns the plugin manager for VRF plugins. | |
| virtual void | dePostInitialize () |
| Called during the post initialize process of the de, initialize some things before drivers get initialized. | |
| virtual void | setupForObserverMode () |
| Called to set up Gui configuration and settings based on current observer mode selection. | |
| virtual void | setupForPvdMode () |
| Sets up GUI for PVD mode only. Experimental as of 4.0. | |
| virtual void | setupForStealthMode () |
| Sets up for Stealth only. Experimental as of 4.0. | |
| virtual bool | updateCurrentGuiConfiguration () |
| Updates the current GUI configuration with the current UI layout status. | |
Protected Member Functions inherited from makVrv::DtVrvApplication | |
| virtual void | createDefaultDisplayEngineConfiguration () |
| Create default engine configurations if none exist. | |
| virtual DtDisplayConfiguration | embeddedMasterDisplayConfig () |
| Helper method that returns an embedded display config. | |
| virtual void | createDefaultObserverConfiguration () |
| Create default observer configurations if none exist. | |
| virtual void | addRecentTerrain (const std::string &terrain) |
| add a terrain/scene to the list of recent terrains. | |
Protected Attributes | |
| DtVrfGuiPluginManager * | myVrfGuiPluginManager |
| std::string | myPluginApplication |
| std::string | myVrfSvnRevision |
| std::string | myVrvSvnRevision |
| bool | myLoadSystemPlugins |
Protected Attributes inherited from makVrv::DtVrvApplication | |
| DtVrvApplicationConfiguration | myConfiguration |
| DtDeInitializer | myInitializer |
| DtVrvCommandLineProcessor * | myCommandLineProcessor |
| DtDe * | myDe |
| DtPluginManager * | myPluginManager |
| DtEventLoop * | myEventLoop |
| InitializerTransformMap | myPrePluginTransforms |
| InitializerTransformMap | myPostPluginTransforms |
| InitializerTransformMap | myPostAssembleTransforms |
| DtSignalConnectionManager * | myConnections |
| bool | myIsSceneLoading |
Static Protected Attributes | |
| static ObserverModeBindings | theObserverModeBindings |
| static std::vector< std::string > | theAdditionalPluginsToLoad |
| static bool | theLoadDefaultPlugins |
| static bool | theCheckPluginVersions |
| static std::string | theTransport |
| static std::string | theLoadScenario |
| static std::string | theLayoutSettingsFile |
| static std::string | theLoadSimulationObjectGroup |
| static std::string | theUseFileCommChannel |
| static std::string | theGuiConfiguration |
| static std::string | theShowPerspective |
| static std::string | theDefaultSimulationModelSet |
| static ObserverMode | theObserverMode |
| static bool | theLoadGuiSavedState |
| static bool | theIgnoreLayoutGeometryOnInitialLoad |
| static bool | theQtDesignerPluginSupport |
Static Protected Attributes inherited from makVrv::DtVrvApplication | |
| static DtVrvApplication * | sLastAppInstance |
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::map< std::string, ApplicationTransform > | InitializerTransformMap |
The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication.
| 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.
Initializes the application with the given command line options.
| argc | command line args |
| argv | command line args |
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtSimulationObjectEditorApplication, DtParameterAlteringApplication, and DtVrfOpdEditorApplication.
|
virtual |
Assembles the application and signals the pre and post of the assembly process.
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtParameterAlteringApplication.
|
virtual |
Runs the application. Signals deInitialized if application has started successfully.
Reimplemented from makVrv::DtVrvApplication.
Reimplemented in DtParameterAlteringApplication.
|
static |
Reimplemented in DtSimulationObjectEditorApplication, DtParameterAlteringApplication, and DtVrfOpdEditorApplication.
|
static |
|
static |
Sets whether or not to use VLD memory tracking. Only enabled is USE_VLD_MEMORY_TRACKING is enabled.
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 |
| 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 |
Returns true if driver is using asynchronous io.
|
virtual |
The front end simulation address of this front-end.
|
virtual |
|
virtual |
|
virtual |
|
inline |
|
inline |
|
inline |
|
inline |
Returns true if there is a valid terrain (patches, ocean layer, featuer layer)
|
protectedvirtual |
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.
|
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 |
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.
| boost::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> makVrf::DtVrfGuiApplication::signal_preAssemble |
| boost::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> makVrf::DtVrfGuiApplication::signal_postAssemble |
| boost::signal<void (makVrv::DtDe&)> makVrf::DtVrfGuiApplication::signal_deInitialized |
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_preLoadPlugins |
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_postLoadPlugins |
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_preWriteGuiConfiguration |
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_postWriteGuiConfiguration |
| boost::signal<void (std::string)> makVrf::DtVrfGuiApplication::signal_terrainSaved |
| boost::signal<void (std::string)> makVrf::DtVrfGuiApplication::signal_simTerrainSaved |
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_defaultLayoutLoaded |
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_qtExtensionsPreInitialize |
Signals sent via the qt extension initialization.
| boost::signal<void ()> makVrf::DtVrfGuiApplication::signal_qtExtensionsPostInitialize |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |