VR-Forces 4.0.4 Class Documentation
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtTMAppOptions Class Reference
Inheritance diagram for DtTMAppOptions:
Inheritance graph
[legend]

List of all members.

Public Slots

virtual void setDisplayOptions (const DtTMDisplayOptions *o)
 Slots.

Signals

void displayOptionsChanged (const DtTMDisplayOptions *o)
 Signals.

Public Member Functions

 DtTMAppOptions (int argc, char **argv)
 Default constructor.
virtual ~DtTMAppOptions ()
 Destructor.
virtual bool init (const DtTMFactory *f)
 Initializer.
virtual void parseCommandLine ()
 This function will parse out and process all command line options.
virtual QString language () const
virtual void setLanguage (const QString &s)
virtual void processConfigFile (const QString &)
 This function will process a configuration file.
virtual void readConfigurationFiles ()
 This function will read a configuration file and set all of the appropriate values in the options object.
virtual void clearFiles ()
 Clears out any files held in arrays (translation, mtl, etc). Default does nothing.
virtual bool usingGlobalMiniMap ()
 Returns true if global minimap was specified.
virtual void setUsingGlobalMiniMap (bool)
virtual QString defaultConfigFile () const
 Returns the name of the default configuration file.
virtual void setDefaultConfigFile (const QString &)
virtual DtTMDisplayOptionsdisplayOptions () const
 Returns a pointer to the global display options.
virtual void setSettingsFile (const QString &file)
 Sets the settings file. Default is ...mtl.
virtual QString settingsFile () const
virtual void setDoNotUseSettingsFile (bool b)
 Set to true to not save out or load settings.
virtual bool doNotUseSettingsFile () const
virtual void setDoNotUsePluginsDirectory (bool b)
 Set to true to not read files from the plugins directory.
virtual bool doNotUsePluginsDirectory () const
virtual void setQtAssistantLocation (const QString &loc)
 Qt assistant help usage information. By default is false (uses browser)
virtual QString qtAssistantLocation () const
virtual void setQtHelpFile (const QString &loc)
virtual QString qtHelpFile () const
virtual void setShowMaximized (bool b)
 Used only for archival purposes.
virtual bool showMaximized () const
virtual void setWindowGeometry (const QRect &r)
virtual const QRect & windowGeometry () const
virtual void initCommandOptions ()
virtual void initMtlData ()
virtual const std::vector
< DtString > & 
symbolMapFiles () const
virtual std::vector< DtString > & symbolMapFiles ()
virtual const std::vector
< DtString > & 
translationFiles () const
virtual std::vector< DtString > & translationFiles ()
virtual void addTranslationFile (const DtString &)
virtual QString defaultSymbolMapFile () const
virtual void setDefaultSymbolMapFile (const QString &s)
virtual QString overlayMenu () const
virtual void setOverlayMenu (const QString &s)
virtual int printMargin () const
virtual void setPrintMargin (int iMargin)
virtual void setDefaultFreehandSamplingRate (int)
 Sets/gets the default number of points used to sample on a freehand line.
virtual int defaultFreehandSamplingRate () const
virtual void setStoreLineValuesMode (int)
 Sets/gets the mode for storing default line mode settings.
virtual int storeLineValuesMode () const
virtual void setHideOffScreenSymbols (bool)
 Set to true, such that when a view driver is created, it will hide rather than destroy symbols that go offscreen.
virtual bool hideOffScreenSymbols () const
virtual void preparse ()
 Called before mtl or command line is parsed.
virtual const DtStringdefaultTerrainDatabasePath () const
virtual void setDefaultTerrainDatabasePath (const DtString &path)
virtual void setShowSplashScreen (bool)
 Set to false in order to not show splash screen. By default, it is true.
virtual bool showSplashScreen () const
virtual void setEnableOverlayLogo (bool)
 Options for watermark.
