src/Cockpit/panel_io.cxx

   1 //  panel_io.cxx - I/O for 2D panel.
   2 //
   3 //  Written by David Megginson, started January 2000.
   4 //
   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.
   9 //
  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.
  14 //
  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 //
  19 //  $Id$
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #ifdef HAVE_WINDOWS_H
  26 #  include <windows.h>
  27 #endif
  28
  29 #include <string.h>             // for strcmp()
  30
  31 #include <simgear/compiler.h>
  32 #include <simgear/structure/exception.hxx>
  33 #include <simgear/debug/logstream.hxx>
  34 #include <simgear/misc/sg_path.hxx>
  35 #include <simgear/props/props.hxx>
  36
  37 #include STL_IOSTREAM
  38 #include STL_FSTREAM
  39 #include STL_STRING
  40
  41 #include <Main/globals.hxx>
  42 #include <Main/fg_props.hxx>
  43
  44 #include <GUI/gui.h>
  45
  46 // #include "panel.hxx"
  47 #include "panel_io.hxx"
  48 #include <Instrumentation/KLN89/kln89.hxx>
  49
  50 //built-in layers
  51 #include "built_in/FGMagRibbon.hxx"
  52
  53 SG_USING_STD(istream);
  54 SG_USING_STD(ifstream);
  55 SG_USING_STD(string);
  56
  57
  58 \f
  59 ////////////////////////////////////////////////////////////////////////
  60 // Read and construct a panel.
  61 //
  62 // The panel is specified as a regular property list, and each of the
  63 // instruments is its own, separate property list (and thus, a separate
  64 // XML document).  The functions in this section read in the files
  65 // as property lists, then extract properties to set up the panel
  66 // itself.
  67 //
  68 // A panel contains zero or more instruments.
  69 //
  70 // An instrument contains one or more layers and zero or more actions.
  71 //
  72 // A layer contains zero or more transformations.
  73 //
  74 // Some special types of layers also contain other objects, such as
  75 // chunks of text or other layers.
  76 //
  77 // There are currently four types of layers:
  78 //
  79 // 1. Textured Layer (type="texture"), the default
  80 // 2. Text Layer (type="text")
  81 // 3. Switch Layer (type="switch")
  82 // 4. Built-in Layer (type="built-in", must also specify class)
  83 //
  84 // The only built-in layer so far is the ribbon for the magnetic compass
  85 // (class="compass-ribbon").
  86 //
  87 // There are three types of actions:
  88 //
  89 // 1. Adjust (type="adjust"), the default
  90 // 2. Swap (type="swap")
  91 // 3. Toggle (type="toggle")
  92 //
  93 // There are three types of transformations:
  94 //
  95 // 1. X shift (type="x-shift"), the default
  96 // 2. Y shift (type="y-shift")
  97 // 3. Rotation (type="rotation")
  98 //
  99 // Each of these may be associated with a property, so that a needle
 100 // will rotate with the airspeed, for example, or may have a fixed
 101 // floating-point value.
 102 ////////////////////////////////////////////////////////////////////////
 103
 104
 105 /**
 106  * Read a cropped texture from the instrument's property list.
 107  *
 108  * The x1 and y1 properties give the starting position of the texture
 109  * (between 0.0 and 1.0), and the the x2 and y2 properties give the
 110  * ending position.  For example, to use the bottom-left quarter of a
 111  * texture, x1=0.0, y1=0.0, x2=0.5, y2=0.5.
 112  */
 113 static FGCroppedTexture
 114 readTexture (const SGPropertyNode * node)
 115 {
 116     FGCroppedTexture texture(node->getStringValue("path"),
 117                              node->getFloatValue("x1"),
 118                              node->getFloatValue("y1"),
 119                              node->getFloatValue("x2", 1.0),
 120                              node->getFloatValue("y2", 1.0));
 121     SG_LOG(SG_COCKPIT, SG_DEBUG, "Read texture " << node->getName());
 122     return texture;
 123 }
 124
 125
 126 /**
 127  * Test for a condition in the current node.
 128  */
 129 \f
 130 ////////////////////////////////////////////////////////////////////////
 131 // Read a condition and use it if necessary.
 132 ////////////////////////////////////////////////////////////////////////
 133
 134 static void
 135 readConditions (SGConditional *component, const SGPropertyNode *node)
 136 {
 137   const SGPropertyNode * conditionNode = node->getChild("condition");
 138   if (conditionNode != 0)
 139                                 // The top level is implicitly AND
 140     component->setCondition(sgReadCondition(globals->get_props(),
 141                                             conditionNode) );
 142 }
 143
 144
 145 /**
 146  * Read an action from the instrument's property list.
 147  *
 148  * The action will be performed when the user clicks a mouse button
 149  * within the specified region of the instrument.  Actions always work
 150  * by modifying the value of a property (see the SGPropertyNode
 151  * class).
 152  *
 153  * The following action types are defined:
 154  *
 155  * "adjust" - modify the value of a floating-point property by
 156  *    the increment specified.  This is the default.
 157  *
 158  * "swap" - swap the values of two-floating-point properties.
 159  *
 160  * "toggle" - toggle the value of a boolean property between true and
 161  *    false.
 162  *
 163  * For the adjust action, it is possible to specify an increment
 164  * (use a negative number for a decrement), a minimum allowed value,
 165  * a maximum allowed value, and a flag to indicate whether the value
 166  * should freeze or wrap-around when it reachs the minimum or maximum.
 167  *
 168  * The action will be scaled automatically if the instrument is not
 169  * being drawn at its regular size.
 170  */
 171 static FGPanelAction *
 172 readAction (const SGPropertyNode * node, float w_scale, float h_scale)
 173 {
 174   unsigned int i, j;
 175   SGPropertyNode *binding;
 176   vector<SGPropertyNode_ptr>bindings = node->getChildren("binding");
 177
 178   // button-less actions are fired initially
 179   if (!node->hasValue("w") || !node->hasValue("h")) {
 180     for (i = 0; i < bindings.size(); i++) {
 181       FGBinding b(bindings[i]);
 182       b.fire();
 183     }
 184     return 0;
 185   }
 186
 187   string name = node->getStringValue("name");
 188
 189   int button = node->getIntValue("button");
 190   int x = int(node->getIntValue("x") * w_scale);
 191   int y = int(node->getIntValue("y") * h_scale);
 192   int w = int(node->getIntValue("w") * w_scale);
 193   int h = int(node->getIntValue("h") * h_scale);
 194   bool repeatable = node->getBoolValue("repeatable", true);
 195
 196   FGPanelAction * action = new FGPanelAction(button, x, y, w, h, repeatable);
 197
 198   SGPropertyNode * dest = fgGetNode("/sim/bindings/panel", true);
 199
 200   for (i = 0; i < bindings.size(); i++) {
 201     SG_LOG(SG_INPUT, SG_INFO, "Reading binding "
 202       << bindings[i]->getStringValue("command"));
 203
 204     j = 0;
 205     while (dest->getChild("binding", j))
 206       j++;
 207
 208     binding = dest->getChild("binding", j, true);
 209     copyProperties(bindings[i], binding);
 210     action->addBinding(new FGBinding(binding), 0);
 211   }
 212
 213   if (node->hasChild("mod-up")) {
 214     bindings = node->getChild("mod-up")->getChildren("binding");
 215     for (i = 0; i < bindings.size(); i++) {
 216       j = 0;
 217       while (dest->getChild("binding", j))
 218         j++;
 219
 220       binding = dest->getChild("binding", j, true);
 221       copyProperties(bindings[i], binding);
 222       action->addBinding(new FGBinding(binding), 1);
 223     }
 224   }
 225
 226   readConditions(action, node);
 227   return action;
 228 }
 229
 230
 231 /**
 232  * Read a transformation from the instrument's property list.
 233  *
 234  * The panel module uses the transformations to slide or spin needles,
 235  * knobs, and other indicators, and to place layers in the correct
 236  * positions.  Every layer starts centered exactly on the x,y co-ordinate,
 237  * and many layers need to be moved or rotated simply to display the
 238  * instrument correctly.
 239  *
 240  * There are three types of transformations:
 241  *
 242  * "x-shift" - move the layer horizontally.
 243  *
 244  * "y-shift" - move the layer vertically.
 245  *
 246  * "rotation" - rotate the layer.
 247  *
 248  * Each transformation may have a fixed offset, and may also have
 249  * a floating-point property value to add to the offset.  The
 250  * floating-point property may be clamped to a minimum and/or
 251  * maximum range and scaled (after clamping).
 252  *
 253  * Note that because of the way OpenGL works, transformations will
 254  * appear to be applied backwards.
 255  */
 256 static FGPanelTransformation *
 257 readTransformation (const SGPropertyNode * node, float w_scale, float h_scale)
 258 {
 259   FGPanelTransformation * t = new FGPanelTransformation;
 260
 261   string name = node->getName();
 262   string type = node->getStringValue("type");
 263   string propName = node->getStringValue("property", "");
 264   SGPropertyNode * target = 0;
 265
 266   if (type.empty()) {
 267     SG_LOG( SG_COCKPIT, SG_INFO,
 268             "No type supplied for transformation " << name
 269             << " assuming \"rotation\"" );
 270     type = "rotation";
 271   }
 272
 273   if (!propName.empty()) {
 274     target = fgGetNode(propName.c_str(), true);
 275   }
 276
 277   t->node = target;
 278   t->min = node->getFloatValue("min", -9999999);
 279   t->max = node->getFloatValue("max", 99999999);
 280   t->has_mod = node->hasChild("modulator");
 281   if (t->has_mod)
 282       t->mod = node->getFloatValue("modulator");
 283   t->factor = node->getFloatValue("scale", 1.0);
 284   t->offset = node->getFloatValue("offset", 0.0);
 285
 286                                 // Check for an interpolation table
 287   const SGPropertyNode * trans_table = node->getNode("interpolation");
 288   if (trans_table != 0) {
 289     SG_LOG( SG_COCKPIT, SG_INFO, "Found interpolation table with "
 290             << trans_table->nChildren() << "children" );
 291     t->table = new SGInterpTable();
 292     for(int i = 0; i < trans_table->nChildren(); i++) {
 293       const SGPropertyNode * node = trans_table->getChild(i);
 294       if (!strcmp(node->getName(), "entry")) {
 295         double ind = node->getDoubleValue("ind", 0.0);
 296         double dep = node->getDoubleValue("dep", 0.0);
 297         SG_LOG( SG_COCKPIT, SG_INFO, "Adding interpolation entry "
 298                 << ind << "==>" << dep );
 299         t->table->addEntry(ind, dep);
 300       } else {
 301         SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
 302                 << " in interpolation" );
 303       }
 304     }
 305   } else {
 306     t->table = 0;
 307   }
 308
 309                                 // Move the layer horizontally.
 310   if (type == "x-shift") {
 311     t->type = FGPanelTransformation::XSHIFT;
 312 //     t->min *= w_scale; //removed by Martin Dressler
 313 //     t->max *= w_scale; //removed by Martin Dressler
 314     t->offset *= w_scale;
 315     t->factor *= w_scale; //Added by Martin Dressler
 316   }
 317
 318                                 // Move the layer vertically.
 319   else if (type == "y-shift") {
 320     t->type = FGPanelTransformation::YSHIFT;
 321     //t->min *= h_scale; //removed
 322     //t->max *= h_scale; //removed
 323     t->offset *= h_scale;
 324     t->factor *= h_scale; //Added
 325   }
 326
 327                                 // Rotate the layer.  The rotation
 328                                 // is in degrees, and does not need
 329                                 // to scale with the instrument size.
 330   else if (type == "rotation") {
 331     t->type = FGPanelTransformation::ROTATION;
 332   }
 333
 334   else {
 335     SG_LOG( SG_COCKPIT, SG_ALERT, "Unrecognized transformation type " << type );
 336     delete t;
 337     return 0;
 338   }
 339
 340   readConditions(t, node);
 341   SG_LOG( SG_COCKPIT, SG_DEBUG, "Read transformation " << name );
 342   return t;
 343 }
 344
 345
 346 /**
 347  * Read a chunk of text from the instrument's property list.
 348  *
 349  * A text layer consists of one or more chunks of text.  All chunks
 350  * share the same font size and color (and eventually, font), but
 351  * each can come from a different source.  There are three types of
 352  * text chunks:
 353  *
 354  * "literal" - a literal text string (the default)
 355  *
 356  * "text-value" - the current value of a string property
 357  *
 358  * "number-value" - the current value of a floating-point property.
 359  *
 360  * All three may also include a printf-style format string.
 361  */
 362 FGTextLayer::Chunk *
 363 readTextChunk (const SGPropertyNode * node)
 364 {
 365   FGTextLayer::Chunk * chunk;
 366   string name = node->getStringValue("name");
 367   string type = node->getStringValue("type");
 368   string format = node->getStringValue("format");
 369
 370                                 // Default to literal text.
 371   if (type.empty()) {
 372     SG_LOG( SG_COCKPIT, SG_INFO, "No type provided for text chunk " << name
 373             << " assuming \"literal\"");
 374     type = "literal";
 375   }
 376
 377                                 // A literal text string.
 378   if (type == "literal") {
 379     string text = node->getStringValue("text");
 380     chunk = new FGTextLayer::Chunk(text, format);
 381   }
 382
 383                                 // The value of a string property.
 384   else if (type == "text-value") {
 385     SGPropertyNode * target =
 386       fgGetNode(node->getStringValue("property"), true);
 387     chunk = new FGTextLayer::Chunk(FGTextLayer::TEXT_VALUE, target, format);
 388   }
 389
 390                                 // The value of a float property.
 391   else if (type == "number-value") {
 392     string propName = node->getStringValue("property");
 393     float scale = node->getFloatValue("scale", 1.0);
 394     float offset = node->getFloatValue("offset", 0.0);
 395     bool truncation = node->getBoolValue("truncate", false);
 396     SGPropertyNode * target = fgGetNode(propName.c_str(), true);
 397     chunk = new FGTextLayer::Chunk(FGTextLayer::DOUBLE_VALUE, target,
 398                                    format, scale, offset, truncation);
 399   }
 400
 401                                 // Unknown type.
 402   else {
 403     SG_LOG( SG_COCKPIT, SG_ALERT, "Unrecognized type " << type
 404             << " for text chunk " << name );
 405     return 0;
 406   }
 407
 408   readConditions(chunk, node);
 409   return chunk;
 410 }
 411
 412
 413 /**
 414  * Read a single layer from an instrument's property list.
 415  *
 416  * Each instrument consists of one or more layers stacked on top
 417  * of each other; the lower layers show through only where the upper
 418  * layers contain an alpha component.  Each layer can be moved
 419  * horizontally and vertically and rotated using transformations.
 420  *
 421  * This module currently recognizes four kinds of layers:
 422  *
 423  * "texture" - a layer containing a texture (the default)
 424  *
 425  * "text" - a layer containing text
 426  *
 427  * "switch" - a layer that switches between two other layers
 428  *   based on the current value of a boolean property.
 429  *
 430  * "built-in" - a hard-coded layer supported by C++ code in FlightGear.
 431  *
 432  * Currently, the only built-in layer class is "compass-ribbon".
 433  */
 434 static FGInstrumentLayer *
 435 readLayer (const SGPropertyNode * node, float w_scale, float h_scale)
 436 {
 437   FGInstrumentLayer * layer = NULL;
 438   string name = node->getStringValue("name");
 439   string type = node->getStringValue("type");
 440   int w = node->getIntValue("w", -1);
 441   int h = node->getIntValue("h", -1);
 442   bool emissive = node->getBoolValue("emissive", false);
 443   if (w != -1)
 444     w = int(w * w_scale);
 445   if (h != -1)
 446     h = int(h * h_scale);
 447
 448
 449   if (type.empty()) {
 450     SG_LOG( SG_COCKPIT, SG_INFO,
 451             "No type supplied for layer " << name
 452             << " assuming \"texture\"" );
 453     type = "texture";
 454   }
 455
 456
 457                                 // A textured instrument layer.
 458   if (type == "texture") {
 459     FGCroppedTexture texture = readTexture(node->getNode("texture"));
 460     layer = new FGTexturedLayer(texture, w, h);
 461     if (emissive) {
 462       FGTexturedLayer *tl=(FGTexturedLayer*)layer;
 463       tl->setEmissive(true);
 464     }
 465
 466   }
 467
 468                                 // A group of sublayers.
 469   else if (type == "group") {
 470     layer = new FGGroupLayer();
 471     for (int i = 0; i < node->nChildren(); i++) {
 472       const SGPropertyNode * child = node->getChild(i);
 473       if (!strcmp(child->getName(), "layer"))
 474         ((FGGroupLayer *)layer)->addLayer(readLayer(child, w_scale, h_scale));
 475     }
 476   }
 477
 478
 479                                 // A textual instrument layer.
 480   else if (type == "text") {
 481     FGTextLayer * tlayer = new FGTextLayer(w, h); // FIXME
 482
 483                                 // Set the text color.
 484     float red = node->getFloatValue("color/red", 0.0);
 485     float green = node->getFloatValue("color/green", 0.0);
 486     float blue = node->getFloatValue("color/blue", 0.0);
 487     tlayer->setColor(red, green, blue);
 488
 489                                 // Set the point size.
 490     float pointSize = node->getFloatValue("point-size", 10.0) * w_scale;
 491     tlayer->setPointSize(pointSize);
 492
 493                                 // Set the font.
 494     string fontName = node->getStringValue("font", "default");
 495     tlayer->setFontName(fontName);
 496
 497     const SGPropertyNode * chunk_group = node->getNode("chunks");
 498     if (chunk_group != 0) {
 499       int nChunks = chunk_group->nChildren();
 500       for (int i = 0; i < nChunks; i++) {
 501         const SGPropertyNode * node = chunk_group->getChild(i);
 502         if (!strcmp(node->getName(), "chunk")) {
 503           FGTextLayer::Chunk * chunk = readTextChunk(node);
 504           if (chunk != 0)
 505             tlayer->addChunk(chunk);
 506         } else {
 507           SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
 508                   << " in chunks" );
 509         }
 510       }
 511       layer = tlayer;
 512     }
 513   }
 514
 515                                 // A switch instrument layer.
 516   else if (type == "switch") {
 517     layer = new FGSwitchLayer();
 518     for (int i = 0; i < node->nChildren(); i++) {
 519       const SGPropertyNode * child = node->getChild(i);
 520       if (!strcmp(child->getName(), "layer"))
 521         ((FGGroupLayer *)layer)->addLayer(readLayer(child, w_scale, h_scale));
 522     }
 523   }
 524
 525                                 // A built-in instrument layer.
 526   else if (type == "built-in") {
 527     string layerclass = node->getStringValue("class");
 528
 529     if (layerclass == "mag-ribbon") {
 530       layer = new FGMagRibbon(w, h);
 531     }
 532
 533     else if (layerclass.empty()) {
 534       SG_LOG( SG_COCKPIT, SG_ALERT, "No class provided for built-in layer "
 535               << name );
 536       return 0;
 537     }
 538
 539     else {
 540       SG_LOG( SG_COCKPIT, SG_ALERT, "Unknown built-in layer class "
 541               << layerclass);
 542       return 0;
 543     }
 544   }
 545
 546                                 // An unknown type.
 547   else {
 548     SG_LOG( SG_COCKPIT, SG_ALERT, "Unrecognized layer type " << type );
 549     delete layer;
 550     return 0;
 551   }
 552
 553   //
 554   // Get the transformations for each layer.
 555   //
 556   const SGPropertyNode * trans_group = node->getNode("transformations");
 557   if (trans_group != 0) {
 558     int nTransformations = trans_group->nChildren();
 559     for (int i = 0; i < nTransformations; i++) {
 560       const SGPropertyNode * node = trans_group->getChild(i);
 561       if (!strcmp(node->getName(), "transformation")) {
 562         FGPanelTransformation * t = readTransformation(node, w_scale, h_scale);
 563         if (t != 0)
 564           layer->addTransformation(t);
 565       } else {
 566         SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
 567                 << " in transformations" );
 568       }
 569     }
 570   }
 571
 572   readConditions(layer, node);
 573   SG_LOG( SG_COCKPIT, SG_DEBUG, "Read layer " << name );
 574   return layer;
 575 }
 576
 577
 578 /**
 579  * Read an instrument from a property list.
 580  *
 581  * The instrument consists of a preferred width and height
 582  * (the panel may override these), together with a list of layers
 583  * and a list of actions to be performed when the user clicks
 584  * the mouse over the instrument.  All co-ordinates are relative
 585  * to the instrument's position, so instruments are fully relocatable;
 586  * likewise, co-ordinates for actions and transformations will be
 587  * scaled automatically if the instrument is not at its preferred size.
 588  */
 589 static FGPanelInstrument *
 590 readInstrument (const SGPropertyNode * node)
 591 {
 592   const string name = node->getStringValue("name");
 593   int x = node->getIntValue("x", -1);
 594   int y = node->getIntValue("y", -1);
 595   int real_w = node->getIntValue("w", -1);
 596   int real_h = node->getIntValue("h", -1);
 597   int w = node->getIntValue("w-base", -1);
 598   int h = node->getIntValue("h-base", -1);
 599
 600   if (x == -1 || y == -1) {
 601     SG_LOG( SG_COCKPIT, SG_ALERT,
 602             "x and y positions must be specified and > 0" );
 603     return 0;
 604   }
 605
 606   float w_scale = 1.0;
 607   float h_scale = 1.0;
 608   if (real_w != -1) {
 609     w_scale = float(real_w) / float(w);
 610     w = real_w;
 611   }
 612   if (real_h != -1) {
 613     h_scale = float(real_h) / float(h);
 614     h = real_h;
 615   }
 616
 617   SG_LOG( SG_COCKPIT, SG_DEBUG, "Reading instrument " << name );
 618
 619   FGLayeredInstrument * instrument =
 620     new FGLayeredInstrument(x, y, w, h);
 621
 622   //
 623   // Get the actions for the instrument.
 624   //
 625   const SGPropertyNode * action_group = node->getNode("actions");
 626   if (action_group != 0) {
 627     int nActions = action_group->nChildren();
 628     for (int i = 0; i < nActions; i++) {
 629       const SGPropertyNode * node = action_group->getChild(i);
 630       if (!strcmp(node->getName(), "action")) {
 631         FGPanelAction * action = readAction(node, w_scale, h_scale);
 632         if (action != 0)
 633           instrument->addAction(action);
 634       } else {
 635         SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
 636                 << " in actions" );
 637       }
 638     }
 639   }
 640
 641   //
 642   // Get the layers for the instrument.
 643   //
 644   const SGPropertyNode * layer_group = node->getNode("layers");
 645   if (layer_group != 0) {
 646     int nLayers = layer_group->nChildren();
 647     for (int i = 0; i < nLayers; i++) {
 648       const SGPropertyNode * node = layer_group->getChild(i);
 649       if (!strcmp(node->getName(), "layer")) {
 650         FGInstrumentLayer * layer = readLayer(node, w_scale, h_scale);
 651         if (layer != 0)
 652           instrument->addLayer(layer);
 653       } else {
 654         SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
 655                 << " in layers" );
 656       }
 657     }
 658   }
 659
 660   readConditions(instrument, node);
 661   SG_LOG( SG_COCKPIT, SG_DEBUG, "Done reading instrument " << name );
 662   return instrument;
 663 }
 664
 665
 666 /**
 667  * Construct the panel from a property tree.
 668  */
 669 FGPanel *
 670 readPanel (const SGPropertyNode * root)
 671 {
 672   SG_LOG( SG_COCKPIT, SG_INFO, "Reading properties for panel " <<
 673           root->getStringValue("name", "[Unnamed Panel]") );
 674
 675   FGPanel * panel = new FGPanel();
 676   panel->setWidth(root->getIntValue("w", 1024));
 677   panel->setHeight(root->getIntValue("h", 443));
 678
 679   //
 680   // Grab the visible external viewing area, default to
 681   //
 682   panel->setViewHeight(root->getIntValue("view-height",
 683                                          768 - panel->getHeight() + 2));
 684
 685   //
 686   // Grab the panel's initial offsets, default to 0, 0.
 687   //
 688   if (!fgHasNode("/sim/panel/x-offset"))
 689     fgSetInt("/sim/panel/x-offset", root->getIntValue("x-offset", 0));
 690
 691   // conditional removed by jim wilson to allow panel xml code
 692   // with y-offset defined to work...
 693   if (!fgHasNode("/sim/panel/y-offset"))
 694     fgSetInt("/sim/panel/y-offset", root->getIntValue("y-offset", 0));
 695
 696   //
 697   // Assign the background texture, if any, or a bogus chequerboard.
 698   //
 699   string bgTexture = root->getStringValue("background");
 700   if (bgTexture.empty())
 701     bgTexture = "FOO";
 702   panel->setBackground(FGTextureManager::createTexture(bgTexture.c_str()));
 703   SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << bgTexture );
 704
 705   //
 706   // Get multibackground if any...
 707   //
 708   string mbgTexture = root->getStringValue("multibackground[0]");
 709   if (!mbgTexture.empty()) {
 710     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 0);
 711     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 712
 713     mbgTexture = root->getStringValue("multibackground[1]");
 714     if (mbgTexture.empty())
 715       mbgTexture = "FOO";
 716     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 1);
 717     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 718
 719     mbgTexture = root->getStringValue("multibackground[2]");
 720     if (mbgTexture.empty())
 721       mbgTexture = "FOO";
 722     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 2);
 723     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 724
 725     mbgTexture = root->getStringValue("multibackground[3]");
 726     if (mbgTexture.empty())
 727       mbgTexture = "FOO";
 728     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 3);
 729     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 730
 731     mbgTexture = root->getStringValue("multibackground[4]");
 732     if (mbgTexture.empty())
 733       mbgTexture = "FOO";
 734     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 4);
 735     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 736
 737     mbgTexture = root->getStringValue("multibackground[5]");
 738     if (mbgTexture.empty())
 739       mbgTexture = "FOO";
 740     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 5);
 741     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 742
 743     mbgTexture = root->getStringValue("multibackground[6]");
 744     if (mbgTexture.empty())
 745       mbgTexture = "FOO";
 746     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 6);
 747     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 748
 749     mbgTexture = root->getStringValue("multibackground[7]");
 750     if (mbgTexture.empty())
 751       mbgTexture = "FOO";
 752     panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 7);
 753     SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
 754
 755   }
 756
 757
 758
 759   //
 760   // Create each instrument.
 761   //
 762   SG_LOG( SG_COCKPIT, SG_INFO, "Reading panel instruments" );
 763   const SGPropertyNode * instrument_group = root->getChild("instruments");
 764   if (instrument_group != 0) {
 765     int nInstruments = instrument_group->nChildren();
 766     for (int i = 0; i < nInstruments; i++) {
 767       const SGPropertyNode * node = instrument_group->getChild(i);
 768       if (!strcmp(node->getName(), "instrument")) {
 769         FGPanelInstrument * instrument = readInstrument(node);
 770         if (instrument != 0)
 771           panel->addInstrument(instrument);
 772       } else if(!strcmp(node->getName(), "special-instrument")) {
 773         //cout << "Special instrument found in instruments section!\n";
 774         const string name = node->getStringValue("name");
 775         if(name == "KLN89 GPS") {
 776           //cout << "Special instrument is KLN89\n";
 777
 778           int x = node->getIntValue("x", -1);
 779           int y = node->getIntValue("y", -1);
 780           int real_w = node->getIntValue("w", -1);
 781           int real_h = node->getIntValue("h", -1);
 782           int w = node->getIntValue("w-base", -1);
 783           int h = node->getIntValue("h-base", -1);
 784
 785           if (x == -1 || y == -1) {
 786             SG_LOG( SG_COCKPIT, SG_ALERT,
 787             "x and y positions must be specified and > 0" );
 788             return 0;
 789           }
 790
 791           float w_scale = 1.0;
 792           float h_scale = 1.0;
 793           if (real_w != -1) {
 794             w_scale = float(real_w) / float(w);
 795             w = real_w;
 796           }
 797           if (real_h != -1) {
 798             h_scale = float(real_h) / float(h);
 799             h = real_h;
 800           }
 801
 802           SG_LOG( SG_COCKPIT, SG_DEBUG, "Reading instrument " << name );
 803
 804           // Warning - hardwired size!!!
 805           RenderArea2D* instrument = new RenderArea2D(158, 40, 158, 40, x, y);
 806           KLN89* gps = (KLN89*)globals->get_subsystem("kln89");
 807                   if(gps == NULL) {
 808                           gps = new KLN89(instrument);
 809                           globals->add_subsystem("kln89", gps);
 810                   }
 811                   //gps->init();  // init seems to get called automagically.
 812                   FGSpecialInstrument* gpsinst = new FGSpecialInstrument(gps);
 813           panel->addInstrument(gpsinst);
 814         } else {
 815           SG_LOG( SG_COCKPIT, SG_WARN, "Unknown special instrument found" );
 816         }
 817       } else {
 818         SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
 819         << " in instruments section" );
 820       }
 821     }
 822   }
 823   SG_LOG( SG_COCKPIT, SG_INFO, "Done reading panel instruments" );
 824
 825
 826   //
 827   // Return the new panel.
 828   //
 829   return panel;
 830 }
 831
 832
 833 /**
 834  * Read a panel from a property list.
 835  *
 836  * Each panel instrument will appear in its own, separate
 837  * property list.  The top level simply names the panel and
 838  * places the instruments in their appropriate locations (and
 839  * optionally resizes them if necessary).
 840  *
 841  * Returns 0 if the read fails for any reason.
 842  */
 843 FGPanel *
 844 fgReadPanel (istream &input)
 845 {
 846   SGPropertyNode root;
 847
 848   try {
 849     readProperties(input, &root);
 850   } catch (const sg_exception &e) {
 851     guiErrorMessage("Error reading panel: ", e);
 852     return 0;
 853   }
 854   return readPanel(&root);
 855 }
 856
 857
 858 /**
 859  * Read a panel from a property list.
 860  *
 861  * This function opens a stream to a file, then invokes the
 862  * main fgReadPanel() function.
 863  */
 864 FGPanel *
 865 fgReadPanel (const string &relative_path)
 866 {
 867   SGPath path(globals->get_fg_root());
 868   path.append(relative_path);
 869   SGPropertyNode root;
 870
 871   try {
 872     readProperties(path.str(), &root);
 873   } catch (const sg_exception &e) {
 874     guiErrorMessage("Error reading panel: ", e);
 875     return 0;
 876   }
 877   return readPanel(&root);
 878 }
 879
 880
 881
 882 // end of panel_io.cxx
 883
 884
 885