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 (int dt);
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 // Background multiple textures.
154 virtual void setMultiBackground (ssgTexture * texture, int idx);
156 // Make the panel visible or invisible.
157 virtual bool getVisibility () const;
158 virtual void setVisibility (bool visibility);
160 // Full width of panel.
161 virtual void setWidth (int width) { _width = width; }
162 virtual int getWidth () const { return _width; }
164 // Full height of panel.
165 virtual void setHeight (int height) { _height = height; }
166 virtual int getHeight () const { return _height; }
169 virtual void setXOffset (int offset);
170 virtual int getXOffset () const { return _x_offset; }
173 virtual void setYOffset (int offset);
174 virtual int getYOffset () const { return _y_offset; }
177 virtual void setViewHeight (int height) { _view_height = height; }
178 virtual int getViewHeight () const { return _view_height; }
180 // Handle a mouse click.
181 virtual bool doMouseAction (int button, int updown, int x, int y);
184 mutable bool _visibility;
185 mutable bool _mouseDown;
186 mutable int _mouseButton, _mouseX, _mouseY;
187 mutable int _mouseDelay;
188 mutable FGPanelInstrument * _mouseInstrument;
189 typedef vector<FGPanelInstrument *> instrument_list_type;
198 const SGPropertyNode * _xsize_node;
199 const SGPropertyNode * _ysize_node;
202 ssgTexture * _mbg[8];
203 // List of instruments in panel.
204 instrument_list_type _instruments;
209 ////////////////////////////////////////////////////////////////////////
211 ////////////////////////////////////////////////////////////////////////
215 * Class for user actions.
217 * The actions are command bindings, like bindings for the keyboard
218 * or joystick, but they are tied to specific mouse actions in
219 * rectangular areas of the panel.
221 class FGPanelAction : public FGConditional
225 FGPanelAction (int button, int x, int y, int w, int h);
226 virtual ~FGPanelAction ();
229 virtual int getButton () const { return _button; }
230 virtual int getX () const { return _x; }
231 virtual int getY () const { return _y; }
232 virtual int getWidth () const { return _w; }
233 virtual int getHeight () const { return _h; }
237 // transfer pointer ownership
238 virtual void addBinding (FGBinding * binding);
239 virtual void setButton (int button) { _button = button; }
240 virtual void setX (int x) { _x = x; }
241 virtual void setY (int y) { _y = y; }
242 virtual void setWidth (int w) { _w = w; }
243 virtual void setHeight (int h) { _h = h; }
245 // Check whether we're in the area.
246 virtual bool inArea (int button, int x, int y)
248 return (button == _button &&
255 // Perform the action.
256 virtual void doAction ();
259 typedef vector<FGBinding *> binding_list_t;
266 binding_list_t _bindings;
271 ////////////////////////////////////////////////////////////////////////
273 ////////////////////////////////////////////////////////////////////////
277 * A transformation for a layer.
279 class FGPanelTransformation : public FGConditional
289 FGPanelTransformation ();
290 virtual ~FGPanelTransformation ();
293 const SGPropertyNode * node;
298 SGInterpTable * table;
304 ////////////////////////////////////////////////////////////////////////
306 ////////////////////////////////////////////////////////////////////////
310 * A single layer of a multi-layered instrument.
312 * Each layer can be subject to a series of transformations based
313 * on current FGFS instrument readings: for example, a texture
314 * representing a needle can rotate to show the airspeed.
316 class FGInstrumentLayer : public FGConditional
320 FGInstrumentLayer (int w = -1, int h = -1);
321 virtual ~FGInstrumentLayer ();
323 virtual void draw () = 0;
324 virtual void transform () const;
326 virtual int getWidth () const { return _w; }
327 virtual int getHeight () const { return _h; }
328 virtual void setWidth (int w) { _w = w; }
329 virtual void setHeight (int h) { _h = h; }
331 // Transfer pointer ownership!!
333 virtual void addTransformation (FGPanelTransformation * transformation);
338 typedef vector<FGPanelTransformation *> transformation_list;
339 transformation_list _transformations;
344 ////////////////////////////////////////////////////////////////////////
346 ////////////////////////////////////////////////////////////////////////
350 * Abstract base class for a panel instrument.
352 * A panel instrument consists of zero or more actions, associated
353 * with mouse clicks in rectangular areas. Currently, the only
354 * concrete class derived from this is FGLayeredInstrument, but others
355 * may show up in the future (some complex instruments could be
356 * entirely hand-coded, for example).
358 class FGPanelInstrument : public FGConditional
361 FGPanelInstrument ();
362 FGPanelInstrument (int x, int y, int w, int h);
363 virtual ~FGPanelInstrument ();
365 virtual void draw () = 0;
367 virtual void setPosition(int x, int y);
368 virtual void setSize(int w, int h);
370 virtual int getXPos () const;
371 virtual int getYPos () const;
372 virtual int getWidth () const;
373 virtual int getHeight () const;
375 // Coordinates relative to centre.
376 // Transfer pointer ownership!!
377 virtual void addAction (FGPanelAction * action);
379 // Coordinates relative to centre.
380 virtual bool doMouseAction (int button, int x, int y);
384 typedef vector<FGPanelAction *> action_list_type;
385 action_list_type _actions;
390 * An instrument constructed of multiple layers.
392 * Each individual layer can be rotated or shifted to correspond
393 * to internal FGFS instrument readings.
395 class FGLayeredInstrument : public FGPanelInstrument
398 FGLayeredInstrument (int x, int y, int w, int h);
399 virtual ~FGLayeredInstrument ();
401 virtual void draw ();
403 // Transfer pointer ownership!!
404 virtual int addLayer (FGInstrumentLayer *layer);
405 virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
407 // Transfer pointer ownership!!
408 virtual void addTransformation (FGPanelTransformation * transformation);
411 typedef vector<FGInstrumentLayer *> layer_list;
417 * An instrument layer containing a group of sublayers.
419 * This class is useful for gathering together a group of related
420 * layers, either to hold in an external file or to work under
421 * the same condition.
423 class FGGroupLayer : public FGInstrumentLayer
427 virtual ~FGGroupLayer ();
428 virtual void draw ();
429 // transfer pointer ownership
430 virtual void addLayer (FGInstrumentLayer * layer);
432 vector<FGInstrumentLayer *> _layers;
437 * A textured layer of an instrument.
439 * This is a layer holding a single texture. Normally, the texture's
440 * backgound should be transparent so that lower layers and the panel
441 * background can show through.
443 class FGTexturedLayer : public FGInstrumentLayer
446 FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
447 FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
448 virtual ~FGTexturedLayer ();
450 virtual void draw ();
452 virtual void setTexture (const FGCroppedTexture &texture) {
455 virtual FGCroppedTexture &getTexture () { return _texture; }
456 virtual const FGCroppedTexture &getTexture () const { return _texture; }
459 mutable FGCroppedTexture _texture;
464 * A text layer of an instrument.
466 * This is a layer holding a string of static and/or generated text.
467 * It is useful for instruments that have text displays, such as
468 * a chronometer, GPS, or NavCom radio.
470 class FGTextLayer : public FGInstrumentLayer
473 typedef enum ChunkType {
479 class Chunk : public FGConditional
482 Chunk (const string &text, const string &fmt = "%s");
483 Chunk (ChunkType type, const SGPropertyNode * node,
484 const string &fmt = "", float mult = 1.0);
486 const char * getValue () const;
490 const SGPropertyNode * _node;
493 mutable char _buf[1024];
496 FGTextLayer (int w = -1, int h = -1);
497 virtual ~FGTextLayer ();
499 virtual void draw ();
501 // Transfer pointer!!
502 virtual void addChunk (Chunk * chunk);
503 virtual void setColor (float r, float g, float b);
504 virtual void setPointSize (float size);
505 virtual void setFont (fntFont * font);
509 void recalc_value () const;
511 typedef vector<Chunk *> chunk_list;
517 mutable string _value;
518 mutable SGTimeStamp _then;
519 mutable SGTimeStamp _now;
524 * A layer that switches between two other layers.
526 * The usefulness of this layer is questionable now that all layers
527 * can have conditions, and it may be deprecated soon.
529 class FGSwitchLayer : public FGInstrumentLayer
532 // Transfer pointers!!
533 FGSwitchLayer (int w, int h, const SGPropertyNode * node,
534 FGInstrumentLayer * layer1,
535 FGInstrumentLayer * layer2);
536 virtual ~FGSwitchLayer ();
538 virtual void draw ();
541 const SGPropertyNode * _node;
542 FGInstrumentLayer * _layer1, * _layer2;
548 ////////////////////////////////////////////////////////////////////////
550 ////////////////////////////////////////////////////////////////////////
553 * Test whether the panel should be visible.
555 bool fgPanelVisible ();
559 ////////////////////////////////////////////////////////////////////////
560 // The current panel, if any.
561 ////////////////////////////////////////////////////////////////////////
563 extern FGPanel * current_panel; // TODO: move to globals
567 #endif // __PANEL_HXX