virtual bool enableOverlayLogo () const
virtual void setPluginsDirectory (const DtFilename &)
 Directory to read for plugins .mtl files.
virtual const DtFilename & pluginsDirectory () const
virtual void setOverlayLogoFile (const DtFilename &)
virtual const DtFilename & overlayLogoFile () const
virtual void setOverlayLogoPosition (int)
 The position of the overlay on the map.
virtual int overlayLogoPosition () const
virtual void setOverlayLogoScaleFactor (double)
virtual double overlayLogoScaleFactor () const
virtual void setOverlayLogoPositionOverride (int x, int y)
virtual void setOverlayLogoPositionOverride (const QPoint &)
virtual QPoint overlayLogoPositionOverride () const
virtual void setPreserveEmptyOverlayLayers (bool)
virtual bool preserveEmptyOverlayLayers () const
virtual void setUseGLWidget (bool)
virtual bool useGLWidget () const
virtual void setLoadPluginsIfVersionMismatch (bool)
virtual bool loadIfVersionMismatch () const
const QVector< DtMenuLink > & helpWebLinks () const
virtual void addHelpWebLink (const QString &helpTitle, const QString &webLink)
virtual void insertHelpWebLink (int iIndex, const QString &helpTitle, const QString &webLink)
virtual void removeHelpWebLink (int iIndex)
virtual void setDisplayStyle (const QString &)
virtual const QString & displayStyle () const
virtual void setAllowRasterMapOptimization (bool)
virtual bool allowRasterMapOptimization () const
virtual void setHideSymbolsWhenMapShifted (bool)
 If this is true, hides the symbols when shifting the map via Ctrl+Shift movement, else shows symbols.
virtual bool hideSymbolsWhenMapShifted () const
virtual void postSettingsFileRead ()
 Called after settings file is read.
virtual int addFont (const QString &)
 Calls down to QFontDatabase to add the specified font. Returns font resource id if added.
virtual void addDefaultFonts ()
 Adds default fonts into the system. Currently MAK-MilStd-2525-b.ttf.
virtual void setFileDialogPriority (int)
 Set to -1 to not use file dialog workaround for slowness in opening any file dialog.
virtual int fileDialogPriority () const
virtual DtApplicationSettings * appSettings ()
virtual char ** argv () const
virtual int argc () const
virtual void setSplashScreenImage (const DtString &)
 Determines the image to be used for the splash screen.
virtual const DtStringsplashScreenImage () const
 Determines the image to be used for the splash screen.

Static Public Member Functions

static DtTMAppOptionscreate (int argc, char **argv)
 Returns a newly created instance of a DTTMAppOptions.

Protected Member Functions

virtual void setupOptionsFromCommandLine ()
virtual void addHelpWebLinks ()

Protected Attributes

DtApplicationSettings myApplicationSettings
 MUST BE FIRST else bad things happen on initialization of command line variables.
DtConfigVariable< boolmyUsingGlobalMiniMap
 Command line used for command parsing.
DtConfigVariable< boolmyDoNotUseSettingsFile
DtConfigVariable< boolmyDoNotUsePluginsDirectory
DtConfigVariable< DtStringmyDefaultConfigFile
DtConfigVariable< DtStringmyPluginFile
DtMultiConfigVariable< DtStringmyConfigFiles
DtMultiConfigVariable< DtStringmyPluginFiles
DtConfigVariable< DtStringmyOverlayMenu
DtConfigVariable< DtStringmySettingsFile
DtMultiConfigVariable< DtStringmySymbolMapFiles
DtMultiConfigVariable< DtStringmyTranslationFiles
DtConfigVariable< DtStringmyDefaultSymbolMapFile
DtConfigVariable< DtStringmyLanguage
int myArgc
char ** myArgv
DtTMDisplayOptionsmyDisplayOptions
bool myHideOffScreenSymbols
int myShowSplashScreen
DtString mySplashScreenImage
DtString myQtAssistantLocation
DtString myQtHelpFile
QRect myWindowGeometry
bool myShowMaximized
int myPrintMargin
int myDefaultFreehandSamplingRate
int myHideSymbolsWhenMapShifted
int myStoreLineValuesMode
DtString myDefaultTerrainDatabasePath
int myEnableLogoOverlay
 Watermark items.
