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);
363 glPushAttrib( GL_COLOR_BUFFER_BIT | GL_ENABLE_BIT | GL_LIGHTING_BIT
364 | GL_TEXTURE_BIT | GL_PIXEL_MODE_BIT );
366 // Draw the background
367 glEnable(GL_TEXTURE_2D);
368 glDisable(GL_LIGHTING);
370 glEnable(GL_ALPHA_TEST);
371 glEnable(GL_COLOR_MATERIAL);
372 // glColor4f(1.0, 1.0, 1.0, 1.0);
373 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
374 glColor4fv( cur_light_params.scene_diffuse );
376 glColor4f(0.7, 0.2, 0.2, 1.0);
379 glBindTexture(GL_TEXTURE_2D, _bg->getHandle());
380 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
381 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
382 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
384 glTexCoord2f(0.0, 0.0); glVertex2f(WIN_X, WIN_Y);
385 glTexCoord2f(1.0, 0.0); glVertex2f(WIN_X + _width, WIN_Y);
386 glTexCoord2f(1.0, 1.0); glVertex2f(WIN_X + _width, WIN_Y + _height);
387 glTexCoord2f(0.0, 1.0); glVertex2f(WIN_X, WIN_Y + _height);
390 for (int i = 0; i < 4; i ++) {
391 // top row of textures...(1,3,5,7)
392 glBindTexture(GL_TEXTURE_2D, _mbg[i*2]->getHandle());
393 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
395 glTexCoord2f(0.0, 0.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y + (_height/2));
396 glTexCoord2f(1.0, 0.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y + (_height/2));
397 glTexCoord2f(1.0, 1.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y + _height);
398 glTexCoord2f(0.0, 1.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y + _height);
400 // bottom row of textures...(2,4,6,8)
401 glBindTexture(GL_TEXTURE_2D, _mbg[(i*2)+1]->getHandle());
402 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
404 glTexCoord2f(0.0, 0.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y);
405 glTexCoord2f(1.0, 0.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y);
406 glTexCoord2f(1.0, 1.0); glVertex2f(WIN_X + (_width/4) * (i+1), WIN_Y + (_height/2));
407 glTexCoord2f(0.0, 1.0); glVertex2f(WIN_X + (_width/4) * i, WIN_Y + (_height/2));
412 // Draw the instruments.
413 instrument_list_type::const_iterator current = _instruments.begin();
414 instrument_list_type::const_iterator end = _instruments.end();
416 for ( ; current != end; current++) {
417 FGPanelInstrument * instr = *current;
419 glTranslated(instr->getXPos(), instr->getYPos(), 0);
424 // restore some original state
426 glDisable(GL_POLYGON_OFFSET_FILL);
430 * Set the panel's visibility.
433 FGPanel::setVisibility (bool visibility)
435 _visibility = visibility;
440 * Return true if the panel is visible.
443 FGPanel::getVisibility () const
450 * Set the panel's background texture.
453 FGPanel::setBackground (ssgTexture * texture)
459 * Set the panel's multiple background textures.
462 FGPanel::setMultiBackground (ssgTexture * texture, int idx)
469 * Set the panel's x-offset.
472 FGPanel::setXOffset (int offset)
474 if (offset <= 0 && offset >= -_width + WIN_W)
480 * Set the panel's y-offset.
483 FGPanel::setYOffset (int offset)
485 if (offset <= 0 && offset >= -_height)
490 * Perform a mouse action.
493 FGPanel::doMouseAction (int button, int updown, int x, int y)
495 // FIXME: this same code appears in update()
496 int xsize = _xsize_node->getIntValue();
497 int ysize = _ysize_node->getIntValue();
498 float aspect_adjust = get_aspect_adjust(xsize, ysize);
500 // Note a released button and return
501 // cerr << "Doing mouse action\n";
504 _mouseInstrument = 0;
508 // Scale for the real window size.
509 if (aspect_adjust < 1.0) {
510 x = int(((float)x / xsize) * WIN_W * aspect_adjust);
511 y = int(WIN_H - ((float(y) / ysize) * WIN_H));
513 x = int(((float)x / xsize) * WIN_W);
514 y = int((WIN_H - ((float(y) / ysize) * WIN_H)) / aspect_adjust);
517 // Adjust for offsets.
521 // Search for a matching instrument.
522 for (int i = 0; i < (int)_instruments.size(); i++) {
523 FGPanelInstrument *inst = _instruments[i];
524 int ix = inst->getXPos();
525 int iy = inst->getYPos();
526 int iw = inst->getWidth() / 2;
527 int ih = inst->getHeight() / 2;
528 if (x >= ix - iw && x < ix + iw && y >= iy - ih && y < iy + ih) {
531 _mouseInstrument = inst;
532 _mouseButton = button;
535 // Always do the action once.
536 return _mouseInstrument->doMouseAction(_mouseButton, _mouseX, _mouseY);
544 ////////////////////////////////////////////////////////////////////////.
545 // Implementation of FGPanelAction.
546 ////////////////////////////////////////////////////////////////////////
548 FGPanelAction::FGPanelAction ()
552 FGPanelAction::FGPanelAction (int button, int x, int y, int w, int h)
553 : _button(button), _x(x), _y(y), _w(w), _h(h)
555 for (unsigned int i = 0; i < _bindings.size(); i++)
559 FGPanelAction::~FGPanelAction ()
564 FGPanelAction::addBinding (FGBinding * binding)
566 _bindings.push_back(binding);
570 FGPanelAction::doAction ()
573 int nBindings = _bindings.size();
574 for (int i = 0; i < nBindings; i++) {
575 _bindings[i]->fire();
582 ////////////////////////////////////////////////////////////////////////
583 // Implementation of FGPanelTransformation.
584 ////////////////////////////////////////////////////////////////////////
586 FGPanelTransformation::FGPanelTransformation ()
591 FGPanelTransformation::~FGPanelTransformation ()
598 ////////////////////////////////////////////////////////////////////////
599 // Implementation of FGPanelInstrument.
600 ////////////////////////////////////////////////////////////////////////
603 FGPanelInstrument::FGPanelInstrument ()
609 FGPanelInstrument::FGPanelInstrument (int x, int y, int w, int h)
615 FGPanelInstrument::~FGPanelInstrument ()
617 for (action_list_type::iterator it = _actions.begin();
618 it != _actions.end();
626 FGPanelInstrument::setPosition (int x, int y)
633 FGPanelInstrument::setSize (int w, int h)
640 FGPanelInstrument::getXPos () const
646 FGPanelInstrument::getYPos () const
652 FGPanelInstrument::getWidth () const
658 FGPanelInstrument::getHeight () const
664 FGPanelInstrument::addAction (FGPanelAction * action)
666 _actions.push_back(action);
669 // Coordinates relative to centre.
671 FGPanelInstrument::doMouseAction (int button, int x, int y)
674 action_list_type::iterator it = _actions.begin();
675 action_list_type::iterator last = _actions.end();
676 for ( ; it != last; it++) {
677 if ((*it)->inArea(button, x, y)) {
688 ////////////////////////////////////////////////////////////////////////
689 // Implementation of FGLayeredInstrument.
690 ////////////////////////////////////////////////////////////////////////
692 FGLayeredInstrument::FGLayeredInstrument (int x, int y, int w, int h)
693 : FGPanelInstrument(x, y, w, h)
697 FGLayeredInstrument::~FGLayeredInstrument ()
699 for (layer_list::iterator it = _layers.begin(); it != _layers.end(); it++) {
706 FGLayeredInstrument::draw ()
711 for (int i = 0; i < (int)_layers.size(); i++) {
713 glPolygonOffset(-1, -POFF_UNITS*(i+2));
720 FGLayeredInstrument::addLayer (FGInstrumentLayer *layer)
722 int n = _layers.size();
723 if (layer->getWidth() == -1) {
724 layer->setWidth(getWidth());
726 if (layer->getHeight() == -1) {
727 layer->setHeight(getHeight());
729 _layers.push_back(layer);
734 FGLayeredInstrument::addLayer (FGCroppedTexture &texture,
737 return addLayer(new FGTexturedLayer(texture, w, h));
741 FGLayeredInstrument::addTransformation (FGPanelTransformation * transformation)
743 int layer = _layers.size() - 1;
744 _layers[layer]->addTransformation(transformation);
749 ////////////////////////////////////////////////////////////////////////
750 // Implementation of FGInstrumentLayer.
751 ////////////////////////////////////////////////////////////////////////
753 FGInstrumentLayer::FGInstrumentLayer (int w, int h)
759 FGInstrumentLayer::~FGInstrumentLayer ()
761 for (transformation_list::iterator it = _transformations.begin();
762 it != _transformations.end();
770 FGInstrumentLayer::transform () const
772 transformation_list::const_iterator it = _transformations.begin();
773 transformation_list::const_iterator last = _transformations.end();
775 FGPanelTransformation *t = *it;
777 float val = (t->node == 0 ? 0.0 : t->node->getFloatValue());
780 } else if (val > t->max) {
784 val = val * t->factor + t->offset;
786 val = t->table->interpolate(val) * t->factor + t->offset;
790 case FGPanelTransformation::XSHIFT:
791 glTranslatef(val, 0.0, 0.0);
793 case FGPanelTransformation::YSHIFT:
794 glTranslatef(0.0, val, 0.0);
796 case FGPanelTransformation::ROTATION:
797 glRotatef(-val, 0.0, 0.0, 1.0);
806 FGInstrumentLayer::addTransformation (FGPanelTransformation * transformation)
808 _transformations.push_back(transformation);
813 ////////////////////////////////////////////////////////////////////////
814 // Implementation of FGGroupLayer.
815 ////////////////////////////////////////////////////////////////////////
817 FGGroupLayer::FGGroupLayer ()
821 FGGroupLayer::~FGGroupLayer ()
823 for (unsigned int i = 0; i < _layers.size(); i++)
828 FGGroupLayer::draw ()
831 int nLayers = _layers.size();
832 for (int i = 0; i < nLayers; i++)
838 FGGroupLayer::addLayer (FGInstrumentLayer * layer)
840 _layers.push_back(layer);
845 ////////////////////////////////////////////////////////////////////////
846 // Implementation of FGTexturedLayer.
847 ////////////////////////////////////////////////////////////////////////
850 FGTexturedLayer::FGTexturedLayer (const FGCroppedTexture &texture, int w, int h)
851 : FGInstrumentLayer(w, h)
857 FGTexturedLayer::~FGTexturedLayer ()
863 FGTexturedLayer::draw ()
870 glBindTexture(GL_TEXTURE_2D, _texture.getTexture()->getHandle());
873 // From Curt: turn on the panel
874 // lights after sundown.
875 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
876 glColor4fv( cur_light_params.scene_diffuse );
878 glColor4f(0.7, 0.2, 0.2, 1.0);
882 glTexCoord2f(_texture.getMinX(), _texture.getMinY()); glVertex2f(-w2, -h2);
883 glTexCoord2f(_texture.getMaxX(), _texture.getMinY()); glVertex2f(w2, -h2);
884 glTexCoord2f(_texture.getMaxX(), _texture.getMaxY()); glVertex2f(w2, h2);
885 glTexCoord2f(_texture.getMinX(), _texture.getMaxY()); glVertex2f(-w2, h2);
892 ////////////////////////////////////////////////////////////////////////
893 // Implementation of FGTextLayer.
894 ////////////////////////////////////////////////////////////////////////
896 FGTextLayer::FGTextLayer (int w, int h)
897 : FGInstrumentLayer(w, h), _pointSize(14.0), _font_name("default")
900 _color[0] = _color[1] = _color[2] = 0.0;
904 FGTextLayer::~FGTextLayer ()
906 chunk_list::iterator it = _chunks.begin();
907 chunk_list::iterator last = _chunks.end();
908 for ( ; it != last; it++) {
919 if ( _font_name == "led" ) {
920 text_renderer.setFont(led_font);
922 text_renderer.setFont(guiFntHandle);
924 text_renderer.setPointSize(_pointSize);
925 text_renderer.begin();
926 text_renderer.start3f(0, 0, 0);
929 long diff = _now - _then;
931 if (diff > 100000 || diff < 0 ) {
932 // ( diff < 0 ) is a sanity check and indicates our time stamp
933 // difference math probably overflowed. We can handle a max
934 // difference of 35.8 minutes since the returned value is in
935 // usec. So if the panel is left off longer than that we can
936 // over flow the math with it is turned back on. This (diff <
937 // 0) catches that situation, get's us out of trouble, and
943 // Something is goofy. The code in this file renders only CCW
944 // polygons, and I have verified that the font code in plib
945 // renders only CCW trianbles. Yet they come out backwards.
946 // Something around here or in plib is either changing the winding
947 // order or (more likely) pushing a left-handed matrix onto the
948 // stack. But I can't find it; get out the chainsaw...
950 text_renderer.puts((char *)(_value.c_str()));
954 glColor4f(1.0, 1.0, 1.0, 1.0); // FIXME
959 FGTextLayer::addChunk (FGTextLayer::Chunk * chunk)
961 _chunks.push_back(chunk);
965 FGTextLayer::setColor (float r, float g, float b)
974 FGTextLayer::setPointSize (float size)
980 FGTextLayer::setFontName(const string &name)
987 FGTextLayer::setFont(fntFont * font)
989 text_renderer.setFont(font);
994 FGTextLayer::recalc_value () const
997 chunk_list::const_iterator it = _chunks.begin();
998 chunk_list::const_iterator last = _chunks.end();
999 for ( ; it != last; it++) {
1000 _value += (*it)->getValue();
1006 ////////////////////////////////////////////////////////////////////////
1007 // Implementation of FGTextLayer::Chunk.
1008 ////////////////////////////////////////////////////////////////////////
1010 FGTextLayer::Chunk::Chunk (const string &text, const string &fmt)
1011 : _type(FGTextLayer::TEXT), _fmt(fmt)
1018 FGTextLayer::Chunk::Chunk (ChunkType type, const SGPropertyNode * node,
1019 const string &fmt, float mult)
1020 : _type(type), _fmt(fmt), _mult(mult)
1023 if (type == TEXT_VALUE)
1032 FGTextLayer::Chunk::getValue () const
1038 sprintf(_buf, _fmt.c_str(), _text.c_str());
1041 sprintf(_buf, _fmt.c_str(), _node->getStringValue());
1044 sprintf(_buf, _fmt.c_str(), _node->getFloatValue() * _mult);
1055 ////////////////////////////////////////////////////////////////////////
1056 // Implementation of FGSwitchLayer.
1057 ////////////////////////////////////////////////////////////////////////
1059 FGSwitchLayer::FGSwitchLayer (int w, int h, const SGPropertyNode * node,
1060 FGInstrumentLayer * layer1,
1061 FGInstrumentLayer * layer2)
1062 : FGInstrumentLayer(w, h), _node(node), _layer1(layer1), _layer2(layer2)
1066 FGSwitchLayer::~FGSwitchLayer ()
1073 FGSwitchLayer::draw ()
1077 if (_node->getBoolValue()) {