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 draw ();
 145   virtual void update (double dt);
 146   virtual void update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh);
 147
 148                                 // transfer pointer ownership!!!
 149   virtual void addInstrument (FGPanelInstrument * instrument);
 150
 151                                 // Background texture.
 152   virtual void setBackground (ssgTexture * texture);
 153
 154                                 // Background multiple textures.
 155   virtual void setMultiBackground (ssgTexture * texture, int idx);
 156
 157                                 // Make the panel visible or invisible.
 158   virtual bool getVisibility () const;
 159   virtual void setVisibility (bool visibility);
 160
 161                                 // Full width of panel.
 162   virtual void setWidth (int width) { _width = width; }
 163   virtual int getWidth () const { return _width; }
 164
 165                                 // Full height of panel.
 166   virtual void setHeight (int height) { _height = height; }
 167   virtual int getHeight () const { return _height; }
 168
 169                                 // X-offset
 170   virtual void setXOffset (int offset);
 171   virtual int getXOffset () const { return _x_offset; }
 172
 173                                 // Y-offset.
 174   virtual void setYOffset (int offset);
 175   virtual int getYOffset () const { return _y_offset; }
 176
 177                                 // View height.
 178   virtual void setViewHeight (int height) { _view_height = height; }
 179   virtual int getViewHeight () const { return _view_height; }
 180
 181                                 // Handle a mouse click.
 182   virtual bool doMouseAction (int button, int updown, int x, int y);
 183
 184 private:
 185   void setupVirtualCockpit();
 186   void cleanupVirtualCockpit();
 187
 188   mutable bool _visibility;
 189   mutable bool _mouseDown;
 190   mutable int _mouseButton, _mouseX, _mouseY;
 191   mutable int _mouseDelay;
 192   mutable FGPanelInstrument * _mouseInstrument;
 193   typedef vector<FGPanelInstrument *> instrument_list_type;
 194   int _width;
 195   int _height;
 196   int _x_offset;
 197   int _y_offset;
 198   int _view_height;
 199   float _jitter;
 200
 201   const SGPropertyNode * _xsize_node;
 202   const SGPropertyNode * _ysize_node;
 203
 204   ssgTexture * _bg;
 205   ssgTexture * _mbg[8];
 206                                 // List of instruments in panel.
 207   instrument_list_type _instruments;
 208 };
 209
 210
 211 \f
 212 ////////////////////////////////////////////////////////////////////////
 213 // Actions
 214 ////////////////////////////////////////////////////////////////////////
 215
 216
 217 /**
 218  * Class for user actions.
 219  *
 220  * The actions are command bindings, like bindings for the keyboard
 221  * or joystick, but they are tied to specific mouse actions in
 222  * rectangular areas of the panel.
 223  */
 224 class FGPanelAction : public FGConditional
 225 {
 226 public:
 227   FGPanelAction ();
 228   FGPanelAction (int button, int x, int y, int w, int h);
 229   virtual ~FGPanelAction ();
 230
 231                                 // Getters.
 232   virtual int getButton () const { return _button; }
 233   virtual int getX () const { return _x; }
 234   virtual int getY () const { return _y; }
 235   virtual int getWidth () const { return _w; }
 236   virtual int getHeight () const { return _h; }
 237
 238                                 // Setters.
 239
 240                                 // transfer pointer ownership
 241   virtual void addBinding (FGBinding * binding);
 242   virtual void setButton (int button) { _button = button; }
 243   virtual void setX (int x) { _x = x; }
 244   virtual void setY (int y) { _y = y; }
 245   virtual void setWidth (int w) { _w = w; }
 246   virtual void setHeight (int h) { _h = h; }
 247
 248                                 // Check whether we're in the area.
 249   virtual bool inArea (int button, int x, int y)
 250   {
 251     return (button == _button &&
 252             x >= _x &&
 253             x < _x + _w &&
 254             y >= _y &&
 255             y < _y + _h);
 256   }
 257
 258                                 // Perform the action.
 259   virtual void doAction ();
 260
 261 private:
 262   typedef vector<FGBinding *> binding_list_t;
 263
 264   int _button;
 265   int _x;
 266   int _y;
 267   int _w;
 268   int _h;
 269   binding_list_t _bindings;
 270 };
 271
 272
 273 \f
 274 ////////////////////////////////////////////////////////////////////////
 275 // Transformations.
 276 ////////////////////////////////////////////////////////////////////////
 277
 278
 279 /**
 280  * A transformation for a layer.
 281  */
 282 class FGPanelTransformation : public FGConditional
 283 {
 284 public:
 285
 286   enum Type {
 287     XSHIFT,
 288     YSHIFT,
 289     ROTATION
 290   };
 291
 292   FGPanelTransformation ();
 293   virtual ~FGPanelTransformation ();
 294
 295   Type type;
 296   const SGPropertyNode * node;
 297   float min;
 298   float max;
 299   float factor;
 300   float offset;
 301   SGInterpTable * table;
 302 };
 303
 304
 305
 306 \f
 307 ////////////////////////////////////////////////////////////////////////
 308 // Layers
 309 ////////////////////////////////////////////////////////////////////////
 310
 311
 312 /**
 313  * A single layer of a multi-layered instrument.
 314  *
 315  * Each layer can be subject to a series of transformations based
 316  * on current FGFS instrument readings: for example, a texture
 317  * representing a needle can rotate to show the airspeed.
 318  */
 319 class FGInstrumentLayer : public FGConditional
 320 {
 321 public:
 322
 323   FGInstrumentLayer (int w = -1, int h = -1);
 324   virtual ~FGInstrumentLayer ();
 325
 326   virtual void draw () = 0;
 327   virtual void transform () const;
 328
 329   virtual int getWidth () const { return _w; }
 330   virtual int getHeight () const { return _h; }
 331   virtual void setWidth (int w) { _w = w; }
 332   virtual void setHeight (int h) { _h = h; }
 333
 334                                 // Transfer pointer ownership!!
 335                                 // DEPRECATED
 336   virtual void addTransformation (FGPanelTransformation * transformation);
 337
 338 protected:
 339   int _w, _h;
 340
 341   typedef vector<FGPanelTransformation *> transformation_list;
 342   transformation_list _transformations;
 343 };
 344
 345
 346 \f
 347 ////////////////////////////////////////////////////////////////////////
 348 // Instruments.
 349 ////////////////////////////////////////////////////////////////////////
 350
 351
 352 /**
 353  * Abstract base class for a panel instrument.
 354  *
 355  * A panel instrument consists of zero or more actions, associated
 356  * with mouse clicks in rectangular areas.  Currently, the only
 357  * concrete class derived from this is FGLayeredInstrument, but others
 358  * may show up in the future (some complex instruments could be
 359  * entirely hand-coded, for example).
 360  */
 361 class FGPanelInstrument : public FGConditional
 362 {
 363 public:
 364   FGPanelInstrument ();
 365   FGPanelInstrument (int x, int y, int w, int h);
 366   virtual ~FGPanelInstrument ();
 367
 368   virtual void draw () = 0;
 369
 370   virtual void setPosition(int x, int y);
 371   virtual void setSize(int w, int h);
 372
 373   virtual int getXPos () const;
 374   virtual int getYPos () const;
 375   virtual int getWidth () const;
 376   virtual int getHeight () const;
 377
 378                                 // Coordinates relative to centre.
 379                                 // Transfer pointer ownership!!
 380   virtual void addAction (FGPanelAction * action);
 381
 382                                 // Coordinates relative to centre.
 383   virtual bool doMouseAction (int button, int x, int y);
 384
 385 protected:
 386   int _x, _y, _w, _h;
 387   typedef vector<FGPanelAction *> action_list_type;
 388   action_list_type _actions;
 389 };
 390
 391
 392 /**
 393  * An instrument constructed of multiple layers.
 394  *
 395  * Each individual layer can be rotated or shifted to correspond
 396  * to internal FGFS instrument readings.
 397  */
 398 class FGLayeredInstrument : public FGPanelInstrument
 399 {
 400 public:
 401   FGLayeredInstrument (int x, int y, int w, int h);
 402   virtual ~FGLayeredInstrument ();
 403
 404   virtual void draw ();
 405
 406                                 // Transfer pointer ownership!!
 407   virtual int addLayer (FGInstrumentLayer *layer);
 408   virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
 409
 410                                 // Transfer pointer ownership!!
 411   virtual void addTransformation (FGPanelTransformation * transformation);
 412
 413 protected:
 414   typedef vector<FGInstrumentLayer *> layer_list;
 415   layer_list _layers;
 416 };
 417
 418
 419 /**
 420  * An instrument layer containing a group of sublayers.
 421  *
 422  * This class is useful for gathering together a group of related
 423  * layers, either to hold in an external file or to work under
 424  * the same condition.
 425  */
 426 class FGGroupLayer : public FGInstrumentLayer
 427 {
 428 public:
 429   FGGroupLayer ();
 430   virtual ~FGGroupLayer ();
 431   virtual void draw ();
 432                                 // transfer pointer ownership
 433   virtual void addLayer (FGInstrumentLayer * layer);
 434 private:
 435   vector<FGInstrumentLayer *> _layers;
 436 };
 437
 438
 439 /**
 440  * A textured layer of an instrument.
 441  *
 442  * This is a layer holding a single texture.  Normally, the texture's
 443  * backgound should be transparent so that lower layers and the panel
 444  * background can show through.
 445  */
 446 class FGTexturedLayer : public FGInstrumentLayer
 447 {
 448 public:
 449   FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
 450   FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
 451   virtual ~FGTexturedLayer ();
 452
 453   virtual void draw ();
 454
 455   virtual void setTexture (const FGCroppedTexture &texture) {
 456     _texture = texture;
 457   }
 458   virtual FGCroppedTexture &getTexture () { return _texture; }
 459   virtual const FGCroppedTexture &getTexture () const { return _texture; }
 460
 461 private:
 462   mutable FGCroppedTexture _texture;
 463 };
 464
 465
 466 /**
 467  * A text layer of an instrument.
 468  *
 469  * This is a layer holding a string of static and/or generated text.
 470  * It is useful for instruments that have text displays, such as
 471  * a chronometer, GPS, or NavCom radio.
 472  */
 473 class FGTextLayer : public FGInstrumentLayer
 474 {
 475 public:
 476   enum ChunkType {
 477     TEXT,
 478     TEXT_VALUE,
 479     DOUBLE_VALUE
 480   };
 481
 482   class Chunk : public FGConditional
 483   {
 484   public:
 485     Chunk (const string &text, const string &fmt = "%s");
 486     Chunk (ChunkType type, const SGPropertyNode * node,
 487            const string &fmt = "", float mult = 1.0);
 488
 489     const char * getValue () const;
 490   private:
 491     ChunkType _type;
 492     string _text;
 493     const SGPropertyNode * _node;
 494     string _fmt;
 495     float _mult;
 496     mutable char _buf[1024];
 497   };
 498
 499   FGTextLayer (int w = -1, int h = -1);
 500   virtual ~FGTextLayer ();
 501
 502   virtual void draw ();
 503
 504                                 // Transfer pointer!!
 505   virtual void addChunk (Chunk * chunk);
 506   virtual void setColor (float r, float g, float b);
 507   virtual void setPointSize (float size);
 508   virtual void setFontName ( const string &name );
 509   virtual void setFont (fntFont * font);
 510
 511 private:
 512
 513   void recalc_value () const;
 514
 515   typedef vector<Chunk *> chunk_list;
 516   chunk_list _chunks;
 517   float _color[4];
 518
 519   float _pointSize;
 520   mutable string _font_name;
 521   mutable string _value;
 522   mutable SGTimeStamp _then;
 523   mutable SGTimeStamp _now;
 524 };
 525
 526
 527 /**
 528  * A layer that switches between two other layers.
 529  *
 530  * The usefulness of this layer is questionable now that all layers
 531  * can have conditions, and it may be deprecated soon.
 532  */
 533 class FGSwitchLayer : public FGInstrumentLayer
 534 {
 535 public:
 536                                 // Transfer pointers!!
 537   FGSwitchLayer (int w, int h, const SGPropertyNode * node,
 538                  FGInstrumentLayer * layer1,
 539                  FGInstrumentLayer * layer2);
 540   virtual ~FGSwitchLayer ();
 541
 542   virtual void draw ();
 543
 544 private:
 545   const SGPropertyNode * _node;
 546   FGInstrumentLayer * _layer1, * _layer2;
 547 };
 548
 549
 550
 551 \f
 552 ////////////////////////////////////////////////////////////////////////
 553 // Functions.
 554 ////////////////////////////////////////////////////////////////////////
 555
 556 /**
 557  * Test whether the panel should be visible.
 558  */
 559 bool fgPanelVisible ();
 560
 561
 562 \f
 563 ////////////////////////////////////////////////////////////////////////
 564 // The current panel, if any.
 565 ////////////////////////////////////////////////////////////////////////
 566
 567 extern FGPanel * current_panel; // TODO: move to globals
 568
 569
 570 \f
 571 #endif // __PANEL_HXX
 572
 573 // end of panel.hxx
 574
 575
 576