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>
55 class FGPanelInstrument;
59 ////////////////////////////////////////////////////////////////////////
60 // Texture manager (should migrate out into FGFS).
62 // This class ensures that no texture is loaded more than once.
63 ////////////////////////////////////////////////////////////////////////
65 class FGTextureManager
68 static ssgTexture * createTexture(const string &relativePath);
70 static map<string,ssgTexture *> _textureMap;
75 ////////////////////////////////////////////////////////////////////////
76 // Cropped texture (should migrate out into FGFS).
78 // This structure wraps an SSG texture with cropping information.
79 ////////////////////////////////////////////////////////////////////////
81 class FGCroppedTexture
86 FGCroppedTexture (const string &path,
87 float _minX = 0.0, float _minY = 0.0,
88 float _maxX = 1.0, float _maxY = 1.0);
89 virtual ~FGCroppedTexture ();
91 virtual void setPath (const string &path) { _path = path; }
93 virtual const string &getPath () const { return _path; }
95 virtual ssgTexture * getTexture ();
97 virtual void setCrop (float minX, float minY, float maxX, float maxY) {
98 _minX = minX; _minY = minY; _maxX = maxX; _maxY = maxY;
101 virtual float getMinX () const { return _minX; }
102 virtual float getMinY () const { return _minY; }
103 virtual float getMaxX () const { return _maxX; }
104 virtual float getMaxY () const { return _maxY; }
109 ssgTexture * _texture;
110 float _minX, _minY, _maxX, _maxY;
115 ////////////////////////////////////////////////////////////////////////
116 // Instrument panel class.
118 // The panel is a container that has a background texture and holds
119 // zero or more instruments. The panel will order the instruments to
120 // redraw themselves when necessary, and will pass mouse clicks on to
121 // the appropriate instruments for processing.
122 ////////////////////////////////////////////////////////////////////////
124 class FGPanel : public FGSubsystem
128 FGPanel (int window_x, int window_y, int window_w, int window_h);
131 // Update the panel (every frame).
132 virtual void init ();
133 virtual void bind ();
134 virtual void unbind ();
135 virtual void update ();
137 // transfer pointer ownership!!!
138 virtual void addInstrument (FGPanelInstrument * instrument);
140 // Background texture.
141 virtual void setBackground (ssgTexture * texture);
143 // Make the panel visible or invisible.
144 virtual bool getVisibility () const;
145 virtual void setVisibility (bool visibility);
147 // Full width of panel.
148 virtual void setWidth (int width) { _width = width; }
149 virtual int getWidth () const { return _width; }
151 // Full height of panel.
152 virtual void setHeight (int height) { _height = height; }
153 virtual int getHeight () const { return _height; }
156 virtual void setXOffset (int offset);
157 virtual int getXOffset () const { return _x_offset; }
160 virtual void setYOffset (int offset);
161 virtual int getYOffset () const { return _y_offset; }
164 virtual void setViewHeight (int height) { _view_height = height; }
165 virtual int getViewHeight () const { return _view_height; }
167 // Handle a mouse click.
168 virtual bool doMouseAction (int button, int updown, int x, int y);
171 mutable bool _visibility;
172 mutable bool _mouseDown;
173 mutable int _mouseButton, _mouseX, _mouseY;
174 mutable int _mouseDelay;
175 mutable FGPanelInstrument * _mouseInstrument;
176 typedef vector<FGPanelInstrument *> instrument_list_type;
177 int _winx, _winy, _winw, _winh;
186 // List of instruments in panel.
187 instrument_list_type _instruments;
192 ////////////////////////////////////////////////////////////////////////
193 // Base class for user action types.
195 // Individual instruments can have actions associated with a mouse
196 // click in a rectangular area. Current concrete classes include
197 // FGAdjustAction, FGSwapAction, and FGToggleAction.
198 ////////////////////////////////////////////////////////////////////////
204 FGPanelAction (int button, int x, int y, int w, int h);
205 virtual ~FGPanelAction ();
208 virtual int getButton () const { return _button; }
209 virtual int getX () const { return _x; }
210 virtual int getY () const { return _y; }
211 virtual int getWidth () const { return _w; }
212 virtual int getHeight () const { return _h; }
215 virtual void setButton (int button) { _button = button; }
216 virtual void setX (int x) { _x = x; }
217 virtual void setY (int y) { _y = y; }
218 virtual void setWidth (int w) { _w = w; }
219 virtual void setHeight (int h) { _h = h; }
221 // Check whether we're in the area.
222 virtual bool inArea (int button, int x, int y)
224 return (button == _button &&
231 // Perform the action.
232 virtual void doAction () = 0;
244 ////////////////////////////////////////////////////////////////////////
245 // Adjustment action.
247 // This is an action to increase or decrease an FGFS value by a certain
248 // increment within a certain range. If the wrap flag is true, the
249 // value will wrap around if it goes below min or above max; otherwise,
250 // it will simply stop at min or max.
251 ////////////////////////////////////////////////////////////////////////
253 class FGAdjustAction : public FGPanelAction
256 FGAdjustAction (int button, int x, int y, int w, int h,
257 SGPropertyNode * node, float increment,
258 float min, float max, bool wrap=false);
259 virtual ~FGAdjustAction ();
260 virtual void doAction ();
263 SGPropertyNode * _node;
272 ////////////////////////////////////////////////////////////////////////
275 // This is an action to swap two values. It's currently used in the
276 // navigation radios.
277 ////////////////////////////////////////////////////////////////////////
279 class FGSwapAction : public FGPanelAction
282 FGSwapAction (int button, int x, int y, int w, int h,
283 SGPropertyNode * node1, SGPropertyNode * node2);
284 virtual ~FGSwapAction ();
285 virtual void doAction ();
288 SGPropertyNode * _node1;
289 SGPropertyNode * _node2;
294 ////////////////////////////////////////////////////////////////////////
297 // This is an action to toggle a boolean value.
298 ////////////////////////////////////////////////////////////////////////
300 class FGToggleAction : public FGPanelAction
303 FGToggleAction (int button, int x, int y, int w, int h,
304 SGPropertyNode * node);
305 virtual ~FGToggleAction ();
306 virtual void doAction ();
309 SGPropertyNode * _node;
314 ////////////////////////////////////////////////////////////////////////
315 // Abstract base class for a panel instrument.
317 // A panel instrument consists of zero or more actions, associated
318 // with mouse clicks in rectangular areas. Currently, the only
319 // concrete class derived from this is FGLayeredInstrument, but others
320 // may show up in the future (some complex instruments could be
321 // entirely hand-coded, for example).
322 ////////////////////////////////////////////////////////////////////////
324 class FGPanelInstrument
327 FGPanelInstrument ();
328 FGPanelInstrument (int x, int y, int w, int h);
329 virtual ~FGPanelInstrument ();
331 virtual void draw () = 0;
333 virtual void setPosition(int x, int y);
334 virtual void setSize(int w, int h);
336 virtual int getXPos () const;
337 virtual int getYPos () const;
338 virtual int getWidth () const;
339 virtual int getHeight () const;
341 // Coordinates relative to centre.
342 // Transfer pointer ownership!!
343 virtual void addAction (FGPanelAction * action);
345 // Coordinates relative to centre.
346 virtual bool doMouseAction (int button, int x, int y);
350 typedef vector<FGPanelAction *> action_list_type;
351 action_list_type _actions;
356 ////////////////////////////////////////////////////////////////////////
357 // Abstract base class for an instrument layer.
359 // The FGLayeredInstrument class builds up instruments by using layers
360 // of textures or text. Each layer can have zero or more
361 // transformations applied to it: for example, a needle layer can
362 // rotate to show the altitude or airspeed.
363 ////////////////////////////////////////////////////////////////////////
367 * A transformation for a layer.
369 class FGPanelTransformation {
378 FGPanelTransformation ();
379 virtual ~FGPanelTransformation ();
382 const SGPropertyNode * node;
387 SGInterpTable * table;
393 * A single layer of a multi-layered instrument.
395 * Each layer can be subject to a series of transformations based
396 * on current FGFS instrument readings: for example, a texture
397 * representing a needle can rotate to show the airspeed.
399 class FGInstrumentLayer
403 FGInstrumentLayer (int w = -1, int h = -1);
404 virtual ~FGInstrumentLayer ();
406 virtual void draw () = 0;
407 virtual void transform () const;
409 virtual int getWidth () const { return _w; }
410 virtual int getHeight () const { return _h; }
411 virtual void setWidth (int w) { _w = w; }
412 virtual void setHeight (int h) { _h = h; }
414 // Transfer pointer ownership!!
416 virtual void addTransformation (FGPanelTransformation * transformation);
421 typedef vector<FGPanelTransformation *> transformation_list;
422 transformation_list _transformations;
427 ////////////////////////////////////////////////////////////////////////
428 // An instrument composed of layers.
430 // This class represents an instrument which is simply a series of
431 // layers piled one on top of the other, each one undergoing its own
432 // set of transformations. For example, one layer can represent
433 // the instrument's face (which doesn't move), while the next layer
434 // can represent a needle that rotates depending on an FGFS variable.
435 ////////////////////////////////////////////////////////////////////////
439 * An instrument constructed of multiple layers.
441 * Each individual layer can be rotated or shifted to correspond
442 * to internal FGFS instrument readings.
444 class FGLayeredInstrument : public FGPanelInstrument
447 FGLayeredInstrument (int x, int y, int w, int h);
448 virtual ~FGLayeredInstrument ();
450 virtual void draw ();
452 // Transfer pointer ownership!!
453 virtual int addLayer (FGInstrumentLayer *layer);
454 virtual int addLayer (FGCroppedTexture &texture, int w = -1, int h = -1);
456 // Transfer pointer ownership!!
457 virtual void addTransformation (FGPanelTransformation * transformation);
460 typedef vector<FGInstrumentLayer *> layer_list;
466 ////////////////////////////////////////////////////////////////////////
467 // A textured layer of an instrument.
469 // This is a layer holding a single texture. Normally, the texture's
470 // backgound should be transparent so that lower layers and the panel
471 // background can show through.
472 ////////////////////////////////////////////////////////////////////////
474 class FGTexturedLayer : public FGInstrumentLayer
477 FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
478 FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
479 virtual ~FGTexturedLayer ();
481 virtual void draw ();
483 virtual void setTexture (const FGCroppedTexture &texture) {
486 virtual FGCroppedTexture &getTexture () { return _texture; }
487 virtual const FGCroppedTexture &getTexture () const { return _texture; }
490 mutable FGCroppedTexture _texture;
495 ////////////////////////////////////////////////////////////////////////
496 // A text layer of an instrument.
498 // This is a layer holding a string of static and/or generated text.
499 // It is useful for instruments that have text displays, such as
500 // a chronometer, GPS, or NavCom radio.
501 ////////////////////////////////////////////////////////////////////////
503 class FGTextLayer : public FGInstrumentLayer
506 typedef enum ChunkType {
514 Chunk (const string &text, const string &fmt = "%s");
515 Chunk (ChunkType type, const SGPropertyNode * node,
516 const string &fmt = "", float mult = 1.0);
518 const char * getValue () const;
522 const SGPropertyNode * _node;
525 mutable char _buf[1024];
528 FGTextLayer (int w = -1, int h = -1);
529 virtual ~FGTextLayer ();
531 virtual void draw ();
533 // Transfer pointer!!
534 virtual void addChunk (Chunk * chunk);
535 virtual void setColor (float r, float g, float b);
536 virtual void setPointSize (float size);
537 virtual void setFont (fntFont * font);
541 void recalc_value () const;
543 typedef vector<Chunk *> chunk_list;
549 mutable string _value;
550 mutable SGTimeStamp _then;
551 mutable SGTimeStamp _now;
556 ////////////////////////////////////////////////////////////////////////
557 // A layer that switches between two other layers.
558 ////////////////////////////////////////////////////////////////////////
560 class FGSwitchLayer : public FGInstrumentLayer
563 // Transfer pointers!!
564 FGSwitchLayer (int w, int h, const SGPropertyNode * node,
565 FGInstrumentLayer * layer1,
566 FGInstrumentLayer * layer2);
567 virtual ~FGSwitchLayer ();
569 virtual void draw ();
572 const SGPropertyNode * _node;
573 FGInstrumentLayer * _layer1, * _layer2;
578 ////////////////////////////////////////////////////////////////////////
580 ////////////////////////////////////////////////////////////////////////
582 bool fgPanelVisible ();
586 ////////////////////////////////////////////////////////////////////////
587 // The current panel, if any.
588 ////////////////////////////////////////////////////////////////////////
590 extern FGPanel * current_panel;
594 #endif // __PANEL_HXX