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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 # error This library requires C++
33 #include <osg/ref_ptr>
34 #include <osg/StateSet>
35 #include <osg/Texture2D>
39 #include <simgear/compiler.h>
40 #include <simgear/props/props.hxx>
41 #include <simgear/structure/subsystem_mgr.hxx>
42 #include <simgear/math/interpolater.hxx>
43 #include <simgear/timing/timestamp.hxx>
49 #include <Main/fg_props.hxx>
50 #include <Input/input.hxx>
51 #include <Instrumentation/dclgps.hxx>
57 class FGPanelInstrument;
61 ////////////////////////////////////////////////////////////////////////
62 // Texture management.
63 ////////////////////////////////////////////////////////////////////////
67 * Texture manager (should migrate out into FGFS).
69 * This class ensures that no texture is loaded more than once.
71 class FGTextureManager
74 static osg::Texture2D* createTexture(const string &relativePath,
75 bool staticTexture = true);
76 static void addTexture(const string &relativePath, osg::Texture2D* texture);
78 static map<string,osg::ref_ptr<osg::Texture2D> > _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 osg::StateSet* 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 osg::ref_ptr<osg::StateSet> _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 SGSubsystem
141 // Update the panel (every frame).
142 virtual void init ();
143 virtual void bind ();
144 virtual void unbind ();
145 virtual void draw (osg::State& state);
146 virtual void update (double);
147 void update (osg::State& state);
148 virtual void update (osg::State& state, GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh);
150 virtual void updateMouseDelay();
152 // transfer pointer ownership!!!
153 virtual void addInstrument (FGPanelInstrument * instrument);
155 // Background texture.
156 virtual void setBackground (osg::Texture2D* texture);
158 // Background multiple textures.
159 virtual void setMultiBackground (osg::Texture2D* texture, int idx);
161 // Make the panel visible or invisible.
162 virtual bool getVisibility () const;
163 virtual void setVisibility (bool visibility);
165 // Full width of panel.
166 virtual void setWidth (int width) { _width = width; }
167 virtual int getWidth () const { return _width; }
169 // Full height of panel.
170 virtual void setHeight (int height) { _height = height; }
171 virtual int getHeight () const { return _height; }
174 virtual void setXOffset (int offset);
175 virtual int getXOffset () const { return _x_offset->getIntValue(); }
178 virtual void setYOffset (int offset);
179 virtual int getYOffset () const { return _y_offset->getIntValue(); }
182 virtual void setViewHeight (int height) { _view_height = height; }
183 virtual int getViewHeight () const { return _view_height; }
185 // Handle a mouse click.
186 virtual bool doMouseAction (int button, int updown, int x, int y);
187 virtual bool doLocalMouseAction(int button, int updown, int x, int y);
189 virtual void setDepthTest (bool enable);
191 bool getAutohide(void) const { return _autohide; };
192 void setAutohide(bool enable) { _autohide = enable; };
195 void setupVirtualCockpit();
196 void cleanupVirtualCockpit();
198 mutable bool _mouseDown;
199 mutable int _mouseButton, _mouseX, _mouseY;
200 mutable int _mouseDelay;
201 mutable FGPanelInstrument * _mouseInstrument;
202 typedef vector<FGPanelInstrument *> instrument_list_type;
207 SGPropertyNode_ptr _visibility;
208 SGPropertyNode_ptr _x_offset;
209 SGPropertyNode_ptr _y_offset;
210 SGPropertyNode_ptr _jitter;
211 SGPropertyNode_ptr _flipx;
213 SGConstPropertyNode_ptr _xsize_node;
214 SGConstPropertyNode_ptr _ysize_node;
216 osg::ref_ptr<osg::StateSet> _bg;
217 osg::ref_ptr<osg::StateSet> _mbg[8];
218 // List of instruments in panel.
219 instrument_list_type _instruments;
220 bool _enable_depth_test;
226 ////////////////////////////////////////////////////////////////////////
228 ////////////////////////////////////////////////////////////////////////
232 * Class for user actions.
234 * The actions are command bindings, like bindings for the keyboard
235 * or joystick, but they are tied to specific mouse actions in
236 * rectangular areas of the panel.
238 class FGPanelAction : public SGConditional
242 FGPanelAction (int button, int x, int y, int w, int h, bool repeatable);
243 virtual ~FGPanelAction ();
246 virtual int getButton () const { return _button; }
247 virtual int getX () const { return _x; }
248 virtual int getY () const { return _y; }
249 virtual int getWidth () const { return _w; }
250 virtual int getHeight () const { return _h; }
254 // transfer pointer ownership
255 virtual void addBinding (SGBinding * binding, int updown);
256 virtual void setButton (int button) { _button = button; }
257 virtual void setX (int x) { _x = x; }
258 virtual void setY (int y) { _y = y; }
259 virtual void setWidth (int w) { _w = w; }
260 virtual void setHeight (int h) { _h = h; }
262 // Check whether we're in the area.
263 virtual bool inArea (int button, int x, int y)
265 return (button == _button &&
272 // Perform the action.
273 virtual bool doAction (int updown);
276 typedef vector<SGBinding *> binding_list_t;
285 binding_list_t _bindings[2];
290 ////////////////////////////////////////////////////////////////////////
292 ////////////////////////////////////////////////////////////////////////
296 * A transformation for a layer.
298 class FGPanelTransformation : public SGConditional
308 FGPanelTransformation ();
309 virtual ~FGPanelTransformation ();
312 SGConstPropertyNode_ptr node;
319 SGInterpTable * table;
325 ////////////////////////////////////////////////////////////////////////
327 ////////////////////////////////////////////////////////////////////////
331 * A single layer of a multi-layered instrument.
333 * Each layer can be subject to a series of transformations based
334 * on current FGFS instrument readings: for example, a texture
335 * representing a needle can rotate to show the airspeed.
337 class FGInstrumentLayer : public SGConditional
341 FGInstrumentLayer (int w = -1, int h = -1);
342 virtual ~FGInstrumentLayer ();
344 virtual void draw (osg::State& state) = 0;
345 virtual void transform () const;
347 virtual int getWidth () const { return _w; }
348 virtual int getHeight () const { return _h; }
349 virtual void setWidth (int w) { _w = w; }
350 virtual void setHeight (int h) { _h = h; }
352 // Transfer pointer ownership!!
354 virtual void addTransformation (FGPanelTransformation * transformation);
359 typedef vector<FGPanelTransformation *> transformation_list;
360 transformation_list _transformations;
365 ////////////////////////////////////////////////////////////////////////
367 ////////////////////////////////////////////////////////////////////////
371 * Abstract base class for a panel instrument.
373 * A panel instrument consists of zero or more actions, associated
374 * with mouse clicks in rectangular areas. Currently, the only
375 * concrete class derived from this is FGLayeredInstrument, but others
376 * may show up in the future (some complex instruments could be
377 * entirely hand-coded, for example).
379 class FGPanelInstrument : public SGConditional
382 FGPanelInstrument ();
383 FGPanelInstrument (int x, int y, int w, int h);
384 virtual ~FGPanelInstrument ();
386 virtual void draw (osg::State& state) = 0;
387 virtual void drawHotspots(osg::State& state);
389 virtual void setPosition(int x, int y);
390 virtual void setSize(int w, int h);
392 virtual int getXPos () const;
393 virtual int getYPos () const;
394 virtual int getWidth () const;
395 virtual int getHeight () const;
397 // Coordinates relative to centre.
398 // Transfer pointer ownership!!
399 virtual void addAction (FGPanelAction * action);
401 // Coordinates relative to centre.
402 virtual bool doMouseAction (int button, int updown, int x, int y);
406 typedef vector<FGPanelAction *> action_list_type;
407 action_list_type _actions;
412 * An instrument constructed of multiple layers.
414 * Each individual layer can be rotated or shifted to correspond
415 * to internal FGFS instrument readings.
417 class FGLayeredInstrument : public FGPanelInstrument
420 FGLayeredInstrument (int x, int y, int w, int h);
421 virtual ~FGLayeredInstrument ();
423 virtual void draw (osg::State& state);
425 // Transfer pointer ownership!!
426 virtual int addLayer (FGInstrumentLayer *layer);
427 virtual int addLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
429 // Transfer pointer ownership!!
430 virtual void addTransformation (FGPanelTransformation * transformation);
433 typedef vector<FGInstrumentLayer *> layer_list;
439 * An empty-shell instrument that exists soley in
440 * order to redirect commands from the panel to a
441 * complex instrument inherited from SGSubsystem.
443 * Currently the only complex instrument is the KLN89,
444 * which we've hardwired this to for now.
446 class FGSpecialInstrument : public FGPanelInstrument
449 FGSpecialInstrument(DCLGPS* sb);
450 //FGSpecialInstrument (int x, int y, int w, int h);
451 virtual ~FGSpecialInstrument ();
453 virtual void draw (osg::State& state);
461 * An instrument layer containing a group of sublayers.
463 * This class is useful for gathering together a group of related
464 * layers, either to hold in an external file or to work under
465 * the same condition.
467 class FGGroupLayer : public FGInstrumentLayer
471 virtual ~FGGroupLayer ();
472 virtual void draw (osg::State& state);
473 // transfer pointer ownership
474 virtual void addLayer (FGInstrumentLayer * layer);
476 vector<FGInstrumentLayer *> _layers;
481 * A textured layer of an instrument.
483 * This is a layer holding a single texture. Normally, the texture's
484 * backgound should be transparent so that lower layers and the panel
485 * background can show through.
487 class FGTexturedLayer : public FGInstrumentLayer
490 FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {}
491 FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1);
492 virtual ~FGTexturedLayer ();
494 virtual void draw (osg::State& state);
496 virtual void setTexture (const FGCroppedTexture &texture) {
499 virtual const FGCroppedTexture &getTexture () const { return _texture; }
500 virtual FGCroppedTexture *getTexture() { return &_texture; }
502 void setEmissive(bool e) { _emissive = e; }
505 FGCroppedTexture _texture;
511 * A text layer of an instrument.
513 * This is a layer holding a string of static and/or generated text.
514 * It is useful for instruments that have text displays, such as
515 * a chronometer, GPS, or NavCom radio.
517 class FGTextLayer : public FGInstrumentLayer
526 class Chunk : public SGConditional
529 Chunk (const string &text, const string &fmt = "%s");
530 Chunk (ChunkType type, const SGPropertyNode * node,
531 const string &fmt = "", float mult = 1.0, float offs = 0.0,
532 bool truncation = false);
534 const char * getValue () const;
538 SGConstPropertyNode_ptr _node;
543 mutable char _buf[1024];
546 FGTextLayer (int w = -1, int h = -1);
547 virtual ~FGTextLayer ();
549 virtual void draw (osg::State& state);
551 // Transfer pointer!!
552 virtual void addChunk (Chunk * chunk);
553 virtual void setColor (float r, float g, float b);
554 virtual void setPointSize (float size);
555 virtual void setFontName ( const string &name );
556 virtual void setFont (fntFont * font);
560 void recalc_value () const;
562 typedef vector<Chunk *> chunk_list;
567 mutable string _font_name;
568 mutable string _value;
569 mutable SGTimeStamp _then;
570 mutable SGTimeStamp _now;
575 * A group layer that switches among its children.
577 * The first layer that passes its condition will be drawn, and
578 * any following layers will be ignored.
580 class FGSwitchLayer : public FGGroupLayer
583 // Transfer pointers!!
585 virtual void draw (osg::State& state);
592 ////////////////////////////////////////////////////////////////////////
594 ////////////////////////////////////////////////////////////////////////
597 * Test whether the panel should be visible.
599 bool fgPanelVisible ();
603 #endif // __PANEL_HXX