VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
vrfExtendedApplicationSettings.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2022 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <vrfGuiCore/vrfGuiCore.h>
13 #include <vrfGuiCore/vrfGuiApplicationSettings.h>
14 #include <vrfGuiCore/entityMapperKey.h>
15 #include <vrfGuiCore/vrfExtendedApplicationSettings.h>
16 #include <vrfGuiCore/vrfDisplayUnitsSettingsManager.h>
17 #include <vrvCore/DtDisplayUnitsSettingsManager.h>
18 
19 #include <set>
20 
21 namespace makVrv
22 {
23  class DtDe;
24 }
25 
26 namespace makVrf
27 {
28 
31  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettingsData : public DtVrfGuiApplicationSetting
32  {
33  protected:
34 
35  enum Flags
36  {
37  ObserversPublished = 0x00000001,
38  DoNotShowMeTellMeAboutFavorites = 0x00000002,
39  ShowWeather = 0x00000004,
40  ShowNavigationAreas = 0x00000008,
41  ShowNavigationProgress = 0x00000010,
42  SaveScenarioToZipFile = 0x00000020,
43  ShowEchelonIdColumn = 0x00000080,
44  FilteredListsAreOrbatEnabled = 0x00000100,
45  ShowFavoritesIcon = 0x00000400,
46  ShowForceColor = 0x00000800,
47  HideSearchBars = 0x00002000,
48  Defaults = ShowWeather | ShowNavigationProgress | SaveScenarioToZipFile | FilteredListsAreOrbatEnabled | ShowForceColor | ShowFavoritesIcon
49  };
50 
51  public:
52 
53  DtVrfExtendedApplicationSettingsData( makVrv::DtDe* = 0 );
54  DtVrfExtendedApplicationSettingsData( const DtVrfExtendedApplicationSettingsData& );
55 
56  virtual ~DtVrfExtendedApplicationSettingsData() override;
57 
59 
60  virtual void setObserversPublished(bool);
61  virtual bool observersPublished() const;
63 
65 
66  virtual void setDoNotShowTellMeAboutFavorites(bool);
67  virtual bool doNotShowTellMeAboutFavorites() const;
69 
73 
74  virtual void setDateAndTimeOfDayFormat(const std::string&);
75  virtual std::string dateAndTimeOfDayFormat() const;
77 
81 
82  virtual void setChatDateAndTimeOfDayFormat(const std::string&);
83  virtual std::string chatDateAndTimeOfDayFormat() const;
85 
87 
88  virtual void setTimezone(const std::string&);
89  virtual std::string timezone() const;
91 
93 
94  virtual void setFormatsSet(const std::string&);
95  virtual std::string formatsSet() const;
97 
99 
100  virtual void setHideSearchBars(bool);
101  virtual bool hideSearchBars() const;
103 
105 
106  virtual void setShowWeather(bool);
107  virtual bool showWeather() const;
109 
112 
113  virtual void setAsynchLoadBufferTime(double d);
114  virtual double asynchLoadBufferTime() const;
116 
118 
119  virtual void setSaveScenarioToZipFile(bool);
120  virtual bool saveScenarioToZipFile() const;
122 
124 
125  virtual void setShowFavoritesIcon(bool);
126  virtual bool showFavoritesIcon() const;
128 
130 
131  virtual void setShowNavigationAreas(bool);
132  virtual bool showNavigationAreas() const;
134 
137 
138  virtual void setSimQueryUpdateTime(double);
139  virtual double simQueryUpdateTime() const;
141 
143 
144  virtual void setObjectConsoleBufferSize( int size );
145  virtual int objectConsoleBufferSize() const;
147 
149 
150  virtual void setMaximumNavigationAreaCellSize(double length, double width);
151  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
153 
155 
156  void setShowProgressOnGenerationStart(bool b);
157  bool showProgressOnGenerationStart() const;
159 
161 
162  virtual void setUseLocalTimezone(bool);
163  virtual bool useLocalTimezone() const;
165 
167  virtual DtVrfGuiApplicationSetting* clone() const override;
168 
170  virtual std::string classType() const override;
171 
173 
174  virtual void write(boost::archive::xml_oarchive& out, const unsigned int) override;
175  virtual void read(boost::archive::xml_iarchive& in, const unsigned int) override;
177 
179 
180  virtual void setAllowChangingOfExtendedLabels(bool);
181  virtual bool allowChangingOfExtendedLabels() const;
183 
186 
187  virtual void setDefaultLayoutSettingsFile(const std::string&);
188  virtual std::string defaultLayoutSettingsFile() const;
190 
192 
193  virtual void setQtDesignerLocation(const std::string&);
194  virtual std::string qtDesignerLocation() const;
196 
198 
199  virtual void setShowEchelonIdColumn(bool);
200  virtual bool showEchelonIdColumn() const;
202 
205 
206  virtual bool filteredListsAreOrbatEnabled() const;
207  virtual void setFilteredListsAreOrbatEnabled(bool);
209 
211 
212  virtual void setDefaultIconList(const std::string&);
213  virtual const std::string& defaultIconList() const;
215 
217 
218  virtual void setShowForceColor(bool);
219  virtual bool showForceColor() const;
221 
223 
224  virtual void setAllowBackendShutdown(bool);
225  virtual bool allowBackendShutdown() const;
227 
229 
230  virtual void setCloseScenarioSendTimeoutRetry(double d);
231  virtual double closeScenarioSendTimeoutRetry() const;
233 
235 
236  virtual void setCloseRetryCount(int);
237  virtual int closeRetryCount() const;
239 
240  virtual int dataVersion() override { return 26; };
241 
242  protected:
243 
244  virtual void setFlag( Flags, bool );
245 
246  protected:
247 
248  int myFlags;
249 
250  std::string myDateAndTimeOfDayFormat;
251  std::string myChatDateAndTimeOfDayFormat;
252  std::string myTimezone;
253  std::string myFormatsSet;
254  bool myUseLocalTimezone;
255  bool myAllowChangingOfExtendedLabels;
256 
258  typedef std::map<std::string, bool> PaletteItemsVisibilityMap;
259  PaletteItemsVisibilityMap myPaletteItemsVisibilityMap;
260 
261  double mySimQueryUpdateTime;
262  int myObjectConsoleBufferSize;
263 
264  double myMaximumNavigationAreaCellWidth;
265  double myMaximumNavigationAreaCellLength;
266  double myAsynchLoadBufferTime;
267 
268  std::string myDefaultLayoutSettingsFile;
269  std::string myQtDesignerLocation;
270 
271  std::string myDefaultIconList;
272 
274  bool myAllowBackendShutdown;
275 
277  double myCloseScenarioSendTimeoutRetry;
278  int myCloseRetryCount;
279 
280  };
281 
282 
285  class DT_DLL_VRFGUICORE DtVrfExtendedApplicationSettings : public makVrv::DtVirtualBaseClass
286  {
287  public:
288 
289  DtVrfExtendedApplicationSettings( makVrv::DtDe& );
290 
291  virtual ~DtVrfExtendedApplicationSettings() override;
292 
294 
295  virtual void setObserversPublished(bool);
296  virtual bool observersPublished() const;
298 
300 
301  virtual void setDoNotShowTellMeAboutFavorites(bool);
302  virtual bool doNotShowTellMeAboutFavorites() const;
304 
306 
307  virtual void setShowWeather(bool);
308  virtual bool showWeather() const;
310 
312 
313  virtual void setShowNavigationAreas(bool);
314  virtual bool showNavigationAreas() const;
316 
318 
319  virtual void setSaveScenarioToZipFile(bool);
320  virtual bool saveScenarioToZipFile() const;
322 
325 
326  virtual void setAsynchLoadBufferTime(double d);
327  virtual double asynchLoadBufferTime() const;
329 
331 
332  virtual void setShowProgressOnGenerationStart(bool b);
333  virtual bool showProgressOnGenerationStart() const;
335 
337 
338  virtual void setPaletteItemVisible(const std::string& item , bool);
339  virtual bool paletteItemVisible(const std::string& item, bool* keyExists = 0) const;
341 
345 
346  virtual void setDateAndTimeOfDayFormat(const std::string&);
347  virtual std::string dateAndTimeOfDayFormat() const;
349 
353 
354  virtual void setChatDateAndTimeOfDayFormat(const std::string&);
355  virtual std::string chatDateAndTimeOfDayFormat() const;
357 
359 
360  virtual void setTimezone(const std::string&);
361  virtual std::string timezone() const;
363 
365 
366  virtual void setFormatSets(const std::string&);
367  virtual std::string formatSets() const;
369 
371 
372  virtual void setAllowChangingOfExtendedLabels(bool);
373  virtual bool allowChangingOfExtendedLabels() const;
375 
377 
378  virtual void setShowFavoritesIcon(bool);
379  virtual bool showFavoritesIcon() const;
381 
383 
384  virtual void setUseLocalTimezone(bool);
385  virtual bool useLocalTimezone() const;
387 
389 
390  virtual void setHideSearchBars(bool);
391  virtual bool hideSearchBars() const;
393 
396 
397  virtual void setSimQueryUpdateTime(double);
398  virtual double simQueryUpdateTime() const;
400 
402 
403  virtual void setObjectConsoleBufferSize( int size );
404  virtual int objectConsoleBufferSize() const;
406 
408 
409  virtual void setMaximumNavigationAreaCellSize(double length, double width);
410  virtual void getMaximumNavigationAreaCellSize(double& length, double& width);
412 
414 
415  virtual void setDefaultLayoutSettingsFile(const std::string&);
416  virtual std::string defaultLayoutSettingsFile() const;
418 
420 
421  virtual void setQtDesignerLocation(const std::string&);
422  virtual std::string qtDesignerLocation() const;
424 
425  static DtVrfExtendedApplicationSettings& instance( makVrv::DtDe& de );
426  static void registerInstance(makVrv::DtDe&, DtVrfExtendedApplicationSettings*);
427 
429 
430  virtual void setCloseScenarioSendTimeoutRetry(double d);
431  virtual double closeScenarioSendTimeoutRetry() const;
433 
435 
436  virtual void setCloseRetryCount(int);
437  virtual int closeRetryCount() const;
439 
441 
442  virtual void setShowEchelonIdColumn(bool);
443  virtual bool showEchelonIdColumn() const;
445 
448 
449  virtual bool filteredListsAreOrbatEnabled() const;
450  virtual void setFilteredListsAreOrbatEnabled(bool);
452 
454 
455  virtual void setDefaultIconList(const std::string&);
456  virtual const std::string& defaultIconList() const;
458 
460 
461  virtual void setShowForceColor(bool);
462  virtual bool showForceColor() const;
464 
466 
467  virtual void setAllowBackendShutdown(bool);
468  virtual bool allowBackendShutdown() const;
470 
472  boost::signals2::signal<void ()> signal_extendedApplicationOptionsChanged;
473 
475  boost::signals2::signal<void (bool)> signal_searchBarVisibilityChanged;
476 
478  boost::signals2::signal<void (double)> signal_simQueryUpdateTimeChanged;
479 
481  boost::signals2::signal<void (double)> signal_objectConsoleBufferSizeChanged;
482 
484  boost::signals2::signal<void (std::string)> signal_defaultIconListChanged;
485 
486  protected:
487 
488  virtual void slot_activated();
489 
490  protected:
491 
492  makVrv::DtDe& myDe;
493 
494  };
495 
496 }
makVrv::DtVirtualBaseClass
Virtual base class. Allows for RTTI and proper virtual destruction. Used by Creators, Factories, Providers, Assemblers and User Interfaces.
Definition: DtVirtualBaseClass.h:19
makVrf::DtVrfExtendedApplicationSettings::signal_extendedApplicationOptionsChanged
boost::signals2::signal< void()> signal_extendedApplicationOptionsChanged
Signal sent any time an option changes.
Definition: vrfExtendedApplicationSettings.h:472
makVrf::DtVrfExtendedApplicationSettingsData
This class will be used to store the extended application states and will be referenced by the DtVrfE...
Definition: vrfExtendedApplicationSettings.h:31
makVrf::DtVrfExtendedApplicationSettingsData::myObjectConsoleBufferSize
int myObjectConsoleBufferSize
Definition: vrfExtendedApplicationSettings.h:262
size
voidpf void uLong size
Definition: ioapi.h:39
makVrf::DtVrfExtendedApplicationSettingsData::dataVersion
virtual int dataVersion() override
Override in subclass to version data.
Definition: vrfExtendedApplicationSettings.h:240
makVrf::DtVrfExtendedApplicationSettingsData::myDateAndTimeOfDayFormat
std::string myDateAndTimeOfDayFormat
Definition: vrfExtendedApplicationSettings.h:250
makVrf::DtVrfExtendedApplicationSettingsData::mySimQueryUpdateTime
double mySimQueryUpdateTime
Definition: vrfExtendedApplicationSettings.h:261
makVrf::DtVrfExtendedApplicationSettingsData::myChatDateAndTimeOfDayFormat
std::string myChatDateAndTimeOfDayFormat
Definition: vrfExtendedApplicationSettings.h:251
makVrf::DtVrfExtendedApplicationSettingsData::Flags
Flags
Definition: vrfExtendedApplicationSettings.h:35
DT_DLL_VRFGUICORE
#define DT_DLL_VRFGUICORE
Contains DLL export macros.
Definition: vrfGuiCore.h:25
makVrf::DtVrfExtendedApplicationSettings
The DtVrfExtendedApplicationSettings class will use the DtVrfGuiApplicationSettings class to keep a f...
Definition: vrfExtendedApplicationSettings.h:285
DtDisplayUnitsSettingsManager.h
Contains the DtDisplayUnitsSettingsManager class declaration.
makVrf::DtVrfGuiApplicationSetting
Definition: vrfGuiApplicationSettings.h:37
makVrf::DtVrfExtendedApplicationSettings::signal_searchBarVisibilityChanged
boost::signals2::signal< void(bool)> signal_searchBarVisibilityChanged
Signal sent when the search bar hide/show changes. Flag is true if shown.
Definition: vrfExtendedApplicationSettings.h:475
makVrf::DtVrfExtendedApplicationSettingsData::myAllowChangingOfExtendedLabels
bool myAllowChangingOfExtendedLabels
Definition: vrfExtendedApplicationSettings.h:255
makVrf::DtVrfExtendedApplicationSettings::signal_objectConsoleBufferSizeChanged
boost::signals2::signal< void(double)> signal_objectConsoleBufferSizeChanged
Signal when object console buffer size changes.
Definition: vrfExtendedApplicationSettings.h:481
makVrf::DtVrfExtendedApplicationSettingsData::myQtDesignerLocation
std::string myQtDesignerLocation
Definition: vrfExtendedApplicationSettings.h:269
makVrf::DtVrfExtendedApplicationSettingsData::myFlags
int myFlags
Definition: vrfExtendedApplicationSettings.h:248
makVrf::DtVrfExtendedApplicationSettings::myDe
makVrv::DtDe & myDe
Definition: vrfExtendedApplicationSettings.h:492
makVrf::DtVrfExtendedApplicationSettingsData::myCloseScenarioSendTimeoutRetry
double myCloseScenarioSendTimeoutRetry
The amount of time to wait before sending close message again if no response from back-end (default 1...
Definition: vrfExtendedApplicationSettings.h:277
makVrf::DtVrfExtendedApplicationSettingsData::myCloseRetryCount
int myCloseRetryCount
Definition: vrfExtendedApplicationSettings.h:278
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellWidth
double myMaximumNavigationAreaCellWidth
Definition: vrfExtendedApplicationSettings.h:264
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultIconList
std::string myDefaultIconList
Definition: vrfExtendedApplicationSettings.h:271
makVrf::DtVrfExtendedApplicationSettingsData::myUseLocalTimezone
bool myUseLocalTimezone
Definition: vrfExtendedApplicationSettings.h:254
makVrf::DtVrfExtendedApplicationSettingsData::myPaletteItemsVisibilityMap
PaletteItemsVisibilityMap myPaletteItemsVisibilityMap
Definition: vrfExtendedApplicationSettings.h:259
vrfExtendedApplicationSettings.h
Contains the makVrf::DtVrfExtendedApplicationSettings class declaration.
makVrf::DtVrfExtendedApplicationSettings::signal_simQueryUpdateTimeChanged
boost::signals2::signal< void(double)> signal_simQueryUpdateTimeChanged
Signal when sim query update time changes.
Definition: vrfExtendedApplicationSettings.h:478
makVrv::vrvTacticalGraphicUtilities::length
DT_DLL_VRVCORE double length(const makVrv::DtCoordinateSystem &, const std::vector< DtVector > &vertices)
Returns the total distance of a segmented line defined by the provided vector of vertices. Coordinates are in local database coordinates. The coordinate system is used to convert between the local database coordinates and geocentric. All distance is in 2D – the Z value is ignored.
makVrf::DtVrfExtendedApplicationSettingsData::myAllowBackendShutdown
bool myAllowBackendShutdown
Separate flag out to make it easier to edit in file.
Definition: vrfExtendedApplicationSettings.h:274
makVrv::DtDe
The DtDe is the core component of any VR-Vantage application. It owns a DtRenderer, DtDeCommunicator, as well as a DtDisplay and other things.
Definition: DtDe.h:76
makVrf::DtVrfExtendedApplicationSettingsData::myMaximumNavigationAreaCellLength
double myMaximumNavigationAreaCellLength
Definition: vrfExtendedApplicationSettings.h:265
makVrf::DtVrfExtendedApplicationSettingsData::myDefaultLayoutSettingsFile
std::string myDefaultLayoutSettingsFile
Definition: vrfExtendedApplicationSettings.h:268
makVrf::DtVrfExtendedApplicationSettings::signal_defaultIconListChanged
boost::signals2::signal< void(std::string)> signal_defaultIconListChanged
Signal when the default icon list changed.
Definition: vrfExtendedApplicationSettings.h:484
makVrf::DtVrfExtendedApplicationSettingsData::myFormatsSet
std::string myFormatsSet
Definition: vrfExtendedApplicationSettings.h:253
makVrf::DtVrfExtendedApplicationSettingsData::myAsynchLoadBufferTime
double myAsynchLoadBufferTime
Definition: vrfExtendedApplicationSettings.h:266
makVrf::DtVrfExtendedApplicationSettingsData::myTimezone
std::string myTimezone
Definition: vrfExtendedApplicationSettings.h:252
makVrf::DtVrfExtendedApplicationSettingsData::PaletteItemsVisibilityMap
std::map< std::string, bool > PaletteItemsVisibilityMap
No longer used as of VRF 4.5, but, kept around for reading previous files.
Definition: vrfExtendedApplicationSettings.h:258
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)