DtFilename myOverlayLogoFile
int myOverlayLogoPosition
 The position of the overlay on the map. 1 is upper left, 2 is upper middle, 3 is upper right, etc.
double myOverlayLogoScaleFactor
 Amount to scale image. 1.0 is normal scale.
int myOverlayLogoPositionX
 Override position. If both are not -1, place logo at that place.
int myOverlayLogoPositionY
int myPreserveEmptyOverlayLayers
 If true, will keep around empty overlay layers when a scenario or database is closed as well as create empty overlay layers that exist in a .ovl file.
DtFilename myPluginsDirectory
 Default is ../plugins unless on 64-bit OS, in which case it's ../plugins64.
short myLoadIfVersionMismatch
QString myDisplayStyle
 Display style. Default is windows.
int myAllowRasterMapOptimization
 Set to false to turn off default raster map optimization (default is on)
QHash< int, QString > myFontMap
 Map of fonts. Will be used to remove when options are deleted.
QVector< DtMenuLinkmyHelpWebLinks
int myFileDialogPriority
 The priority to use when setting file dialog thread.
int myUseGLWidget

Private Member Functions

 DtTMAppOptions (const DtTMAppOptions &orig)
 Copy constructor -- not implemented.
DtTMAppOptionsoperator= (const DtTMAppOptions &rhs)
 Assignment operator -- not implemented.

Constructor & Destructor Documentation

DtTMAppOptions::DtTMAppOptions ( int  argc,
char **  argv 
)

Default constructor.

virtual DtTMAppOptions::~DtTMAppOptions ( ) [virtual]

Destructor.

DtTMAppOptions::DtTMAppOptions ( const DtTMAppOptions orig) [private]

Copy constructor -- not implemented.


Member Function Documentation

virtual bool DtTMAppOptions::init ( const DtTMFactory f) [virtual]

Initializer.

virtual void DtTMAppOptions::parseCommandLine ( ) [virtual]

This function will parse out and process all command line options.

virtual QString DtTMAppOptions::language ( ) const [virtual]
virtual void DtTMAppOptions::setLanguage ( const QString &  s) [virtual]
virtual void DtTMAppOptions::processConfigFile ( const QString &  ) [virtual]

This function will process a configuration file.

Reimplemented in DtEntityEditorAppOptions.

virtual void DtTMAppOptions::readConfigurationFiles ( ) [virtual]

This function will read a configuration file and set all of the appropriate values in the options object.

virtual void DtTMAppOptions::clearFiles ( ) [virtual]

Clears out any files held in arrays (translation, mtl, etc). Default does nothing.

Returns true if global minimap was specified.

virtual void DtTMAppOptions::setUsingGlobalMiniMap ( bool  ) [virtual]
virtual QString DtTMAppOptions::defaultConfigFile ( ) const [virtual]

Returns the name of the default configuration file.

virtual void DtTMAppOptions::setDefaultConfigFile ( const QString &  ) [virtual]
virtual DtTMDisplayOptions* DtTMAppOptions::displayOptions ( ) const [virtual]

Returns a pointer to the global display options.

Referenced by DtTMApplication::displayOptions().

virtual void DtTMAppOptions::setSettingsFile ( const QString &  file) [virtual]

Sets the settings file. Default is ...mtl.

virtual QString DtTMAppOptions::settingsFile ( ) const [virtual]
virtual void DtTMAppOptions::setDoNotUseSettingsFile ( bool  b) [virtual]

Set to true to not save out or load settings.

