VR-Forces 4.2 Class Documentation
List of all members | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtTerrainApplication Class Reference
Inheritance diagram for DtTerrainApplication:
Inheritance graph
[legend]

Public Slots

virtual void setTerrainDatabase (const DtTerrainDatabase *t)
 Called when the event controller emit signals that the terrain and paper map databases have been set.
virtual void setPaperMapDatabase (const DtPaperMapDatabase *p)
virtual void setFeaturesList (DtTerrainFeaturesListEx *features)
- Public Slots inherited from DtTMApplication
virtual void removeAttachedEventController (QObject *)
virtual DtBaseWindowfileNewWindow (bool show=true)
 Slots.
virtual void fileExit ()
virtual void removeWindow (const DtBaseWindow *w)
 Removes a window from the list.
virtual void windowDestroyed (QObject *w)
virtual void modelDataAdded (const DtModelKey &key)
 Called when model data is added, marks the data for update.
virtual void modelDataRemoved (const DtModelKey &key)
 Called when model data is removed, removes from update.
virtual void setDisplayFrameRate (int iFramesPerSecond)
 Called to display target display frame rate.
virtual int displayFrameRate () const
 Called to return the target display frame rate.
virtual void tick ()
 This will go through the windows list and ask then windows to tick. Calls tickInternal if should tick.
virtual void tickInternal ()
virtual void setFullScreenMode (bool b)
 Changes the myFullScreenMode flag, but does not change the mode.
virtual void saveSettingsFile ()
 Saves out settings.
virtual void saveSettings (QTextStream &stream)
virtual void readSettingsFile (DtBaseWindow *w, bool windowOnly=false)
 Reads out settings file.
virtual void readSettings (DtBaseWindow *w, QTextStream &stream, bool windowOnly=false)
virtual void splashScreenDestroyed ()
virtual void removeManagedArea (QObject *)
 Call to remove a managed area. Is also called when an area is destroyed that is managed.
virtual void removeFromUpdate (const DtModelData &data)
 Removes this data for update (if exists)
virtual void markForUpdate (const DtModelData &)
virtual void markForUpdate (const DtModelKey &)
virtual void showSplashScreen ()
 Creates and shows the splash screen (if there is a splash image to show)
virtual void closeSplashScreen ()
 Closes splash screen and frees splash screen object.
virtual void showSplashScreen (bool show)
virtual void processMsgItem (const DtMsgItem &item)
virtual bool shouldTick ()
 Returns true if application should tick.
static void addUserDataFor (const DtEntityMapperKey &, DtArchivableObjectCreator)
 Called when a model data is added, adds a user data for the particular item (based on entity mapper key)
static void removeUserDataFor (const DtEntityMapperKey &)
virtual void addToUpdate (const DtModelData &data)
virtual void addToRemoval (const DtModelData &data)

Signals

void terrainDatabaseSet (const DtTerrainDatabase *t)
 For backwards compatibility, these signals are just resent when the event controller sends them.
void paperMapLoaded (const DtPaperMapDatabase *p)
- Signals inherited from DtTMApplication
void filenameInUseChanged (const QString &s)
 Signals.
void symbolMapChangedSignal ()
void pluginLoaded (const DtTMPlugin *)
void pasteAvailable ()
void pasteUnavailable ()

Public Member Functions

 DtTerrainApplication (int &argc, char **argv)
 Constructor.
virtual ~DtTerrainApplication ()
 Destructor.
virtual bool init (DtTMFactory *f, bool bShowSplashScreen=true)
 Initializer. MUST BE CALLED.
virtual DtTerrainFeaturesListExfeaturesList ()
virtual DtTerrainDrawerCollterrainDrawerColl () const
 Access terrain drawer collection.
virtual DtBoundingVolumesManagerboundingVolumesManager () const
 Access bounding volumes manager.
virtual bool openTerrainDatabase (const QString &db)
 Higher level API that allows the user to open a terrain database.
virtual void closeTerrainDatabase ()
 Closes any database that is currently opened without promping for user feedback.
virtual void setTerrainUnitFormatter (DtTerrainUnitFormatter *)
const DtTerrainUnitFormatterunitFormatter () const
- Public Member Functions inherited from DtTMApplication
 DtTMApplication ()
 Default Constructor.
 DtTMApplication (int &argc, char **argv)
 Constructor.
virtual ~DtTMApplication ()
 Destructor.
virtual void initializeQApplicationObject ()
 If there is no global qApp defined, this routine will create one and install this object as the event filter.
