The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication. More...

Inheritance diagram for makVrf::DtVrfGuiApplication:

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.
void	setPluginApplication (const std::string &)
	Sets the plugin application name.
const std::string &	pluginApplication () const
	Gets the plugin application name.
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 void	writeGuiConfiguration ()
	Writes the toolbars and panels layout in the UI so they can be restored next time the app is loaded.
virtual bool	updateCurrentGuiConfiguration ()
	Updates the current GUI configuration with the current UI layout status.
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 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 ObserverMode	observerMode ()
	Gets the current observer mode.
static void	setObserverMode (ObserverMode)
	Sets the current observer mode.
Static Public Member Functions inherited from makVrv::DtVrvApplication
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

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	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 void	setupAdditionalVisualizers ()
	Set up any additional visualizers VR-Forces needs, for example, Range rings.
virtual void	setupBoundingVolumes ()
	Sets up bounding volumes for entities.
virtual void	setupObjectConsoleWarngForTacticalGraphics ()
	Sets up object console warning visualizer for tactical graphics.
virtual void	setupBoundingVolumes (const std::string &root)
	Sets up the bounding volumes to be under a particular root node.
virtual void	setupRangeRings ()
	Sets up range ring items.
virtual void	setupAdditionalAggregateVisualizers ()
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	loadSavedGuiState ()
	Load saved gui state from the default UI layout file.

Protected Attributes
DtVrfGuiPluginManager *	myVrfGuiPluginManager
std::string	myPluginApplication
std::map < makVrv::DtElementDefinitionManager *, bool >	myModifiedManagers
	Managers that are modified as part of the start-up process that need to be saved out.
Protected Attributes inherited from makVrv::DtVrvApplication
DtVrvApplicationConfiguration	myConfiguration
DtDeInitializer	myInitializer
DtVrvCommandLineProcessor *	myCommandLineProcessor
DtDe *	myDe
DtPluginManager *	myPluginManager
DtEventLoop *	myEventLoop
InitializerTransformMap	myPrePluginTransforms
InitializerTransformMap	myPostPluginTransforms
InitializerTransformMap	myPostAssembleTransforms

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 ObserverMode	theObserverMode

Additional Inherited Members
Protected Types inherited from makVrv::DtVrvApplication
typedef std::map< std::string, ApplicationTransform >	InitializerTransformMap

Detailed Description

The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication.

Member Typedef Documentation

typedef std::map<std::string, std::string> makVrf::DtVrfGuiApplication::ObserverModeBindings

Member Enumeration Documentation

enum makVrf::DtVrfGuiApplication::ObserverMode

Enumerator:

PvdAndStealthMode
PvdMode
StealthMode

Constructor & Destructor Documentation

makVrf::DtVrfGuiApplication::DtVrfGuiApplication ( makVrv::DtVrvApplicationConfiguration & config )

Constructor to the VRFGUI application.

Parameters

config Configuration to load

virtual makVrf::DtVrfGuiApplication::~DtVrfGuiApplication ( )

virtual

Destructor to the VRFGUI application.

Member Function Documentation

virtual void makVrf::DtVrfGuiApplication::initialize	(	int	argc,
		char **	argv
	)

virtual

Initializes the application with the given command line options.

Parameters

argc	command line args
argv	command line args

Reimplemented from makVrv::DtVrvApplication.

virtual void makVrf::DtVrfGuiApplication::assemble ( )

virtual

Assembles the application and signals the pre and post of the assembly process.

Reimplemented from makVrv::DtVrvApplication.

virtual void makVrf::DtVrfGuiApplication::run ( )

virtual

Runs the application. Signals deInitialized if application has started successfully.

Reimplemented from makVrv::DtVrvApplication.

static void makVrf::DtVrfGuiApplication::setObserverModeBindings ( const ObserverModeBindings & modes )

static

Sets the observer mode bindings to a different set of bindings.

Parameters

modes Modes to set the observer to

static const ObserverModeBindings& makVrf::DtVrfGuiApplication::observerModeBindings ( )

static

Gets the current observer mode bindings that are set.

Returns: Current observer mode bindings.

static const std::vector<std::string>& makVrf::DtVrfGuiApplication::additionalPluginsToLoad ( )

static

Gets a list of additional plugins to be loaded or were loaded by loadPluginModules()

Returns: a std::vector of std::string with the name of the plugins

static void makVrf::DtVrfGuiApplication::setAdditionalPluginsToLoad ( const std::vector< std::string > & )

static

Sets the list of additional plugins to be loaded by loadPluginModules()

Parameters

aVector a std::vector of std::string with the name of the plugins

static bool makVrf::DtVrfGuiApplication::loadDefaultPlugins ( )

static

Gets whether the default plugins should be loaded or not.

Returns: true if it was set to true, false otherwise

static void makVrf::DtVrfGuiApplication::setLoadDefaultPlugins ( bool )

static

Sets whether the default plugins were loaded or not.

Parameters

value of true or false