virtual bool DtTMAppOptions::doNotUseSettingsFile ( ) const [virtual]
virtual void DtTMAppOptions::setDoNotUsePluginsDirectory ( bool  b) [virtual]

Set to true to not read files from the plugins directory.

virtual bool DtTMAppOptions::doNotUsePluginsDirectory ( ) const [virtual]
virtual void DtTMAppOptions::setQtAssistantLocation ( const QString &  loc) [virtual]

Qt assistant help usage information. By default is false (uses browser)

virtual QString DtTMAppOptions::qtAssistantLocation ( ) const [virtual]
virtual void DtTMAppOptions::setQtHelpFile ( const QString &  loc) [virtual]
virtual QString DtTMAppOptions::qtHelpFile ( ) const [virtual]
virtual void DtTMAppOptions::setShowMaximized ( bool  b) [virtual]

Used only for archival purposes.

virtual bool DtTMAppOptions::showMaximized ( ) const [virtual]
virtual void DtTMAppOptions::setWindowGeometry ( const QRect &  r) [virtual]
virtual const QRect& DtTMAppOptions::windowGeometry ( ) const [virtual]
virtual void DtTMAppOptions::initCommandOptions ( ) [virtual]
virtual void DtTMAppOptions::initMtlData ( ) [virtual]

Reimplemented in DtEntityEditorAppOptions.

virtual const std::vector<DtString>& DtTMAppOptions::symbolMapFiles ( ) const [virtual]
virtual std::vector<DtString>& DtTMAppOptions::symbolMapFiles ( ) [virtual]
virtual const std::vector<DtString>& DtTMAppOptions::translationFiles ( ) const [virtual]
virtual std::vector<DtString>& DtTMAppOptions::translationFiles ( ) [virtual]
virtual void DtTMAppOptions::addTranslationFile ( const DtString ) [virtual]
virtual QString DtTMAppOptions::defaultSymbolMapFile ( ) const [virtual]
virtual void DtTMAppOptions::setDefaultSymbolMapFile ( const QString &  s) [virtual]
virtual QString DtTMAppOptions::overlayMenu ( ) const [virtual]
virtual void DtTMAppOptions::setOverlayMenu ( const QString &  s) [virtual]
virtual int DtTMAppOptions::printMargin ( ) const [virtual]
virtual void DtTMAppOptions::setPrintMargin ( int  iMargin) [virtual]
virtual void DtTMAppOptions::setDefaultFreehandSamplingRate ( int  ) [virtual]

Sets/gets the default number of points used to sample on a freehand line.

Default is one

virtual int DtTMAppOptions::defaultFreehandSamplingRate ( ) const [virtual]
virtual void DtTMAppOptions::setStoreLineValuesMode ( int  ) [virtual]

Sets/gets the mode for storing default line mode settings.

All settings are valid for this session only

0 - Do not store 1 - Only store if object is a freehand object 2 - Store all values

Default is 1

virtual int DtTMAppOptions::storeLineValuesMode ( ) const [virtual]
virtual void DtTMAppOptions::setHideOffScreenSymbols ( bool  ) [virtual]

Set to true, such that when a view driver is created, it will hide rather than destroy symbols that go offscreen.

Performance enhacement for large exercises. By default is false

virtual bool DtTMAppOptions::hideOffScreenSymbols ( ) const [virtual]
virtual void DtTMAppOptions::preparse ( ) [virtual]

Called before mtl or command line is parsed.

Use to preparse command line or any other setup. This is for mtl file reading, currently

Reimplemented in DtTerrainAppOptions.

virtual const DtString& DtTMAppOptions::defaultTerrainDatabasePath ( ) const [virtual]
virtual void DtTMAppOptions::setDefaultTerrainDatabasePath ( const DtString path) [virtual]
virtual void DtTMAppOptions::setShowSplashScreen ( bool  ) [virtual]

Set to false in order to not show splash screen. By default, it is true.