virtual DtBaseWindowcreateWindow (QWidget *parent, int mode=DtMenu_Hide, const Qt::WindowFlags &flags=0)
 This routine will create a new window (from the factory) and return a pointer to it.
virtual QVector< DtModelKeyselectedModelKeys () const
 Given the current active window, and active map area within that window, return the current selected model keys.
virtual const DtTMFactoryfactory () const
 Returns a pointer to the current factory.
virtual DtTMFactoryfactory ()
virtual void setFactory (DtTMFactory *f)
 Sets the current factory.
virtual DtTMMiniMapglobalMiniMap () const
 Returns pointer to terrain minimap.
virtual DtModelDataDictModelDataDict ()
 Returns the list of Symbol Datas.
virtual DtModelDataIterModelDataIter () const
 Returns the list of Symbol Datas.
virtual DtBaseWindowcreateNewWindow (QWidget *parent=NULL, int mode=DtWindow_NoAction, const Qt::WindowFlags &f=0)
 Creates a new window.
virtual DtBaseWindowactiveWindow () const
 Returns the currently active window.
DtTMAppOptionsoptions () const
DtTMDisplayOptionsdisplayOptions () const
virtual DtDrawerColldrawerColl ()
virtual const QString & filenameInUse ()
virtual void setFilenameInUse (const QString &filename)
virtual DtBaseSymbolMapperbaseSymbolMapper () const
 Returns the default instance of the symbol mapper.
DtArchiverarchiver ()
 Returns archiver that can be used to add in items to save/restore from settings file.
virtual DtBaseWindowmainWindowFromObject (QObject *o, DtBaseWindow *defaultWindow) const
 Used in reparenting global mini-map.
virtual void addWindow (const DtBaseWindow *w)
 Adds a new window to the window list.
virtual void addManagedArea (DtTMArea *)
 Adds a new area to be managed by this application.
virtual bool hasWindows () const
 Returns true if a window exists.
virtual DtWindowListwindowList ()
 Returns the list of windows.
virtual int fastestFrameRate ()
 Of all the windows opened, return the fastest frame rate.
virtual bool exec ()
 Run the qApp exec.
virtual void startTickTimer (int mSec, bool allowFutureOverride=true)
 Starts the tick timer at the specified msec.
virtual void setAllowTickTimerOverride (bool b)
virtual bool allowTickTimerOverride ()
virtual void adjustTickTimerToMeet (int mSec)
 This routine will attempt to meet the minimum frame rate request if the tick timer can be modified.
virtual int tickTimerRate ()
 Returns the rate of the current user tick timer.
virtual void setSuspendTicking (bool b)
 Suspend ticking of application.
virtual bool suspendTicking ()
virtual void setInTick (bool b)
 Set when the application is in the process of ticking.
virtual DtModelDatadataWithName (const QString &name, const QVector< int > *except=NULL)
 Returns the model data with the specified name.
virtual DtModelDatafindLocalDataFor (const DtModelKey &key)
 Find data in local data dictionaries for the specified key.
virtual const DtModelKeyfindLocalModelKey (DtSymbol *s)
 Find the model key, searching the view drivers of our known main windows.
virtual DtModelDatafindModelData (DtSymbol *s)
 Find the model key, searching the view drivers of our known main windows.
virtual DtViewDriverviewDriverFor (DtSymbol *s)
 Returns the view driver that holds the specified symbols.
virtual DtViewDriverviewDriverFor (const DtModelKey &key)
 Returns the view driver that holds the specified model key.
virtual DtPopupMenumenuFromAction (QAction *)
 Returns a menu that has this QAction.
virtual void markForUpdate (DtModelDataIter *iter)
 Mark this data for update by telling all child windows to mark it for update.
virtual void modelDataChanged (const DtModelData &data, int iChangedFlags)
 Different from markForUpdate in that it will mark the data for update and emit a model changed signal.
virtual DtModelDatacheckForDuplicateName (const DtModelData *checker, QString name, const QVector< int > *except=NULL)
 Does a name check for the requesting model data and the new name.
virtual void setDuplicateNameCheck (bool b)
 Set to false if duplicate name checks should not be made (default is true)
virtual bool duplicateNameCheck () const
virtual DtEventSignallereventSignaller ()
 Returns the event signaller the user can register to handle certain application level events.
virtual DtEventControllereventController ()
 Returns the applications event controller.
virtual const DtEventControllereventController () const
virtual const DtTerrainDatabase * terrainDatabase () const
 Stub routine to allow users to return a terrain database more easily from application subclasses.
