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>
43 #include <simgear/math/interpolater.hxx>
44 #include <simgear/misc/props.hxx>
45 #include <simgear/timing/timestamp.hxx>
51 #include <Main/fgfs.hxx>
52 #include <Main/fg_props.hxx>
54 #include <Input/input.hxx>
59 class FGPanelInstrument;
63 ////////////////////////////////////////////////////////////////////////
64 // Texture management.
65 ////////////////////////////////////////////////////////////////////////
69 * Texture manager (should migrate out into FGFS).
71 * This class ensures that no texture is loaded more than once.
73 class FGTextureManager
76 static ssgTexture * createTexture(const string &relativePath);
78 static map<string,ssgTexture *> _textureMap;
83 * Cropped texture (should migrate out into FGFS).
85 * This structure wraps an SSG texture with cropping information.
87 class FGCroppedTexture
92 FGCroppedTexture (const string &path,
93 float _minX = 0.0, float _minY = 0.0,
94 float _maxX = 1.0, float _maxY = 1.0);
95 virtual ~FGCroppedTexture ();
97 virtual void setPath (const string &path) { _path = path; }
99 virtual const string &getPath () const { return _path; }
101 virtual ssgTexture * getTexture ();
103 virtual void setCrop (float minX, float minY, float maxX, float maxY) {
104 _minX = minX; _minY = minY; _maxX = maxX; _maxY = maxY;
107 virtual float getMinX () const { return _minX; }
108 virtual float getMinY () const { return _minY; }
109 virtual float getMaxX () const { return _maxX; }
110 virtual float getMaxY () const { return _maxY; }
115 ssgTexture * _texture;
116 float _minX, _minY, _maxX, _maxY;
121 ////////////////////////////////////////////////////////////////////////
123 ////////////////////////////////////////////////////////////////////////
127 * Instrument panel class.
129 * The panel is a container that has a background texture and holds
130 * zero or more instruments. The panel will order the instruments to
131 * redraw themselves when necessary, and will pass mouse clicks on to
132 * the appropriate instruments for processing.
134 class FGPanel : public FGSubsystem
141 // Update the panel (every frame).
142 virtual void init ();
143 virtual void bind ();
144 virtual void unbind ();
145 virtual void draw ();
146 virtual void update (double dt);
147 virtual void update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh);
149 virtual void updateMouseDelay();
151 // transfer pointer ownership!!!
152 virtual void addInstrument (FGPanelInstrument * instrument);
154 // Background texture.
155 virtual void setBackground (ssgTexture * texture);
157 // Background multiple textures.
158 virtual void setMultiBackground (ssgTexture * texture, int idx);
160 // Make the panel visible or invisible.
161 virtual bool getVisibility () const;
162 virtual void setVisibility (bool visibility);
164 // Full width of panel.
165 virtual void setWidth (int width) { _width = width; }
166 virtual int getWidth () const { return _width; }
168 // Full height of panel.
169 virtual void setHeight (int height) { _height = height; }
170 virtual int getHeight () const { return _height; }
173 virtual void setXOffset (int offset);
174 virtual int getXOffset () const { return _x_offset; }
177 virtual void setYOffset (int offset);
178 virtual int getYOffset () const { return _y_offset; }
181 virtual void setViewHeight (int height) { _view_height = height; }
182 virtual int getViewHeight () const { return _view_height; }
184 // Handle a mouse click.
185 virtual bool doMouseAction (int button, int updown, int x, int y);
186 virtual bool doLocalMouseAction(int button, int updown, int x, int y);
189 void setupVirtualCockpit();
190 void cleanupVirtualCockpit();
192 mutable bool _visibility;
193 mutable bool _mouseDown;
194 mutable int _mouseButton, _mouseX, _mouseY;
195 mutable int _mouseDelay;
196 mutable FGPanelInstrument * _mouseInstrument;
197 typedef vector<FGPanelInstrument *> instrument_list_type;
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 FGConditional
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 FGConditional
299 FGPanelTransformation ();
300 virtual ~FGPanelTransformation ();
303 const SGPropertyNode * node;
308 SGInterpTable * table;
314 ////////////////////////////////////////////////////////////////////////
316 ////////////////////////////////////////////////////////////////////////
320 * A single layer of a multi-layered instrument.
322 * Each layer can be subject to a series of transformations based
323 * on current FGFS instrument readings: for example, a texture
324 * representing a needle can rotate to show the airspeed.
326 class FGInstrumentLayer : public FGConditional
330 FGInstrumentLayer (int w = -1, int h = -1);
331 virtual ~FGInstrumentLayer ();
333 virtual void draw () = 0;
334 virtual void transform () const;
336 virtual int getWidth () const { return _w; }
337 virtual int getHeight () const { return _h; }
338 virtual void setWidth (int w) { _w = w; }
339 virtual void setHeight (int h) { _h = h; }
341 // Transfer pointer ownership!!
343 virtual void addTransformation (FGPanelTransformation * transformation);
348 typedef vector<FGPanelTransformation *> transformation_list;
349 transformation_list _transformations;
354 ////////////////////////////////////////////////////////////////////////
356 ////////////////////////////////////////////////////////////////////////
360 * Abstract base class for a panel instrument.
362 * A panel instrument consists of zero or more actions, associated
363 * with mouse clicks in rectangular areas. Currently, the only
364 * concrete class derived from this is FGLayeredInstrument, but others
365 * may show up in the future (some complex instruments could be
366 * entirely hand-coded, for example).
368 class FGPanelInstrument : public FGConditional
371 FGPanelInstrument ();
372 FGPanelInstrument (int x, int y, int w, int h);
373 virtual ~FGPanelInstrument ();
375 virtual void draw () = 0;
376 virtual void drawHotspots();
378 virtual void setPosition(int x, int y);
379 virtual void setSize(int w, int h);
381 virtual int getXPos () const;
382 virtual int getYPos () const;
383 virtual int getWidth () const;
384 virtual int getHeight () const;
386 // Coordinates relative to centre.
387 // Transfer pointer ownership!!
388 virtual void addAction (FGPanelAction * action);
390 // Coordinates relative to centre.
391 virtual bool doMouseAction (int button, int updown, int x, int y);
395 typedef vector<FGPanelAction *> action_list_type;
396 action_list_type _actions;
401 * An instrument constructed of multiple layers.
403 * Each individual layer can be rotated or shifted to correspond
404 * to internal FGFS instrument readings.
406 class FGLayeredInstrument : public FGPanelInstrument
409 FGLayeredInstrument (int x, int y, int w, int h);
410 virtual ~FGLayeredInstrument ();
412 virtual void draw ();
414 // Transfer pointer ownership!!
415 virtual int addLayer (FGInstrumentLayer *layer);
416 virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
418 // Transfer pointer ownership!!
419 virtual void addTransformation (FGPanelTransformation * transformation);
422 typedef vector<FGInstrumentLayer *> layer_list;
428 * An instrument layer containing a group of sublayers.
430 * This class is useful for gathering together a group of related
431 * layers, either to hold in an external file or to work under
432 * the same condition.
434 class FGGroupLayer : public FGInstrumentLayer
438 virtual ~FGGroupLayer ();
439 virtual void draw ();
440 // transfer pointer ownership
441 virtual void addLayer (FGInstrumentLayer * layer);
443 vector<FGInstrumentLayer *> _layers;
448 * A textured layer of an instrument.
450 * This is a layer holding a single texture. Normally, the texture's
451 * backgound should be transparent so that lower layers and the panel
452 * background can show through.
454 class FGTexturedLayer : public FGInstrumentLayer
457 FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
458 FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
459 virtual ~FGTexturedLayer ();
461 virtual void draw ();
463 virtual void setTexture (const FGCroppedTexture &texture) {
466 virtual FGCroppedTexture &getTexture () { return _texture; }
467 virtual const FGCroppedTexture &getTexture () const { return _texture; }
470 mutable FGCroppedTexture _texture;
475 * A text layer of an instrument.
477 * This is a layer holding a string of static and/or generated text.
478 * It is useful for instruments that have text displays, such as
479 * a chronometer, GPS, or NavCom radio.
481 class FGTextLayer : public FGInstrumentLayer
490 class Chunk : public FGConditional
493 Chunk (const string &text, const string &fmt = "%s");
494 Chunk (ChunkType type, const SGPropertyNode * node,
495 const string &fmt = "", float mult = 1.0);
497 const char * getValue () const;
501 const SGPropertyNode * _node;
504 mutable char _buf[1024];
507 FGTextLayer (int w = -1, int h = -1);
508 virtual ~FGTextLayer ();
510 virtual void draw ();
512 // Transfer pointer!!
513 virtual void addChunk (Chunk * chunk);
514 virtual void setColor (float r, float g, float b);
515 virtual void setPointSize (float size);
516 virtual void setFontName ( const string &name );
517 virtual void setFont (fntFont * font);
521 void recalc_value () const;
523 typedef vector<Chunk *> chunk_list;
528 mutable string _font_name;
529 mutable string _value;
530 mutable SGTimeStamp _then;
531 mutable SGTimeStamp _now;
536 * A layer that switches between two other layers.
538 * The usefulness of this layer is questionable now that all layers
539 * can have conditions, and it may be deprecated soon.
541 class FGSwitchLayer : public FGInstrumentLayer
544 // Transfer pointers!!
545 FGSwitchLayer (int w, int h, const SGPropertyNode * node,
546 FGInstrumentLayer * layer1,
547 FGInstrumentLayer * layer2);
548 virtual ~FGSwitchLayer ();
550 virtual void draw ();
553 const SGPropertyNode * _node;
554 FGInstrumentLayer * _layer1, * _layer2;
560 ////////////////////////////////////////////////////////////////////////
562 ////////////////////////////////////////////////////////////////////////
565 * Test whether the panel should be visible.
567 bool fgPanelVisible ();
571 ////////////////////////////////////////////////////////////////////////
572 // The current panel, if any.
573 ////////////////////////////////////////////////////////////////////////
575 extern FGPanel * current_panel; // TODO: move to globals
579 #endif // __PANEL_HXX