DtTerrainAppOptions Class Reference

Inheritance diagram for DtTerrainAppOptions:

Signals
void	recentTerrainDatabasesChanged (const QStringList &)
void	compassMapPositionChanged (int)
void	showMapCompassChanged (bool)
Signals inherited from DtTMAppOptions
void	displayOptionsChanged (const DtTMDisplayOptions *o)
	Signals.

Public Member Functions
	DtTerrainAppOptions (int argc, char **argv)
	Default constructor.
virtual	~DtTerrainAppOptions ()
	Destructor.
virtual QString	outputFile () const
virtual void	setOutputFile (const QString &s)
virtual QString	databaseFile () const
virtual void	setDatabaseFile (const QString &s)
virtual bool	loadDatabase () const
	Returns true of a database file has been set.
virtual void	setMaximumRecentTerrainDatabases (int)
	Sets the maximum terrain databases to save on recent list.
int	maximumRecentTerrainDatabases () const
const QStringList &	recentTerrainDatabases () const
void	clearRecentTerrainDatabases ()
virtual void	addRecentTerrainDatabase (const QString &)
virtual void	removeRecentTerrainDatabase (const QString &)
virtual void	preparse ()
	Called before mtl or command line is parsed.
virtual void	setShowMapCompass (bool)
virtual bool	showMapCompass () const
virtual void	setCompassMapPosition (int)
virtual int	compassMapPosition () const
virtual void	initCommandOptions ()
Public Member Functions inherited from DtTMAppOptions
	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 DtTMDisplayOptions *	displayOptions () 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	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 const DtString &	defaultTerrainDatabasePath () 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 DtString &	splashScreenImage () const
	Determines the image to be used for the splash screen.
Public Member Functions inherited from DtArchivableObject
	DtArchivableObject (QString name, DtArchivableObjectCreator fcn)
	This constructor will add this object to the archivable object factory.
	DtArchivableObject (QString name)
	DtArchivableObject ()
virtual	~DtArchivableObject ()
virtual QString	name () const
DtArchiver *	archiver ()
	Returns the archiver of this object.
virtual void	read (QTextStream &s)
	Reads/writes archiver.
virtual void	write (QTextStream &s)
virtual void	setLevel (int i)
virtual int	level () const
virtual DtArchivableObject *	clone ()
	Allows for cloning of this object.

Static Public Member Functions
static void	setLogDirectory (const QString &s)
	Sets into globalEnv. If want to change, call before app.init()
static DtTMAppOptions *	create (int argc, char **argv)
	Returns a newly created instance of a DtPvdAppOptions.

Protected Attributes
DtConfigVariable< DtString >	myOutputFile
DtConfigVariable< DtString >	myLogDirectory
DtConfigVariable< DtString >	myDatabaseFile
QStringList	myRecentTerrainDatabases
int	myMaximumRecentTerrainDatabases
int	myShowMapCompass
int	myCompassMapPosition
Protected Attributes inherited from DtTMAppOptions
DtApplicationSettings	myApplicationSettings
	MUST BE FIRST else bad things happen on initialization of command line variables.
DtConfigVariable< bool >	myUsingGlobalMiniMap
	Command line used for command parsing.
DtConfigVariable< bool >	myDoNotUseSettingsFile
DtConfigVariable< bool >	myDoNotUsePluginsDirectory
DtConfigVariable< DtString >	myDefaultConfigFile
DtConfigVariable< DtString >	myPluginFile
DtMultiConfigVariable< DtString >	myConfigFiles
DtMultiConfigVariable< DtString >	myPluginFiles
DtConfigVariable< DtString >	myOverlayMenu
DtConfigVariable< DtString >	mySettingsFile
DtMultiConfigVariable< DtString >	mySymbolMapFiles
DtMultiConfigVariable< DtString >	myTranslationFiles
DtConfigVariable< DtString >	myDefaultSymbolMapFile
DtConfigVariable< DtString >	myLanguage
int	myArgc
char **	myArgv
DtTMDisplayOptions *	myDisplayOptions
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< DtMenuLink >	myHelpWebLinks
int	myFileDialogPriority
	The priority to use when setting file dialog thread.
int	myUseGLWidget
Protected Attributes inherited from DtArchivableObject
DtArchiver *	myArchiver

