X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCockpit%2Fpanel.hxx;h=ca1eefbe6aaeafbeff36b02dace81309158b7554;hb=68c71d5787f2a0309e35c3e05939950113618cb7;hp=bc70ff2166af8e88ab982e0d57cdfd59e35d8398;hpb=e891f2ff05c8428b77f137d5f86244a4dc9d716c;p=flightgear.git diff --git a/src/Cockpit/panel.hxx b/src/Cockpit/panel.hxx index bc70ff216..ca1eefbe6 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,231 +11,364 @@ // 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 -# error This library requires C++ -#endif - - -#ifdef HAVE_CONFIG_H -# include -#endif +#include +#include +#include -#ifdef HAVE_WINDOWS_H -# include -#endif +#include +#include +#include -#include -#include - -#include +#include +#include +#include +#include #include #include -#include -FG_USING_STD(vector); -FG_USING_STD(map); +#include
class FGPanelInstrument; +class fntFont; +class DCLGPS; +class IntRect; - - //////////////////////////////////////////////////////////////////////// -// 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 string &relativePath); + static osg::Texture2D* createTexture(const std::string &relativePath, + bool staticTexture = true); + static void addTexture(const std::string &relativePath, osg::Texture2D* texture); private: - static map_textureMap; + static std::map > _textureMap; }; - -//////////////////////////////////////////////////////////////////////// -// Cropped texture (should migrate out into FGFS). -// -// This class defines a rectangular cropped area of a texture. -//////////////////////////////////////////////////////////////////////// - -struct CroppedTexture +/** + * Cropped texture (should migrate out into FGFS). + * + * This structure wraps an SSG texture with cropping information. + */ +class FGCroppedTexture { - CroppedTexture () {} - CroppedTexture (const string &path, +public: + + FGCroppedTexture (); + FGCroppedTexture (const std::string &path, float _minX = 0.0, float _minY = 0.0, - float _maxX = 1.0, float _maxY = 1.0) - : texture(FGTextureManager::createTexture(path)), - minX(_minX), minY(_minY), maxX(_maxX), maxY(_maxY) {} + float _maxX = 1.0, float _maxY = 1.0); + virtual ~FGCroppedTexture (); + + virtual void setPath (const std::string &path) { _path = path; } + + virtual const std::string &getPath () const { return _path; } + + virtual osg::StateSet* getTexture (); - ssgTexture * texture; - float minX, minY, maxX, maxY; + 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: + std::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 SGReferenced { public: - FGPanel (int x, int y, int w, int h); + FGPanel (); virtual ~FGPanel (); + virtual void draw (osg::State& state); + + virtual void updateMouseDelay(double dt); + // 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); + + virtual void setWidth (int width) { _width = width; } + virtual int getWidth () const { return _width; } - // Make the panel visible or invisible. - virtual bool getVisibility () const; - virtual void setVisibility (bool visibility); + // 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; } + + /** + * find the actual logical extend of the panel, including all instruments + * and actions. + */ + void getLogicalExtent(int &x0, int& y0, int& x1, int &y1); + // 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; }; + + double getAspectScale() const; private: - bool _visibility; - bool _mouseDown; - int _mouseButton, _mouseX, _mouseY; - mutable int _mouseDelay; - FGPanelInstrument * _mouseInstrument; - typedef vector instrument_list_type; - int _x, _y, _w, _h; - int _panel_h; - ssgTexture * _bg; + void setupVirtualCockpit(); + void cleanupVirtualCockpit(); + + mutable bool _mouseDown; + mutable int _mouseButton, _mouseX, _mouseY; + double _mouseActionRepeat; + + mutable FGPanelInstrument * _mouseInstrument; + typedef std::vector instrument_list_type; + int _width; + int _height; + // int _view_height; + + 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; + + SGPropObjBool _drawPanelHotspots; }; //////////////////////////////////////////////////////////////////////// -// 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 + +/** + * 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: - virtual void doAction () = 0; -}; + 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. - -//////////////////////////////////////////////////////////////////////// -// 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. -//////////////////////////////////////////////////////////////////////// + // 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; } -class FGAdjustAction : public FGPanelAction -{ -public: - FGAdjustAction (SGValue * value, float increment, - float min, float max, bool wrap=false); - virtual ~FGAdjustAction (); - virtual void doAction (); + // 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: - SGValue * _value; - float _increment; - float _min; - float _max; - bool _wrap; + typedef std::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: - FGSwapAction (SGValue * value1, SGValue * value2); - virtual ~FGSwapAction (); - virtual void doAction (); -private: - SGValue * _value1; - SGValue * _value2; + 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; }; + //////////////////////////////////////////////////////////////////////// -// 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: - FGToggleAction (SGValue * value); - virtual ~FGToggleAction (); - virtual void doAction (); -private: - SGValue * _value; + 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: + int _w, _h; + + typedef std::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 () = 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); @@ -247,243 +380,199 @@ 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); + void extendRect(IntRect& r) const; 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 std::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; - - FGInstrumentLayer (int w = -1, int h = -1); - virtual ~FGInstrumentLayer (); + FGLayeredInstrument (int x, int y, int w, int h); + virtual ~FGLayeredInstrument (); - virtual void draw () = 0; - virtual void transform () const; + virtual void draw (osg::State& state); - 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!! + virtual int addLayer (FGInstrumentLayer *layer); + virtual int addLayer (const FGCroppedTexture &texture, int w = -1, int h = -1); - virtual void addTransformation (transform_type type, const SGValue * value, - 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; - const SGValue * value; - float min; - float max; - float factor; - float offset; - } transformation; - typedef vector transformation_list; - transformation_list _transformations; + typedef std::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 (); + virtual void draw (osg::State& state); + +protected: + DCLGPS* complex; +}; - // Transfer pointer ownership!! - virtual int addLayer (FGInstrumentLayer *layer); - virtual int addLayer (CroppedTexture &texture, - int w = -1, int h = -1); - virtual void addTransformation (FGInstrumentLayer::transform_type type, - const SGValue * value, - 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; + std::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 (int w = -1, int h = -1) : FGInstrumentLayer(w, h) {} - FGTexturedLayer (CroppedTexture &texture, int w = -1, int h = -1); + FGTexturedLayer (const FGCroppedTexture &texture, int w = -1, int h = -1); virtual ~FGTexturedLayer (); - virtual void draw (); + 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; } - virtual void setTexture (CroppedTexture &texture) { _texture = &texture; } - virtual CroppedTexture &getTexture () { return *_texture; } + void setEmissive(bool e) { _emissive = e; } private: - mutable CroppedTexture * _texture; + 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 enum ChunkType { + enum ChunkType { TEXT, TEXT_VALUE, DOUBLE_VALUE }; - class Chunk { + class Chunk : public SGConditional + { public: - Chunk (char * text, char * fmt = "%s"); - Chunk (ChunkType type, const SGValue * value, - char * fmt = 0, float mult = 1.0); + Chunk (const std::string &text, const std::string &fmt = "%s"); + Chunk (ChunkType type, const SGPropertyNode * node, + const std::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; - const SGValue * _value; - } _value; - char * _fmt; + std::string _text; + SGConstPropertyNode_ptr _node; + std::string _fmt; float _mult; + float _offs; + bool _trunc; mutable char _buf[1024]; }; - FGTextLayer (int w = -1, int h = -1, Chunk * chunk1 = 0, Chunk * chunk2 = 0, - Chunk * chunk3 = 0); + FGTextLayer (int w = -1, int h = -1); virtual ~FGTextLayer (); - virtual void draw (); + 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 std::string &name ); virtual void setFont (fntFont * font); private: - typedef vector chunk_list; + + void recalc_value () const; + + typedef std::vector chunk_list; chunk_list _chunks; float _color[4]; - // FIXME: need only one globally - mutable fntRenderer _renderer; -}; + float _pointSize; + mutable std::string _font_name; + mutable std::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: // Transfer pointers!! - FGSwitchLayer (int w, int h, const SGValue * value, - FGInstrumentLayer * layer1, - FGInstrumentLayer * layer2); - virtual ~FGSwitchLayer (); - - virtual void draw (); + FGSwitchLayer (); + virtual void draw (osg::State& state); -private: - const SGValue * _value; - FGInstrumentLayer * _layer1, * _layer2; -}; - - - -//////////////////////////////////////////////////////////////////////// -// The current panel, if any. -//////////////////////////////////////////////////////////////////////// - -extern FGPanel * current_panel; - - - +}; #endif // __PANEL_HXX // end of panel.hxx +