X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCockpit%2Fpanel.hxx;h=58c1eed4a0e5190208af5a3ee2cb2386c839205a;hb=35396de6f87e2a8b8d0c21eb1d0908db586799f8;hp=c0906834d754c4b117ef44117b80fcb54e40e8d5;hpb=9a207fb4e10eb88c410499eb641e0c27c4ad6f68;p=flightgear.git diff --git a/src/Cockpit/panel.hxx b/src/Cockpit/panel.hxx index c0906834d..58c1eed4a 100644 --- a/src/Cockpit/panel.hxx +++ b/src/Cockpit/panel.hxx @@ -1,9 +1,7 @@ -// panel.hxx -- instrument panel defines and prototypes -// -// Written by Friedemann Reinhard, started June 1998. +// panel.hxx - generic support classes for a 2D panel. +// +// Written by David Megginson, started January 2000. // -// Major code reorganization by David Megginson, November 1999. -// // This program is free software; you can redistribute it and/or // modify it under the terms of the GNU General Public License as // published by the Free Software Foundation; either version 2 of the @@ -13,253 +11,598 @@ // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // General Public License for more details. -// +// // You should have received a copy of the GNU General Public License // along with this program; if not, write to the Free Software -// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. // // $Id$ +#ifndef __PANEL_HXX +#define __PANEL_HXX -#ifndef _PANEL_HXX -#define _PANEL_HXX - - -#ifndef __cplusplus +#ifndef __cplusplus # error This library requires C++ -#endif +#endif #ifdef HAVE_CONFIG_H # include #endif -#ifdef HAVE_WINDOWS_H -# include -#endif +#include +#include +#include -#include -#include +#include -class FGInstrument; // FIXME: rearrange to avoid this? +#include +#include +#include +#include +#include + +#include +#include +#include + +#include
+#include +#include + +using std::vector; +using std::map; + + +class FGPanelInstrument; + + + +//////////////////////////////////////////////////////////////////////// +// Texture management. +//////////////////////////////////////////////////////////////////////// /** - * Top-level class to hold an instance of a panel. + * Texture manager (should migrate out into FGFS). + * + * This class ensures that no texture is loaded more than once. */ -class FGPanel{ +class FGTextureManager +{ +public: + static osg::Texture2D* createTexture(const string &relativePath, + bool staticTexture = true); + static void addTexture(const string &relativePath, osg::Texture2D* texture); +private: + static map > _textureMap; +}; + +/** + * Cropped texture (should migrate out into FGFS). + * + * This structure wraps an SSG texture with cropping information. + */ +class FGCroppedTexture +{ public: - static FGPanel *OurPanel; // current_panel would be better - // FIXME: a few other classes have a - // dependency on this information; it - // would be nice to fix that. - GLuint panel_tex_id[2]; + FGCroppedTexture (); + FGCroppedTexture (const string &path, + float _minX = 0.0, float _minY = 0.0, + float _maxX = 1.0, float _maxY = 1.0); + virtual ~FGCroppedTexture (); - FGPanel(); - virtual ~FGPanel (); - virtual float get_height(void) { return height; } - virtual void ReInit( int x, int y, int finx, int finy); - virtual void Update(void); + virtual void setPath (const string &path) { _path = path; } -private: + virtual const string &getPath () const { return _path; } + + virtual osg::StateSet* getTexture (); - int height; - int width; - GLubyte *background; - GLubyte *imag; - int imag_width, imag_height; - GLubyte *img; - int img_width, img_height; - // The instruments on the panel. - FGInstrument * horizonIndicator; - FGInstrument * turnCoordinator; - FGInstrument * rpmIndicator; - FGInstrument * airspeedIndicator; - FGInstrument * verticalSpeedIndicator; - FGInstrument * altimeter; - FGInstrument * altimeter2; + virtual void setCrop (float minX, float minY, float maxX, float maxY) { + _minX = minX; _minY = minY; _maxX = maxX; _maxY = maxY; + } + + virtual float getMinX () const { return _minX; } + virtual float getMinY () const { return _minY; } + virtual float getMaxX () const { return _maxX; } + virtual float getMaxY () const { return _maxY; } + + +private: + string _path; + osg::ref_ptr _texture; + float _minX, _minY, _maxX, _maxY; }; + +//////////////////////////////////////////////////////////////////////// +// Top-level panel. +//////////////////////////////////////////////////////////////////////// + + /** - * Abstract base class for all panel instruments. + * Instrument panel class. + * + * The panel is a container that has a background texture and holds + * zero or more instruments. The panel will order the instruments to + * redraw themselves when necessary, and will pass mouse clicks on to + * the appropriate instruments for processing. */ -class FGInstrument{ - +class FGPanel : public SGSubsystem +{ public: - FGInstrument (void) {} - virtual ~FGInstrument (void) {} - virtual void Init(void) = 0; - virtual void Render(void) = 0; -protected: - float XPos; - float YPos; + FGPanel (); + virtual ~FGPanel (); + + // Update the panel (every frame). + virtual void init (); + virtual void bind (); + virtual void unbind (); + virtual void draw (osg::State& state); + virtual void update (double); + void update (osg::State& state); + virtual void update (osg::State& state, GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh); + + virtual void updateMouseDelay(); + + // transfer pointer ownership!!! + virtual void addInstrument (FGPanelInstrument * instrument); + + // Background texture. + virtual void setBackground (osg::Texture2D* texture); + + // Background multiple textures. + virtual void setMultiBackground (osg::Texture2D* texture, int idx); + + // Make the panel visible or invisible. + virtual bool getVisibility () const; + virtual void setVisibility (bool visibility); + + // Full width of panel. + virtual void setWidth (int width) { _width = width; } + virtual int getWidth () const { return _width; } + + // Full height of panel. + virtual void setHeight (int height) { _height = height; } + virtual int getHeight () const { return _height; } + + // X-offset + virtual void setXOffset (int offset); + virtual int getXOffset () const { return _x_offset->getIntValue(); } + + // Y-offset. + virtual void setYOffset (int offset); + virtual int getYOffset () const { return _y_offset->getIntValue(); } + + // View height. + virtual void setViewHeight (int height) { _view_height = height; } + virtual int getViewHeight () const { return _view_height; } + + // Handle a mouse click. + virtual bool doMouseAction (int button, int updown, int x, int y); + virtual bool doLocalMouseAction(int button, int updown, int x, int y); + + virtual void setDepthTest (bool enable); + + bool getAutohide(void) const { return _autohide; }; + void setAutohide(bool enable) { _autohide = enable; }; + +private: + void setupVirtualCockpit(); + void cleanupVirtualCockpit(); + + mutable bool _mouseDown; + mutable int _mouseButton, _mouseX, _mouseY; + mutable int _mouseDelay; + mutable FGPanelInstrument * _mouseInstrument; + typedef vector instrument_list_type; + int _width; + int _height; + int _view_height; + + SGPropertyNode_ptr _visibility; + SGPropertyNode_ptr _x_offset; + SGPropertyNode_ptr _y_offset; + SGPropertyNode_ptr _jitter; + SGPropertyNode_ptr _flipx; + + SGConstPropertyNode_ptr _xsize_node; + SGConstPropertyNode_ptr _ysize_node; + + osg::ref_ptr _bg; + osg::ref_ptr _mbg[8]; + // List of instruments in panel. + instrument_list_type _instruments; + bool _enable_depth_test; + bool _autohide; }; + +//////////////////////////////////////////////////////////////////////// +// Actions +//////////////////////////////////////////////////////////////////////// + + /** - * Instrument: the artificial horizon. + * Class for user actions. + * + * The actions are command bindings, like bindings for the keyboard + * or joystick, but they are tied to specific mouse actions in + * rectangular areas of the panel. */ -class FGHorizon : public FGInstrument +class FGPanelAction : public SGConditional { - public: - FGHorizon (float inXPos, float inYPos); - virtual ~FGHorizon (void); - virtual void Init (void); - virtual void Render (void); - + FGPanelAction (); + FGPanelAction (int button, int x, int y, int w, int h, bool repeatable); + virtual ~FGPanelAction (); + + // Getters. + virtual int getButton () const { return _button; } + virtual int getX () const { return _x; } + virtual int getY () const { return _y; } + virtual int getWidth () const { return _w; } + virtual int getHeight () const { return _h; } + + // Setters. + + // transfer pointer ownership + virtual void addBinding (SGBinding * binding, int updown); + virtual void setButton (int button) { _button = button; } + virtual void setX (int x) { _x = x; } + virtual void setY (int y) { _y = y; } + virtual void setWidth (int w) { _w = w; } + virtual void setHeight (int h) { _h = h; } + + // Check whether we're in the area. + virtual bool inArea (int button, int x, int y) + { + return (button == _button && + x >= _x && + x < _x + _w && + y >= _y && + y < _y + _h); + } + + // Perform the action. + virtual bool doAction (int updown); + private: - float texXPos; - float texYPos; - float radius; - float bottom; // tell the program the offset between midpoint and bottom - float top; // guess what ;-) - float vertices[180][2]; - float normals[180][3]; - float texCoord[180][2]; + typedef vector binding_list_t; + + int _button; + int _x; + int _y; + int _w; + int _h; + bool _repeatable; + int _last_state; + binding_list_t _bindings[2]; }; + +//////////////////////////////////////////////////////////////////////// +// Transformations. +//////////////////////////////////////////////////////////////////////// + + /** - * Instrument: the turn co-ordinator. + * A transformation for a layer. */ -class FGTurnCoordinator : public FGInstrument +class FGPanelTransformation : public SGConditional { - public: - FGTurnCoordinator (float inXPos, float inYPos); - virtual ~FGTurnCoordinator (void); - virtual void Init (void); - virtual void Render(void); - -private: - float PlaneTexXPos; - float PlaneTexYPos; - float alpha; - float PlaneAlpha; - float alphahist[2]; - float rollhist[2]; - float BallXPos; - float BallYPos; - float BallTexXPos; - float BallTexYPos; - float BallRadius; - GLfloat vertices[72]; - static GLfloat wingArea[]; - static GLfloat elevatorArea[]; - static GLfloat rudderArea[]; + + enum Type { + XSHIFT, + YSHIFT, + ROTATION + }; + + FGPanelTransformation (); + virtual ~FGPanelTransformation (); + + Type type; + SGConstPropertyNode_ptr node; + float min; + float max; + bool has_mod; + float mod; + float factor; + float offset; + SGInterpTable * table; }; + + +//////////////////////////////////////////////////////////////////////// +// Layers +//////////////////////////////////////////////////////////////////////// + + /** - * Abstract base class for gauges with needles and textured backgrounds. + * A single layer of a multi-layered instrument. * - * The airspeed indicator, vertical speed indicator, altimeter, and RPM - * gauge are all derived from this class. + * Each layer can be subject to a series of transformations based + * on current FGFS instrument readings: for example, a texture + * representing a needle can rotate to show the airspeed. */ -class FGTexInstrument : public FGInstrument +class FGInstrumentLayer : public SGConditional { public: - FGTexInstrument (void); - virtual ~FGTexInstrument (); - virtual void Init(void); - virtual void Render(void); - + + FGInstrumentLayer (int w = -1, int h = -1); + virtual ~FGInstrumentLayer (); + + virtual void draw (osg::State& state) = 0; + virtual void transform () const; + + virtual int getWidth () const { return _w; } + virtual int getHeight () const { return _h; } + virtual void setWidth (int w) { _w = w; } + virtual void setHeight (int h) { _h = h; } + + // Transfer pointer ownership!! + // DEPRECATED + virtual void addTransformation (FGPanelTransformation * transformation); + protected: - virtual void CreatePointer(void); - virtual void UpdatePointer(void); - virtual double getValue () const = 0; - - float radius; - float length; - float width; - float angle; - float tape[2]; - float value1; - float value2; - float alpha1; - float alpha2; - float textureXPos; - float textureYPos; - GLfloat vertices[20]; + int _w, _h; + + typedef vector transformation_list; + transformation_list _transformations; }; + +//////////////////////////////////////////////////////////////////////// +// Instruments. +//////////////////////////////////////////////////////////////////////// + + /** - * Instrument: the airspeed indicator. + * Abstract base class for a panel instrument. + * + * A panel instrument consists of zero or more actions, associated + * with mouse clicks in rectangular areas. Currently, the only + * concrete class derived from this is FGLayeredInstrument, but others + * may show up in the future (some complex instruments could be + * entirely hand-coded, for example). */ -class FGAirspeedIndicator : public FGTexInstrument +class FGPanelInstrument : public SGConditional { public: - FGAirspeedIndicator (int x, int y); - virtual ~FGAirspeedIndicator (); + FGPanelInstrument (); + FGPanelInstrument (int x, int y, int w, int h); + virtual ~FGPanelInstrument (); + + virtual void draw (osg::State& state) = 0; + virtual void drawHotspots(osg::State& state); + + virtual void setPosition(int x, int y); + virtual void setSize(int w, int h); + + virtual int getXPos () const; + virtual int getYPos () const; + virtual int getWidth () const; + virtual int getHeight () const; + + // Coordinates relative to centre. + // Transfer pointer ownership!! + virtual void addAction (FGPanelAction * action); + + // Coordinates relative to centre. + virtual bool doMouseAction (int button, int updown, int x, int y); protected: - double getValue () const; + int _x, _y, _w, _h; + typedef vector action_list_type; + action_list_type _actions; }; /** - * Instrument: the vertical speed indicator. + * An instrument constructed of multiple layers. + * + * Each individual layer can be rotated or shifted to correspond + * to internal FGFS instrument readings. */ -class FGVerticalSpeedIndicator : public FGTexInstrument +class FGLayeredInstrument : public FGPanelInstrument { public: - FGVerticalSpeedIndicator (int x, int y); - virtual ~FGVerticalSpeedIndicator (); + FGLayeredInstrument (int x, int y, int w, int h); + virtual ~FGLayeredInstrument (); + + virtual void draw (osg::State& state); + + // Transfer pointer ownership!! + virtual int addLayer (FGInstrumentLayer *layer); + virtual int addLayer (const FGCroppedTexture &texture, int w = -1, int h = -1); + + // Transfer pointer ownership!! + virtual void addTransformation (FGPanelTransformation * transformation); protected: - double getValue () const; + typedef vector layer_list; + layer_list _layers; }; /** - * Instrument: the altimeter (big hand?) + * An empty-shell instrument that exists soley in + * order to redirect commands from the panel to a + * complex instrument inherited from SGSubsystem. + * + * Currently the only complex instrument is the KLN89, + * which we've hardwired this to for now. */ -class FGAltimeter : public FGTexInstrument +class FGSpecialInstrument : public FGPanelInstrument { public: - FGAltimeter (int x, int y); - virtual ~FGAltimeter (); + FGSpecialInstrument(DCLGPS* sb); + //FGSpecialInstrument (int x, int y, int w, int h); + virtual ~FGSpecialInstrument (); + virtual void draw (osg::State& state); + protected: - double getValue () const; + DCLGPS* complex; }; /** - * Instrument: the altimeter (little hand?) + * An instrument layer containing a group of sublayers. + * + * This class is useful for gathering together a group of related + * layers, either to hold in an external file or to work under + * the same condition. */ -class FGAltimeter2 : public FGTexInstrument +class FGGroupLayer : public FGInstrumentLayer { public: - FGAltimeter2 (int x, int y); - virtual ~FGAltimeter2 (); - + FGGroupLayer (); + virtual ~FGGroupLayer (); + virtual void draw (osg::State& state); + // transfer pointer ownership + virtual void addLayer (FGInstrumentLayer * layer); protected: - double getValue () const; + vector _layers; }; /** - * Instrument: the RPM gauge (actually manifold pressure right now). + * A textured layer of an instrument. + * + * This is a layer holding a single texture. Normally, the texture's + * backgound should be transparent so that lower layers and the panel + * background can show through. */ -class FGRPMIndicator : public FGTexInstrument +class FGTexturedLayer : public FGInstrumentLayer { public: - FGRPMIndicator (int x, int y); - virtual ~FGRPMIndicator (); + FGTexturedLayer (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {} + FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1); + virtual ~FGTexturedLayer (); + + virtual void draw (osg::State& state); + + virtual void setTexture (const FGCroppedTexture &texture) { + _texture = texture; + } + virtual const FGCroppedTexture &getTexture () const { return _texture; } + virtual FGCroppedTexture *getTexture() { return &_texture; } + + void setEmissive(bool e) { _emissive = e; } + +private: + FGCroppedTexture _texture; + bool _emissive; +}; + + +/** + * A text layer of an instrument. + * + * This is a layer holding a string of static and/or generated text. + * It is useful for instruments that have text displays, such as + * a chronometer, GPS, or NavCom radio. + */ +class FGTextLayer : public FGInstrumentLayer +{ +public: + enum ChunkType { + TEXT, + TEXT_VALUE, + DOUBLE_VALUE + }; + + class Chunk : public SGConditional + { + public: + Chunk (const string &text, const string &fmt = "%s"); + Chunk (ChunkType type, const SGPropertyNode * node, + const string &fmt = "", float mult = 1.0, float offs = 0.0, + bool truncation = false); + + const char * getValue () const; + private: + ChunkType _type; + string _text; + SGConstPropertyNode_ptr _node; + string _fmt; + float _mult; + float _offs; + bool _trunc; + mutable char _buf[1024]; + }; + + FGTextLayer (int w = -1, int h = -1); + virtual ~FGTextLayer (); + + virtual void draw (osg::State& state); + + // Transfer pointer!! + virtual void addChunk (Chunk * chunk); + virtual void setColor (float r, float g, float b); + virtual void setPointSize (float size); + virtual void setFontName ( const string &name ); + virtual void setFont (fntFont * font); + +private: + + void recalc_value () const; + + typedef vector chunk_list; + chunk_list _chunks; + float _color[4]; + + float _pointSize; + mutable string _font_name; + mutable string _value; + mutable SGTimeStamp _then; + mutable SGTimeStamp _now; +}; + + +/** + * A group layer that switches among its children. + * + * The first layer that passes its condition will be drawn, and + * any following layers will be ignored. + */ +class FGSwitchLayer : public FGGroupLayer +{ +public: + // Transfer pointers!! + FGSwitchLayer (); + virtual void draw (osg::State& state); -protected: - double getValue () const; }; - // FIXME: move to FGPanel, somehow -void fgEraseArea(GLfloat *array, int NumVerti, GLfloat texXPos, GLfloat texYPos, GLfloat XPos, GLfloat YPos, int Texid, float ScaleFactor); -#endif // _PANEL_HXX + +//////////////////////////////////////////////////////////////////////// +// Functions. +//////////////////////////////////////////////////////////////////////// + +/** + * Test whether the panel should be visible. + */ +bool fgPanelVisible (); + + + +#endif // __PANEL_HXX + +// end of panel.hxx + + +