1 // panel.cxx - default, 2D single-engine prop instrument 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.
29 #include <stdio.h> // sprintf
35 #include <simgear/debug/logstream.hxx>
36 #include <simgear/misc/sg_path.hxx>
38 #include <Main/globals.hxx>
39 #include <Main/fg_props.hxx>
40 #include <Main/viewmgr.hxx>
41 #include <Objects/texload.h>
42 #include <Time/light.hxx>
52 // The number of polygon-offset "units" to place between layers. In
53 // principle, one is supposed to be enough. In practice, I find that
54 // my hardware/driver requires many more.
58 ////////////////////////////////////////////////////////////////////////
60 ////////////////////////////////////////////////////////////////////////
64 * Calculate the aspect adjustment for the panel.
67 get_aspect_adjust (int xsize, int ysize)
69 float ideal_aspect = float(WIN_W) / float(WIN_H);
70 float real_aspect = float(xsize) / float(ysize);
71 return (real_aspect / ideal_aspect);
76 ////////////////////////////////////////////////////////////////////////
78 ////////////////////////////////////////////////////////////////////////
83 if(current_panel == 0)
85 if(current_panel->getVisibility() == 0)
87 if(globals->get_viewmgr()->get_current() != 0)
89 if(globals->get_current_view()->getHeadingOffset_deg() * SGD_DEGREES_TO_RADIANS != 0)
96 ////////////////////////////////////////////////////////////////////////
97 // Implementation of FGTextureManager.
98 ////////////////////////////////////////////////////////////////////////
100 map<string,ssgTexture *> FGTextureManager::_textureMap;
103 FGTextureManager::createTexture (const string &relativePath)
105 ssgTexture * texture = _textureMap[relativePath];
107 SG_LOG( SG_COCKPIT, SG_DEBUG,
108 "Texture " << relativePath << " does not yet exist" );
109 SGPath tpath(globals->get_fg_root());
110 tpath.append(relativePath);
111 texture = new ssgTexture((char *)tpath.c_str(), false, false);
112 _textureMap[relativePath] = texture;
113 if (_textureMap[relativePath] == 0)
114 SG_LOG( SG_COCKPIT, SG_ALERT, "Texture *still* doesn't exist" );
115 SG_LOG( SG_COCKPIT, SG_DEBUG, "Created texture " << relativePath
116 << " handle=" << texture->getHandle() );
125 ////////////////////////////////////////////////////////////////////////
126 // Implementation of FGCropped Texture.
127 ////////////////////////////////////////////////////////////////////////
130 FGCroppedTexture::FGCroppedTexture ()
131 : _path(""), _texture(0),
132 _minX(0.0), _minY(0.0), _maxX(1.0), _maxY(1.0)
137 FGCroppedTexture::FGCroppedTexture (const string &path,
138 float minX, float minY,
139 float maxX, float maxY)
140 : _path(path), _texture(0),
141 _minX(minX), _minY(minY), _maxX(maxX), _maxY(maxY)
146 FGCroppedTexture::~FGCroppedTexture ()
152 FGCroppedTexture::getTexture ()
155 _texture = FGTextureManager::createTexture(_path);
162 ////////////////////////////////////////////////////////////////////////
163 // Implementation of FGPanel.
164 ////////////////////////////////////////////////////////////////////////
166 FGPanel * current_panel = NULL;
167 static fntRenderer text_renderer;
168 static fntTexFont *default_font;
169 static fntTexFont *led_font;
177 _width(WIN_W), _height(int(WIN_H * 0.5768 + 1)),
178 _x_offset(0), _y_offset(0), _view_height(int(WIN_H * 0.4232)),
180 _xsize_node(fgGetNode("/sim/startup/xsize", true)),
181 _ysize_node(fgGetNode("/sim/startup/ysize", true))
183 setVisibility(fgPanelVisible());
192 for (instrument_list_type::iterator it = _instruments.begin();
193 it != _instruments.end();
202 * Add an instrument to the panel.
205 FGPanel::addInstrument (FGPanelInstrument * instrument)
207 _instruments.push_back(instrument);
212 * Initialize the panel.
218 char* envp = ::getenv( "FG_FONTS" );
219 if ( envp != NULL ) {
220 base_path.set( envp );
222 base_path.set( globals->get_fg_root() );
223 base_path.append( "Fonts" );
228 // Install the default font
230 fntpath.append( "typewriter.txf" );
231 default_font = new fntTexFont ;
232 default_font -> load ( (char *)fntpath.c_str() ) ;
234 // Install the LED font
236 fntpath.append( "led.txf" );
237 led_font = new fntTexFont ;
238 led_font -> load ( (char *)fntpath.c_str() ) ;
243 * Bind panel properties.
248 fgSetArchivable("/sim/panel/visibility");
249 fgSetArchivable("/sim/panel/x-offset");
250 fgSetArchivable("/sim/panel/y-offset");
251 fgSetArchivable("/sim/panel/jitter");
256 * Unbind panel properties.
268 FGPanel::update (double dt)
270 // TODO: cache the nodes
271 _visibility = fgGetBool("/sim/panel/visibility");
272 _x_offset = fgGetInt("/sim/panel/x-offset");
273 _y_offset = fgGetInt("/sim/panel/y-offset");
274 _jitter = fgGetFloat("/sim/panel/jitter");
276 // Do nothing if the panel isn't visible.
277 if ( !fgPanelVisible() ) {
281 // If the mouse is down, do something
284 if (_mouseDelay < 0) {
285 _mouseInstrument->doMouseAction(_mouseButton, _mouseX, _mouseY);
290 // Now, draw the panel
291 float aspect_adjust = get_aspect_adjust(_xsize_node->getIntValue(),
292 _ysize_node->getIntValue());
293 if (aspect_adjust <1.0)
294 update(WIN_X, int(WIN_W * aspect_adjust), WIN_Y, WIN_H);
296 update(WIN_X, WIN_W, WIN_Y, int(WIN_H / aspect_adjust));
301 FGPanel::update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh)
303 // Calculate accelerations
304 // and jiggle the panel accordingly
305 // The factors and bounds are just
306 // initial guesses; using sqrt smooths
308 double x_offset = _x_offset;
309 double y_offset = _y_offset;
312 if (_jitter != 0.0) {
313 double a_x_pilot = current_aircraft.fdm_state->get_A_X_pilot();
314 double a_y_pilot = current_aircraft.fdm_state->get_A_Y_pilot();
315 double a_z_pilot = current_aircraft.fdm_state->get_A_Z_pilot();
317 double a_zx_pilot = a_z_pilot - a_x_pilot;
319 int x_adjust = int(sqrt(fabs(a_y_pilot) * _jitter)) *
320 (a_y_pilot < 0 ? -1 : 1);
321 int y_adjust = int(sqrt(fabs(a_zx_pilot) * _jitter)) *
322 (a_zx_pilot < 0 ? -1 : 1);
324 // adjustments in screen coordinates
325 x_offset += x_adjust;
326 y_offset += y_adjust;
330 glMatrixMode(GL_PROJECTION);
333 gluOrtho2D(winx, winx + winw, winy, winy + winh); /* right side up */
334 // gluOrtho2D(winx + winw, winx, winy + winh, winy); /* up side down */
336 glMatrixMode(GL_MODELVIEW);
340 glTranslated(x_offset, y_offset, 0);
344 glMatrixMode(GL_PROJECTION);
346 glMatrixMode(GL_MODELVIEW);
349 ssgForceBasicState();
350 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
356 // In 3D mode, it's possible that we are being drawn exactly on top
357 // of an existing polygon. Use an offset to prevent z-fighting. In
358 // 2D mode, this is a no-op.
359 glEnable(GL_POLYGON_OFFSET_FILL);
360 glPolygonOffset(0, -POFF_UNITS);
362 // Draw the background
363 glEnable(GL_TEXTURE_2D);
364 glDisable(GL_LIGHTING);
366 glEnable(GL_ALPHA_TEST);
367 glEnable(GL_COLOR_MATERIAL);
368 // glColor4f(1.0, 1.0, 1.0, 1.0);
369 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
370 glColor4fv( cur_light_params.scene_diffuse );
372 glColor4f(0.7, 0.2, 0.2, 1.0);
375 glBindTexture(GL_TEXTURE_2D, _bg->getHandle());
376 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
377 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
378 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
380 glTexCoord2f(0.0, 0.0); glVertex2f(WIN_X, WIN_Y);
381 glTexCoord2f(1.0, 0.0); glVertex2f(WIN_X + _width, WIN_Y);
382 glTexCoord2f(1.0, 1.0); glVertex2f(WIN_X + _width, WIN_Y + _height);
383 glTexCoord2f(0.0, 1.0); glVertex2f(WIN_X, WIN_Y + _height);
386 for (int i = 0; i < 4; i ++) {
387 // top row of textures...(1,3,5,7)
388 glBindTexture(GL_TEXTURE_2D, _mbg[i*2]->getHandle());
389 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
391 glTexCoord2f(0.0, 0.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y + (_height/2));
392 glTexCoord2f(1.0, 0.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y + (_height/2));
393 glTexCoord2f(1.0, 1.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y + _height);
394 glTexCoord2f(0.0, 1.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y + _height);
396 // bottom row of textures...(2,4,6,8)
397 glBindTexture(GL_TEXTURE_2D, _mbg[(i*2)+1]->getHandle());
398 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
400 glTexCoord2f(0.0, 0.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y);
401 glTexCoord2f(1.0, 0.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y);
402 glTexCoord2f(1.0, 1.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y + (_height/2));
403 glTexCoord2f(0.0, 1.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y + (_height/2));
408 // Draw the instruments.
409 instrument_list_type::const_iterator current = _instruments.begin();
410 instrument_list_type::const_iterator end = _instruments.end();
412 for ( ; current != end; current++) {
413 FGPanelInstrument * instr = *current;
415 glTranslated(instr->getXPos(), instr->getYPos(), 0);
420 glDisable(GL_POLYGON_OFFSET_FILL);
424 * Set the panel's visibility.
427 FGPanel::setVisibility (bool visibility)
429 _visibility = visibility;
434 * Return true if the panel is visible.
437 FGPanel::getVisibility () const
444 * Set the panel's background texture.
447 FGPanel::setBackground (ssgTexture * texture)
453 * Set the panel's multiple background textures.
456 FGPanel::setMultiBackground (ssgTexture * texture, int idx)
463 * Set the panel's x-offset.
466 FGPanel::setXOffset (int offset)
468 if (offset <= 0 && offset >= -_width + WIN_W)
474 * Set the panel's y-offset.
477 FGPanel::setYOffset (int offset)
479 if (offset <= 0 && offset >= -_height)
484 * Perform a mouse action.
487 FGPanel::doMouseAction (int button, int updown, int x, int y)
489 // FIXME: this same code appears in update()
490 int xsize = _xsize_node->getIntValue();
491 int ysize = _ysize_node->getIntValue();
492 float aspect_adjust = get_aspect_adjust(xsize, ysize);
494 // Note a released button and return
495 // cerr << "Doing mouse action\n";
498 _mouseInstrument = 0;
502 // Scale for the real window size.
503 if (aspect_adjust < 1.0) {
504 x = int(((float)x / xsize) * WIN_W * aspect_adjust);
505 y = int(WIN_H - ((float(y) / ysize) * WIN_H));
507 x = int(((float)x / xsize) * WIN_W);
508 y = int((WIN_H - ((float(y) / ysize) * WIN_H)) / aspect_adjust);
511 // Adjust for offsets.
515 // Search for a matching instrument.
516 for (int i = 0; i < (int)_instruments.size(); i++) {
517 FGPanelInstrument *inst = _instruments[i];
518 int ix = inst->getXPos();
519 int iy = inst->getYPos();
520 int iw = inst->getWidth() / 2;
521 int ih = inst->getHeight() / 2;
522 if (x >= ix - iw && x < ix + iw && y >= iy - ih && y < iy + ih) {
525 _mouseInstrument = inst;
526 _mouseButton = button;
529 // Always do the action once.
530 return _mouseInstrument->doMouseAction(_mouseButton, _mouseX, _mouseY);
538 ////////////////////////////////////////////////////////////////////////.
539 // Implementation of FGPanelAction.
540 ////////////////////////////////////////////////////////////////////////
542 FGPanelAction::FGPanelAction ()
546 FGPanelAction::FGPanelAction (int button, int x, int y, int w, int h)
547 : _button(button), _x(x), _y(y), _w(w), _h(h)
549 for (unsigned int i = 0; i < _bindings.size(); i++)
553 FGPanelAction::~FGPanelAction ()
558 FGPanelAction::addBinding (FGBinding * binding)
560 _bindings.push_back(binding);
564 FGPanelAction::doAction ()
567 int nBindings = _bindings.size();
568 for (int i = 0; i < nBindings; i++) {
569 _bindings[i]->fire();
576 ////////////////////////////////////////////////////////////////////////
577 // Implementation of FGPanelTransformation.
578 ////////////////////////////////////////////////////////////////////////
580 FGPanelTransformation::FGPanelTransformation ()
585 FGPanelTransformation::~FGPanelTransformation ()
592 ////////////////////////////////////////////////////////////////////////
593 // Implementation of FGPanelInstrument.
594 ////////////////////////////////////////////////////////////////////////
597 FGPanelInstrument::FGPanelInstrument ()
603 FGPanelInstrument::FGPanelInstrument (int x, int y, int w, int h)
609 FGPanelInstrument::~FGPanelInstrument ()
611 for (action_list_type::iterator it = _actions.begin();
612 it != _actions.end();
620 FGPanelInstrument::setPosition (int x, int y)
627 FGPanelInstrument::setSize (int w, int h)
634 FGPanelInstrument::getXPos () const
640 FGPanelInstrument::getYPos () const
646 FGPanelInstrument::getWidth () const
652 FGPanelInstrument::getHeight () const
658 FGPanelInstrument::addAction (FGPanelAction * action)
660 _actions.push_back(action);
663 // Coordinates relative to centre.
665 FGPanelInstrument::doMouseAction (int button, int x, int y)
668 action_list_type::iterator it = _actions.begin();
669 action_list_type::iterator last = _actions.end();
670 for ( ; it != last; it++) {
671 if ((*it)->inArea(button, x, y)) {
682 ////////////////////////////////////////////////////////////////////////
683 // Implementation of FGLayeredInstrument.
684 ////////////////////////////////////////////////////////////////////////
686 FGLayeredInstrument::FGLayeredInstrument (int x, int y, int w, int h)
687 : FGPanelInstrument(x, y, w, h)
691 FGLayeredInstrument::~FGLayeredInstrument ()
693 for (layer_list::iterator it = _layers.begin(); it != _layers.end(); it++) {
700 FGLayeredInstrument::draw ()
705 for (int i = 0; i < (int)_layers.size(); i++) {
707 glPolygonOffset(-1, -POFF_UNITS*(i+2));
714 FGLayeredInstrument::addLayer (FGInstrumentLayer *layer)
716 int n = _layers.size();
717 if (layer->getWidth() == -1) {
718 layer->setWidth(getWidth());
720 if (layer->getHeight() == -1) {
721 layer->setHeight(getHeight());
723 _layers.push_back(layer);
728 FGLayeredInstrument::addLayer (FGCroppedTexture &texture,
731 return addLayer(new FGTexturedLayer(texture, w, h));
735 FGLayeredInstrument::addTransformation (FGPanelTransformation * transformation)
737 int layer = _layers.size() - 1;
738 _layers[layer]->addTransformation(transformation);
743 ////////////////////////////////////////////////////////////////////////
744 // Implementation of FGInstrumentLayer.
745 ////////////////////////////////////////////////////////////////////////
747 FGInstrumentLayer::FGInstrumentLayer (int w, int h)
753 FGInstrumentLayer::~FGInstrumentLayer ()
755 for (transformation_list::iterator it = _transformations.begin();
756 it != _transformations.end();
764 FGInstrumentLayer::transform () const
766 transformation_list::const_iterator it = _transformations.begin();
767 transformation_list::const_iterator last = _transformations.end();
769 FGPanelTransformation *t = *it;
771 float val = (t->node == 0 ? 0.0 : t->node->getFloatValue());
774 } else if (val > t->max) {
778 val = val * t->factor + t->offset;
780 val = t->table->interpolate(val) * t->factor + t->offset;
784 case FGPanelTransformation::XSHIFT:
785 glTranslatef(val, 0.0, 0.0);
787 case FGPanelTransformation::YSHIFT:
788 glTranslatef(0.0, val, 0.0);
790 case FGPanelTransformation::ROTATION:
791 glRotatef(-val, 0.0, 0.0, 1.0);
800 FGInstrumentLayer::addTransformation (FGPanelTransformation * transformation)
802 _transformations.push_back(transformation);
807 ////////////////////////////////////////////////////////////////////////
808 // Implementation of FGGroupLayer.
809 ////////////////////////////////////////////////////////////////////////
811 FGGroupLayer::FGGroupLayer ()
815 FGGroupLayer::~FGGroupLayer ()
817 for (unsigned int i = 0; i < _layers.size(); i++)
822 FGGroupLayer::draw ()
825 int nLayers = _layers.size();
826 for (int i = 0; i < nLayers; i++)
832 FGGroupLayer::addLayer (FGInstrumentLayer * layer)
834 _layers.push_back(layer);
839 ////////////////////////////////////////////////////////////////////////
840 // Implementation of FGTexturedLayer.
841 ////////////////////////////////////////////////////////////////////////
844 FGTexturedLayer::FGTexturedLayer (const FGCroppedTexture &texture, int w, int h)
845 : FGInstrumentLayer(w, h)
851 FGTexturedLayer::~FGTexturedLayer ()
857 FGTexturedLayer::draw ()
864 glBindTexture(GL_TEXTURE_2D, _texture.getTexture()->getHandle());
867 // From Curt: turn on the panel
868 // lights after sundown.
869 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
870 glColor4fv( cur_light_params.scene_diffuse );
872 glColor4f(0.7, 0.2, 0.2, 1.0);
876 glTexCoord2f(_texture.getMinX(), _texture.getMinY()); glVertex2f(-w2, -h2);
877 glTexCoord2f(_texture.getMaxX(), _texture.getMinY()); glVertex2f(w2, -h2);
878 glTexCoord2f(_texture.getMaxX(), _texture.getMaxY()); glVertex2f(w2, h2);
879 glTexCoord2f(_texture.getMinX(), _texture.getMaxY()); glVertex2f(-w2, h2);
886 ////////////////////////////////////////////////////////////////////////
887 // Implementation of FGTextLayer.
888 ////////////////////////////////////////////////////////////////////////
890 FGTextLayer::FGTextLayer (int w, int h)
891 : FGInstrumentLayer(w, h), _pointSize(14.0), _font_name("default")
894 _color[0] = _color[1] = _color[2] = 0.0;
898 FGTextLayer::~FGTextLayer ()
900 chunk_list::iterator it = _chunks.begin();
901 chunk_list::iterator last = _chunks.end();
902 for ( ; it != last; it++) {
913 if ( _font_name == "led" ) {
914 text_renderer.setFont(led_font);
916 text_renderer.setFont(guiFntHandle);
918 text_renderer.setPointSize(_pointSize);
919 text_renderer.begin();
920 text_renderer.start3f(0, 0, 0);
923 long diff = _now - _then;
925 if (diff > 100000 || diff < 0 ) {
926 // ( diff < 0 ) is a sanity check and indicates our time stamp
927 // difference math probably overflowed. We can handle a max
928 // difference of 35.8 minutes since the returned value is in
929 // usec. So if the panel is left off longer than that we can
930 // over flow the math with it is turned back on. This (diff <
931 // 0) catches that situation, get's us out of trouble, and
937 // Something is goofy. The code in this file renders only CCW
938 // polygons, and I have verified that the font code in plib
939 // renders only CCW trianbles. Yet they come out backwards.
940 // Something around here or in plib is either changing the winding
941 // order or (more likely) pushing a left-handed matrix onto the
942 // stack. But I can't find it; get out the chainsaw...
944 text_renderer.puts((char *)(_value.c_str()));
948 glColor4f(1.0, 1.0, 1.0, 1.0); // FIXME
953 FGTextLayer::addChunk (FGTextLayer::Chunk * chunk)
955 _chunks.push_back(chunk);
959 FGTextLayer::setColor (float r, float g, float b)
968 FGTextLayer::setPointSize (float size)
974 FGTextLayer::setFontName(const string &name)
981 FGTextLayer::setFont(fntFont * font)
983 text_renderer.setFont(font);
988 FGTextLayer::recalc_value () const
991 chunk_list::const_iterator it = _chunks.begin();
992 chunk_list::const_iterator last = _chunks.end();
993 for ( ; it != last; it++) {
994 _value += (*it)->getValue();
1000 ////////////////////////////////////////////////////////////////////////
1001 // Implementation of FGTextLayer::Chunk.
1002 ////////////////////////////////////////////////////////////////////////
1004 FGTextLayer::Chunk::Chunk (const string &text, const string &fmt)
1005 : _type(FGTextLayer::TEXT), _fmt(fmt)
1012 FGTextLayer::Chunk::Chunk (ChunkType type, const SGPropertyNode * node,
1013 const string &fmt, float mult)
1014 : _type(type), _fmt(fmt), _mult(mult)
1017 if (type == TEXT_VALUE)
1026 FGTextLayer::Chunk::getValue () const
1032 sprintf(_buf, _fmt.c_str(), _text.c_str());
1035 sprintf(_buf, _fmt.c_str(), _node->getStringValue());
1038 sprintf(_buf, _fmt.c_str(), _node->getFloatValue() * _mult);
1049 ////////////////////////////////////////////////////////////////////////
1050 // Implementation of FGSwitchLayer.
1051 ////////////////////////////////////////////////////////////////////////
1053 FGSwitchLayer::FGSwitchLayer (int w, int h, const SGPropertyNode * node,
1054 FGInstrumentLayer * layer1,
1055 FGInstrumentLayer * layer2)
1056 : FGInstrumentLayer(w, h), _node(node), _layer1(layer1), _layer2(layer2)
1060 FGSwitchLayer::~FGSwitchLayer ()
1067 FGSwitchLayer::draw ()
1071 if (_node->getBoolValue()) {