src/Cockpit/panel.hxx

   1 //  panel.hxx - generic support classes for a 2D panel.
   2 //
   3 //  Written by David Megginson, started January 2000.
   4 //
   5 //  This program is free software; you can redistribute it and/or
   6 //  modify it under the terms of the GNU General Public License as
   7 //  published by the Free Software Foundation; either version 2 of the
   8 //  License, or (at your option) any later version.
   9 //
  10 //  This program is distributed in the hope that it will be useful, but
  11 //  WITHOUT ANY WARRANTY; without even the implied warranty of
  12 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 //  General Public License for more details.
  14 //
  15 //  You should have received a copy of the GNU General Public License
  16 //  along with this program; if not, write to the Free Software
  17 //  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 //
  19 //  $Id$
  20
  21 #ifndef __PANEL_HXX
  22 #define __PANEL_HXX
  23
  24 #ifndef __cplusplus
  25 # error This library requires C++
  26 #endif
  27
  28
  29 #ifdef HAVE_CONFIG_H
  30 #  include <config.h>
  31 #endif
  32
  33 #include <simgear/compiler.h>
  34
  35 #ifdef HAVE_WINDOWS_H
  36 #  include <windows.h>
  37 #endif
  38
  39 #include <GL/glut.h>
  40 #include <plib/ssg.h>
  41
  42 #include <simgear/math/interpolater.hxx>
  43 #include <simgear/misc/props.hxx>
  44 #include <simgear/timing/timestamp.hxx>
  45
  46 #include <vector>
  47 #include <map>
  48 #include <plib/fnt.h>
  49
  50 #include <Main/fgfs.hxx>
  51 #include <Main/fg_props.hxx>
  52
  53 #include <Input/input.hxx>
  54
  55 SG_USING_STD(vector);
  56 SG_USING_STD(map);
  57
  58 class FGPanelInstrument;
  59
  60
  61 \f
  62 ////////////////////////////////////////////////////////////////////////
  63 // Texture management.
  64 ////////////////////////////////////////////////////////////////////////
  65
  66
  67 /**
  68  * Texture manager (should migrate out into FGFS).
  69  *
  70  * This class ensures that no texture is loaded more than once.
  71  */
  72 class FGTextureManager
  73 {
  74 public:
  75   static ssgTexture * createTexture(const string &relativePath);
  76 private:
  77   static map<string,ssgTexture *> _textureMap;
  78 };
  79
  80
  81 /**
  82  * Cropped texture (should migrate out into FGFS).
  83  *
  84  * This structure wraps an SSG texture with cropping information.
  85  */
  86 class FGCroppedTexture
  87 {
  88 public:
  89
  90   FGCroppedTexture ();
  91   FGCroppedTexture (const string &path,
  92                   float _minX = 0.0, float _minY = 0.0,
  93                   float _maxX = 1.0, float _maxY = 1.0);
  94   virtual ~FGCroppedTexture ();
  95
  96   virtual void setPath (const string &path) { _path = path; }
  97
  98   virtual const string &getPath () const { return _path; }
  99
 100   virtual ssgTexture * getTexture ();
 101
 102   virtual void setCrop (float minX, float minY, float maxX, float maxY) {
 103     _minX = minX; _minY = minY; _maxX = maxX; _maxY = maxY;
 104   }
 105
 106   virtual float getMinX () const { return _minX; }
 107   virtual float getMinY () const { return _minY; }
 108   virtual float getMaxX () const { return _maxX; }
 109   virtual float getMaxY () const { return _maxY; }
 110
 111
 112 private:
 113   string _path;
 114   ssgTexture * _texture;
 115   float _minX, _minY, _maxX, _maxY;
 116 };
 117
 118
 119 \f
 120 ////////////////////////////////////////////////////////////////////////
 121 // Top-level panel.
 122 ////////////////////////////////////////////////////////////////////////
 123
 124
 125 /**
 126  * Instrument panel class.
 127  *
 128  * The panel is a container that has a background texture and holds
 129  * zero or more instruments.  The panel will order the instruments to
 130  * redraw themselves when necessary, and will pass mouse clicks on to
 131  * the appropriate instruments for processing.
 132  */
 133 class FGPanel : public FGSubsystem
 134 {
 135 public:
 136
 137   FGPanel ();
 138   virtual ~FGPanel ();
 139
 140                                 // Update the panel (every frame).
 141   virtual void init ();
 142   virtual void bind ();
 143   virtual void unbind ();
 144   virtual void update ();
 145   virtual void update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh);
 146
 147                                 // transfer pointer ownership!!!
 148   virtual void addInstrument (FGPanelInstrument * instrument);
 149
 150                                 // Background texture.
 151   virtual void setBackground (ssgTexture * texture);
 152
 153                                 // Make the panel visible or invisible.
 154   virtual bool getVisibility () const;
 155   virtual void setVisibility (bool visibility);
 156
 157                                 // Full width of panel.
 158   virtual void setWidth (int width) { _width = width; }
 159   virtual int getWidth () const { return _width; }
 160
 161                                 // Full height of panel.
 162   virtual void setHeight (int height) { _height = height; }
 163   virtual int getHeight () const { return _height; }
 164
 165                                 // X-offset
 166   virtual void setXOffset (int offset);
 167   virtual int getXOffset () const { return _x_offset; }
 168
 169                                 // Y-offset.
 170   virtual void setYOffset (int offset);
 171   virtual int getYOffset () const { return _y_offset; }
 172
 173                                 // View height.
 174   virtual void setViewHeight (int height) { _view_height = height; }
 175   virtual int getViewHeight () const { return _view_height; }
 176
 177                                 // Handle a mouse click.
 178   virtual bool doMouseAction (int button, int updown, int x, int y);
 179
 180 private:
 181   mutable bool _visibility;
 182   mutable bool _mouseDown;
 183   mutable int _mouseButton, _mouseX, _mouseY;
 184   mutable int _mouseDelay;
 185   mutable FGPanelInstrument * _mouseInstrument;
 186   typedef vector<FGPanelInstrument *> instrument_list_type;
 187   int _width;
 188   int _height;
 189   int _x_offset;
 190   int _y_offset;
 191   int _view_height;
 192   bool _bound;
 193
 194   const SGPropertyNode * _xsize_node;
 195   const SGPropertyNode * _ysize_node;
 196
 197   ssgTexture * _bg;
 198                                 // List of instruments in panel.
 199   instrument_list_type _instruments;
 200 };
 201
 202
 203 \f
 204 ////////////////////////////////////////////////////////////////////////
 205 // Actions
 206 ////////////////////////////////////////////////////////////////////////
 207
 208
 209 /**
 210  * Class for user actions.
 211  *
 212  * The actions are command bindings, like bindings for the keyboard
 213  * or joystick, but they are tied to specific mouse actions in
 214  * rectangular areas of the panel.
 215  */
 216 class FGPanelAction : public FGConditional
 217 {
 218 public:
 219   FGPanelAction ();
 220   FGPanelAction (int button, int x, int y, int w, int h);
 221   virtual ~FGPanelAction ();
 222
 223                                 // Getters.
 224   virtual int getButton () const { return _button; }
 225   virtual int getX () const { return _x; }
 226   virtual int getY () const { return _y; }
 227   virtual int getWidth () const { return _w; }
 228   virtual int getHeight () const { return _h; }
 229
 230                                 // Setters.
 231
 232                                 // transfer pointer ownership
 233   virtual void addBinding (FGBinding * binding);
 234   virtual void setButton (int button) { _button = button; }
 235   virtual void setX (int x) { _x = x; }
 236   virtual void setY (int y) { _y = y; }
 237   virtual void setWidth (int w) { _w = w; }
 238   virtual void setHeight (int h) { _h = h; }
 239
 240                                 // Check whether we're in the area.
 241   virtual bool inArea (int button, int x, int y)
 242   {
 243     return (button == _button &&
 244             x >= _x &&
 245             x < _x + _w &&
 246             y >= _y &&
 247             y < _y + _h);
 248   }
 249
 250                                 // Perform the action.
 251   virtual void doAction ();
 252
 253 private:
 254   typedef vector<FGBinding *> binding_list_t;
 255
 256   int _button;
 257   int _x;
 258   int _y;
 259   int _w;
 260   int _h;
 261   binding_list_t _bindings;
 262 };
 263
 264
 265 \f
 266 ////////////////////////////////////////////////////////////////////////
 267 // Transformations.
 268 ////////////////////////////////////////////////////////////////////////
 269
 270
 271 /**
 272  * A transformation for a layer.
 273  */
 274 class FGPanelTransformation : public FGConditional
 275 {
 276 public:
 277
 278   enum Type {
 279     XSHIFT,
 280     YSHIFT,
 281     ROTATION
 282   };
 283
 284   FGPanelTransformation ();
 285   virtual ~FGPanelTransformation ();
 286
 287   Type type;
 288   const SGPropertyNode * node;
 289   float min;
 290   float max;
 291   float factor;
 292   float offset;
 293   SGInterpTable * table;
 294 };
 295
 296
 297
 298 \f
 299 ////////////////////////////////////////////////////////////////////////
 300 // Layers
 301 ////////////////////////////////////////////////////////////////////////
 302
 303
 304 /**
 305  * A single layer of a multi-layered instrument.
 306  *
 307  * Each layer can be subject to a series of transformations based
 308  * on current FGFS instrument readings: for example, a texture
 309  * representing a needle can rotate to show the airspeed.
 310  */
 311 class FGInstrumentLayer : public FGConditional
 312 {
 313 public:
 314
 315   FGInstrumentLayer (int w = -1, int h = -1);
 316   virtual ~FGInstrumentLayer ();
 317
 318   virtual void draw () = 0;
 319   virtual void transform () const;
 320
 321   virtual int getWidth () const { return _w; }
 322   virtual int getHeight () const { return _h; }
 323   virtual void setWidth (int w) { _w = w; }
 324   virtual void setHeight (int h) { _h = h; }
 325
 326                                 // Transfer pointer ownership!!
 327                                 // DEPRECATED
 328   virtual void addTransformation (FGPanelTransformation * transformation);
 329
 330 protected:
 331   int _w, _h;
 332
 333   typedef vector<FGPanelTransformation *> transformation_list;
 334   transformation_list _transformations;
 335 };
 336
 337
 338 \f
 339 ////////////////////////////////////////////////////////////////////////
 340 // Instruments.
 341 ////////////////////////////////////////////////////////////////////////
 342
 343
 344 /**
 345  * Abstract base class for a panel instrument.
 346  *
 347  * A panel instrument consists of zero or more actions, associated
 348  * with mouse clicks in rectangular areas.  Currently, the only
 349  * concrete class derived from this is FGLayeredInstrument, but others
 350  * may show up in the future (some complex instruments could be
 351  * entirely hand-coded, for example).
 352  */
 353 class FGPanelInstrument : public FGConditional
 354 {
 355 public:
 356   FGPanelInstrument ();
 357   FGPanelInstrument (int x, int y, int w, int h);
 358   virtual ~FGPanelInstrument ();
 359
 360   virtual void draw () = 0;
 361
 362   virtual void setPosition(int x, int y);
 363   virtual void setSize(int w, int h);
 364
 365   virtual int getXPos () const;
 366   virtual int getYPos () const;
 367   virtual int getWidth () const;
 368   virtual int getHeight () const;
 369
 370                                 // Coordinates relative to centre.
 371                                 // Transfer pointer ownership!!
 372   virtual void addAction (FGPanelAction * action);
 373
 374                                 // Coordinates relative to centre.
 375   virtual bool doMouseAction (int button, int x, int y);
 376
 377 protected:
 378   int _x, _y, _w, _h;
 379   typedef vector<FGPanelAction *> action_list_type;
 380   action_list_type _actions;
 381 };
 382
 383
 384 /**
 385  * An instrument constructed of multiple layers.
 386  *
 387  * Each individual layer can be rotated or shifted to correspond
 388  * to internal FGFS instrument readings.
 389  */
 390 class FGLayeredInstrument : public FGPanelInstrument
 391 {
 392 public:
 393   FGLayeredInstrument (int x, int y, int w, int h);
 394   virtual ~FGLayeredInstrument ();
 395
 396   virtual void draw ();
 397
 398                                 // Transfer pointer ownership!!
 399   virtual int addLayer (FGInstrumentLayer *layer);
 400   virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
 401
 402                                 // Transfer pointer ownership!!
 403   virtual void addTransformation (FGPanelTransformation * transformation);
 404
 405 protected:
 406   typedef vector<FGInstrumentLayer *> layer_list;
 407   layer_list _layers;
 408 };
 409
 410
 411 /**
 412  * An instrument layer containing a group of sublayers.
 413  *
 414  * This class is useful for gathering together a group of related
 415  * layers, either to hold in an external file or to work under
 416  * the same condition.
 417  */
 418 class FGGroupLayer : public FGInstrumentLayer
 419 {
 420 public:
 421   FGGroupLayer ();
 422   virtual ~FGGroupLayer ();
 423   virtual void draw ();
 424                                 // transfer pointer ownership
 425   virtual void addLayer (FGInstrumentLayer * layer);
 426 private:
 427   vector<FGInstrumentLayer *> _layers;
 428 };
 429
 430
 431 /**
 432  * A textured layer of an instrument.
 433  *
 434  * This is a layer holding a single texture.  Normally, the texture's
 435  * backgound should be transparent so that lower layers and the panel
 436  * background can show through.
 437  */
 438 class FGTexturedLayer : public FGInstrumentLayer
 439 {
 440 public:
 441   FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
 442   FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
 443   virtual ~FGTexturedLayer ();
 444
 445   virtual void draw ();
 446
 447   virtual void setTexture (const FGCroppedTexture &texture) {
 448     _texture = texture;
 449   }
 450   virtual FGCroppedTexture &getTexture () { return _texture; }
 451   virtual const FGCroppedTexture &getTexture () const { return _texture; }
 452
 453 private:
 454   mutable FGCroppedTexture _texture;
 455 };
 456
 457
 458 /**
 459  * A text layer of an instrument.
 460  *
 461  * This is a layer holding a string of static and/or generated text.
 462  * It is useful for instruments that have text displays, such as
 463  * a chronometer, GPS, or NavCom radio.
 464  */
 465 class FGTextLayer : public FGInstrumentLayer
 466 {
 467 public:
 468   typedef enum ChunkType {
 469     TEXT,
 470     TEXT_VALUE,
 471     DOUBLE_VALUE
 472   };
 473
 474   class Chunk : public FGConditional
 475   {
 476   public:
 477     Chunk (const string &text, const string &fmt = "%s");
 478     Chunk (ChunkType type, const SGPropertyNode * node,
 479            const string &fmt = "", float mult = 1.0);
 480
 481     const char * getValue () const;
 482   private:
 483     ChunkType _type;
 484     string _text;
 485     const SGPropertyNode * _node;
 486     string _fmt;
 487     float _mult;
 488     mutable char _buf[1024];
 489   };
 490
 491   FGTextLayer (int w = -1, int h = -1);
 492   virtual ~FGTextLayer ();
 493
 494   virtual void draw ();
 495
 496                                 // Transfer pointer!!
 497   virtual void addChunk (Chunk * chunk);
 498   virtual void setColor (float r, float g, float b);
 499   virtual void setPointSize (float size);
 500   virtual void setFont (fntFont * font);
 501
 502 private:
 503
 504   void recalc_value () const;
 505
 506   typedef vector<Chunk *> chunk_list;
 507   chunk_list _chunks;
 508   float _color[4];
 509
 510   float _pointSize;
 511
 512   mutable string _value;
 513   mutable SGTimeStamp _then;
 514   mutable SGTimeStamp _now;
 515 };
 516
 517
 518 /**
 519  * A layer that switches between two other layers.
 520  *
 521  * The usefulness of this layer is questionable now that all layers
 522  * can have conditions, and it may be deprecated soon.
 523  */
 524 class FGSwitchLayer : public FGInstrumentLayer
 525 {
 526 public:
 527                                 // Transfer pointers!!
 528   FGSwitchLayer (int w, int h, const SGPropertyNode * node,
 529                  FGInstrumentLayer * layer1,
 530                  FGInstrumentLayer * layer2);
 531   virtual ~FGSwitchLayer ();
 532
 533   virtual void draw ();
 534
 535 private:
 536   const SGPropertyNode * _node;
 537   FGInstrumentLayer * _layer1, * _layer2;
 538 };
 539
 540
 541
 542 \f
 543 ////////////////////////////////////////////////////////////////////////
 544 // Functions.
 545 ////////////////////////////////////////////////////////////////////////
 546
 547 /**
 548  * Test whether the panel should be visible.
 549  */
 550 bool fgPanelVisible ();
 551
 552
 553 \f
 554 ////////////////////////////////////////////////////////////////////////
 555 // The current panel, if any.
 556 ////////////////////////////////////////////////////////////////////////
 557
 558 extern FGPanel * current_panel; // TODO: move to globals
 559
 560
 561 \f
 562 #endif // __PANEL_HXX
 563
 564 // end of panel.hxx
 565
 566