virtual bool DtTMAppOptions::showSplashScreen ( ) const [virtual]
virtual void DtTMAppOptions::setSplashScreenImage ( const DtString ) [virtual]

Determines the image to be used for the splash screen.

virtual const DtString& DtTMAppOptions::splashScreenImage ( ) const [virtual]

Determines the image to be used for the splash screen.

virtual void DtTMAppOptions::setEnableOverlayLogo ( bool  ) [virtual]

Options for watermark.

These must be set before the application has started. Setting them after application initialization will have no effect

virtual bool DtTMAppOptions::enableOverlayLogo ( ) const [virtual]
virtual void DtTMAppOptions::setPluginsDirectory ( const DtFilename &  ) [virtual]

Directory to read for plugins .mtl files.

virtual const DtFilename& DtTMAppOptions::pluginsDirectory ( ) const [virtual]
virtual void DtTMAppOptions::setOverlayLogoFile ( const DtFilename &  ) [virtual]
virtual const DtFilename& DtTMAppOptions::overlayLogoFile ( ) const [virtual]
virtual void DtTMAppOptions::setOverlayLogoPosition ( int  ) [virtual]

The position of the overlay on the map.

7 is upper left, 8 is upper middle, 9 is upper right, etc. The positioning follows the keypad numbering

virtual int DtTMAppOptions::overlayLogoPosition ( ) const [virtual]
virtual void DtTMAppOptions::setOverlayLogoScaleFactor ( double  ) [virtual]
virtual double DtTMAppOptions::overlayLogoScaleFactor ( ) const [virtual]
virtual void DtTMAppOptions::setOverlayLogoPositionOverride ( int  x,
int  y 
) [virtual]
virtual void DtTMAppOptions::setOverlayLogoPositionOverride ( const QPoint &  ) [virtual]
virtual QPoint DtTMAppOptions::overlayLogoPositionOverride ( ) const [virtual]
virtual bool DtTMAppOptions::preserveEmptyOverlayLayers ( ) const [virtual]
virtual void DtTMAppOptions::setUseGLWidget ( bool  ) [virtual]
virtual bool DtTMAppOptions::useGLWidget ( ) const [virtual]
virtual bool DtTMAppOptions::loadIfVersionMismatch ( ) const [virtual]
const QVector< DtMenuLink > & DtTMAppOptions::helpWebLinks ( ) const [inline]

References myHelpWebLinks.

virtual void DtTMAppOptions::addHelpWebLink ( const QString &  helpTitle,
const QString &  webLink 
) [virtual]
virtual void DtTMAppOptions::insertHelpWebLink ( int  iIndex,
const QString &  helpTitle,
const QString &  webLink 
) [virtual]
virtual void DtTMAppOptions::removeHelpWebLink ( int  iIndex) [virtual]
virtual void DtTMAppOptions::setDisplayStyle ( const QString &  ) [virtual]
virtual const QString& DtTMAppOptions::displayStyle ( ) const [virtual]
virtual bool DtTMAppOptions::allowRasterMapOptimization ( ) const [virtual]
virtual void DtTMAppOptions::setHideSymbolsWhenMapShifted ( bool  ) [virtual]

If this is true, hides the symbols when shifting the map via Ctrl+Shift movement, else shows symbols.

virtual bool DtTMAppOptions::hideSymbolsWhenMapShifted ( ) const [virtual]
virtual void DtTMAppOptions::postSettingsFileRead ( ) [virtual]

Called after settings file is read.

virtual int DtTMAppOptions::addFont ( const QString &  ) [virtual]

Calls down to QFontDatabase to add the specified font. Returns font resource id if added.

virtual void DtTMAppOptions::addDefaultFonts ( ) [virtual]

Adds default fonts into the system. Currently MAK-MilStd-2525-b.ttf.

Reimplemented in DtEntityEditorAppOptions.

virtual void DtTMAppOptions::setFileDialogPriority ( int  ) [virtual]