virtual DtTerrainDatabase * terrainDatabase ()
virtual const DtPaperMapDatabase * paperMapDatabase () const
virtual DtPaperMapDatabase * paperMapDatabase ()
virtual bool fullScreenMode () const
 Returns state of full screen mode.
virtual bool isConcave (QVector< DtPoint > *pointList)
 Returns true if the point list supplied creates a concave shape.
virtual void addSymbol (const DtModelData &, bool force=true)
 Adds the specified symbol to all opened windows.
virtual void addSymbol (const DtModelData &, DtSymbol *)
virtual void removeSymbol (const DtModelData &, bool removeFromDict=false)
 Removes the symbol from the windows, and, optionally the dictionary as well.
virtual void clear ()
 Removes any model data from the data dictionary that is of type DtLocalControlModelDataType.
virtual void symbolMapChanged ()
 Removes all symbols from all map areas and windows.
virtual bool terrainLoaded () const
 Returns true if a terrain database is loaded.
virtual
DtCoordinateSystemCollection
coordinateSystemCollection () const
virtual DtUnitDisplayManagerunitDisplayManager () const
virtual DtUnitConverterFactoryunitConverterFactory () const
virtual bool allowTerrainProfileTracking () const
 Return true to allow terrain profile tracking to be enabled for terrain profile dialogs.
virtual void setUpdateOnTick (bool b, bool updateMini=false)
 Tells all children windows (and mini map) to update on next tick.
virtual void setPrintMode (bool b)
 If we are in print mode, so objects (such as routes) can draw differently.
virtual bool printMode () const
virtual QString dataFolder ()
 Returns the data folder of this application.
virtual QString makeRelativeTo (QString filename, QString path)
 If the name given contains the directory, adds ../ to that path, removing everything before it.
virtual QString relativePath ()
 Returns the folder that paths should be made relative to.
int settingsVersion () const
virtual QString appName () const
virtual QString appVersion () const
virtual QString pluginVersion () const
virtual QString buildDate () const
virtual DtString pluginName () const
 Used for plugins only.
virtual void setSplashScreenMessage (const QString &)
 If there is a splash screen, shows message on it.
virtual bool startSplashScreenProgress (const QString &title, int iTotalSteps)
 Returns true if the progress status can be started on the splash screen.
virtual void updateSplashScreenProgress (int)
virtual void endSplashScreenProgress ()
virtual bool splashScreenIsActive () const
 Returns true if splash screen is active.
bool applicationInitialized () const
 Set to true when first window is shown, meaning application has been initialized.
virtual void attachEventController (DtEventController *)
 If you are creating an event controller that can be used with this application, call this method to add it to event controllers that are tickable.
QList< DtEventController * > & attachedEventControllers ()
 Does not include the default event controller.
virtual void tickEventControllers ()
virtual void clearCurrentEvents ()
virtual void setSplashScreenImage (const QString &)
 Must call before init.
virtual DtTMMapAreamapContainsData (const DtModelData *data) const
 If a map area contains the model data, returns the map area that contains it.
virtual bool eventFilter (QObject *o, QEvent *e)
 This is part of the work-around described in recursiveTimer.h.
virtual bool event (QEvent *e)
virtual QString resolveFile (const QString &) const
 Returns full qualified filename given current directory and relative file to it.
virtual DtTMPluginManagerpluginManager () const
virtual void mergeFeatureActionManager (const DtFeatureActionManager &)
 Because feature action managers are local to windows, passes this down to each window to merge.
virtual void mergeToolbarManager (const DtToolbarFactoryManager &)
 Because toolbar managers are local to windows, passes this down to each window to merge.
virtual void revertToolbars ()
 Asks all windows to revert toolbars using stored toolbar factory information.
virtual DtEnvironmentalModelDatacreateObject (const QString &object, QVector< DtPoint > &points, const QString &name=QString::null)
 These routines will aide in the creating of symbols and model data based on their name.
virtual bool canPaste () const
 Routines that are used to store paste information for copy/paste operation.
virtual void setPasteData (const QByteArray &)
virtual void clearPasteData ()
const QByteArray & pasteData () const

Static Public Member Functions

static DtTMApplicationcreate (int argc, char **argv)
- Static Public Member Functions inherited from DtTMApplication
static DtTMApplicationapp ()

Protected Member Functions

virtual bool initMenuSystem ()
 Call to override or initialize menu structure.
virtual bool needsTerrainDatabase () const
 Returns true.
virtual bool initConnections ()
 Init application level QT connections. Called from init.
virtual bool readOptions (DtTMFactory *f)
virtual bool createBoundingVolumesManager (DtTMFactory *f)
 Creates and inits the bounding volume manager.
