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