1 // panel.hxx - generic support classes for a 2D panel.
3 // Written by David Megginson, started January 2000.
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.
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.
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.
25 # error This library requires C++
33 #include <simgear/compiler.h>
42 #include <simgear/math/interpolater.hxx>
43 #include <simgear/misc/props.hxx>
44 #include <simgear/timing/timestamp.hxx>
50 #include <Main/fgfs.hxx>
51 #include <Main/fg_props.hxx>
53 #include <Input/input.hxx>
58 class FGPanelInstrument;
62 ////////////////////////////////////////////////////////////////////////
63 // Texture management.
64 ////////////////////////////////////////////////////////////////////////
68 * Texture manager (should migrate out into FGFS).
70 * This class ensures that no texture is loaded more than once.
72 class FGTextureManager
75 static ssgTexture * createTexture(const string &relativePath);
77 static map<string,ssgTexture *> _textureMap;
82 * Cropped texture (should migrate out into FGFS).
84 * This structure wraps an SSG texture with cropping information.
86 class 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 ();
96 virtual void setPath (const string &path) { _path = path; }
98 virtual const string &getPath () const { return _path; }
100 virtual ssgTexture * getTexture ();
102 virtual void setCrop (float minX, float minY, float maxX, float maxY) {
103 _minX = minX; _minY = minY; _maxX = maxX; _maxY = maxY;
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; }
114 ssgTexture * _texture;
115 float _minX, _minY, _maxX, _maxY;
120 ////////////////////////////////////////////////////////////////////////
122 ////////////////////////////////////////////////////////////////////////
126 * Instrument panel class.
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.
133 class FGPanel : public FGSubsystem
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);
147 // transfer pointer ownership!!!
148 virtual void addInstrument (FGPanelInstrument * instrument);
150 // Background texture.
151 virtual void setBackground (ssgTexture * texture);
153 // Make the panel visible or invisible.
154 virtual bool getVisibility () const;
155 virtual void setVisibility (bool visibility);
157 // Full width of panel.
158 virtual void setWidth (int width) { _width = width; }
159 virtual int getWidth () const { return _width; }
161 // Full height of panel.
162 virtual void setHeight (int height) { _height = height; }
163 virtual int getHeight () const { return _height; }
166 virtual void setXOffset (int offset);
167 virtual int getXOffset () const { return _x_offset; }
170 virtual void setYOffset (int offset);
171 virtual int getYOffset () const { return _y_offset; }
174 virtual void setViewHeight (int height) { _view_height = height; }
175 virtual int getViewHeight () const { return _view_height; }
177 // Handle a mouse click.
178 virtual bool doMouseAction (int button, int updown, int x, int y);
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;
194 const SGPropertyNode * _xsize_node;
195 const SGPropertyNode * _ysize_node;
198 // List of instruments in panel.
199 instrument_list_type _instruments;
204 ////////////////////////////////////////////////////////////////////////
206 ////////////////////////////////////////////////////////////////////////
210 * Class for user actions.
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.
216 class FGPanelAction : public FGConditional
220 FGPanelAction (int button, int x, int y, int w, int h);
221 virtual ~FGPanelAction ();
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; }
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; }
240 // Check whether we're in the area.
241 virtual bool inArea (int button, int x, int y)
243 return (button == _button &&
250 // Perform the action.
251 virtual void doAction ();
254 typedef vector<FGBinding *> binding_list_t;
261 binding_list_t _bindings;
266 ////////////////////////////////////////////////////////////////////////
268 ////////////////////////////////////////////////////////////////////////
272 * A transformation for a layer.
274 class FGPanelTransformation : public FGConditional
284 FGPanelTransformation ();
285 virtual ~FGPanelTransformation ();
288 const SGPropertyNode * node;
293 SGInterpTable * table;
299 ////////////////////////////////////////////////////////////////////////
301 ////////////////////////////////////////////////////////////////////////
305 * A single layer of a multi-layered instrument.
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.
311 class FGInstrumentLayer : public FGConditional
315 FGInstrumentLayer (int w = -1, int h = -1);
316 virtual ~FGInstrumentLayer ();
318 virtual void draw () = 0;
319 virtual void transform () const;
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; }
326 // Transfer pointer ownership!!
328 virtual void addTransformation (FGPanelTransformation * transformation);
333 typedef vector<FGPanelTransformation *> transformation_list;
334 transformation_list _transformations;
339 ////////////////////////////////////////////////////////////////////////
341 ////////////////////////////////////////////////////////////////////////
345 * Abstract base class for a panel instrument.
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).
353 class FGPanelInstrument : public FGConditional
356 FGPanelInstrument ();
357 FGPanelInstrument (int x, int y, int w, int h);
358 virtual ~FGPanelInstrument ();
360 virtual void draw () = 0;
362 virtual void setPosition(int x, int y);
363 virtual void setSize(int w, int h);
365 virtual int getXPos () const;
366 virtual int getYPos () const;
367 virtual int getWidth () const;
368 virtual int getHeight () const;
370 // Coordinates relative to centre.
371 // Transfer pointer ownership!!
372 virtual void addAction (FGPanelAction * action);
374 // Coordinates relative to centre.
375 virtual bool doMouseAction (int button, int x, int y);
379 typedef vector<FGPanelAction *> action_list_type;
380 action_list_type _actions;
385 * An instrument constructed of multiple layers.
387 * Each individual layer can be rotated or shifted to correspond
388 * to internal FGFS instrument readings.
390 class FGLayeredInstrument : public FGPanelInstrument
393 FGLayeredInstrument (int x, int y, int w, int h);
394 virtual ~FGLayeredInstrument ();
396 virtual void draw ();
398 // Transfer pointer ownership!!
399 virtual int addLayer (FGInstrumentLayer *layer);
400 virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
402 // Transfer pointer ownership!!
403 virtual void addTransformation (FGPanelTransformation * transformation);
406 typedef vector<FGInstrumentLayer *> layer_list;
412 * An instrument layer containing a group of sublayers.
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.
418 class FGGroupLayer : public FGInstrumentLayer
422 virtual ~FGGroupLayer ();
423 virtual void draw ();
424 // transfer pointer ownership
425 virtual void addLayer (FGInstrumentLayer * layer);
427 vector<FGInstrumentLayer *> _layers;
432 * A textured layer of an instrument.
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.
438 class FGTexturedLayer : public FGInstrumentLayer
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 ();
445 virtual void draw ();
447 virtual void setTexture (const FGCroppedTexture &texture) {
450 virtual FGCroppedTexture &getTexture () { return _texture; }
451 virtual const FGCroppedTexture &getTexture () const { return _texture; }
454 mutable FGCroppedTexture _texture;
459 * A text layer of an instrument.
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.
465 class FGTextLayer : public FGInstrumentLayer
468 typedef enum ChunkType {
474 class Chunk : public FGConditional
477 Chunk (const string &text, const string &fmt = "%s");
478 Chunk (ChunkType type, const SGPropertyNode * node,
479 const string &fmt = "", float mult = 1.0);
481 const char * getValue () const;
485 const SGPropertyNode * _node;
488 mutable char _buf[1024];
491 FGTextLayer (int w = -1, int h = -1);
492 virtual ~FGTextLayer ();
494 virtual void draw ();
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);
504 void recalc_value () const;
506 typedef vector<Chunk *> chunk_list;
512 mutable string _value;
513 mutable SGTimeStamp _then;
514 mutable SGTimeStamp _now;
519 * A layer that switches between two other layers.
521 * The usefulness of this layer is questionable now that all layers
522 * can have conditions, and it may be deprecated soon.
524 class FGSwitchLayer : public FGInstrumentLayer
527 // Transfer pointers!!
528 FGSwitchLayer (int w, int h, const SGPropertyNode * node,
529 FGInstrumentLayer * layer1,
530 FGInstrumentLayer * layer2);
531 virtual ~FGSwitchLayer ();
533 virtual void draw ();
536 const SGPropertyNode * _node;
537 FGInstrumentLayer * _layer1, * _layer2;
543 ////////////////////////////////////////////////////////////////////////
545 ////////////////////////////////////////////////////////////////////////
548 * Test whether the panel should be visible.
550 bool fgPanelVisible ();
554 ////////////////////////////////////////////////////////////////////////
555 // The current panel, if any.
556 ////////////////////////////////////////////////////////////////////////
558 extern FGPanel * current_panel; // TODO: move to globals
562 #endif // __PANEL_HXX