virtual void initGlobalMiniMapConnections ()
virtual bool setupFromOptions ()
virtual DtTerrainUnitFormattercreateTerrainUnitFormatter ()
- Protected Member Functions inherited from DtTMApplication
virtual void postAppInit ()
virtual DtTMPluginManagercreatePluginManager (DtTMFactory *)
 Initializes and loads up all plugins. Done before calling any other factory methods.
virtual void initPlugins (DtTMFactory *f)
virtual bool setupOptions ()
 Initializes command line arguments and mtl arguments for the app options.
virtual bool processOptions (DtTMFactory *f)
virtual bool initGlobalMiniMap ()
 Initialize global mini map from DtTMFactory.
virtual bool initUnitConverterFactory (DtTMFactory *f)
 Initialize unit converter factory.
virtual bool initUnitDisplayManager (DtTMFactory *f)
 Initialize unit display manager.
virtual void setupApplicationFromSettings ()
 Called as the last operation of readSettings().
virtual bool setupMapReaders ()
 Override to add new types of map readers to the symbol mapper.
virtual bool initSymbolMapper (DtTMFactory *f)
virtual void setupWindowFromSettings (DtBaseWindow *w, bool show)
virtual bool createCoordinateSystemCollection (const DtTMFactory *f)
 Creates an instance of a terrain coordinate system collection from the factory and initializes it.
virtual bool shouldClear (const DtModelData *data)
 Returns true if the model data specified should be deleted when all model data is asked to be cleared when closing a terrain database.
virtual const QString & splashScreenImage () const
 Returns empty string by default to prevent splash screen.
virtual DtTMPluginloadPlugin (const QString &)
 Calls down to plugin manager to load plugin. This should only be called during the init process.
virtual void applicationReady ()
 Call when application is ready to start ticking for updates.
virtual bool loadTranslationFiles (const QString &lang)
 Loads up translation files that are part of the app options object.
virtual bool loadSymbolMapFilesAtStartup () const
virtual DtString initialLogFile () const
 Returns the log file used to store initial startup information before final output log file is known from command line or .mtl file.
virtual bool useConsole () const
virtual void setEnableGuiPrinter (bool enable, int level)
 Enables/disables the printer object that connects DtInfo/DtWarn/DtVerbose statements with the DtMessageHandler.write call.
virtual void timerEvent (QTimerEvent *e)
virtual void initUserData ()
virtual void addUserDataFor (DtEnvironmentalModelData *)
 In respone to a model data being added, see if there is a user data that needs to be added for this model.
virtual void setupLanguage ()

Protected Attributes

DtTerrainFeaturesListExmyFeaturesList
DtTerrainDrawerCollmyTerrainDrawerColl
DtBoundingVolumesManagermyBoundingVolumesManager
DtTerrainUnitFormattermyTerrainUnitFormatter
bool myOwnsTerrainUnitFormatter
- Protected Attributes inherited from DtTMApplication
DtTMFactorymyFactory
DtTMMiniMapmyTMGlobalMiniMap
DtBaseSymbolMappermyMapper
DtModelDataDictmyModelDataDict
 Changed from stack to pointer in order to support plugins.
DtModelDataItermyModelDataIter
DtTMAppOptionsmyOptions
int myArgc
char ** myArgv
QString myFilenameInUse
DtWindowList myWindows
DtAreaListmyManagedAreas
bool mySuspendTicking
 This is part of the work-around described in recursiveTimer.h.
bool myInTick
int myTickTimerRate
bool myAllowTickTimerOverride
bool myDuplicateNameCheck
 Set to false if duplicate name checks should not be made.
DtEventControllermyEventController
 Application level event controller.
bool myFullScreenMode
bool myLoadedSettings
bool myPrintMode
DtArchivermyArchiver
DtDrawerCollmyDrawerColl
DtCoordinateSystemCollectionmyCoordinateSystemCollection
QList< QObject * > myInactiveWindows
 Keeps track of windows that have been closed but not yet deleted Can be useful to make sure windows that are about to go away are not referenced.
int mySettingsVersion
int myTimerId
QSplashScreen * mySplashScreen
QProgressBar * mySplashProgress
DtTMPluginManagermyPluginManager
DtEventSignaller myEventSignaller
 Even though this can be created through the factory, it is not due to the fact that this needs to be available before other objects are created (such as the application options)
