src/GUI/new_gui.hxx

   1 // new_gui.hxx - XML-configured GUI subsystem.
   2
   3 #ifndef __NEW_GUI_HXX
   4 #define __NEW_GUI_HXX 1
   5
   6 #ifndef __cplusplus
   7 # error This library requires C++
   8 #endif
   9
  10 #ifdef HAVE_CONFIG_H
  11 #  include <config.h>
  12 #endif
  13
  14 #include <plib/pu.h>
  15
  16 #include <simgear/compiler.h>   // for SG_USING_STD
  17 #include <simgear/props/props.hxx>
  18 #include <simgear/structure/subsystem_mgr.hxx>
  19
  20 #include <vector>
  21 SG_USING_STD(vector);
  22
  23 #include <map>
  24 SG_USING_STD(map);
  25
  26 #include <Main/fg_props.hxx>
  27
  28 class FGMenuBar;
  29 class FGDialog;
  30 class FGBinding;
  31 class FGColor;
  32
  33
  34 /**
  35  * XML-configured GUI subsystem.
  36  *
  37  * This subsystem manages the graphical user interface for FlightGear.
  38  * It creates a menubar from the XML configuration file in
  39  * $FG_ROOT/gui/menubar.xml, then stores the configuration properties
  40  * for XML-configured dialog boxes found in $FG_ROOT/gui/dialogs/.  It
  41  * can show or hide the menubar, and can display any dialog by name.
  42  */
  43 class NewGUI : public SGSubsystem
  44 {
  45 public:
  46
  47     /**
  48      * Constructor.
  49      */
  50     NewGUI ();
  51
  52     /**
  53      * Destructor.
  54      */
  55     virtual ~NewGUI ();
  56
  57     /**
  58      * Initialize the GUI subsystem.
  59      */
  60     virtual void init ();
  61
  62     /**
  63      * Reinitialize the GUI subsystem.
  64      */
  65     virtual void reinit ();
  66
  67     /**
  68      * Bind properties for the GUI subsystem.
  69      *
  70      * Currently, this method binds the properties for showing and
  71      * hiding the menu.
  72      */
  73     virtual void bind ();
  74
  75     /**
  76      * Unbind properties for the GUI subsystem.
  77      */
  78     virtual void unbind ();
  79
  80     /**
  81      * Update the GUI subsystem.
  82      *
  83      * Currently, this method is a no-op, because nothing the GUI
  84      * subsystem does is time-dependent.
  85      */
  86     virtual void update (double delta_time_sec);
  87
  88     /**
  89      * Creates a new dialog box, using the same property format as the
  90      * gui/dialogs configuration files.  Does not display the
  91      * resulting dialog.  If a pre-existing dialog of the same name
  92      * exists, it will be deleted.  The node argument will be stored
  93      * in the GUI subsystem using SGPropertNode_ptr reference counting.
  94      * It should not be deleted by user code.
  95      *
  96      * @param node A property node containing the dialog definition
  97      */
  98     virtual void newDialog (SGPropertyNode* node);
  99
 100     /**
 101      * Display a dialog box.
 102      *
 103      * At initialization time, the subsystem reads all of the XML
 104      * configuration files from the directory $FG_ROOT/gui/dialogs/.
 105      * The configuration for each dialog specifies a name, and this
 106      * method invokes the dialog with the name specified (if it
 107      * exists).
 108      *
 109      * @param name The name of the dialog box.
 110      * @return true if the dialog exists, false otherwise.
 111      */
 112     virtual bool showDialog (const string &name);
 113
 114
 115     /**
 116      * Close the currenty active dialog.  This function is intended to
 117      * be called from code (pui callbacks, for instance) that registers
 118      * its dialog object as active via setActiveDialog().  Other
 119      * user-level code should use the closeDialog(name) API.
 120      *
 121      * @return true if a dialog was active, false otherwise
 122      */
 123     virtual bool closeActiveDialog ();
 124
 125     /**
 126      * Close a named dialog, if it is open.
 127      *
 128      * @param name The name of the dialog box.
 129      * @return true if the dialog was active, false otherwise.
 130      */
 131     virtual bool closeDialog (const string &name);
 132
 133     /**
 134      * Return a pointer to the current menubar.
 135      */
 136     virtual FGMenuBar * getMenuBar ();
 137
 138
 139     /**
 140      * Ignore this method.
 141      *
 142      * This method is for internal use only, but it has to be public
 143      * so that a non-class callback can see it.
 144      */
 145     virtual void setActiveDialog (FGDialog * dialog);
 146
 147     /**
 148      * Get the dialog currently active, if any.
 149      *
 150      * @return The active dialog, or 0 if none is active.
 151      */
 152     virtual FGDialog * getActiveDialog ();
 153
 154     virtual const FGColor& getColor (const char * which) { return _colors[which]; }
 155     virtual const FGColor& getColor (string which) { return _colors[which.c_str()]; }
 156
 157     virtual puFont *getDefaultFont() { return &_font; }
 158
 159 protected:
 160
 161     /**
 162      * Test if the menubar is visible.
 163      *
 164      * This method exists only for binding.
 165      */
 166     virtual bool getMenuBarVisible () const;
 167
 168     /**
 169      * Show or hide the menubar.
 170      *
 171      * This method exists only for binding.
 172      */
 173     virtual void setMenuBarVisible (bool visible);
 174
 175     virtual void setStyle ();
 176     virtual void setupFont ();
 177
 178 private:
 179     fntTexFont _tex_font;
 180     puFont _font;
 181     map<string,FGColor> _colors;
 182
 183     // Free all allocated memory.
 184     void clear ();
 185
 186     // Read all the configuration files in a directory.
 187     void readDir (const char * path);
 188
 189     FGMenuBar * _menubar;
 190     FGDialog * _active_dialog;
 191     map<string,FGDialog *> _active_dialogs;
 192     map<string,SGPropertyNode_ptr> _dialog_props;
 193
 194 };
 195
 196
 197 class FGColor {
 198 public:
 199         FGColor() { clear(); }
 200         FGColor(float r, float g, float b, float a = 1.0f) { set(r, g, b, a); }
 201         FGColor(const SGPropertyNode *prop) { set(prop); }
 202
 203         FGColor& operator=(const FGColor& c) {
 204                 _red = c._red;
 205                 _green = c._green;
 206                 _blue = c._blue;
 207                 _alpha = c._alpha;
 208                 return *this;
 209         }
 210
 211         inline void clear() { _red = _green = _blue = -1.0f; _alpha = 1.0f; }
 212         // merges in non-negative components from property with children <red> etc.
 213         void merge(const SGPropertyNode *prop);
 214         void merge(const FGColor& color);
 215
 216         void set(const SGPropertyNode *prop) { clear(); merge(prop); };
 217         void set(const FGColor& color) { clear(); merge(color); }
 218         void set(float r, float g, float b, float a = 1.0f) {
 219                 _red = clamp(r), _green = clamp(g), _blue = clamp(b), _alpha = clamp(a);
 220         }
 221         bool isValid() const {
 222                 return _red >= 0.0 && _green >= 0.0 && _blue >= 0.0
 223                                 && _alpha >= 0.0;
 224         }
 225         void print() const {
 226                 std::cerr << "red=" << _red << ", green=" << _green
 227                 << ", blue=" << _blue << ", alpha=" << _alpha << std::endl;
 228         }
 229
 230         inline void setRed(float red) { _red = clamp(red); }
 231         inline void setGreen(float green) { _green = clamp(green); }
 232         inline void setBlue(float blue) { _blue = clamp(blue); }
 233         inline void setAlpha(float alpha) { _alpha = clamp(alpha); }
 234
 235         inline float red() const { return _red; }
 236         inline float green() const { return _green; }
 237         inline float blue() const { return _blue; }
 238         inline float alpha() const { return _alpha; }
 239
 240 protected:
 241         float _red, _green, _blue, _alpha;
 242
 243 private:
 244         float clamp(float f) { return f < 0.0 ? 0.0 : f > 1.0 ? 1.0 : f; }
 245 };
 246
 247
 248 #endif // __NEW_GUI_HXX
 249