VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtParameterAlteringApplication Class Reference

Fairly specific application used by entity editor and opd editor as a common class for modifying parameter databases. More...

Inheritance diagram for DtParameterAlteringApplication:
Inheritance graph
[legend]

Public Member Functions

 DtParameterAlteringApplication (makVrv::DtVrvApplicationConfiguration &config)
 Constructor.
virtual ~DtParameterAlteringApplication ()
 Destructor.
virtual void initialize (int argc, char **argv)
 Initializes the application with the given command line options and replaces main window.
virtual std::string startupValue (const std::string &) const
 Returns a value that is set at startup to use in the application.
virtual void setStartupValue (const std::string &key, const std::string &value)
 Sets a startup value, replacing any that exists.
virtual void run ()
 Runs the application. Signals deInitialized if application has started successfully.
virtual void setMainWindowCreatorFunction (makVrv::DtDeMainWindowProvider *)
 MUST be called to create a new main window of the appropriate type.
virtual void addParameterType (const char *controllerName, const char *likeUi, DtSimObjectParametersCreatorFcn fcn=NULL)
 Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.
virtual void addController (const char *controllerName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)
 Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.
virtual void addSensor (const char *sensorName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)
 Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.
virtual void addActuator (const char *actuatorName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)
 Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.
virtual void addUserExtentsion (const DtString &type, DtVrfSRUserExtensionCreatorFcn fcn)
 Add a creator for user extension SR.
- Public Member Functions inherited from makVrf::DtVrfGuiApplication
 DtVrfGuiApplication (makVrv::DtVrvApplicationConfiguration &config)
 Constructor to the VRFGUI application.
virtual ~DtVrfGuiApplication ()
 Destructor to the VRFGUI application.
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

Static Public Member Functions

static
DtParameterAlteringApplication
app (makVrv::DtDe &)
 Returns a pointer to this object given the de.
- Static Public Member Functions inherited from makVrf::DtVrfGuiApplication
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 ObserverModeBindingsobserverModeBindings ()
 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.

Protected Member Functions

virtual void setupMenu ()=0
 Sets up a menu.
virtual void assemble ()
 Assembles the application and signals the pre and post of the assembly process.
virtual void dePostInitialize ()
 Called during the post initialize process of the de, initialize some things before drivers get initialized.
virtual void loadPluginModulesExt ()
 Calls setupMenu()
- Protected Member Functions inherited from makVrf::DtVrfGuiApplication
virtual void loadPluginModules ()
 Override to set up additional plugins to load.
virtual void bindObserverModes (const ObserverModeBindings &modes)
 Given the list, binds the observers (if they exist) to the visual mode.
virtual DtVrfGuiPluginManagercreatePluginManager ()
 Creates and returns the plugin manager for VRF plugins.
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 ()
virtual void loadSavedGuiState ()
 Keep toolbar and page configurations from gui configuration.

Protected Attributes

std::map< std::string,
std::string > 
myStartupValues
std::map< DtString, DtVectormyVisualPlacements
- Protected Attributes inherited from makVrf::DtVrfGuiApplication
DtVrfGuiPluginManagermyVrfGuiPluginManager
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.
bool myLoadSystemPlugins

Additional Inherited Members

- Public Types inherited from makVrf::DtVrfGuiApplication
enum  ObserverMode { PvdAndStealthMode = 0, PvdMode, StealthMode }
typedef std::map< std::string,
std::string > 
ObserverModeBindings
- Public Attributes inherited from makVrf::DtVrfGuiApplication
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(std::string)> signal_terrainSaved
- Static Protected Attributes inherited from makVrf::DtVrfGuiApplication
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 theGuiConfiguration
static ObserverMode theObserverMode

Detailed Description

Fairly specific application used by entity editor and opd editor as a common class for modifying parameter databases.

Constructor & Destructor Documentation

DtParameterAlteringApplication::DtParameterAlteringApplication ( makVrv::DtVrvApplicationConfiguration &  config)

Constructor.

virtual DtParameterAlteringApplication::~DtParameterAlteringApplication ( )
virtual

Destructor.

Member Function Documentation

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

Initializes the application with the given command line options and replaces main window.

Parameters
argccommand line args
argvcommand line args

Reimplemented from makVrf::DtVrfGuiApplication.

Reimplemented in DtEntityEditorApplication.

virtual std::string DtParameterAlteringApplication::startupValue ( const std::string &  ) const
virtual

Returns a value that is set at startup to use in the application.

Valid values are: uiFile - ui file to use. Default is ../appData/settings/entityEditor/entityEditorUi.mtl

virtual void DtParameterAlteringApplication::setStartupValue ( const std::string &  key,
const std::string &  value 
)
virtual

Sets a startup value, replacing any that exists.

static DtParameterAlteringApplication* DtParameterAlteringApplication::app ( makVrv::DtDe &  )
static

Returns a pointer to this object given the de.

Reimplemented from makVrf::DtVrfGuiApplication.

Reimplemented in DtEntityEditorApplication.

virtual void DtParameterAlteringApplication::run ( )
virtual

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

Reimplemented from makVrf::DtVrfGuiApplication.

virtual void DtParameterAlteringApplication::setMainWindowCreatorFunction ( makVrv::DtDeMainWindowProvider *  )
virtual

MUST be called to create a new main window of the appropriate type.

virtual void DtParameterAlteringApplication::addParameterType ( const char *  controllerName,
const char *  likeUi,
DtSimObjectParametersCreatorFcn  fcn = NULL 
)
virtual

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe) If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addController ( const char *  controllerName,
const char *  descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
)
virtual

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe) If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addSensor ( const char *  sensorName,
const char *  descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
)
virtual

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe) If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addActuator ( const char *  actuatorName,
const char *  descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
)
virtual

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe) If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addUserExtentsion ( const DtString type,
DtVrfSRUserExtensionCreatorFcn  fcn 
)
virtual

Add a creator for user extension SR.

virtual void DtParameterAlteringApplication::setupMenu ( )
protectedpure virtual

Sets up a menu.

Implemented in DtEntityEditorApplication.

virtual void DtParameterAlteringApplication::assemble ( )
protectedvirtual

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

Reimplemented from makVrf::DtVrfGuiApplication.

virtual void DtParameterAlteringApplication::dePostInitialize ( )
protectedvirtual

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

Reimplemented from makVrf::DtVrfGuiApplication.

virtual void DtParameterAlteringApplication::loadPluginModulesExt ( )
protectedvirtual

Calls setupMenu()

Reimplemented from makVrf::DtVrfGuiApplication.

Member Data Documentation

std::map<std::string, std::string> DtParameterAlteringApplication::myStartupValues
protected
std::map<DtString, DtVector> DtParameterAlteringApplication::myVisualPlacements
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)