VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
vrfExtendedEntitySettings.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
8 
9 #pragma once
10 
11 #include <vrfGuiCore/vrfGuiCore.h>
12 #include <vrfGuiCore/vrfGuiApplicationSettings.h>
13 
14 #include <vrvCore/DtObserverSettingsManager.h>
15 #include <boost/signals2.hpp>
16 
17 namespace makVrv
18 {
19  class DtDe;
20 }
21 
22 namespace makVrf
23 {
24  const makVrv::DtObserverSettingsManager::ObserverSetting DtVrfGuiEntityExtentsShowType = makVrv::DtObserverSettingsManager::ObserverSetting(202);
25 
28  class DT_DLL_VRFGUICORE DtVrfExtendedEntitySettingsData : public DtVrfGuiApplicationSetting
29  {
30  protected:
31  enum Flags
32  {
33  DisplayObjectConsoleWarningIcon = 0x00000001,
34  DisplayBoundingBoxesWhenSelected = 0x00000002,
35  AllowNonVrfEntitiesToBeTasked = 0x00000010,
36  DisplayAttackLines = 0x00000020,
37  DisplayAttackAnimation = 0x00000040,
38  DisplaySupplyLines = 0x00000080,
39  DisplayGumballs = 0x00000100,
40  DisplayTaskVisualizationsWhenSelected = 0x00000200,
41  AutomaticallSelectDeselectAggregateExpansionChanges = 0x00000800,
42  DisplayHealth = 0x00001000,
43 
44  Defaults = DisplayObjectConsoleWarningIcon | DisplayAttackLines | DisplayAttackAnimation |
45  DisplaySupplyLines | DisplayHealth | DisplayHealth | DisplayTaskVisualizationsWhenSelected |
46  AutomaticallSelectDeselectAggregateExpansionChanges
47  };
48 
49  public:
50  DtVrfExtendedEntitySettingsData(makVrv::DtDe* = 0);
51  DtVrfExtendedEntitySettingsData(const DtVrfExtendedEntitySettingsData&);
52 
53  virtual ~DtVrfExtendedEntitySettingsData();
54 
56  virtual void setDisplayObjectConsoleWarningIcon(bool);
57  virtual bool displayObjectConsoleWarningIcon() const;
58 
60  virtual void setShowGumballs(bool);
61  virtual bool showGumballs() const;
62 
64  virtual void setShowHealth(bool);
65  virtual bool showHealth() const;
66 
68  virtual void setDisplayAttackLines(bool);
69  virtual bool displayAttackLines() const;
70 
72  virtual void setDisplayAttackAnimation(bool);
73  virtual bool displayAttackAnimation() const;
74 
76  virtual void setDisplaySupplyLines(bool);
77  virtual bool displaySupplyLines() const;
78 
81  virtual void setDisplayBoundingBoxesWhenSelected(bool);
82  virtual bool displayBoundingBoxesWhenSelected() const;
83 
85  virtual void setAutomaticallSelectDeselectAggregateExpansionChanges(bool);
86  virtual bool automaticallSelectDeselectAggregateExpansionChanges() const;
87 
90  virtual void setDisplayTaskVisualizationsWhenSelected(bool);
91  virtual bool displayTaskVisualizationsWhenSelected() const;
92 
94  virtual void setAllowNonVrfObjectsToBeTasked(bool);
95  virtual bool allowNonVrfObjectsToBeTasked() const;
96 
98  virtual DtVrfGuiApplicationSetting* clone() const;
99 
101  virtual std::string classType() const;
102 
104  virtual void write(boost::archive::xml_oarchive& out, const unsigned int);
105  virtual void read(boost::archive::xml_iarchive& in, const unsigned int);
106 
108  virtual void setFlags(int);
109  virtual int flags() const;
110 
112  virtual int dataVersion() { return 2; };
113 
114  protected:
115  virtual void setFlag(Flags, bool);
116 
117  protected:
118  int myFlags;
119  };
120 
124  class DT_DLL_VRFGUICORE DtVrfExtendedEntitySettings : public makVrv::DtVirtualBaseClass
125  {
126  public:
127  DtVrfExtendedEntitySettings(makVrv::DtDe&);
128 
129  virtual ~DtVrfExtendedEntitySettings();
130 
132  virtual void setDisplayObjectConsoleWarningIcon(bool);
133  virtual bool displayObjectConsoleWarningIcon() const;
134 
136  virtual void setDisplayAttackLines(bool);
137  virtual bool displayAttackLines() const;
138 
140  virtual void setDisplayAttackAnimation(bool);
141  virtual bool displayAttackAnimation() const;
142 
144  virtual void setDisplaySupplyLines(bool);
145  virtual bool displaySupplyLines() const;
146 
149  virtual void setDisplayBoundingBoxesWhenSelected(bool);
150  virtual bool displayBoundingBoxesWhenSelected() const;
151 
154  virtual void setDisplayTaskVisualizationsWhenSelected(bool);
155  virtual bool displayTaskVisualizationsWhenSelected() const;
156 
158  virtual void setAutomaticallSelectDeselectAggregateExpansionChanges(bool);
159  virtual bool automaticallSelectDeselectAggregateExpansionChanges() const;
160 
162  virtual void setShowGumballs(bool);
163  virtual bool showGumballs() const;
164 
166  virtual void setShowHealth(bool);
167  virtual bool showHealth() const;
168 
170  virtual void setPromptBeforeAbandoningPlan(bool);
171  virtual bool promptBeforeAbandoningPlan() const;
172 
174  virtual void setPromptBeforeInterruptingTask(bool);
175  virtual bool promptBeforeInterruptingTask() const;
176 
178  virtual void setAllowNonVrfObjectsToBeTasked(bool);
179  virtual bool allowNonVrfObjectsToBeTasked() const;
180 
182  virtual void setFlags(int);
183  virtual int flags() const;
184 
185  static DtVrfExtendedEntitySettings& instance( makVrv::DtDe& de );
186  static void registerInstance(makVrv::DtDe&, DtVrfExtendedEntitySettings*);
187 
190  virtual void setImageFileForCategory(const std::string&, const std::string&);
191  virtual std::string imageFileForCategory(const std::string&) const;
193 
195  boost::signals2::signal<void ()> signal_extendedEntityOptionsChanged;
196  boost::signals2::signal<void (bool)> signal_gumballSettingsChanged;
197  boost::signals2::signal<void (bool)> signal_healthSettingsChanged;
198 
199  protected:
200  makVrv::DtDe& myDe;
201  };
202 }
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::DtVrfExtendedEntitySettingsData::myFlags
int myFlags
Definition: vrfExtendedEntitySettings.h:118
makVrf::DtVrfExtendedEntitySettings::signal_extendedEntityOptionsChanged
boost::signals2::signal< void()> signal_extendedEntityOptionsChanged
Signal sent any time an option changes.
Definition: vrfExtendedEntitySettings.h:195
DT_DLL_VRFGUICORE
#define DT_DLL_VRFGUICORE
Contains DLL export macros.
Definition: vrfGuiCore.h:25
DtObserverSettingsManager.h
Contains makVrv::DtObserverSettingsManager class.
makVrf::DtVrfExtendedEntitySettingsData
This class will be used to store the extended entity states and will be referenced by the DtVrfExtend...
Definition: vrfExtendedEntitySettings.h:28
makVrf::DtVrfGuiApplicationSetting
Definition: vrfGuiApplicationSettings.h:37
makVrf::DtVrfExtendedEntitySettings::signal_healthSettingsChanged
boost::signals2::signal< void(bool)> signal_healthSettingsChanged
Definition: vrfExtendedEntitySettings.h:197
makVrf::DtVrfExtendedEntitySettings::myDe
makVrv::DtDe & myDe
Definition: vrfExtendedEntitySettings.h:200
makVrf::DtVrfExtendedEntitySettingsData::dataVersion
virtual int dataVersion()
Override in subclass to version data.
Definition: vrfExtendedEntitySettings.h:112
makVrf::DtVrfExtendedEntitySettings
The DtVrfExtendedEntitySettings class will use the DtVrfGuiApplicationSettings class to keep a flag o...
Definition: vrfExtendedEntitySettings.h:124
makVrf::DtVrfGuiEntityExtentsShowType
const makVrv::DtObserverSettingsManager::ObserverSetting DtVrfGuiEntityExtentsShowType
Definition: vrfExtendedEntitySettings.h:24
makVrv::DtObserverSettingsManager::ObserverSetting
ObserverSetting
Definition: DtObserverSettingsManager.h:40
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:70
makVrf::DtVrfExtendedEntitySettings::signal_gumballSettingsChanged
boost::signals2::signal< void(bool)> signal_gumballSettingsChanged
Definition: vrfExtendedEntitySettings.h:196
makVrf::DtVrfExtendedEntitySettingsData::Flags
Flags
Definition: vrfExtendedEntitySettings.h:31
Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)