Set to -1 to not use file dialog workaround for slowness in opening any file dialog.

virtual int DtTMAppOptions::fileDialogPriority ( ) const [virtual]
virtual DtApplicationSettings* DtTMAppOptions::appSettings ( ) [virtual]
char ** DtTMAppOptions::argv ( ) const [inline, virtual]

References myArgv.

int DtTMAppOptions::argc ( ) const [inline, virtual]

References myArgc.

virtual void DtTMAppOptions::setupOptionsFromCommandLine ( ) [protected, virtual]
virtual void DtTMAppOptions::addHelpWebLinks ( ) [protected, virtual]
static DtTMAppOptions* DtTMAppOptions::create ( int  argc,
char **  argv 
) [static]

Returns a newly created instance of a DTTMAppOptions.

Reimplemented in DtTerrainAppOptions, and DtEntityEditorAppOptions.

Signals.

virtual void DtTMAppOptions::setDisplayOptions ( const DtTMDisplayOptions o) [virtual, slot]

Slots.

DtTMAppOptions& DtTMAppOptions::operator= ( const DtTMAppOptions rhs) [private]

Assignment operator -- not implemented.


Member Data Documentation

DtApplicationSettings DtTMAppOptions::myApplicationSettings [protected]

MUST BE FIRST else bad things happen on initialization of command line variables.

DtConfigVariable<bool> DtTMAppOptions::myUsingGlobalMiniMap [protected]

Command line used for command parsing.

DtConfigVariable<bool> DtTMAppOptions::myDoNotUseSettingsFile [protected]
DtConfigVariable<bool> DtTMAppOptions::myDoNotUsePluginsDirectory [protected]
DtConfigVariable<DtString> DtTMAppOptions::myDefaultConfigFile [protected]
DtConfigVariable<DtString> DtTMAppOptions::myPluginFile [protected]
DtMultiConfigVariable<DtString> DtTMAppOptions::myConfigFiles [protected]
DtMultiConfigVariable<DtString> DtTMAppOptions::myPluginFiles [protected]
DtConfigVariable<DtString> DtTMAppOptions::myOverlayMenu [protected]
DtConfigVariable<DtString> DtTMAppOptions::mySettingsFile [protected]
DtMultiConfigVariable<DtString> DtTMAppOptions::mySymbolMapFiles [protected]
DtMultiConfigVariable<DtString> DtTMAppOptions::myTranslationFiles [protected]
DtConfigVariable<DtString> DtTMAppOptions::myDefaultSymbolMapFile [protected]
DtConfigVariable<DtString> DtTMAppOptions::myLanguage [protected]
int DtTMAppOptions::myArgc [protected]

Referenced by argc().

char** DtTMAppOptions::myArgv [protected]

Referenced by argv().

Watermark items.

DtFilename DtTMAppOptions::myOverlayLogoFile [protected]

The position of the overlay on the map. 1 is upper left, 2 is upper middle, 3 is upper right, etc.

Amount to scale image. 1.0 is normal scale.

Override position. If both are not -1, place logo at that place.

If true, will keep around empty overlay layers when a scenario or database is closed as well as create empty overlay layers that exist in a .ovl file.

If false, will remove those layers when the scenario or database is closed and/or not create empty layers found in the .ovl file. Default is false

DtFilename DtTMAppOptions::myPluginsDirectory [protected]

Default is ../plugins unless on 64-bit OS, in which case it's ../plugins64.

QString DtTMAppOptions::myDisplayStyle [protected]

Display style. Default is windows.

Set to false to turn off default raster map optimization (default is on)

QHash<int, QString> DtTMAppOptions::myFontMap [protected]

Map of fonts. Will be used to remove when options are deleted.

Referenced by helpWebLinks().

The priority to use when setting file dialog thread.

Work around for Qt slowness in opening file dialog on windows. If this value is -1, will not use scheme. Default is THREAD_PRIORITY_TIME_CRITICAL


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)