QString mySplashScreenMessage
QString mySplashScreenImage
bool myApplicationInitialized
bool myNeedsPostAppInit
QList< DtEventController * > * myAttachedEventControllers
QHash< DtModelKey, DtModelData * > myUpdateData
QHash< DtModelKey, DtModelData * > myRemoveData
bool myResetPruneStatus
bool myStashPrune
bool myMarkTime
QByteArray myPasteBuffer
int myTickCount
std::map< std::string, double > myTickTimes
DtUnitConverterFactorymyUnitConverterFactory
DtUnitDisplayManagermyUnitDisplayManager
DtMsgGuiPrintermyGuiPrinter
DtRecursiveTimermyRecursiveTimer

Additional Inherited Members

- Static Protected Attributes inherited from DtTMApplication
static DtTMApplicationtheApplication
static QHash< QString,
DtArchivableObjectCreator
theUserData

Constructor & Destructor Documentation

DtTerrainApplication::DtTerrainApplication ( int &  argc,
char **  argv 
)

Constructor.

virtual DtTerrainApplication::~DtTerrainApplication ( )
virtual

Destructor.

Member Function Documentation

virtual bool DtTerrainApplication::init ( DtTMFactory f,
bool  bShowSplashScreen = true 
)
virtual

Initializer. MUST BE CALLED.

Reimplemented from DtTMApplication.

virtual DtTerrainFeaturesListEx* DtTerrainApplication::featuresList ( )
virtual
virtual DtTerrainDrawerColl* DtTerrainApplication::terrainDrawerColl ( ) const
virtual

Access terrain drawer collection.

virtual DtBoundingVolumesManager* DtTerrainApplication::boundingVolumesManager ( ) const
virtual

Access bounding volumes manager.

virtual bool DtTerrainApplication::openTerrainDatabase ( const QString &  db)
virtual

Higher level API that allows the user to open a terrain database.

virtual void DtTerrainApplication::closeTerrainDatabase ( )
virtual

Closes any database that is currently opened without promping for user feedback.

virtual void DtTerrainApplication::setTerrainUnitFormatter ( DtTerrainUnitFormatter )
virtual
const DtTerrainUnitFormatter * DtTerrainApplication::unitFormatter ( ) const
inline
virtual void DtTerrainApplication::setTerrainDatabase ( const DtTerrainDatabase *  t)
virtualslot

Called when the event controller emit signals that the terrain and paper map databases have been set.

Will also emit signals that they have been set as well

virtual void DtTerrainApplication::setPaperMapDatabase ( const DtPaperMapDatabase *  p)
virtualslot
virtual void DtTerrainApplication::setFeaturesList ( DtTerrainFeaturesListEx features)
virtualslot
static DtTMApplication* DtTerrainApplication::create ( int  argc,
char **  argv 
)
static

Reimplemented from DtTMApplication.

void DtTerrainApplication::terrainDatabaseSet ( const DtTerrainDatabase *  t)
signal

For backwards compatibility, these signals are just resent when the event controller sends them.

void DtTerrainApplication::paperMapLoaded ( const DtPaperMapDatabase *  p)
signal
virtual bool DtTerrainApplication::initMenuSystem ( )
protectedvirtual

Call to override or initialize menu structure.

Reimplemented from DtTMApplication.

virtual bool DtTerrainApplication::needsTerrainDatabase ( ) const
protectedvirtual

Returns true.

Reimplemented from DtTMApplication.

virtual bool DtTerrainApplication::initConnections ( )
protectedvirtual

Init application level QT connections. Called from init.

Reimplemented from DtTMApplication.

virtual bool DtTerrainApplication::readOptions ( DtTMFactory f)
protectedvirtual

Reimplemented from DtTMApplication.

virtual bool DtTerrainApplication::createBoundingVolumesManager ( DtTMFactory f)
protectedvirtual

Creates and inits the bounding volume manager.

virtual void DtTerrainApplication::initGlobalMiniMapConnections ( )
protectedvirtual

Reimplemented from DtTMApplication.

virtual bool DtTerrainApplication::setupFromOptions ( )
protectedvirtual

Reimplemented from DtTMApplication.

virtual DtTerrainUnitFormatter* DtTerrainApplication::createTerrainUnitFormatter ( )
protectedvirtual

Member Data Documentation

DtTerrainFeaturesListEx* DtTerrainApplication::myFeaturesList
protected
DtTerrainDrawerColl* DtTerrainApplication::myTerrainDrawerColl
protected
DtBoundingVolumesManager* DtTerrainApplication::myBoundingVolumesManager
protected
DtTerrainUnitFormatter* DtTerrainApplication::myTerrainUnitFormatter
protected

Referenced by unitFormatter().

bool DtTerrainApplication::myOwnsTerrainUnitFormatter
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)