makVrf::DtVrfGuiApplication Class Reference

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

Inheritance diagram for makVrf::DtVrfGuiApplication:

List of all members.

Public Types
enum	ObserverMode { PvdAndStealthMode = 0, PvdMode, StealthMode }
typedef std::map< std::string, std::string >	ObserverModeBindings
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.
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.
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	setupIndirectFire ()
	Sets up indirect fire items (circle/ellipse)
virtual void	setupBoundingVolumes ()
	Sets up bounding volumes for entities.
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 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.
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

---

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

(

)

[protected, virtual]

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

(

)

[protected, virtual]

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

)

[protected, virtual]

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

Parameters:

modes

ObserverModeBindings list

virtual DtVrfGuiPluginManager* makVrf::DtVrfGuiApplication::createPluginManager

(

)

[protected, virtual]

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

(

)

[protected, virtual]

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

virtual void makVrf::DtVrfGuiApplication::setupForObserverMode

(

)

[protected, virtual]

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

Experimental as of 4.0

virtual void makVrf::DtVrfGuiApplication::setupForPvdMode

(

)

[protected, virtual]

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

virtual void makVrf::DtVrfGuiApplication::setupForStealthMode

(

)

[protected, virtual]

Sets up for Stealth only. Experimental as of 4.0.

virtual void makVrf::DtVrfGuiApplication::setupAdditionalVisualizers

(

)

[protected, virtual]

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

virtual void makVrf::DtVrfGuiApplication::setupIndirectFire

(

)

[protected, virtual]

Sets up indirect fire items (circle/ellipse)

virtual void makVrf::DtVrfGuiApplication::setupBoundingVolumes

(

)

[protected, virtual]

Sets up bounding volumes for entities.

virtual void makVrf::DtVrfGuiApplication::setupBoundingVolumes

(

const std::string &

root

)

[protected, virtual]

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

virtual void makVrf::DtVrfGuiApplication::setupRangeRings

(

)

[protected, virtual]

Sets up range ring items.

virtual void makVrf::DtVrfGuiApplication::setupAdditionalAggregateVisualizers

(

)

[protected, virtual]

---

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 [static, protected]

std::vector<std::string> makVrf::DtVrfGuiApplication::theAdditionalPluginsToLoad [static, protected]

bool makVrf::DtVrfGuiApplication::theLoadDefaultPlugins [static, protected]

bool makVrf::DtVrfGuiApplication::theCheckPluginVersions [static, protected]

std::string makVrf::DtVrfGuiApplication::theTransport [static, protected]

std::string makVrf::DtVrfGuiApplication::theLoadScenario [static, protected]

ObserverMode makVrf::DtVrfGuiApplication::theObserverMode [static, protected]

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