]> git.mxchange.org Git - flightgear.git/blobdiff - src/Cockpit/panel.hxx
Small tweaks to initialization sequence and logic so we can default to
[flightgear.git] / src / Cockpit / panel.hxx
index 25c0037ac5ad87574da1558b634589a99b8d585c..0d29ba503d456a56ef827e3fd29d098e1b80c924 100644 (file)
 #include <GL/glut.h>
 #include <plib/ssg.h>
 
+#include <simgear/math/interpolater.hxx>
 #include <simgear/misc/props.hxx>
+#include <simgear/timing/timestamp.hxx>
 
 #include <vector>
 #include <map>
 #include <plib/fnt.h>
 
-#include <Time/timestamp.hxx>
+#include <Main/fgfs.hxx>
+#include <Main/fg_props.hxx>
 
-FG_USING_STD(vector);
-FG_USING_STD(map);
+#include <Input/input.hxx>
+
+SG_USING_STD(vector);
+SG_USING_STD(map);
 
 class FGPanelInstrument;
 
 
 \f
 ////////////////////////////////////////////////////////////////////////
-// Texture manager (should migrate out into FGFS).
-//
-// This class ensures that no texture is loaded more than once.
+// Texture management.
 ////////////////////////////////////////////////////////////////////////
 
+
+/**
+ * Texture manager (should migrate out into FGFS).
+ *
+ * This class ensures that no texture is loaded more than once.
+ */
 class FGTextureManager
 {
 public:
@@ -69,13 +78,11 @@ private:
 };
 
 
-\f
-////////////////////////////////////////////////////////////////////////
-// Cropped texture (should migrate out into FGFS).
-//
-// This structure wraps an SSG texture with cropping information.
-////////////////////////////////////////////////////////////////////////
-
+/**
+ * Cropped texture (should migrate out into FGFS).
+ *
+ * This structure wraps an SSG texture with cropping information.
+ */
 class FGCroppedTexture
 {
 public:
@@ -111,27 +118,35 @@ private:
 
 \f
 ////////////////////////////////////////////////////////////////////////
-// Instrument panel class.
-//
-// The panel is a container that has a background texture and holds
-// zero or more instruments.  The panel will order the instruments to
-// redraw themselves when necessary, and will pass mouse clicks on to
-// the appropriate instruments for processing.
+// Top-level panel.
 ////////////////////////////////////////////////////////////////////////
 
-class FGPanel
+
+/**
+ * Instrument panel class.
+ *
+ * The panel is a container that has a background texture and holds
+ * zero or more instruments.  The panel will order the instruments to
+ * redraw themselves when necessary, and will pass mouse clicks on to
+ * the appropriate instruments for processing.
+ */
+class FGPanel : public FGSubsystem
 {
 public:
 
-  FGPanel (int window_x, int window_y, int window_w, int window_h);
+  FGPanel ();
   virtual ~FGPanel ();
 
+                               // Update the panel (every frame).
+  virtual void init ();
+  virtual void bind ();
+  virtual void unbind ();
+  virtual void update ();
+  virtual void update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh);
+
                                // transfer pointer ownership!!!
   virtual void addInstrument (FGPanelInstrument * instrument);
 
-                               // Update the panel (every frame).
-  virtual void update () const;
-
                                // Background texture.
   virtual void setBackground (ssgTexture * texture);
 
@@ -169,12 +184,16 @@ private:
   mutable int _mouseDelay;
   mutable FGPanelInstrument * _mouseInstrument;
   typedef vector<FGPanelInstrument *> instrument_list_type;
-  int _winx, _winy, _winw, _winh;
   int _width;
   int _height;
   int _x_offset;
   int _y_offset;
   int _view_height;
+  bool _bound;
+  float _jitter;
+
+  const SGPropertyNode * _xsize_node;
+  const SGPropertyNode * _ysize_node;
   
   ssgTexture * _bg;
                                // List of instruments in panel.
@@ -184,14 +203,18 @@ private:
 
 \f
 ////////////////////////////////////////////////////////////////////////
-// Base class for user action types.
-//
-// Individual instruments can have actions associated with a mouse
-// click in a rectangular area.  Current concrete classes include
-// FGAdjustAction, FGSwapAction, and FGToggleAction.
+// Actions
 ////////////////////////////////////////////////////////////////////////
 
-class FGPanelAction
+
+/**
+ * Class for user actions.
+ *
+ * The actions are command bindings, like bindings for the keyboard
+ * or joystick, but they are tied to specific mouse actions in
+ * rectangular areas of the panel.
+ */
+class FGPanelAction : public FGConditional
 {
 public:
   FGPanelAction ();
@@ -206,6 +229,9 @@ public:
   virtual int getHeight () const { return _h; }
 
                                // Setters.
+
+                               // transfer pointer ownership
+  virtual void addBinding (FGBinding * binding);
   virtual void setButton (int button) { _button = button; }
   virtual void setX (int x) { _x = x; }
   virtual void setY (int y) { _y = y; }
@@ -223,144 +249,31 @@ public:
   }
 
                                // Perform the action.
-  virtual void doAction () = 0;
+  virtual void doAction ();
 
 private:
+  typedef vector<FGBinding *> binding_list_t;
+
   int _button;
   int _x;
   int _y;
   int _w;
   int _h;
+  binding_list_t _bindings;
 };
 
 
 \f
 ////////////////////////////////////////////////////////////////////////
