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 #include <simgear/misc/sg_path.hxx>
  20
  21 #include <vector>
  22 #include <map>
  23
  24 SG_USING_STD(vector);
  25 SG_USING_STD(map);
  26 SG_USING_STD(string);
  27
  28 #include <Main/fg_props.hxx>
  29
  30 class FGMenuBar;
  31 class FGDialog;
  32 class FGBinding;
  33 class FGColor;
  34 class FGFontCache;
  35
  36
  37 /**
  38  * XML-configured GUI subsystem.
  39  *
  40  * This subsystem manages the graphical user interface for FlightGear.
  41  * It creates a menubar from the XML configuration file in
  42  * $FG_ROOT/gui/menubar.xml, then stores the configuration properties
  43  * for XML-configured dialog boxes found in $FG_ROOT/gui/dialogs/.  It
  44  * can show or hide the menubar, and can display any dialog by name.
  45  */
  46 class NewGUI : public SGSubsystem
  47 {
  48 public:
  49
  50     /**
  51      * Constructor.
  52      */
  53     NewGUI ();
  54
  55     /**
  56      * Destructor.
  57      */
  58     virtual ~NewGUI ();
  59
  60     /**
  61      * Initialize the GUI subsystem.
  62      */
  63     virtual void init ();
  64
  65     /**
  66      * Reinitialize the GUI subsystem.
  67      */
  68     virtual void reinit ();
  69
  70     /**
  71      * Bind properties for the GUI subsystem.
  72      *
  73      * Currently, this method binds the properties for showing and
  74      * hiding the menu.
  75      */
  76     virtual void bind ();
  77
  78     /**
  79      * Unbind properties for the GUI subsystem.
  80      */
  81     virtual void unbind ();
  82
  83     /**
  84      * Update the GUI subsystem.
  85      *
  86      * Currently, this method is a no-op, because nothing the GUI
  87      * subsystem does is time-dependent.
  88      */
  89     virtual void update (double delta_time_sec);
  90
  91     /**
  92      * Creates a new dialog box, using the same property format as the
  93      * gui/dialogs configuration files.  Does not display the
  94      * resulting dialog.  If a pre-existing dialog of the same name
  95      * exists, it will be deleted.  The node argument will be stored
  96      * in the GUI subsystem using SGPropertNode_ptr reference counting.
  97      * It should not be deleted by user code.
  98      *
  99      * @param node A property node containing the dialog definition
 100      */
 101     virtual void newDialog (SGPropertyNode* node);
 102
 103     /**
 104      * Display a dialog box.
 105      *
 106      * At initialization time, the subsystem reads all of the XML
 107      * configuration files from the directory $FG_ROOT/gui/dialogs/.
 108      * The configuration for each dialog specifies a name, and this
 109      * method invokes the dialog with the name specified (if it
 110      * exists).
 111      *
 112      * @param name The name of the dialog box.
 113      * @return true if the dialog exists, false otherwise.
 114      */
 115     virtual bool showDialog (const string &name);
 116
 117
 118     /**
 119      * Close the currenty active dialog.  This function is intended to
 120      * be called from code (pui callbacks, for instance) that registers
 121      * its dialog object as active via setActiveDialog().  Other
 122      * user-level code should use the closeDialog(name) API.
 123      *
 124      * @return true if a dialog was active, false otherwise
 125      */
 126     virtual bool closeActiveDialog ();
 127
 128     /**
 129      * Close a named dialog, if it is open.
 130      *
 131      * @param name The name of the dialog box.
 132      * @return true if the dialog was active, false otherwise.
 133      */
 134     virtual bool closeDialog (const string &name);
 135
 136     /**
 137      * Get dialog property tree's root node.
 138      * @param name The name of the dialog box.
 139      * @return node pointer if the dialog was found, zero otherwise.
 140      */
 141     virtual SGPropertyNode_ptr getDialog (const string &name);
 142
 143     /**
 144      * Return a pointer to the current menubar.
 145      */
 146     virtual FGMenuBar * getMenuBar ();
 147
 148
 149     /**
 150      * Ignore this method.
 151      *
 152      * This method is for internal use only, but it has to be public
 153      * so that a non-class callback can see it.
 154      */
 155     virtual void setActiveDialog (FGDialog * dialog);
 156
 157     /**
 158      * Get the dialog currently active, if any.
 159      *
 160      * @return The active dialog, or 0 if none is active.
 161      */
 162     virtual FGDialog * getActiveDialog ();
 163
 164     virtual FGColor *getColor (const char * name) const {
 165         _citt_t it = _colors.find(name);
 166         return (it != _colors.end()) ? it->second : NULL;
 167     }
 168     virtual FGColor *getColor (const string &name) const {
 169         _citt_t it = _colors.find(name.c_str());
 170         return (it != _colors.end()) ? it->second : NULL;
 171     }
 172
 173     virtual puFont *getDefaultFont() { return &_font; }
 174
 175
 176     /**
 177      * menu wide font cache, accessible from other classes as well.
 178      */
 179     FGFontCache *get_fontcache() { return _fontcache; }
 180
 181 protected:
 182
 183     FGFontCache * _fontcache;
 184
 185     /**
 186      * Test if the menubar is visible.
 187      *
 188      * This method exists only for binding.
 189      */
 190     virtual bool getMenuBarVisible () const;
 191
 192     /**
 193      * Show or hide the menubar.
 194      *
 195      * This method exists only for binding.
 196      */
 197     virtual void setMenuBarVisible (bool visible);
 198
 199     virtual void setStyle ();
 200     virtual void setupFont (SGPropertyNode *);
 201
 202 private:
 203     struct ltstr
 204     {
 205         bool operator()(const char* s1, const char* s2) const {
 206             return strcmp(s1, s2) < 0;
 207         }
 208     };
 209
 210     fntTexFont _tex_font;
 211     puFont _font;
 212     map<const char*,FGColor*, ltstr> _colors;
 213     typedef map<const char*,FGColor*, ltstr>::iterator _itt_t;
 214     typedef map<const char*,FGColor*, ltstr>::const_iterator _citt_t;
 215
 216     // Free all allocated memory.
 217     void clear ();
 218
 219     // Read all the configuration files in a directory.
 220     void readDir (const char * path);
 221
 222     FGMenuBar * _menubar;
 223     FGDialog * _active_dialog;
 224     map<string,FGDialog *> _active_dialogs;
 225     map<string,SGPropertyNode_ptr> _dialog_props;
 226
 227 };
 228
 229
 230 class FGColor {
 231 public:
 232     FGColor() { clear(); }
 233     FGColor(float r, float g, float b, float a = 1.0f) { set(r, g, b, a); }
 234     FGColor(const SGPropertyNode *prop) { set(prop); }
 235     FGColor(FGColor *c) {
 236         if (c) set(c->_red, c->_green, c->_blue, c->_alpha);
 237     }
 238
 239     inline void clear() { _red = _green = _blue = _alpha = -1.0f; }
 240     // merges in non-negative components from property with children <red> etc.
 241     bool merge(const SGPropertyNode *prop);
 242     bool merge(const FGColor *color);
 243
 244     bool set(const SGPropertyNode *prop) { clear(); return merge(prop); };
 245     bool set(const FGColor *color) { clear(); return merge(color); }
 246     bool set(float r, float g, float b, float a = 1.0f) {
 247         _red = r, _green = g, _blue = b, _alpha = a;
 248         return true;
 249     }
 250     bool isValid() const {
 251         return _red >= 0.0 && _green >= 0.0 && _blue >= 0.0;
 252     }
 253     void print() const {
 254         std::cerr << "red=" << _red << ", green=" << _green
 255         << ", blue=" << _blue << ", alpha=" << _alpha << std::endl;
 256     }
 257
 258     inline void setRed(float red) { _red = red; }
 259     inline void setGreen(float green) { _green = green; }
 260     inline void setBlue(float blue) { _blue = blue; }
 261     inline void setAlpha(float alpha) { _alpha = alpha; }
 262
 263     inline float red() const { return clamp(_red); }
 264     inline float green() const { return clamp(_green); }
 265     inline float blue() const { return clamp(_blue); }
 266     inline float alpha() const { return _alpha < 0.0 ? 1.0 : clamp(_alpha); }
 267
 268 protected:
 269     float _red, _green, _blue, _alpha;
 270
 271 private:
 272     float clamp(float f) const { return f < 0.0 ? 0.0 : f > 1.0 ? 1.0 : f; }
 273 };
 274
 275
 276
 277 /**
 278  * A small class to keep all fonts available for future use.
 279  * This also assures a font isn't resident more than once.
 280  */
 281 class FGFontCache {
 282 private:
 283     SGPath _path;
 284
 285     map<const char*,puFont*> _fonts;
 286     typedef map<const char*,puFont*>::iterator _itt_t;
 287
 288 public:
 289     FGFontCache();
 290     ~FGFontCache();
 291
 292     puFont *get(const char *name, float size=15.0, float slant=0.0);
 293     puFont *get(SGPropertyNode *node);
 294 };
 295
 296
 297 #endif // __NEW_GUI_HXX
 298