X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCockpit%2Fpanel.hxx;h=58c1eed4a0e5190208af5a3ee2cb2386c839205a;hb=35396de6f87e2a8b8d0c21eb1d0908db586799f8;hp=db242d9fa88e487a0263fc5569b223b39dfe9380;hpb=9dc5c9ca226cdb0c370e2a06e425522ab23b98b6;p=flightgear.git diff --git a/src/Cockpit/panel.hxx b/src/Cockpit/panel.hxx index db242d9fa..58c1eed4a 100644 --- a/src/Cockpit/panel.hxx +++ b/src/Cockpit/panel.hxx @@ -1,4 +1,4 @@ -// panel.hxx - default, 2D single-engine prop instrument panel +// panel.hxx - generic support classes for a 2D panel. // // Written by David Megginson, started January 2000. // @@ -11,219 +11,380 @@ // 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 __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 + +#include +#include +#include +#include +#include +#include #include #include -#include -FG_USING_STD(vector); -FG_USING_STD(map); +#include
+#include +#include + +using std::vector; +using std::map; + class FGPanelInstrument; //////////////////////////////////////////////////////////////////////// -// Texture manager (should migrate out into FGFS). -// -// This class ensures that no texture is loaded more than once. +// Texture management. //////////////////////////////////////////////////////////////////////// + +/** + * Texture manager (should migrate out into FGFS). + * + * This class ensures that no texture is loaded more than once. + */ class FGTextureManager { public: - static ssgTexture * createTexture(const char * relativePath); + static osg::Texture2D* createTexture(const string &relativePath, + bool staticTexture = true); + static void addTexture(const string &relativePath, osg::Texture2D* texture); private: - static map_textureMap; + static map > _textureMap; }; + +/** + * Cropped texture (should migrate out into FGFS). + * + * This structure wraps an SSG texture with cropping information. + */ +class FGCroppedTexture +{ +public: + + FGCroppedTexture (); + FGCroppedTexture (const string &path, + float _minX = 0.0, float _minY = 0.0, + float _maxX = 1.0, float _maxY = 1.0); + virtual ~FGCroppedTexture (); + + virtual void setPath (const string &path) { _path = path; } + + virtual const string &getPath () const { return _path; } + + virtual osg::StateSet* getTexture (); + + 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; +}; + + //////////////////////////////////////////////////////////////////////// -// 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. +// Top-level panel. //////////////////////////////////////////////////////////////////////// -class FGPanel + +/** + * 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 FGPanel : public SGSubsystem { public: - FGPanel (int x, int y, int w, int h); + 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); - // Update the panel (every frame). - virtual void update () const; - // Background texture. - virtual void setBackground (ssgTexture * 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: - bool _visibility; - bool _mouseDown; - int _mouseButton, _mouseX, _mouseY; + void setupVirtualCockpit(); + void cleanupVirtualCockpit(); + + mutable bool _mouseDown; + mutable int _mouseButton, _mouseX, _mouseY; mutable int _mouseDelay; - FGPanelInstrument * _mouseInstrument; + mutable FGPanelInstrument * _mouseInstrument; typedef vector instrument_list_type; - int _x, _y, _w, _h; - int _panel_h; - ssgTexture * _bg; + 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; }; //////////////////////////////////////////////////////////////////////// -// Base class for user action types. -// -// Individual instruments can have actions associated with a mouse -// click in a rectangular area. Current concrete classes are -// FGAdjustAction and FGSwapAction. +// Actions //////////////////////////////////////////////////////////////////////// -class FGPanelAction -{ -public: - virtual void doAction () = 0; -}; - - -//////////////////////////////////////////////////////////////////////// -// Adjustment action. -// -// This is an action to increase or decrease an FGFS value by a certain -// increment within a certain range. If the wrap flag is true, the -// value will wrap around if it goes below min or above max; otherwise, -// it will simply stop at min or max. -//////////////////////////////////////////////////////////////////////// - -class FGAdjustAction : public FGPanelAction +/** + * 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 FGPanelAction : public SGConditional { public: - typedef double (*getter_type)(); - typedef void (*setter_type)(double); + 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); + } - FGAdjustAction (getter_type getter, setter_type setter, float increment, - float min, float max, bool wrap=false); - virtual ~FGAdjustAction (); - virtual void doAction (); + // Perform the action. + virtual bool doAction (int updown); private: - getter_type _getter; - setter_type _setter; - float _increment; - float _min; - float _max; - bool _wrap; + 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]; }; //////////////////////////////////////////////////////////////////////// -// Swap action. -// -// This is an action to swap two values. It's currently used in the -// navigation radios. +// Transformations. //////////////////////////////////////////////////////////////////////// -class FGSwapAction : public FGPanelAction + +/** + * A transformation for a layer. + */ +class FGPanelTransformation : public SGConditional { public: - typedef double (*getter_type)(); - typedef void (*setter_type)(double); - FGSwapAction (getter_type getter1, setter_type setter1, - getter_type getter2, setter_type setter2); - virtual ~FGSwapAction (); - virtual void doAction (); + enum Type { + XSHIFT, + YSHIFT, + ROTATION + }; -private: - getter_type _getter1, _getter2; - setter_type _setter1, _setter2; + FGPanelTransformation (); + virtual ~FGPanelTransformation (); + + Type type; + SGConstPropertyNode_ptr node; + float min; + float max; + bool has_mod; + float mod; + float factor; + float offset; + SGInterpTable * table; }; + //////////////////////////////////////////////////////////////////////// -// Toggle action. -// -// This is an action to toggle a boolean value. +// Layers //////////////////////////////////////////////////////////////////////// -class FGToggleAction : public FGPanelAction + +/** + * A single layer of a multi-layered instrument. + * + * 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 FGInstrumentLayer : public SGConditional { public: - typedef bool (*getter_type)(); - typedef void (*setter_type)(bool); - FGToggleAction (getter_type getter, setter_type setter); - virtual ~FGToggleAction (); - virtual void doAction (); + FGInstrumentLayer (int w = -1, int h = -1); + virtual ~FGInstrumentLayer (); -private: - getter_type _getter; - setter_type _setter; + 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: + int _w, _h; + + typedef vector transformation_list; + transformation_list _transformations; }; //////////////////////////////////////////////////////////////////////// -// 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). +// Instruments. //////////////////////////////////////////////////////////////////////// -class FGPanelInstrument + +/** + * 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 FGPanelInstrument : public SGConditional { public: FGPanelInstrument (); FGPanelInstrument (int x, int y, int w, int h); virtual ~FGPanelInstrument (); - virtual void draw () const = 0; + 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); @@ -235,255 +396,207 @@ public: // Coordinates relative to centre. // Transfer pointer ownership!! - virtual void addAction (int button, int x, int y, int w, int h, - FGPanelAction * action); + virtual void addAction (FGPanelAction * action); // Coordinates relative to centre. - virtual bool doMouseAction (int button, int x, int y); + virtual bool doMouseAction (int button, int updown, int x, int y); protected: int _x, _y, _w, _h; - typedef struct { - int button; - int x; - int y; - int w; - int h; - FGPanelAction * action; - } inst_action; - typedef vector action_list_type; + typedef vector action_list_type; action_list_type _actions; }; - -//////////////////////////////////////////////////////////////////////// -// Abstract base class for an instrument layer. -// -// The FGLayeredInstrument class builds up instruments by using layers -// of textures or text. Each layer can have zero or more -// transformations applied to it: for example, a needle layer can -// rotate to show the altitude or airspeed. -//////////////////////////////////////////////////////////////////////// - /** - * A single layer of a multi-layered instrument. + * An instrument constructed of multiple layers. * - * 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. + * Each individual layer can be rotated or shifted to correspond + * to internal FGFS instrument readings. */ -class FGInstrumentLayer +class FGLayeredInstrument : public FGPanelInstrument { public: - typedef enum { - XSHIFT, - YSHIFT, - ROTATION - } transform_type; - - typedef double (*transform_func)(); - + FGLayeredInstrument (int x, int y, int w, int h); + virtual ~FGLayeredInstrument (); - FGInstrumentLayer (); - FGInstrumentLayer (int w, int h); - virtual ~FGInstrumentLayer (); + virtual void draw (osg::State& state); - virtual void draw () const = 0; - virtual void transform () const; + // Transfer pointer ownership!! + virtual int addLayer (FGInstrumentLayer *layer); + virtual int addLayer (const FGCroppedTexture &texture, int w = -1, int h = -1); - virtual void addTransformation (transform_type type, transform_func func, - float min, float max, - float factor = 1.0, float offset = 0.0); + // Transfer pointer ownership!! + virtual void addTransformation (FGPanelTransformation * transformation); protected: - int _w, _h; - - typedef struct { - transform_type type; - transform_func func; - float min; - float max; - float factor; - float offset; - } transformation; - typedef vector transformation_list; - transformation_list _transformations; + typedef vector layer_list; + layer_list _layers; }; - -//////////////////////////////////////////////////////////////////////// -// An instrument composed of layers. -// -// This class represents an instrument which is simply a series of -// layers piled one on top of the other, each one undergoing its own -// set of transformations. For example, one layer can represent -// the instrument's face (which doesn't move), while the next layer -// can represent a needle that rotates depending on an FGFS variable. -//////////////////////////////////////////////////////////////////////// - - /** - * An instrument constructed of multiple layers. + * An empty-shell instrument that exists soley in + * order to redirect commands from the panel to a + * complex instrument inherited from SGSubsystem. * - * Each individual layer can be rotated or shifted to correspond - * to internal FGFS instrument readings. + * Currently the only complex instrument is the KLN89, + * which we've hardwired this to for now. */ -class FGLayeredInstrument : public FGPanelInstrument +class FGSpecialInstrument : public FGPanelInstrument { public: - typedef vector layer_list; - FGLayeredInstrument (int x, int y, int w, int h); - virtual ~FGLayeredInstrument (); + FGSpecialInstrument(DCLGPS* sb); + //FGSpecialInstrument (int x, int y, int w, int h); + virtual ~FGSpecialInstrument (); - virtual void draw () const; + virtual void draw (osg::State& state); + +protected: + DCLGPS* complex; +}; - // Transfer pointer ownership!! - virtual int addLayer (FGInstrumentLayer *layer); - virtual int addLayer (ssgTexture * texture, - int w = -1, int h = -1, - float texX1 = 0.0, float texY1 = 0.0, - float texX2 = 1.0, float texY2 = 1.0); - virtual void addTransformation (FGInstrumentLayer::transform_type type, - FGInstrumentLayer::transform_func func, - float min, float max, - float factor = 1.0, float offset = 0.0); - virtual void addTransformation (FGInstrumentLayer::transform_type type, - float offset); +/** + * 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 FGGroupLayer : public FGInstrumentLayer +{ +public: + FGGroupLayer (); + virtual ~FGGroupLayer (); + virtual void draw (osg::State& state); + // transfer pointer ownership + virtual void addLayer (FGInstrumentLayer * layer); protected: - layer_list _layers; + vector _layers; }; - -//////////////////////////////////////////////////////////////////////// -// 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. -//////////////////////////////////////////////////////////////////////// - +/** + * 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 FGTexturedLayer : public FGInstrumentLayer { public: - FGTexturedLayer (ssgTexture * texture, int w, int h, - float texX1 = 0.0, float texY1 = 0.0, - float texX2 = 1.0, float texY2 = 1.0); + 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 () const; - - virtual void setTexture (ssgTexture * texture) { _texture = texture; } - virtual void setTextureCoords (float x1, float y1, float x2, float y2) { - _texX1 = x1; _texY1 = y1; _texX2 = x2; _texY2 = y2; - } + virtual void draw (osg::State& state); -protected: - - virtual void setTextureCoords (float x1, float y1, - float x2, float y2) const { - _texX1 = x1; _texY1 = y1; _texX2 = x2; _texY2 = y2; + 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: - ssgTexture * _texture; - mutable float _texX1, _texY1, _texX2, _texY2; + 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. -//////////////////////////////////////////////////////////////////////// - +/** + * 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: - typedef char * (*text_func)(); - typedef double (*double_func)(); - typedef enum ChunkType { + enum ChunkType { TEXT, - TEXT_FUNC, - DOUBLE_FUNC + TEXT_VALUE, + DOUBLE_VALUE }; - class Chunk { + class Chunk : public SGConditional + { public: - Chunk (char * text, char * fmt = "%s"); - Chunk (text_func func, char * fmt = "%s"); - Chunk (double_func func, char * fmt = "%.2f", float mult = 1.0); + 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); - char * getValue () const; + const char * getValue () const; private: ChunkType _type; - union { - char * _text; - text_func _tfunc; - double_func _dfunc; - } _value; - char * _fmt; + string _text; + SGConstPropertyNode_ptr _node; + string _fmt; float _mult; + float _offs; + bool _trunc; mutable char _buf[1024]; }; - FGTextLayer (int w, int h); + FGTextLayer (int w = -1, int h = -1); virtual ~FGTextLayer (); - virtual void draw () const; + 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]; - // FIXME: need only one globally - mutable fntRenderer _renderer; -}; + float _pointSize; + mutable string _font_name; + mutable string _value; + mutable SGTimeStamp _then; + mutable SGTimeStamp _now; +}; - -//////////////////////////////////////////////////////////////////////// -// A layer that switches between two other layers. -//////////////////////////////////////////////////////////////////////// -class FGSwitchLayer : public FGInstrumentLayer +/** + * 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: - typedef bool (*switch_func)(); - // Transfer pointers!! - FGSwitchLayer (int w, int h, switch_func func, - FGInstrumentLayer * layer1, - FGInstrumentLayer * layer2); - virtual ~FGSwitchLayer (); + FGSwitchLayer (); + virtual void draw (osg::State& state); - virtual void draw () const; - -private: - switch_func _func; - FGInstrumentLayer * _layer1, * _layer2; }; + //////////////////////////////////////////////////////////////////////// -// The current panel, if any. +// Functions. //////////////////////////////////////////////////////////////////////// -extern FGPanel * current_panel; +/** + * Test whether the panel should be visible. + */ +bool fgPanelVisible (); @@ -492,3 +605,4 @@ extern FGPanel * current_panel; // end of panel.hxx +