-// Adjustment action.
-//
-// This is an action to increase or decrease an FGFS value by a certain
-// increment within a certain range.  If the wrap flag is true, the
-// value will wrap around if it goes below min or above max; otherwise,
-// it will simply stop at min or max.
-////////////////////////////////////////////////////////////////////////
-
-class FGAdjustAction : public FGPanelAction
-{
-public:
-  FGAdjustAction (int button, int x, int y, int w, int h,
-                 SGValue * value, float increment,
-                 float min, float max, bool wrap=false);
-  virtual ~FGAdjustAction ();
-  virtual void doAction ();
-
-private:
-  SGValue * _value;
-  float _increment;
-  float _min;
-  float _max;
-  bool _wrap;
-};
-
-
-\f
-////////////////////////////////////////////////////////////////////////
-// Swap action.
-//
-// This is an action to swap two values.  It's currently used in the
-// navigation radios.
-////////////////////////////////////////////////////////////////////////
-
-class FGSwapAction : public FGPanelAction
-{
-public:
-  FGSwapAction (int button, int x, int y, int w, int h,
-               SGValue * value1, SGValue * value2);
-  virtual ~FGSwapAction ();
-  virtual void doAction ();
-
-private:
-  SGValue * _value1;
-  SGValue * _value2;
-};
-
-
-\f
-////////////////////////////////////////////////////////////////////////
-// Toggle action.
-//
-// This is an action to toggle a boolean value.
-////////////////////////////////////////////////////////////////////////
-
-class FGToggleAction : public FGPanelAction
-{
-public:
-  FGToggleAction (int button, int x, int y, int w, int h,
-                 SGValue * value);
-  virtual ~FGToggleAction ();
-  virtual void doAction ();
-
-private:
-  SGValue * _value;
-};
-
-
-\f
-////////////////////////////////////////////////////////////////////////
-// Abstract base class for a panel instrument.
-//
-// A panel instrument consists of zero or more actions, associated
-// with mouse clicks in rectangular areas.  Currently, the only
-// concrete class derived from this is FGLayeredInstrument, but others
-// may show up in the future (some complex instruments could be 
-// entirely hand-coded, for example).
-////////////////////////////////////////////////////////////////////////
-
-class FGPanelInstrument
-{
-public:
-  FGPanelInstrument ();
-  FGPanelInstrument (int x, int y, int w, int h);
-  virtual ~FGPanelInstrument ();
-
-  virtual void draw () = 0;
-
-  virtual void setPosition(int x, int y);
-  virtual void setSize(int w, int h);
-
-  virtual int getXPos () const;
-  virtual int getYPos () const;
-  virtual int getWidth () const;
-  virtual int getHeight () const;
-
-                               // Coordinates relative to centre.
-                               // Transfer pointer ownership!!
-  virtual void addAction (FGPanelAction * action);
-
-                               // Coordinates relative to centre.
-  virtual bool doMouseAction (int button, int x, int y);
-
-protected:
-  int _x, _y, _w, _h;
-  typedef vector<FGPanelAction *> action_list_type;
-  action_list_type _actions;
-};
-
-
-\f
-////////////////////////////////////////////////////////////////////////
-// Abstract base class for an instrument layer.
-//
-// The FGLayeredInstrument class builds up instruments by using layers
-// of textures or text.  Each layer can have zero or more
-// transformations applied to it: for example, a needle layer can
-// rotate to show the altitude or airspeed.
+// Transformations.
 ////////////////////////////////////////////////////////////////////////
 
 
 /**
  * A transformation for a layer.
  */