static bool makVrf::DtVrfGuiApplication::checkPluginVersions ( )

static

Gets whether to check the plugin versions or not.

Returns: true if should check plugin versions, false otherwise

static void makVrf::DtVrfGuiApplication::setCheckPluginVersions ( bool )

static

Sets whether to check the plugin versions or not.

Parameters

value true or false

static const std::string& makVrf::DtVrfGuiApplication::transport ( )

static

Gets the transport string.

Returns: String of the transport

static void makVrf::DtVrfGuiApplication::setTransport ( const std::string & )

static

Sets the transport string.

Parameters

value the transport

static const std::string& makVrf::DtVrfGuiApplication::loadScenario ( )

static

Gets the currently loaded scenario name.

Will return an empty string if no scenario is loaded.

Returns: the name of the scenario loaded

static void makVrf::DtVrfGuiApplication::setLoadScenario ( const std::string & )

static

Sets the currently loaded scenario name.

Parameters

value the name of the scenario loaded

static ObserverMode makVrf::DtVrfGuiApplication::observerMode ( )

static

Gets the current observer mode.

Returns: The observer mode

static void makVrf::DtVrfGuiApplication::setObserverMode ( ObserverMode )

static

Sets the current observer mode.

Parameters

value The observer mode

void makVrf::DtVrfGuiApplication::setPluginApplication ( const std::string & )

Sets the plugin application name.

Parameters

value string name

const std::string& makVrf::DtVrfGuiApplication::pluginApplication ( ) const

Gets the plugin application name.

Returns: String name of plugin application

virtual void makVrf::DtVrfGuiApplication::loadPluginModules ( )

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.

virtual void makVrf::DtVrfGuiApplication::loadPluginModulesExt ( )

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

virtual void makVrf::DtVrfGuiApplication::bindObserverModes ( const ObserverModeBindings & modes )

protectedvirtual

Given the list, binds the observers (if they exist) to the visual mode.

Parameters

modes ObserverModeBindings list

virtual DtVrfGuiPluginManager* makVrf::DtVrfGuiApplication::createPluginManager ( )

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

Returns: Pointer to the plugin manager

virtual void makVrf::DtVrfGuiApplication::dePostInitialize ( )

protectedvirtual

Called during the post initialize process of the de, initialize some things before drivers get initialized.

virtual void makVrf::DtVrfGuiApplication::setupForObserverMode ( )

protectedvirtual

Called to set up Gui configuration and settings based on current observer mode selection.

Experimental as of 4.0

virtual void makVrf::DtVrfGuiApplication::setupForPvdMode ( )

protectedvirtual

Sets up GUI for PVD mode only. Experimental as of 4.0.

virtual void makVrf::DtVrfGuiApplication::setupForStealthMode ( )

protectedvirtual

Sets up for Stealth only. Experimental as of 4.0.

virtual void makVrf::DtVrfGuiApplication::setupAdditionalVisualizers ( )

protectedvirtual

Set up any additional visualizers VR-Forces needs, for example, Range rings.

virtual void makVrf::DtVrfGuiApplication::setupBoundingVolumes ( )

protectedvirtual

Sets up bounding volumes for entities.

virtual void makVrf::DtVrfGuiApplication::setupObjectConsoleWarngForTacticalGraphics ( )

protectedvirtual

Sets up object console warning visualizer for tactical graphics.

virtual void makVrf::DtVrfGuiApplication::setupBoundingVolumes ( const std::string & root )

protectedvirtual

Sets up the bounding volumes to be under a particular root node.

virtual void makVrf::DtVrfGuiApplication::setupRangeRings ( )

protectedvirtual

Sets up range ring items.

virtual void makVrf::DtVrfGuiApplication::setupAdditionalAggregateVisualizers ( )

protectedvirtual

Member Data Documentation

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

ObserverModeBindings makVrf::DtVrfGuiApplication::theObserverModeBindings

staticprotected

std::vector<std::string> makVrf::DtVrfGuiApplication::theAdditionalPluginsToLoad

staticprotected

bool makVrf::DtVrfGuiApplication::theLoadDefaultPlugins

staticprotected

bool makVrf::DtVrfGuiApplication::theCheckPluginVersions

staticprotected

std::string makVrf::DtVrfGuiApplication::theTransport

staticprotected

std::string makVrf::DtVrfGuiApplication::theLoadScenario

staticprotected

ObserverMode makVrf::DtVrfGuiApplication::theObserverMode

staticprotected

DtVrfGuiPluginManager* makVrf::DtVrfGuiApplication::myVrfGuiPluginManager

protected

std::string makVrf::DtVrfGuiApplication::myPluginApplication

protected

std::map<makVrv::DtElementDefinitionManager*, bool> makVrf::DtVrfGuiApplication::myModifiedManagers

protected

Managers that are modified as part of the start-up process that need to be saved out.

The documentation for this class was generated from the following file:

include/vrfGuiCore/DtVrfGuiApplication.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation