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 #if defined( NONE ) && defined( _MSC_VER )
53 # pragma message( "A sloppy coder has defined NONE as a macro!!!" )
56 # pragma warn A sloppy coder has defined NONE as a macro!!!
62 ////////////////////////////////////////////////////////////////////////
64 ////////////////////////////////////////////////////////////////////////
68 * Calculate the aspect adjustment for the panel.
71 get_aspect_adjust (int xsize, int ysize)
73 float ideal_aspect = float(WIN_W) / float(WIN_H);
74 float real_aspect = float(xsize) / float(ysize);
75 return (real_aspect / ideal_aspect);
80 ////////////////////////////////////////////////////////////////////////
82 ////////////////////////////////////////////////////////////////////////
87 return ((current_panel != 0) &&
88 (current_panel->getVisibility()) &&
89 (globals->get_viewmgr()->get_current() == 0) &&
90 (globals->get_current_view()->get_view_offset() == 0.0));
95 ////////////////////////////////////////////////////////////////////////
96 // Implementation of FGTextureManager.
97 ////////////////////////////////////////////////////////////////////////
99 map<string,ssgTexture *> FGTextureManager::_textureMap;
102 FGTextureManager::createTexture (const string &relativePath)
104 ssgTexture * texture = _textureMap[relativePath];
106 SG_LOG( SG_COCKPIT, SG_DEBUG,
107 "Texture " << relativePath << " does not yet exist" );
108 SGPath tpath(globals->get_fg_root());
109 tpath.append(relativePath);
110 texture = new ssgTexture((char *)tpath.c_str(), false, false);
111 _textureMap[relativePath] = texture;
112 if (_textureMap[relativePath] == 0)
113 SG_LOG( SG_COCKPIT, SG_ALERT, "Texture *still* doesn't exist" );
114 SG_LOG( SG_COCKPIT, SG_DEBUG, "Created texture " << relativePath
115 << " handle=" << texture->getHandle() );
124 ////////////////////////////////////////////////////////////////////////
125 // Implementation of FGCropped Texture.
126 ////////////////////////////////////////////////////////////////////////
129 FGCroppedTexture::FGCroppedTexture ()
130 : _path(""), _texture(0),
131 _minX(0.0), _minY(0.0), _maxX(1.0), _maxY(1.0)
136 FGCroppedTexture::FGCroppedTexture (const string &path,
137 float minX, float minY,
138 float maxX, float maxY)
139 : _path(path), _texture(0),
140 _minX(minX), _minY(minY), _maxX(maxX), _maxY(maxY)
145 FGCroppedTexture::~FGCroppedTexture ()
151 FGCroppedTexture::getTexture ()
154 _texture = FGTextureManager::createTexture(_path);
161 ////////////////////////////////////////////////////////////////////////
162 // Implementation of FGPanel.
163 ////////////////////////////////////////////////////////////////////////
165 FGPanel * current_panel = NULL;
166 static fntRenderer text_renderer;
167 static fntTexFont *default_font;
168 static fntTexFont *led_font;
176 _width(WIN_W), _height(int(WIN_H * 0.5768 + 1)),
177 _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());
194 for (instrument_list_type::iterator it = _instruments.begin();
195 it != _instruments.end();
204 * Add an instrument to the panel.
207 FGPanel::addInstrument (FGPanelInstrument * instrument)
209 _instruments.push_back(instrument);
214 * Initialize the panel.
220 char* envp = ::getenv( "FG_FONTS" );
221 if ( envp != NULL ) {
222 base_path.set( envp );
224 base_path.set( globals->get_fg_root() );
225 base_path.append( "Fonts" );
230 // Install the default font
232 fntpath.append( "typewriter.txf" );
233 default_font = new fntTexFont ;
234 default_font -> load ( (char *)fntpath.c_str() ) ;
236 // Install the LED font
238 fntpath.append( "led.txf" );
239 led_font = new fntTexFont ;
240 led_font -> load ( (char *)fntpath.c_str() ) ;
245 * Bind panel properties.
250 fgTie("/sim/panel/visibility", &_visibility);
251 fgSetArchivable("/sim/panel/visibility");
252 fgTie("/sim/panel/x-offset", &_x_offset);
253 fgSetArchivable("/sim/panel/x-offset");
254 fgTie("/sim/panel/y-offset", &_y_offset);
255 fgSetArchivable("/sim/panel/y-offset");
256 fgTie("/sim/panel/jitter", &_jitter);
257 fgSetArchivable("/sim/panel/jitter");
263 * Unbind panel properties.
268 fgUntie("/sim/panel/visibility");
269 fgUntie("/sim/panel/x-offset");
270 fgUntie("/sim/panel/y-offset");
279 FGPanel::update (int dt)
281 // Do nothing if the panel isn't visible.
282 if ( !fgPanelVisible() ) {
286 // If the mouse is down, do something
289 if (_mouseDelay < 0) {
290 _mouseInstrument->doMouseAction(_mouseButton, _mouseX, _mouseY);
295 // Now, draw the panel
296 float aspect_adjust = get_aspect_adjust(_xsize_node->getIntValue(),
297 _ysize_node->getIntValue());
298 if (aspect_adjust <1.0)
299 update(WIN_X, int(WIN_W * aspect_adjust), WIN_Y, WIN_H);
301 update(WIN_X, WIN_W, WIN_Y, int(WIN_H / aspect_adjust));
306 FGPanel::update (GLfloat winx, GLfloat winw, GLfloat winy, GLfloat winh)
308 // Calculate accelerations
309 // and jiggle the panel accordingly
310 // The factors and bounds are just
311 // initial guesses; using sqrt smooths
313 double x_offset = _x_offset;
314 double y_offset = _y_offset;
316 if (_jitter != 0.0) {
317 double a_x_pilot = current_aircraft.fdm_state->get_A_X_pilot();
318 double a_y_pilot = current_aircraft.fdm_state->get_A_Y_pilot();
319 double a_z_pilot = current_aircraft.fdm_state->get_A_Z_pilot();
321 double a_zx_pilot = a_z_pilot - a_x_pilot;
323 int x_adjust = int(sqrt(fabs(a_y_pilot) * _jitter)) *
324 (a_y_pilot < 0 ? -1 : 1);
325 int y_adjust = int(sqrt(fabs(a_zx_pilot) * _jitter)) *
326 (a_zx_pilot < 0 ? -1 : 1);
328 // adjustments in screen coordinates
329 x_offset += x_adjust;
330 y_offset += y_adjust;
333 glMatrixMode(GL_PROJECTION);
336 gluOrtho2D(winx, winx + winw, winy, winy + winh); /* right side up */
337 // gluOrtho2D(winx + winw, winx, winy + winh, winy); /* up side down */
339 glMatrixMode(GL_MODELVIEW);
343 glTranslated(x_offset, y_offset, 0);
345 // Draw the background
346 glEnable(GL_TEXTURE_2D);
347 glDisable(GL_LIGHTING);
349 glEnable(GL_ALPHA_TEST);
350 glEnable(GL_COLOR_MATERIAL);
351 // glColor4f(1.0, 1.0, 1.0, 1.0);
352 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
353 glColor4fv( cur_light_params.scene_diffuse );
355 glColor4f(0.7, 0.2, 0.2, 1.0);
358 glBindTexture(GL_TEXTURE_2D, _bg->getHandle());
359 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
360 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
361 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
363 glTexCoord2f(0.0, 0.0); glVertex3f(WIN_X, WIN_Y, 0);
364 glTexCoord2f(1.0, 0.0); glVertex3f(WIN_X + _width, WIN_Y, 0);
365 glTexCoord2f(1.0, 1.0); glVertex3f(WIN_X + _width, WIN_Y + _height, 0);
366 glTexCoord2f(0.0, 1.0); glVertex3f(WIN_X, WIN_Y + _height, 0);
369 for (int i = 0; i < 4; i ++) {
370 // top row of textures...(1,3,5,7)
371 glBindTexture(GL_TEXTURE_2D, _mbg[i*2]->getHandle());
372 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
374 glTexCoord2f(0.0, 0.0); glVertex3f(WIN_X + (_width/4) * i, WIN_Y + (_height/2), 0);
375 glTexCoord2f(1.0, 0.0); glVertex3f(WIN_X + (_width/4) * (i+1), WIN_Y + (_height/2), 0);
376 glTexCoord2f(1.0, 1.0); glVertex3f(WIN_X + (_width/4) * (i+1), WIN_Y + _height, 0);
377 glTexCoord2f(0.0, 1.0); glVertex3f(WIN_X + (_width/4) * i, WIN_Y + _height, 0);
379 // bottom row of textures...(2,4,6,8)
380 glBindTexture(GL_TEXTURE_2D, _mbg[(i*2)+1]->getHandle());
381 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
383 glTexCoord2f(0.0, 0.0); glVertex3f(WIN_X + (_width/4) * i, WIN_Y, 0);
384 glTexCoord2f(1.0, 0.0); glVertex3f(WIN_X + (_width/4) * (i+1), WIN_Y, 0);
385 glTexCoord2f(1.0, 1.0); glVertex3f(WIN_X + (_width/4) * (i+1), WIN_Y + (_height/2), 0);
386 glTexCoord2f(0.0, 1.0); glVertex3f(WIN_X + (_width/4) * i, WIN_Y + (_height/2), 0);
392 // Draw the instruments.
393 instrument_list_type::const_iterator current = _instruments.begin();
394 instrument_list_type::const_iterator end = _instruments.end();
396 for ( ; current != end; current++) {
397 FGPanelInstrument * instr = *current;
399 glTranslated(x_offset, y_offset, 0);
400 glTranslated(instr->getXPos(), instr->getYPos(), 0);
404 glMatrixMode(GL_PROJECTION);
406 glMatrixMode(GL_MODELVIEW);
408 ssgForceBasicState();
409 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
414 * Set the panel's visibility.
417 FGPanel::setVisibility (bool visibility)
419 _visibility = visibility;
424 * Return true if the panel is visible.
427 FGPanel::getVisibility () const
434 * Set the panel's background texture.
437 FGPanel::setBackground (ssgTexture * texture)
443 * Set the panel's multiple background textures.
446 FGPanel::setMultiBackground (ssgTexture * texture, int idx)
453 * Set the panel's x-offset.
456 FGPanel::setXOffset (int offset)
458 if (offset <= 0 && offset >= -_width + WIN_W)
464 * Set the panel's y-offset.
467 FGPanel::setYOffset (int offset)
469 if (offset <= 0 && offset >= -_height)
475 * Perform a mouse action.
478 FGPanel::doMouseAction (int button, int updown, int x, int y)
480 // FIXME: this same code appears in update()
481 int xsize = _xsize_node->getIntValue();
482 int ysize = _ysize_node->getIntValue();
483 float aspect_adjust = get_aspect_adjust(xsize, ysize);
485 // Note a released button and return
486 // cerr << "Doing mouse action\n";
489 _mouseInstrument = 0;
493 // Scale for the real window size.
494 if (aspect_adjust < 1.0) {
495 x = int(((float)x / xsize) * WIN_W * aspect_adjust);
496 y = int(WIN_H - ((float(y) / ysize) * WIN_H));
498 x = int(((float)x / xsize) * WIN_W);
499 y = int((WIN_H - ((float(y) / ysize) * WIN_H)) / aspect_adjust);
502 // Adjust for offsets.
506 // Search for a matching instrument.
507 for (int i = 0; i < (int)_instruments.size(); i++) {
508 FGPanelInstrument *inst = _instruments[i];
509 int ix = inst->getXPos();
510 int iy = inst->getYPos();
511 int iw = inst->getWidth() / 2;
512 int ih = inst->getHeight() / 2;
513 if (x >= ix - iw && x < ix + iw && y >= iy - ih && y < iy + ih) {
516 _mouseInstrument = inst;
517 _mouseButton = button;
520 // Always do the action once.
521 _mouseInstrument->doMouseAction(_mouseButton, _mouseX, _mouseY);
530 ////////////////////////////////////////////////////////////////////////.
531 // Implementation of FGPanelAction.
532 ////////////////////////////////////////////////////////////////////////
534 FGPanelAction::FGPanelAction ()
538 FGPanelAction::FGPanelAction (int button, int x, int y, int w, int h)
539 : _button(button), _x(x), _y(y), _w(w), _h(h)
541 for (unsigned int i = 0; i < _bindings.size(); i++)
545 FGPanelAction::~FGPanelAction ()
550 FGPanelAction::addBinding (FGBinding * binding)
552 _bindings.push_back(binding);
556 FGPanelAction::doAction ()
559 int nBindings = _bindings.size();
560 for (int i = 0; i < nBindings; i++) {
561 _bindings[i]->fire();
568 ////////////////////////////////////////////////////////////////////////
569 // Implementation of FGPanelTransformation.
570 ////////////////////////////////////////////////////////////////////////
572 FGPanelTransformation::FGPanelTransformation ()
577 FGPanelTransformation::~FGPanelTransformation ()
584 ////////////////////////////////////////////////////////////////////////
585 // Implementation of FGPanelInstrument.
586 ////////////////////////////////////////////////////////////////////////
589 FGPanelInstrument::FGPanelInstrument ()
595 FGPanelInstrument::FGPanelInstrument (int x, int y, int w, int h)
601 FGPanelInstrument::~FGPanelInstrument ()
603 for (action_list_type::iterator it = _actions.begin();
604 it != _actions.end();
612 FGPanelInstrument::setPosition (int x, int y)
619 FGPanelInstrument::setSize (int w, int h)
626 FGPanelInstrument::getXPos () const
632 FGPanelInstrument::getYPos () const
638 FGPanelInstrument::getWidth () const
644 FGPanelInstrument::getHeight () const
650 FGPanelInstrument::addAction (FGPanelAction * action)
652 _actions.push_back(action);
655 // Coordinates relative to centre.
657 FGPanelInstrument::doMouseAction (int button, int x, int y)
660 action_list_type::iterator it = _actions.begin();
661 action_list_type::iterator last = _actions.end();
662 for ( ; it != last; it++) {
663 if ((*it)->inArea(button, x, y)) {
674 ////////////////////////////////////////////////////////////////////////
675 // Implementation of FGLayeredInstrument.
676 ////////////////////////////////////////////////////////////////////////
678 FGLayeredInstrument::FGLayeredInstrument (int x, int y, int w, int h)
679 : FGPanelInstrument(x, y, w, h)
683 FGLayeredInstrument::~FGLayeredInstrument ()
685 for (layer_list::iterator it = _layers.begin(); it != _layers.end(); it++) {
692 FGLayeredInstrument::draw ()
695 for (int i = 0; i < (int)_layers.size(); i++) {
697 glTranslatef(0.0, 0.0, (i / 100.0) + 0.1);
705 FGLayeredInstrument::addLayer (FGInstrumentLayer *layer)
707 int n = _layers.size();
708 if (layer->getWidth() == -1) {
709 layer->setWidth(getWidth());
711 if (layer->getHeight() == -1) {
712 layer->setHeight(getHeight());
714 _layers.push_back(layer);
719 FGLayeredInstrument::addLayer (FGCroppedTexture &texture,
722 return addLayer(new FGTexturedLayer(texture, w, h));
726 FGLayeredInstrument::addTransformation (FGPanelTransformation * transformation)
728 int layer = _layers.size() - 1;
729 _layers[layer]->addTransformation(transformation);
734 ////////////////////////////////////////////////////////////////////////
735 // Implementation of FGInstrumentLayer.
736 ////////////////////////////////////////////////////////////////////////
738 FGInstrumentLayer::FGInstrumentLayer (int w, int h)
744 FGInstrumentLayer::~FGInstrumentLayer ()
746 for (transformation_list::iterator it = _transformations.begin();
747 it != _transformations.end();
755 FGInstrumentLayer::transform () const
757 transformation_list::const_iterator it = _transformations.begin();
758 transformation_list::const_iterator last = _transformations.end();
760 FGPanelTransformation *t = *it;
762 float val = (t->node == 0 ? 0.0 : t->node->getFloatValue());
765 } else if (val > t->max) {
769 val = val * t->factor + t->offset;
771 val = t->table->interpolate(val) * t->factor + t->offset;
775 case FGPanelTransformation::XSHIFT:
776 glTranslatef(val, 0.0, 0.0);
778 case FGPanelTransformation::YSHIFT:
779 glTranslatef(0.0, val, 0.0);
781 case FGPanelTransformation::ROTATION:
782 glRotatef(-val, 0.0, 0.0, 1.0);
791 FGInstrumentLayer::addTransformation (FGPanelTransformation * transformation)
793 _transformations.push_back(transformation);
798 ////////////////////////////////////////////////////////////////////////
799 // Implementation of FGGroupLayer.
800 ////////////////////////////////////////////////////////////////////////
802 FGGroupLayer::FGGroupLayer ()
806 FGGroupLayer::~FGGroupLayer ()
808 for (unsigned int i = 0; i < _layers.size(); i++)
813 FGGroupLayer::draw ()
816 int nLayers = _layers.size();
817 for (int i = 0; i < nLayers; i++)
823 FGGroupLayer::addLayer (FGInstrumentLayer * layer)
825 _layers.push_back(layer);
830 ////////////////////////////////////////////////////////////////////////
831 // Implementation of FGTexturedLayer.
832 ////////////////////////////////////////////////////////////////////////
835 FGTexturedLayer::FGTexturedLayer (const FGCroppedTexture &texture, int w, int h)
836 : FGInstrumentLayer(w, h)
842 FGTexturedLayer::~FGTexturedLayer ()
848 FGTexturedLayer::draw ()
855 glBindTexture(GL_TEXTURE_2D, _texture.getTexture()->getHandle());
858 // From Curt: turn on the panel
859 // lights after sundown.
860 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
861 glColor4fv( cur_light_params.scene_diffuse );
863 glColor4f(0.7, 0.2, 0.2, 1.0);
867 glTexCoord2f(_texture.getMinX(), _texture.getMinY()); glVertex2f(-w2, -h2);
868 glTexCoord2f(_texture.getMaxX(), _texture.getMinY()); glVertex2f(w2, -h2);
869 glTexCoord2f(_texture.getMaxX(), _texture.getMaxY()); glVertex2f(w2, h2);
870 glTexCoord2f(_texture.getMinX(), _texture.getMaxY()); glVertex2f(-w2, h2);
877 ////////////////////////////////////////////////////////////////////////
878 // Implementation of FGTextLayer.
879 ////////////////////////////////////////////////////////////////////////
881 FGTextLayer::FGTextLayer (int w, int h)
882 : FGInstrumentLayer(w, h), _pointSize(14.0), _font_name("default")
885 _color[0] = _color[1] = _color[2] = 0.0;
889 FGTextLayer::~FGTextLayer ()
891 chunk_list::iterator it = _chunks.begin();
892 chunk_list::iterator last = _chunks.end();
893 for ( ; it != last; it++) {
905 if ( _font_name == "led" ) {
906 text_renderer.setFont(led_font);
908 text_renderer.setFont(guiFntHandle);
910 text_renderer.setPointSize(_pointSize);
911 text_renderer.begin();
912 text_renderer.start3f(0, 0, 0);
915 if (_now - _then > 100000) {
919 text_renderer.puts((char *)(_value.c_str()));
922 glColor4f(1.0, 1.0, 1.0, 1.0); // FIXME
928 FGTextLayer::addChunk (FGTextLayer::Chunk * chunk)
930 _chunks.push_back(chunk);
934 FGTextLayer::setColor (float r, float g, float b)
943 FGTextLayer::setPointSize (float size)
949 FGTextLayer::setFontName(const string &name)
956 FGTextLayer::setFont(fntFont * font)
958 text_renderer.setFont(font);
963 FGTextLayer::recalc_value () const
966 chunk_list::const_iterator it = _chunks.begin();
967 chunk_list::const_iterator last = _chunks.end();
968 for ( ; it != last; it++) {
969 _value += (*it)->getValue();
975 ////////////////////////////////////////////////////////////////////////
976 // Implementation of FGTextLayer::Chunk.
977 ////////////////////////////////////////////////////////////////////////
979 FGTextLayer::Chunk::Chunk (const string &text, const string &fmt)
980 : _type(FGTextLayer::TEXT), _fmt(fmt)
987 FGTextLayer::Chunk::Chunk (ChunkType type, const SGPropertyNode * node,
988 const string &fmt, float mult)
989 : _type(type), _fmt(fmt), _mult(mult)
992 if (type == TEXT_VALUE)
1001 FGTextLayer::Chunk::getValue () const
1006 sprintf(_buf, _fmt.c_str(), _text.c_str());
1009 sprintf(_buf, _fmt.c_str(), _node->getStringValue().c_str());
1012 sprintf(_buf, _fmt.c_str(), _node->getFloatValue() * _mult);
1023 ////////////////////////////////////////////////////////////////////////
1024 // Implementation of FGSwitchLayer.
1025 ////////////////////////////////////////////////////////////////////////
1027 FGSwitchLayer::FGSwitchLayer (int w, int h, const SGPropertyNode * node,
1028 FGInstrumentLayer * layer1,
1029 FGInstrumentLayer * layer2)
1030 : FGInstrumentLayer(w, h), _node(node), _layer1(layer1), _layer2(layer2)
1034 FGSwitchLayer::~FGSwitchLayer ()
1041 FGSwitchLayer::draw ()
1045 if (_node->getBoolValue()) {