-class FGPanelTransformation {
+class FGPanelTransformation : public FGConditional
+{
 public:
 
   enum Type {
@@ -373,15 +286,22 @@ public:
   virtual ~FGPanelTransformation ();
 
   Type type;
-  const SGValue * value;
+  const SGPropertyNode * node;
   float min;
   float max;
   float factor;
   float offset;
+  SGInterpTable * table;
 };
 
 
 
+\f
+////////////////////////////////////////////////////////////////////////
+// Layers
+////////////////////////////////////////////////////////////////////////
+
+
 /**
  * A single layer of a multi-layered instrument.
  *
@@ -389,7 +309,7 @@ public:
  * on current FGFS instrument readings: for example, a texture
  * representing a needle can rotate to show the airspeed.
  */
-class FGInstrumentLayer
+class FGInstrumentLayer : public FGConditional
 {
 public:
 
@@ -418,16 +338,50 @@ protected:
 
 \f
 ////////////////////////////////////////////////////////////////////////
-// An instrument composed of layers.
-//
-// This class represents an instrument which is simply a series of
-// layers piled one on top of the other, each one undergoing its own
-// set of transformations.  For example, one layer can represent
-// the instrument's face (which doesn't move), while the next layer
-// can represent a needle that rotates depending on an FGFS variable.
+// Instruments.
 ////////////////////////////////////////////////////////////////////////
 
 
+/**
+ * Abstract base class for a panel instrument.
+ *
+ * A panel instrument consists of zero or more actions, associated
+ * with mouse clicks in rectangular areas.  Currently, the only
+ * concrete class derived from this is FGLayeredInstrument, but others
+ * may show up in the future (some complex instruments could be 
+ * entirely hand-coded, for example).
+ */
+class FGPanelInstrument : public FGConditional
+{
+public:
+  FGPanelInstrument ();
+  FGPanelInstrument (int x, int y, int w, int h);
+  virtual ~FGPanelInstrument ();
+
+  virtual void draw () = 0;
+
+  virtual void setPosition(int x, int y);
+  virtual void setSize(int w, int h);
+
+  virtual int getXPos () const;
+  virtual int getYPos () const;
+  virtual int getWidth () const;
+  virtual int getHeight () const;
+
+                               // Coordinates relative to centre.
+                               // Transfer pointer ownership!!
+  virtual void addAction (FGPanelAction * action);
+
+                               // Coordinates relative to centre.
+  virtual bool doMouseAction (int button, int x, int y);
+
+protected:
+  int _x, _y, _w, _h;
+  typedef vector<FGPanelAction *> action_list_type;
+  action_list_type _actions;
+};
+
+
 /**
  * An instrument constructed of multiple layers.
  *
@@ -455,15 +409,33 @@ protected:
 };
 
 
-\f
-////////////////////////////////////////////////////////////////////////
-// A textured layer of an instrument.
-//
-// This is a layer holding a single texture.  Normally, the texture's
-// backgound should be transparent so that lower layers and the panel
-// background can show through.
-////////////////////////////////////////////////////////////////////////
+/**
+ * An instrument layer containing a group of sublayers.
+ *
+ * This class is useful for gathering together a group of related
+ * layers, either to hold in an external file or to work under
+ * the same condition.
+ */
+class FGGroupLayer : public FGInstrumentLayer
+{
+public:
+  FGGroupLayer ();
+  virtual ~FGGroupLayer ();
+  virtual void draw ();
+                               // transfer pointer ownership
+  virtual void addLayer (FGInstrumentLayer * layer);
+private:
+  vector<FGInstrumentLayer *> _layers;
+};
 
+
+/**
+ * A textured layer of an instrument.
+ *
+ * This is a layer holding a single texture.  Normally, the texture's
+ * backgound should be transparent so that lower layers and the panel
+ * background can show through.
+ */
 class FGTexturedLayer : public FGInstrumentLayer
 {
 public:
@@ -484,15 +456,13 @@ private:
 };
 
 
-\f
-////////////////////////////////////////////////////////////////////////
-// A text layer of an instrument.
-//
-// This is a layer holding a string of static and/or generated text.
-// It is useful for instruments that have text displays, such as
-// a chronometer, GPS, or NavCom radio.
-////////////////////////////////////////////////////////////////////////
-
+/**
+ * A text layer of an instrument.
+ *
+ * This is a layer holding a string of static and/or generated text.
+ * It is useful for instruments that have text displays, such as
+ * a chronometer, GPS, or NavCom radio.
+ */
 class FGTextLayer : public FGInstrumentLayer
 {
 public:
@@ -502,17 +472,18 @@ public:
     DOUBLE_VALUE
   };
 
-  class Chunk {
+  class Chunk : public FGConditional
+  {
   public:
     Chunk (const string &text, const string &fmt = "%s");
-    Chunk (ChunkType type, const SGValue * value,
+    Chunk (ChunkType type, const SGPropertyNode * node,
           const string &fmt = "", float mult = 1.0);
 
     const char * getValue () const;
   private:
     ChunkType _type;
     string _text;
-    const SGValue * _value;
+    const SGPropertyNode * _node;
     string _fmt;
     float _mult;
     mutable char _buf[1024];
@@ -540,21 +511,22 @@ private:
   float _pointSize;
 
   mutable string _value;
-  mutable FGTimeStamp _then;
-  mutable FGTimeStamp _now;
+  mutable SGTimeStamp _then;
+  mutable SGTimeStamp _now;
 };
 
 
-\f
-////////////////////////////////////////////////////////////////////////
-// A layer that switches between two other layers.
-////////////////////////////////////////////////////////////////////////
-
+/**
+ * A layer that switches between two other layers.
+ *
+ * The usefulness of this layer is questionable now that all layers
+ * can have conditions, and it may be deprecated soon.
+ */
 class FGSwitchLayer : public FGInstrumentLayer
 {
 public:
                                // Transfer pointers!!
-  FGSwitchLayer (int w, int h, const SGValue * value,
+  FGSwitchLayer (int w, int h, const SGPropertyNode * node,
                 FGInstrumentLayer * layer1,
                 FGInstrumentLayer * layer2);
   virtual ~FGSwitchLayer ();
@@ -562,17 +534,29 @@ public:
   virtual void draw ();
 
 private:
-  const SGValue * _value;
+  const SGPropertyNode * _node;
   FGInstrumentLayer * _layer1, * _layer2;
 };
 
 
+
+\f
+////////////////////////////////////////////////////////////////////////
+// Functions.
+////////////////////////////////////////////////////////////////////////
+
+/**
+ * Test whether the panel should be visible.
+ */
+bool fgPanelVisible ();
+
+
 \f
 ////////////////////////////////////////////////////////////////////////
 // The current panel, if any.
 ////////////////////////////////////////////////////////////////////////
 
-extern FGPanel * current_panel;
+extern FGPanel * current_panel;        // TODO: move to globals
 
 
 \f