Private Member Functions
	DtTerrainAppOptions (const DtTerrainAppOptions &orig)
	Copy constructor.
DtTerrainAppOptions &	operator= (const DtTerrainAppOptions &rhs)
	Assignment operator.

Additional Inherited Members
Public Slots inherited from DtTMAppOptions
virtual void	setDisplayOptions (const DtTMDisplayOptions *o)
	Slots.
Protected Member Functions inherited from DtTMAppOptions
virtual void	setupOptionsFromCommandLine ()
virtual void	addHelpWebLinks ()

Constructor & Destructor Documentation

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

Default constructor.

virtual DtTerrainAppOptions::~DtTerrainAppOptions ( )

virtual

Destructor.

DtTerrainAppOptions::DtTerrainAppOptions ( const DtTerrainAppOptions &  orig )

private

Copy constructor.

Member Function Documentation

virtual QString DtTerrainAppOptions::outputFile ( ) const

virtual

virtual void DtTerrainAppOptions::setOutputFile ( const QString &  s )

virtual

static void DtTerrainAppOptions::setLogDirectory ( const QString &  s )

static

Sets into globalEnv. If want to change, call before app.init()

virtual QString DtTerrainAppOptions::databaseFile ( ) const

virtual

virtual void DtTerrainAppOptions::setDatabaseFile ( const QString &  s )

virtual

virtual bool DtTerrainAppOptions::loadDatabase ( ) const

virtual

Returns true of a database file has been set.

virtual void DtTerrainAppOptions::setMaximumRecentTerrainDatabases ( int  )

virtual

Sets the maximum terrain databases to save on recent list.

Default is 4, maximum is 10

int DtTerrainAppOptions::maximumRecentTerrainDatabases ( ) const

inline

References myMaximumRecentTerrainDatabases.

const QStringList & DtTerrainAppOptions::recentTerrainDatabases ( ) const

inline

References myRecentTerrainDatabases.

void DtTerrainAppOptions::clearRecentTerrainDatabases ( )

inline

References myRecentTerrainDatabases, and recentTerrainDatabasesChanged().

virtual void DtTerrainAppOptions::addRecentTerrainDatabase ( const QString &  )

virtual

virtual void DtTerrainAppOptions::removeRecentTerrainDatabase ( const QString &  )

virtual

virtual void DtTerrainAppOptions::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 from DtTMAppOptions.

virtual void DtTerrainAppOptions::setShowMapCompass ( bool  )

virtual

virtual bool DtTerrainAppOptions::showMapCompass ( ) const

virtual

virtual void DtTerrainAppOptions::setCompassMapPosition ( int  )

virtual

virtual int DtTerrainAppOptions::compassMapPosition ( ) const

virtual

virtual void DtTerrainAppOptions::initCommandOptions ( )

virtual

Reimplemented from DtTMAppOptions.

static DtTMAppOptions* DtTerrainAppOptions::create ( int  argc, char **  argv  )

static

Returns a newly created instance of a DtPvdAppOptions.

Reimplemented from DtTMAppOptions.

void DtTerrainAppOptions::recentTerrainDatabasesChanged ( const QStringList &  )

signal

Referenced by clearRecentTerrainDatabases().

void DtTerrainAppOptions::compassMapPositionChanged ( int  )

signal

void DtTerrainAppOptions::showMapCompassChanged ( bool  )

signal

DtTerrainAppOptions& DtTerrainAppOptions::operator= ( const DtTerrainAppOptions &  rhs )

private

Assignment operator.

Member Data Documentation

DtConfigVariable<DtString> DtTerrainAppOptions::myOutputFile

protected

DtConfigVariable<DtString> DtTerrainAppOptions::myLogDirectory

protected

DtConfigVariable<DtString> DtTerrainAppOptions::myDatabaseFile

protected

QStringList DtTerrainAppOptions::myRecentTerrainDatabases

protected

Referenced by clearRecentTerrainDatabases(), and recentTerrainDatabases().

int DtTerrainAppOptions::myMaximumRecentTerrainDatabases

protected

Referenced by maximumRecentTerrainDatabases().

int DtTerrainAppOptions::myShowMapCompass

protected

int DtTerrainAppOptions::myCompassMapPosition

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/terrainqt/terrainAppOptions.h