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);
357 glBindTexture(GL_TEXTURE_2D, _bg->getHandle());
358 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
359 // glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
360 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
362 glTexCoord2f(0.0, 0.0); glVertex3f(WIN_X, WIN_Y, 0);
363 glTexCoord2f(1.0, 0.0); glVertex3f(WIN_X + _width, WIN_Y, 0);
364 glTexCoord2f(1.0, 1.0); glVertex3f(WIN_X + _width, WIN_Y + _height, 0);
365 glTexCoord2f(0.0, 1.0); glVertex3f(WIN_X, WIN_Y + _height, 0);
368 // Draw the instruments.
369 instrument_list_type::const_iterator current = _instruments.begin();
370 instrument_list_type::const_iterator end = _instruments.end();
372 for ( ; current != end; current++) {
373 FGPanelInstrument * instr = *current;
375 glTranslated(x_offset, y_offset, 0);
376 glTranslated(instr->getXPos(), instr->getYPos(), 0);
380 glMatrixMode(GL_PROJECTION);
382 glMatrixMode(GL_MODELVIEW);
384 ssgForceBasicState();
385 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
390 * Set the panel's visibility.
393 FGPanel::setVisibility (bool visibility)
395 _visibility = visibility;
400 * Return true if the panel is visible.
403 FGPanel::getVisibility () const
410 * Set the panel's background texture.
413 FGPanel::setBackground (ssgTexture * texture)
420 * Set the panel's x-offset.
423 FGPanel::setXOffset (int offset)
425 if (offset <= 0 && offset >= -_width + WIN_W)
431 * Set the panel's y-offset.
434 FGPanel::setYOffset (int offset)
436 if (offset <= 0 && offset >= -_height)
442 * Perform a mouse action.
445 FGPanel::doMouseAction (int button, int updown, int x, int y)
447 // FIXME: this same code appears in update()
448 int xsize = _xsize_node->getIntValue();
449 int ysize = _ysize_node->getIntValue();
450 float aspect_adjust = get_aspect_adjust(xsize, ysize);
452 // Note a released button and return
453 // cerr << "Doing mouse action\n";
456 _mouseInstrument = 0;
460 // Scale for the real window size.
461 if (aspect_adjust < 1.0) {
462 x = int(((float)x / xsize) * WIN_W * aspect_adjust);
463 y = int(WIN_H - ((float(y) / ysize) * WIN_H));
465 x = int(((float)x / xsize) * WIN_W);
466 y = int((WIN_H - ((float(y) / ysize) * WIN_H)) / aspect_adjust);
469 // Adjust for offsets.
473 // Search for a matching instrument.
474 for (int i = 0; i < (int)_instruments.size(); i++) {
475 FGPanelInstrument *inst = _instruments[i];
476 int ix = inst->getXPos();
477 int iy = inst->getYPos();
478 int iw = inst->getWidth() / 2;
479 int ih = inst->getHeight() / 2;
480 if (x >= ix - iw && x < ix + iw && y >= iy - ih && y < iy + ih) {
483 _mouseInstrument = inst;
484 _mouseButton = button;
487 // Always do the action once.
488 _mouseInstrument->doMouseAction(_mouseButton, _mouseX, _mouseY);
497 ////////////////////////////////////////////////////////////////////////.
498 // Implementation of FGPanelAction.
499 ////////////////////////////////////////////////////////////////////////
501 FGPanelAction::FGPanelAction ()
505 FGPanelAction::FGPanelAction (int button, int x, int y, int w, int h)
506 : _button(button), _x(x), _y(y), _w(w), _h(h)
508 for (unsigned int i = 0; i < _bindings.size(); i++)
512 FGPanelAction::~FGPanelAction ()
517 FGPanelAction::addBinding (FGBinding * binding)
519 _bindings.push_back(binding);
523 FGPanelAction::doAction ()
526 int nBindings = _bindings.size();
527 for (int i = 0; i < nBindings; i++) {
528 _bindings[i]->fire();
535 ////////////////////////////////////////////////////////////////////////
536 // Implementation of FGPanelTransformation.
537 ////////////////////////////////////////////////////////////////////////
539 FGPanelTransformation::FGPanelTransformation ()
544 FGPanelTransformation::~FGPanelTransformation ()
551 ////////////////////////////////////////////////////////////////////////
552 // Implementation of FGPanelInstrument.
553 ////////////////////////////////////////////////////////////////////////
556 FGPanelInstrument::FGPanelInstrument ()
562 FGPanelInstrument::FGPanelInstrument (int x, int y, int w, int h)
568 FGPanelInstrument::~FGPanelInstrument ()
570 for (action_list_type::iterator it = _actions.begin();
571 it != _actions.end();
579 FGPanelInstrument::setPosition (int x, int y)
586 FGPanelInstrument::setSize (int w, int h)
593 FGPanelInstrument::getXPos () const
599 FGPanelInstrument::getYPos () const
605 FGPanelInstrument::getWidth () const
611 FGPanelInstrument::getHeight () const
617 FGPanelInstrument::addAction (FGPanelAction * action)
619 _actions.push_back(action);
622 // Coordinates relative to centre.
624 FGPanelInstrument::doMouseAction (int button, int x, int y)
627 action_list_type::iterator it = _actions.begin();
628 action_list_type::iterator last = _actions.end();
629 for ( ; it != last; it++) {
630 if ((*it)->inArea(button, x, y)) {
641 ////////////////////////////////////////////////////////////////////////
642 // Implementation of FGLayeredInstrument.
643 ////////////////////////////////////////////////////////////////////////
645 FGLayeredInstrument::FGLayeredInstrument (int x, int y, int w, int h)
646 : FGPanelInstrument(x, y, w, h)
650 FGLayeredInstrument::~FGLayeredInstrument ()
652 for (layer_list::iterator it = _layers.begin(); it != _layers.end(); it++) {
659 FGLayeredInstrument::draw ()
662 for (int i = 0; i < (int)_layers.size(); i++) {
664 glTranslatef(0.0, 0.0, (i / 100.0) + 0.1);
672 FGLayeredInstrument::addLayer (FGInstrumentLayer *layer)
674 int n = _layers.size();
675 if (layer->getWidth() == -1) {
676 layer->setWidth(getWidth());
678 if (layer->getHeight() == -1) {
679 layer->setHeight(getHeight());
681 _layers.push_back(layer);
686 FGLayeredInstrument::addLayer (FGCroppedTexture &texture,
689 return addLayer(new FGTexturedLayer(texture, w, h));
693 FGLayeredInstrument::addTransformation (FGPanelTransformation * transformation)
695 int layer = _layers.size() - 1;
696 _layers[layer]->addTransformation(transformation);
701 ////////////////////////////////////////////////////////////////////////
702 // Implementation of FGInstrumentLayer.
703 ////////////////////////////////////////////////////////////////////////
705 FGInstrumentLayer::FGInstrumentLayer (int w, int h)
711 FGInstrumentLayer::~FGInstrumentLayer ()
713 for (transformation_list::iterator it = _transformations.begin();
714 it != _transformations.end();
722 FGInstrumentLayer::transform () const
724 transformation_list::const_iterator it = _transformations.begin();
725 transformation_list::const_iterator last = _transformations.end();
727 FGPanelTransformation *t = *it;
729 float val = (t->node == 0 ? 0.0 : t->node->getFloatValue());
732 } else if (val > t->max) {
736 val = val * t->factor + t->offset;
738 val = t->table->interpolate(val) * t->factor + t->offset;
742 case FGPanelTransformation::XSHIFT:
743 glTranslatef(val, 0.0, 0.0);
745 case FGPanelTransformation::YSHIFT:
746 glTranslatef(0.0, val, 0.0);
748 case FGPanelTransformation::ROTATION:
749 glRotatef(-val, 0.0, 0.0, 1.0);
758 FGInstrumentLayer::addTransformation (FGPanelTransformation * transformation)
760 _transformations.push_back(transformation);
765 ////////////////////////////////////////////////////////////////////////
766 // Implementation of FGGroupLayer.
767 ////////////////////////////////////////////////////////////////////////
769 FGGroupLayer::FGGroupLayer ()
773 FGGroupLayer::~FGGroupLayer ()
775 for (unsigned int i = 0; i < _layers.size(); i++)
780 FGGroupLayer::draw ()
783 int nLayers = _layers.size();
784 for (int i = 0; i < nLayers; i++)
790 FGGroupLayer::addLayer (FGInstrumentLayer * layer)
792 _layers.push_back(layer);
797 ////////////////////////////////////////////////////////////////////////
798 // Implementation of FGTexturedLayer.
799 ////////////////////////////////////////////////////////////////////////
802 FGTexturedLayer::FGTexturedLayer (const FGCroppedTexture &texture, int w, int h)
803 : FGInstrumentLayer(w, h)
809 FGTexturedLayer::~FGTexturedLayer ()
815 FGTexturedLayer::draw ()
822 glBindTexture(GL_TEXTURE_2D, _texture.getTexture()->getHandle());
825 // From Curt: turn on the panel
826 // lights after sundown.
827 if ( cur_light_params.sun_angle * SGD_RADIANS_TO_DEGREES < 95.0 ) {
828 glColor4fv( cur_light_params.scene_diffuse );
830 glColor4f(0.7, 0.2, 0.2, 1.0);
834 glTexCoord2f(_texture.getMinX(), _texture.getMinY()); glVertex2f(-w2, -h2);
835 glTexCoord2f(_texture.getMaxX(), _texture.getMinY()); glVertex2f(w2, -h2);
836 glTexCoord2f(_texture.getMaxX(), _texture.getMaxY()); glVertex2f(w2, h2);
837 glTexCoord2f(_texture.getMinX(), _texture.getMaxY()); glVertex2f(-w2, h2);
844 ////////////////////////////////////////////////////////////////////////
845 // Implementation of FGTextLayer.
846 ////////////////////////////////////////////////////////////////////////
848 FGTextLayer::FGTextLayer (int w, int h)
849 : FGInstrumentLayer(w, h), _pointSize(14.0), _font_name("default")
852 _color[0] = _color[1] = _color[2] = 0.0;
856 FGTextLayer::~FGTextLayer ()
858 chunk_list::iterator it = _chunks.begin();
859 chunk_list::iterator last = _chunks.end();
860 for ( ; it != last; it++) {
872 if ( _font_name == "led" ) {
873 text_renderer.setFont(led_font);
875 text_renderer.setFont(guiFntHandle);
877 text_renderer.setPointSize(_pointSize);
878 text_renderer.begin();
879 text_renderer.start3f(0, 0, 0);
882 if (_now - _then > 100000) {
886 text_renderer.puts((char *)(_value.c_str()));
889 glColor4f(1.0, 1.0, 1.0, 1.0); // FIXME
895 FGTextLayer::addChunk (FGTextLayer::Chunk * chunk)
897 _chunks.push_back(chunk);
901 FGTextLayer::setColor (float r, float g, float b)
910 FGTextLayer::setPointSize (float size)
916 FGTextLayer::setFontName(const string &name)
923 FGTextLayer::setFont(fntFont * font)
925 text_renderer.setFont(font);
930 FGTextLayer::recalc_value () const
933 chunk_list::const_iterator it = _chunks.begin();
934 chunk_list::const_iterator last = _chunks.end();
935 for ( ; it != last; it++) {
936 _value += (*it)->getValue();
942 ////////////////////////////////////////////////////////////////////////
943 // Implementation of FGTextLayer::Chunk.
944 ////////////////////////////////////////////////////////////////////////
946 FGTextLayer::Chunk::Chunk (const string &text, const string &fmt)
947 : _type(FGTextLayer::TEXT), _fmt(fmt)
954 FGTextLayer::Chunk::Chunk (ChunkType type, const SGPropertyNode * node,
955 const string &fmt, float mult)
956 : _type(type), _fmt(fmt), _mult(mult)
959 if (type == TEXT_VALUE)
968 FGTextLayer::Chunk::getValue () const
973 sprintf(_buf, _fmt.c_str(), _text.c_str());
976 sprintf(_buf, _fmt.c_str(), _node->getStringValue().c_str());
979 sprintf(_buf, _fmt.c_str(), _node->getFloatValue() * _mult);
990 ////////////////////////////////////////////////////////////////////////
991 // Implementation of FGSwitchLayer.
992 ////////////////////////////////////////////////////////////////////////
994 FGSwitchLayer::FGSwitchLayer (int w, int h, const SGPropertyNode * node,
995 FGInstrumentLayer * layer1,
996 FGInstrumentLayer * layer2)
997 : FGInstrumentLayer(w, h), _node(node), _layer1(layer1), _layer2(layer2)
1001 FGSwitchLayer::~FGSwitchLayer ()
1008 FGSwitchLayer::draw ()
1012 if (_node->getBoolValue()) {