1 // panel_io.cxx - I/O for 2D 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 <string.h> // for strcmp()
31 #include <simgear/compiler.h>
32 #include <simgear/misc/exception.hxx>
34 #include <simgear/misc/sg_path.hxx>
35 #include <simgear/debug/logstream.hxx>
36 #include <simgear/misc/props.hxx>
42 #include <Main/globals.hxx>
43 #include <Main/fg_props.hxx>
48 #include "panel_io.hxx"
51 #include "built_in/FGMagRibbon.hxx"
53 SG_USING_STD(istream);
54 SG_USING_STD(ifstream);
59 ////////////////////////////////////////////////////////////////////////
60 // Read and construct a panel.
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
68 // A panel contains zero or more instruments.
70 // An instrument contains one or more layers and zero or more actions.
72 // A layer contains zero or more transformations.
74 // Some special types of layers also contain other objects, such as
75 // chunks of text or other layers.
77 // There are currently four types of layers:
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)
84 // The only built-in layer so far is the ribbon for the magnetic compass
85 // (class="compass-ribbon").
87 // There are three types of actions:
89 // 1. Adjust (type="adjust"), the default
90 // 2. Swap (type="swap")
91 // 3. Toggle (type="toggle")
93 // There are three types of transformations:
95 // 1. X shift (type="x-shift"), the default
96 // 2. Y shift (type="y-shift")
97 // 3. Rotation (type="rotation")
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 ////////////////////////////////////////////////////////////////////////
106 * Read a cropped texture from the instrument's property list.
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.
113 static FGCroppedTexture
114 readTexture (const SGPropertyNode * node)
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());
127 * Test for a condition in the current node.
130 ////////////////////////////////////////////////////////////////////////
131 // Read a condition and use it if necessary.
132 ////////////////////////////////////////////////////////////////////////
135 readConditions (FGConditional * component, const SGPropertyNode * node)
137 const SGPropertyNode * conditionNode = node->getChild("condition");
138 if (conditionNode != 0)
139 // The top level is implicitly AND
140 component->setCondition(fgReadCondition(conditionNode));
145 * Read an action from the instrument's property list.
147 * The action will be performed when the user clicks a mouse button
148 * within the specified region of the instrument. Actions always work
149 * by modifying the value of a property (see the SGPropertyNode
152 * The following action types are defined:
154 * "adjust" - modify the value of a floating-point property by
155 * the increment specified. This is the default.
157 * "swap" - swap the values of two-floating-point properties.
159 * "toggle" - toggle the value of a boolean property between true and
162 * For the adjust action, it is possible to specify an increment
163 * (use a negative number for a decrement), a minimum allowed value,
164 * a maximum allowed value, and a flag to indicate whether the value
165 * should freeze or wrap-around when it reachs the minimum or maximum.
167 * The action will be scaled automatically if the instrument is not
168 * being drawn at its regular size.
170 static FGPanelAction *
171 readAction (const SGPropertyNode * node, float w_scale, float h_scale)
173 string name = node->getStringValue("name");
175 int button = node->getIntValue("button");
176 int x = int(node->getIntValue("x") * w_scale);
177 int y = int(node->getIntValue("y") * h_scale);
178 int w = int(node->getIntValue("w") * w_scale);
179 int h = int(node->getIntValue("h") * h_scale);
180 bool repeatable = node->getBoolValue("repeatable", true);
182 FGPanelAction * action = new FGPanelAction(button, x, y, w, h, repeatable);
184 vector<SGPropertyNode_ptr>bindings = node->getChildren("binding");
187 for (i = 0; i < bindings.size(); i++) {
188 SG_LOG(SG_INPUT, SG_INFO, "Reading binding "
189 << bindings[i]->getStringValue("command"));
190 action->addBinding(new FGBinding(bindings[i]), 0);
193 if (node->hasChild("mod-up")) {
194 bindings = node->getChild("mod-up")->getChildren("binding");
195 for (i = 0; i < bindings.size(); i++) {
196 action->addBinding(new FGBinding(bindings[i]), 1);
200 readConditions(action, node);
206 * Read a transformation from the instrument's property list.
208 * The panel module uses the transformations to slide or spin needles,
209 * knobs, and other indicators, and to place layers in the correct
210 * positions. Every layer starts centered exactly on the x,y co-ordinate,
211 * and many layers need to be moved or rotated simply to display the
212 * instrument correctly.
214 * There are three types of transformations:
216 * "x-shift" - move the layer horizontally.
218 * "y-shift" - move the layer vertically.
220 * "rotation" - rotate the layer.
222 * Each transformation may have a fixed offset, and may also have
223 * a floating-point property value to add to the offset. The
224 * floating-point property may be clamped to a minimum and/or
225 * maximum range and scaled (after clamping).
227 * Note that because of the way OpenGL works, transformations will
228 * appear to be applied backwards.
230 static FGPanelTransformation *
231 readTransformation (const SGPropertyNode * node, float w_scale, float h_scale)
233 FGPanelTransformation * t = new FGPanelTransformation;
235 string name = node->getName();
236 string type = node->getStringValue("type");
237 string propName = node->getStringValue("property", "");
238 SGPropertyNode * target = 0;
241 SG_LOG( SG_COCKPIT, SG_ALERT,
242 "No type supplied for transformation " << name
243 << " assuming \"rotation\"" );
247 if (!propName.empty()) {
248 target = fgGetNode(propName.c_str(), true);
252 t->min = node->getFloatValue("min", -9999999);
253 t->max = node->getFloatValue("max", 99999999);
254 t->has_mod = node->hasChild("modulator");
256 t->mod = node->getFloatValue("modulator");
257 t->factor = node->getFloatValue("scale", 1.0);
258 t->offset = node->getFloatValue("offset", 0.0);
260 // Check for an interpolation table
261 const SGPropertyNode * trans_table = node->getNode("interpolation");
262 if (trans_table != 0) {
263 SG_LOG( SG_COCKPIT, SG_INFO, "Found interpolation table with "
264 << trans_table->nChildren() << "children" );
265 t->table = new SGInterpTable();
266 for(int i = 0; i < trans_table->nChildren(); i++) {
267 const SGPropertyNode * node = trans_table->getChild(i);
268 if (!strcmp(node->getName(), "entry")) {
269 double ind = node->getDoubleValue("ind", 0.0);
270 double dep = node->getDoubleValue("dep", 0.0);
271 SG_LOG( SG_COCKPIT, SG_INFO, "Adding interpolation entry "
272 << ind << "==>" << dep );
273 t->table->addEntry(ind, dep);
275 SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
276 << " in interpolation" );
283 // Move the layer horizontally.
284 if (type == "x-shift") {
285 t->type = FGPanelTransformation::XSHIFT;
286 // t->min *= w_scale; //removed by Martin Dressler
287 // t->max *= w_scale; //removed by Martin Dressler
288 t->offset *= w_scale;
289 t->factor *= w_scale; //Added by Martin Dressler
292 // Move the layer vertically.
293 else if (type == "y-shift") {
294 t->type = FGPanelTransformation::YSHIFT;
295 //t->min *= h_scale; //removed
296 //t->max *= h_scale; //removed
297 t->offset *= h_scale;
298 t->factor *= h_scale; //Added
301 // Rotate the layer. The rotation
302 // is in degrees, and does not need
303 // to scale with the instrument size.
304 else if (type == "rotation") {
305 t->type = FGPanelTransformation::ROTATION;
309 SG_LOG( SG_COCKPIT, SG_ALERT, "Unrecognized transformation type " << type );
314 readConditions(t, node);
315 SG_LOG( SG_COCKPIT, SG_DEBUG, "Read transformation " << name );
321 * Read a chunk of text from the instrument's property list.
323 * A text layer consists of one or more chunks of text. All chunks
324 * share the same font size and color (and eventually, font), but
325 * each can come from a different source. There are three types of
328 * "literal" - a literal text string (the default)
330 * "text-value" - the current value of a string property
332 * "number-value" - the current value of a floating-point property.
334 * All three may also include a printf-style format string.
337 readTextChunk (const SGPropertyNode * node)
339 FGTextLayer::Chunk * chunk;
340 string name = node->getStringValue("name");
341 string type = node->getStringValue("type");
342 string format = node->getStringValue("format");
344 // Default to literal text.
346 SG_LOG( SG_COCKPIT, SG_INFO, "No type provided for text chunk " << name
347 << " assuming \"literal\"");
351 // A literal text string.
352 if (type == "literal") {
353 string text = node->getStringValue("text");
354 chunk = new FGTextLayer::Chunk(text, format);
357 // The value of a string property.
358 else if (type == "text-value") {
359 SGPropertyNode * target =
360 fgGetNode(node->getStringValue("property"), true);
361 chunk = new FGTextLayer::Chunk(FGTextLayer::TEXT_VALUE, target, format);
364 // The value of a float property.
365 else if (type == "number-value") {
366 string propName = node->getStringValue("property");
367 float scale = node->getFloatValue("scale", 1.0);
368 SGPropertyNode * target = fgGetNode(propName.c_str(), true);
369 chunk = new FGTextLayer::Chunk(FGTextLayer::DOUBLE_VALUE, target,
375 SG_LOG( SG_COCKPIT, SG_ALERT, "Unrecognized type " << type
376 << " for text chunk " << name );
380 readConditions(chunk, node);
386 * Read a single layer from an instrument's property list.
388 * Each instrument consists of one or more layers stacked on top
389 * of each other; the lower layers show through only where the upper
390 * layers contain an alpha component. Each layer can be moved
391 * horizontally and vertically and rotated using transformations.
393 * This module currently recognizes four kinds of layers:
395 * "texture" - a layer containing a texture (the default)
397 * "text" - a layer containing text
399 * "switch" - a layer that switches between two other layers
400 * based on the current value of a boolean property.
402 * "built-in" - a hard-coded layer supported by C++ code in FlightGear.
404 * Currently, the only built-in layer class is "compass-ribbon".
406 static FGInstrumentLayer *
407 readLayer (const SGPropertyNode * node, float w_scale, float h_scale)
409 FGInstrumentLayer * layer = NULL;
410 string name = node->getStringValue("name");
411 string type = node->getStringValue("type");
412 int w = node->getIntValue("w", -1);
413 int h = node->getIntValue("h", -1);
415 w = int(w * w_scale);
417 h = int(h * h_scale);
421 SG_LOG( SG_COCKPIT, SG_ALERT,
422 "No type supplied for layer " << name
423 << " assuming \"texture\"" );
428 // A textured instrument layer.
429 if (type == "texture") {
430 FGCroppedTexture texture = readTexture(node->getNode("texture"));
431 layer = new FGTexturedLayer(texture, w, h);
434 // A group of sublayers.
435 else if (type == "group") {
436 layer = new FGGroupLayer();
437 for (int i = 0; i < node->nChildren(); i++) {
438 const SGPropertyNode * child = node->getChild(i);
439 if (!strcmp(child->getName(), "layer"))
440 ((FGGroupLayer *)layer)->addLayer(readLayer(child, w_scale, h_scale));
445 // A textual instrument layer.
446 else if (type == "text") {
447 FGTextLayer * tlayer = new FGTextLayer(w, h); // FIXME
449 // Set the text color.
450 float red = node->getFloatValue("color/red", 0.0);
451 float green = node->getFloatValue("color/green", 0.0);
452 float blue = node->getFloatValue("color/blue", 0.0);
453 tlayer->setColor(red, green, blue);
455 // Set the point size.
456 float pointSize = node->getFloatValue("point-size", 10.0) * w_scale;
457 tlayer->setPointSize(pointSize);
460 string fontName = node->getStringValue("font", "default");
461 tlayer->setFontName(fontName);
463 const SGPropertyNode * chunk_group = node->getNode("chunks");
464 if (chunk_group != 0) {
465 int nChunks = chunk_group->nChildren();
466 for (int i = 0; i < nChunks; i++) {
467 const SGPropertyNode * node = chunk_group->getChild(i);
468 if (!strcmp(node->getName(), "chunk")) {
469 FGTextLayer::Chunk * chunk = readTextChunk(node);
471 tlayer->addChunk(chunk);
473 SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
481 // A switch instrument layer.
482 else if (type == "switch") {
483 layer = new FGSwitchLayer();
484 for (int i = 0; i < node->nChildren(); i++) {
485 const SGPropertyNode * child = node->getChild(i);
486 if (!strcmp(child->getName(), "layer"))
487 ((FGGroupLayer *)layer)->addLayer(readLayer(child, w_scale, h_scale));
491 // A built-in instrument layer.
492 else if (type == "built-in") {
493 string layerclass = node->getStringValue("class");
495 if (layerclass == "mag-ribbon") {
496 layer = new FGMagRibbon(w, h);
499 else if (layerclass.empty()) {
500 SG_LOG( SG_COCKPIT, SG_ALERT, "No class provided for built-in layer "
506 SG_LOG( SG_COCKPIT, SG_ALERT, "Unknown built-in layer class "
514 SG_LOG( SG_COCKPIT, SG_ALERT, "Unrecognized layer type " << type );
520 // Get the transformations for each layer.
522 const SGPropertyNode * trans_group = node->getNode("transformations");
523 if (trans_group != 0) {
524 int nTransformations = trans_group->nChildren();
525 for (int i = 0; i < nTransformations; i++) {
526 const SGPropertyNode * node = trans_group->getChild(i);
527 if (!strcmp(node->getName(), "transformation")) {
528 FGPanelTransformation * t = readTransformation(node, w_scale, h_scale);
530 layer->addTransformation(t);
532 SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
533 << " in transformations" );
538 readConditions(layer, node);
539 SG_LOG( SG_COCKPIT, SG_DEBUG, "Read layer " << name );
545 * Read an instrument from a property list.
547 * The instrument consists of a preferred width and height
548 * (the panel may override these), together with a list of layers
549 * and a list of actions to be performed when the user clicks
550 * the mouse over the instrument. All co-ordinates are relative
551 * to the instrument's position, so instruments are fully relocatable;
552 * likewise, co-ordinates for actions and transformations will be
553 * scaled automatically if the instrument is not at its preferred size.
555 static FGPanelInstrument *
556 readInstrument (const SGPropertyNode * node)
558 const string name = node->getStringValue("name");
559 int x = node->getIntValue("x", -1);
560 int y = node->getIntValue("y", -1);
561 int real_w = node->getIntValue("w", -1);
562 int real_h = node->getIntValue("h", -1);
563 int w = node->getIntValue("w-base", -1);
564 int h = node->getIntValue("h-base", -1);
566 if (x == -1 || y == -1) {
567 SG_LOG( SG_COCKPIT, SG_ALERT,
568 "x and y positions must be specified and > 0" );
575 w_scale = float(real_w) / float(w);
579 h_scale = float(real_h) / float(h);
583 SG_LOG( SG_COCKPIT, SG_DEBUG, "Reading instrument " << name );
585 FGLayeredInstrument * instrument =
586 new FGLayeredInstrument(x, y, w, h);
589 // Get the actions for the instrument.
591 const SGPropertyNode * action_group = node->getNode("actions");
592 if (action_group != 0) {
593 int nActions = action_group->nChildren();
594 for (int i = 0; i < nActions; i++) {
595 const SGPropertyNode * node = action_group->getChild(i);
596 if (!strcmp(node->getName(), "action")) {
597 FGPanelAction * action = readAction(node, w_scale, h_scale);
599 instrument->addAction(action);
601 SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
608 // Get the layers for the instrument.
610 const SGPropertyNode * layer_group = node->getNode("layers");
611 if (layer_group != 0) {
612 int nLayers = layer_group->nChildren();
613 for (int i = 0; i < nLayers; i++) {
614 const SGPropertyNode * node = layer_group->getChild(i);
615 if (!strcmp(node->getName(), "layer")) {
616 FGInstrumentLayer * layer = readLayer(node, w_scale, h_scale);
618 instrument->addLayer(layer);
620 SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
626 readConditions(instrument, node);
627 SG_LOG( SG_COCKPIT, SG_DEBUG, "Done reading instrument " << name );
633 * Construct the panel from a property tree.
636 readPanel (const SGPropertyNode * root)
638 SG_LOG( SG_COCKPIT, SG_INFO, "Reading properties for panel " <<
639 root->getStringValue("name", "[Unnamed Panel]") );
641 FGPanel * panel = new FGPanel();
642 panel->setWidth(root->getIntValue("w", 1024));
643 panel->setHeight(root->getIntValue("h", 443));
646 // Grab the visible external viewing area, default to
648 panel->setViewHeight(root->getIntValue("view-height",
649 768 - panel->getHeight() + 2));
652 // Grab the panel's initial offsets, default to 0, 0.
654 if (!fgHasNode("/sim/panel/x-offset"))
655 fgSetInt("/sim/panel/x-offset", root->getIntValue("x-offset", 0));
657 // conditional removed by jim wilson to allow panel xml code
658 // with y-offset defined to work...
659 if (!fgHasNode("/sim/panel/y-offset"))
660 fgSetInt("/sim/panel/y-offset", root->getIntValue("y-offset", 0));
663 // Assign the background texture, if any, or a bogus chequerboard.
665 string bgTexture = root->getStringValue("background");
666 if (bgTexture.empty())
668 panel->setBackground(FGTextureManager::createTexture(bgTexture.c_str()));
669 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << bgTexture );
672 // Get multibackground if any...
674 string mbgTexture = root->getStringValue("multibackground[0]");
675 if (!mbgTexture.empty()) {
676 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 0);
677 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
679 mbgTexture = root->getStringValue("multibackground[1]");
680 if (mbgTexture.empty())
682 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 1);
683 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
685 mbgTexture = root->getStringValue("multibackground[2]");
686 if (mbgTexture.empty())
688 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 2);
689 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
691 mbgTexture = root->getStringValue("multibackground[3]");
692 if (mbgTexture.empty())
694 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 3);
695 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
697 mbgTexture = root->getStringValue("multibackground[4]");
698 if (mbgTexture.empty())
700 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 4);
701 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
703 mbgTexture = root->getStringValue("multibackground[5]");
704 if (mbgTexture.empty())
706 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 5);
707 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
709 mbgTexture = root->getStringValue("multibackground[6]");
710 if (mbgTexture.empty())
712 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 6);
713 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
715 mbgTexture = root->getStringValue("multibackground[7]");
716 if (mbgTexture.empty())
718 panel->setMultiBackground(FGTextureManager::createTexture(mbgTexture.c_str()), 7);
719 SG_LOG( SG_COCKPIT, SG_INFO, "Set background texture to " << mbgTexture );
726 // Create each instrument.
728 SG_LOG( SG_COCKPIT, SG_INFO, "Reading panel instruments" );
729 const SGPropertyNode * instrument_group = root->getChild("instruments");
730 if (instrument_group != 0) {
731 int nInstruments = instrument_group->nChildren();
732 for (int i = 0; i < nInstruments; i++) {
733 const SGPropertyNode * node = instrument_group->getChild(i);
734 if (!strcmp(node->getName(), "instrument")) {
735 FGPanelInstrument * instrument = readInstrument(node);
737 panel->addInstrument(instrument);
739 SG_LOG( SG_COCKPIT, SG_INFO, "Skipping " << node->getName()
740 << " in instruments section" );
744 SG_LOG( SG_COCKPIT, SG_INFO, "Done reading panel instruments" );
748 // Return the new panel.
755 * Read a panel from a property list.
757 * Each panel instrument will appear in its own, separate
758 * property list. The top level simply names the panel and
759 * places the instruments in their appropriate locations (and
760 * optionally resizes them if necessary).
762 * Returns 0 if the read fails for any reason.
765 fgReadPanel (istream &input)
770 readProperties(input, &root);
771 } catch (const sg_exception &e) {
772 guiErrorMessage("Error reading panel: ", e);
775 return readPanel(&root);
780 * Read a panel from a property list.
782 * This function opens a stream to a file, then invokes the
783 * main fgReadPanel() function.
786 fgReadPanel (const string &relative_path)
788 SGPath path(globals->get_fg_root());
789 path.append(relative_path);
793 readProperties(path.str(), &root);
794 } catch (const sg_exception &e) {
795 guiErrorMessage("Error reading panel: ", e);
798 return readPanel(&root);
803 // end of panel_io.cxx