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>
41 #include <simgear/math/interpolater.hxx>
42 #include <simgear/props/props.hxx>
43 #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 draw ();
145 virtual void update (double dt);
146 virtual void update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh);
148 virtual void updateMouseDelay();
150 // transfer pointer ownership!!!
151 virtual void addInstrument (FGPanelInstrument * instrument);
153 // Background texture.
154 virtual void setBackground (ssgTexture * texture);
156 // Background multiple textures.
157 virtual void setMultiBackground (ssgTexture * texture, int idx);
159 // Make the panel visible or invisible.
160 virtual bool getVisibility () const;
161 virtual void setVisibility (bool visibility);
163 // Full width of panel.
164 virtual void setWidth (int width) { _width = width; }
165 virtual int getWidth () const { return _width; }
167 // Full height of panel.
168 virtual void setHeight (int height) { _height = height; }
169 virtual int getHeight () const { return _height; }
172 virtual void setXOffset (int offset);
173 virtual int getXOffset () const { return _x_offset->getIntValue(); }
176 virtual void setYOffset (int offset);
177 virtual int getYOffset () const { return _y_offset->getIntValue(); }
180 virtual void setViewHeight (int height) { _view_height = height; }
181 virtual int getViewHeight () const { return _view_height; }
183 // Handle a mouse click.
184 virtual bool doMouseAction (int button, int updown, int x, int y);
185 virtual bool doLocalMouseAction(int button, int updown, int x, int y);
188 void setupVirtualCockpit();
189 void cleanupVirtualCockpit();
191 mutable bool _mouseDown;
192 mutable int _mouseButton, _mouseX, _mouseY;
193 mutable int _mouseDelay;
194 mutable FGPanelInstrument * _mouseInstrument;
195 typedef vector<FGPanelInstrument *> instrument_list_type;
200 SGPropertyNode * _visibility;
201 SGPropertyNode * _x_offset;
202 SGPropertyNode * _y_offset;
203 SGPropertyNode * _jitter;
204 SGPropertyNode * _flipx;
206 const SGPropertyNode * _xsize_node;
207 const SGPropertyNode * _ysize_node;
210 ssgTexture * _mbg[8];
211 // List of instruments in panel.
212 instrument_list_type _instruments;
217 ////////////////////////////////////////////////////////////////////////
219 ////////////////////////////////////////////////////////////////////////
223 * Class for user actions.
225 * The actions are command bindings, like bindings for the keyboard
226 * or joystick, but they are tied to specific mouse actions in
227 * rectangular areas of the panel.
229 class FGPanelAction : public SGConditional
233 FGPanelAction (int button, int x, int y, int w, int h, bool repeatable);
234 virtual ~FGPanelAction ();
237 virtual int getButton () const { return _button; }
238 virtual int getX () const { return _x; }
239 virtual int getY () const { return _y; }
240 virtual int getWidth () const { return _w; }
241 virtual int getHeight () const { return _h; }
245 // transfer pointer ownership
246 virtual void addBinding (FGBinding * binding, int updown);
247 virtual void setButton (int button) { _button = button; }
248 virtual void setX (int x) { _x = x; }
249 virtual void setY (int y) { _y = y; }
250 virtual void setWidth (int w) { _w = w; }
251 virtual void setHeight (int h) { _h = h; }
253 // Check whether we're in the area.
254 virtual bool inArea (int button, int x, int y)
256 return (button == _button &&
263 // Perform the action.
264 virtual bool doAction (int updown);
267 typedef vector<FGBinding *> binding_list_t;
276 binding_list_t _bindings[2];
281 ////////////////////////////////////////////////////////////////////////
283 ////////////////////////////////////////////////////////////////////////
287 * A transformation for a layer.
289 class FGPanelTransformation : public SGConditional
299 FGPanelTransformation ();
300 virtual ~FGPanelTransformation ();
303 const SGPropertyNode * node;
310 SGInterpTable * table;
316 ////////////////////////////////////////////////////////////////////////
318 ////////////////////////////////////////////////////////////////////////
322 * A single layer of a multi-layered instrument.
324 * Each layer can be subject to a series of transformations based
325 * on current FGFS instrument readings: for example, a texture
326 * representing a needle can rotate to show the airspeed.
328 class FGInstrumentLayer : public SGConditional
332 FGInstrumentLayer (int w = -1, int h = -1);
333 virtual ~FGInstrumentLayer ();
335 virtual void draw () = 0;
336 virtual void transform () const;
338 virtual int getWidth () const { return _w; }
339 virtual int getHeight () const { return _h; }
340 virtual void setWidth (int w) { _w = w; }
341 virtual void setHeight (int h) { _h = h; }
343 // Transfer pointer ownership!!
345 virtual void addTransformation (FGPanelTransformation * transformation);
350 typedef vector<FGPanelTransformation *> transformation_list;
351 transformation_list _transformations;
356 ////////////////////////////////////////////////////////////////////////
358 ////////////////////////////////////////////////////////////////////////
362 * Abstract base class for a panel instrument.
364 * A panel instrument consists of zero or more actions, associated
365 * with mouse clicks in rectangular areas. Currently, the only
366 * concrete class derived from this is FGLayeredInstrument, but others
367 * may show up in the future (some complex instruments could be
368 * entirely hand-coded, for example).
370 class FGPanelInstrument : public SGConditional
373 FGPanelInstrument ();
374 FGPanelInstrument (int x, int y, int w, int h);
375 virtual ~FGPanelInstrument ();
377 virtual void draw () = 0;
378 virtual void drawHotspots();
380 virtual void setPosition(int x, int y);
381 virtual void setSize(int w, int h);
383 virtual int getXPos () const;
384 virtual int getYPos () const;
385 virtual int getWidth () const;
386 virtual int getHeight () const;
388 // Coordinates relative to centre.
389 // Transfer pointer ownership!!
390 virtual void addAction (FGPanelAction * action);
392 // Coordinates relative to centre.
393 virtual bool doMouseAction (int button, int updown, int x, int y);
397 typedef vector<FGPanelAction *> action_list_type;
398 action_list_type _actions;
403 * An instrument constructed of multiple layers.
405 * Each individual layer can be rotated or shifted to correspond
406 * to internal FGFS instrument readings.
408 class FGLayeredInstrument : public FGPanelInstrument
411 FGLayeredInstrument (int x, int y, int w, int h);
412 virtual ~FGLayeredInstrument ();
414 virtual void draw ();
416 // Transfer pointer ownership!!
417 virtual int addLayer (FGInstrumentLayer *layer);
418 virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
420 // Transfer pointer ownership!!
421 virtual void addTransformation (FGPanelTransformation * transformation);
424 typedef vector<FGInstrumentLayer *> layer_list;
430 * An instrument layer containing a group of sublayers.
432 * This class is useful for gathering together a group of related
433 * layers, either to hold in an external file or to work under
434 * the same condition.
436 class FGGroupLayer : public FGInstrumentLayer
440 virtual ~FGGroupLayer ();
441 virtual void draw ();
442 // transfer pointer ownership
443 virtual void addLayer (FGInstrumentLayer * layer);
445 vector<FGInstrumentLayer *> _layers;
450 * A textured layer of an instrument.
452 * This is a layer holding a single texture. Normally, the texture's
453 * backgound should be transparent so that lower layers and the panel
454 * background can show through.
456 class FGTexturedLayer : public FGInstrumentLayer
459 FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
460 FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
461 virtual ~FGTexturedLayer ();
463 virtual void draw ();
465 virtual void setTexture (const FGCroppedTexture &texture) {
468 virtual FGCroppedTexture &getTexture () { return _texture; }
469 virtual const FGCroppedTexture &getTexture () const { return _texture; }
472 mutable FGCroppedTexture _texture;
477 * A text layer of an instrument.
479 * This is a layer holding a string of static and/or generated text.
480 * It is useful for instruments that have text displays, such as
481 * a chronometer, GPS, or NavCom radio.
483 class FGTextLayer : public FGInstrumentLayer
492 class Chunk : public SGConditional
495 Chunk (const string &text, const string &fmt = "%s");
496 Chunk (ChunkType type, const SGPropertyNode * node,
497 const string &fmt = "", float mult = 1.0);
499 const char * getValue () const;
503 const SGPropertyNode * _node;
506 mutable char _buf[1024];
509 FGTextLayer (int w = -1, int h = -1);
510 virtual ~FGTextLayer ();
512 virtual void draw ();
514 // Transfer pointer!!
515 virtual void addChunk (Chunk * chunk);
516 virtual void setColor (float r, float g, float b);
517 virtual void setPointSize (float size);
518 virtual void setFontName ( const string &name );
519 virtual void setFont (fntFont * font);
523 void recalc_value () const;
525 typedef vector<Chunk *> chunk_list;
530 mutable string _font_name;
531 mutable string _value;
532 mutable SGTimeStamp _then;
533 mutable SGTimeStamp _now;
538 * A group layer that switches among its children.
540 * The first layer that passes its condition will be drawn, and
541 * any following layers will be ignored.
543 class FGSwitchLayer : public FGGroupLayer
546 // Transfer pointers!!
548 virtual void draw ();
555 ////////////////////////////////////////////////////////////////////////
557 ////////////////////////////////////////////////////////////////////////
560 * Test whether the panel should be visible.
562 bool fgPanelVisible ();
566 #endif // __PANEL_HXX