1 // fg_props.cxx -- support for FlightGear properties.
3 // Written by David Megginson, started 2000.
5 // Copyright (C) 2000, 2001 David Megginson - david@megginson.com
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <simgear/compiler.h>
29 #include <simgear/structure/exception.hxx>
30 #include <simgear/magvar/magvar.hxx>
31 #include <simgear/timing/sg_time.hxx>
32 #include <simgear/misc/sg_path.hxx>
33 #include <simgear/scene/material/matlib.hxx>
34 #include <simgear/sound/soundmgr_openal.hxx>
38 #include <ATC/ATCdisplay.hxx>
39 #include <Aircraft/aircraft.hxx>
40 #include <Time/tmp.hxx>
41 #include <Environment/environment.hxx>
45 #include "globals.hxx"
46 #include "fg_props.hxx"
48 SG_USING_STD(istream);
49 SG_USING_STD(ostream);
51 static bool winding_ccw = true; // FIXME: temporary
53 static bool fdm_data_logging = false; // FIXME: temporary
55 static bool frozen = false; // FIXME: temporary
59 ////////////////////////////////////////////////////////////////////////
60 // Default property bindings (not yet handled by any module).
61 ////////////////////////////////////////////////////////////////////////
63 struct LogClassMapping {
66 LogClassMapping(sgDebugClass cc, string nname) { c = cc; name = nname; }
69 LogClassMapping log_class_mappings [] = {
70 LogClassMapping(SG_NONE, "none"),
71 LogClassMapping(SG_TERRAIN, "terrain"),
72 LogClassMapping(SG_ASTRO, "astro"),
73 LogClassMapping(SG_FLIGHT, "flight"),
74 LogClassMapping(SG_INPUT, "input"),
75 LogClassMapping(SG_GL, "gl"),
76 LogClassMapping(SG_VIEW, "view"),
77 LogClassMapping(SG_COCKPIT, "cockpit"),
78 LogClassMapping(SG_GENERAL, "general"),
79 LogClassMapping(SG_MATH, "math"),
80 LogClassMapping(SG_EVENT, "event"),
81 LogClassMapping(SG_AIRCRAFT, "aircraft"),
82 LogClassMapping(SG_AUTOPILOT, "autopilot"),
83 LogClassMapping(SG_IO, "io"),
84 LogClassMapping(SG_CLIPPER, "clipper"),
85 LogClassMapping(SG_NETWORK, "network"),
86 LogClassMapping(SG_INSTR, "instrumentation"),
87 LogClassMapping(SG_SYSTEMS, "systems"),
88 LogClassMapping(SG_UNDEFD, "")
93 * Get the logging classes.
98 sgDebugClass classes = logbuf::get_log_classes();
99 static string result = ""; // FIXME
100 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
101 if ((classes&log_class_mappings[i].c) > 0) {
104 result += log_class_mappings[i].name;
107 return result.c_str();
112 addLoggingClass (const string &name)
114 sgDebugClass classes = logbuf::get_log_classes();
115 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
116 if (name == log_class_mappings[i].name) {
117 logbuf::set_log_classes(sgDebugClass(classes|log_class_mappings[i].c));
121 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging class: " << name);
126 * Set the logging classes.
129 setLoggingClasses (const char * c)
132 logbuf::set_log_classes(SG_NONE);
134 if (classes == "none") {
135 SG_LOG(SG_GENERAL, SG_INFO, "Disabled all logging classes");
139 if (classes.empty() || classes == "all") { // default
140 logbuf::set_log_classes(SG_ALL);
141 SG_LOG(SG_GENERAL, SG_INFO, "Enabled all logging classes: "
142 << getLoggingClasses());
146 string rest = classes;
148 int sep = rest.find('|');
150 name = rest.substr(0, sep);
151 rest = rest.substr(sep+1);
152 addLoggingClass(name);
153 sep = rest.find('|');
155 addLoggingClass(rest);
156 SG_LOG(SG_GENERAL, SG_INFO, "Set logging classes to "
157 << getLoggingClasses());
162 * Get the logging priority.
165 getLoggingPriority ()
167 switch (logbuf::get_log_priority()) {
179 SG_LOG(SG_GENERAL, SG_WARN, "Internal: Unknown logging priority number: "
180 << logbuf::get_log_priority());
187 * Set the logging priority.
190 setLoggingPriority (const char * p)
195 if (priority == "bulk") {
196 logbuf::set_log_priority(SG_BULK);
197 } else if (priority == "debug") {
198 logbuf::set_log_priority(SG_DEBUG);
199 } else if (priority.empty() || priority == "info") { // default
200 logbuf::set_log_priority(SG_INFO);
201 } else if (priority == "warn") {
202 logbuf::set_log_priority(SG_WARN);
203 } else if (priority == "alert") {
204 logbuf::set_log_priority(SG_ALERT);
206 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
208 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << getLoggingPriority());
213 * Return the current frozen state.
223 * Set the current frozen state.
230 // Stop sound on a pause
231 SGSoundMgr *s = globals->get_soundmgr();
243 * Return the number of milliseconds elapsed since simulation started.
246 getElapsedTime_sec ()
248 return globals->get_sim_time_sec();
253 * Return the current Zulu time.
258 static char buf[64]; // FIXME
259 struct tm * t = globals->get_time_params()->getGmt();
260 sprintf(buf, "%.4d-%.2d-%.2dT%.2d:%.2d:%.2d",
261 t->tm_year + 1900, t->tm_mon + 1, t->tm_mday,
262 t->tm_hour, t->tm_min, t->tm_sec);
268 * Set the current Zulu time.
271 setDateString (const char * date_string)
273 static const SGPropertyNode *cur_time_override
274 = fgGetNode("/sim/time/cur-time-override", true);
276 SGTime * st = globals->get_time_params();
277 struct tm * current_time = st->getGmt();
280 // Scan for basic ISO format
281 // YYYY-MM-DDTHH:MM:SS
282 int ret = sscanf(date_string, "%d-%d-%dT%d:%d:%d",
283 &(new_time.tm_year), &(new_time.tm_mon),
284 &(new_time.tm_mday), &(new_time.tm_hour),
285 &(new_time.tm_min), &(new_time.tm_sec));
287 // Be pretty picky about this, so
288 // that strange things don't happen
289 // if the save file has been edited
292 SG_LOG(SG_INPUT, SG_WARN, "Date/time string " << date_string
293 << " not in YYYY-MM-DDTHH:MM:SS format; skipped");
297 // OK, it looks like we got six
298 // values, one way or another.
299 new_time.tm_year -= 1900;
300 new_time.tm_mon -= 1;
302 // Now, tell flight gear to use
303 // the new time. This was far
304 // too difficult, by the way.
306 mktime(&new_time) - mktime(current_time) + globals->get_warp();
307 double lon = current_aircraft.fdm_state->get_Longitude();
308 double lat = current_aircraft.fdm_state->get_Latitude();
309 globals->set_warp(warp);
310 st->update(lon, lat, cur_time_override->getLongValue(), warp);
314 * Return the GMT as a string.
319 static char buf[16]; // FIXME
320 struct tm *t = globals->get_time_params()->getGmt();
321 sprintf(buf, " %.2d:%.2d:%.2d",
322 t->tm_hour, t->tm_min, t->tm_sec);
323 // cout << t << " " << buf << endl;
328 * Return the magnetic variation
333 return globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
338 * Return the magnetic dip
343 return globals->get_mag()->get_magdip() * SGD_RADIANS_TO_DEGREES;
348 * Return the current heading in degrees.
354 magheading = current_aircraft.fdm_state->get_Psi() * SGD_RADIANS_TO_DEGREES - getMagVar();
355 if (magheading < 0) magheading += 360;
362 return globals->get_warp();
368 globals->set_warp(warp);
374 return globals->get_warp_delta();
378 setWarpDelta (long delta)
380 globals->set_warp_delta(delta);
390 setWindingCCW (bool state)
394 glFrontFace ( GL_CCW );
396 glFrontFace ( GL_CW );
402 #if defined(FX) && !defined(WIN32)
403 return globals->get_fullscreen();
410 setFullScreen (bool state)
412 #if defined(FX) && !defined(WIN32)
413 globals->set_fullscreen(state);
414 # if defined(XMESA_FX_FULLSCREEN) && defined(XMESA_FX_WINDOW)
415 XMesaSetFXmode( state ? XMESA_FX_FULLSCREEN : XMESA_FX_WINDOW );
423 return fdm_data_logging;
427 setFDMDataLogging (bool state)
429 // kludge; no getter or setter available
430 if (state != fdm_data_logging) {
431 fgToggleFDMdataLogging();
432 fdm_data_logging = state;
437 getLongitudeString ()
439 static SGConstPropertyNode_ptr n = fgGetNode("/position/longitude-deg", true);
440 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
442 double d = n->getDoubleValue();
443 int format = f->getIntValue();
444 char c = d < 0.0 ? 'W' : 'E';
447 snprintf(buf, 32, "%3.6f%c", d, c);
449 } else if (format == 1) {
450 // dd mm.mmm' (DMM-Format) -- uses a round-off factor tailored to the
451 // required precision of the minutes field (three decimal places),
452 // preventing minute values of 60.
453 double deg = fabs(d) + 5.0E-4 / 60.0;
454 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
455 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
458 // mm'ss.s'' (DMS-Format) -- uses a round-off factor tailored to the
459 // required precision of the seconds field (one decimal place),
460 // preventing second values of 60.
461 double deg = fabs(d) + 0.05 / 3600.0;
462 double min = (deg - int(deg)) * 60.0;
463 double sec = (min - int(min)) * 60.0 - 0.049;
464 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
465 int(min), fabs(sec), c);
473 static SGConstPropertyNode_ptr n = fgGetNode("/position/latitude-deg", true);
474 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
476 double d = n->getDoubleValue();
477 int format = f->getIntValue();
478 char c = d < 0.0 ? 'S' : 'N';
481 snprintf(buf, 32, "%3.6f%c", d, c);
483 } else if (format == 1) {
484 double deg = fabs(d) + 5.0E-4 / 60.0;
485 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
486 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
489 double deg = fabs(d) + 0.05 / 3600.0;
490 double min = (deg - int(deg)) * 60.0;
491 double sec = (min - int(min)) * 60.0 - 0.049;
492 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
493 int(min), fabs(sec), c);
501 ////////////////////////////////////////////////////////////////////////
502 // Tie the properties.
503 ////////////////////////////////////////////////////////////////////////
505 FGProperties::FGProperties ()
509 FGProperties::~FGProperties ()
514 FGProperties::init ()
519 FGProperties::bind ()
522 fgTie("/sim/logging/priority", getLoggingPriority, setLoggingPriority);
523 fgTie("/sim/logging/classes", getLoggingClasses, setLoggingClasses);
524 fgTie("/sim/freeze/master", getFreeze, setFreeze);
526 fgTie("/sim/time/elapsed-sec", getElapsedTime_sec);
527 fgTie("/sim/time/gmt", getDateString, setDateString);
528 fgSetArchivable("/sim/time/gmt");
529 fgTie("/sim/time/gmt-string", getGMTString);
532 fgTie("/position/latitude-string", getLatitudeString);
533 fgTie("/position/longitude-string", getLongitudeString);
536 fgTie("/orientation/heading-magnetic-deg", getHeadingMag);
538 fgTie("/environment/magnetic-variation-deg", getMagVar);
539 fgTie("/environment/magnetic-dip-deg", getMagDip);
541 fgTie("/sim/time/warp", getWarp, setWarp, false);
542 fgTie("/sim/time/warp-delta", getWarpDelta, setWarpDelta);
544 // Misc. Temporary junk.
545 fgTie("/sim/temp/winding-ccw", getWindingCCW, setWindingCCW, false);
546 fgTie("/sim/temp/full-screen", getFullScreen, setFullScreen);
547 fgTie("/sim/temp/fdm-data-logging", getFDMDataLogging, setFDMDataLogging);
551 FGProperties::unbind ()
554 fgUntie("/sim/logging/priority");
555 fgUntie("/sim/logging/classes");
556 fgUntie("/sim/freeze/master");
558 fgUntie("/sim/time/elapsed-sec");
559 fgUntie("/sim/time/gmt");
560 fgUntie("/sim/time/gmt-string");
562 fgUntie("/position/latitude-string");
563 fgUntie("/position/longitude-string");
566 fgUntie("/orientation/heading-magnetic-deg");
569 fgUntie("/environment/magnetic-variation-deg");
570 fgUntie("/environment/magnetic-dip-deg");
572 fgUntie("/sim/time/warp");
573 fgUntie("/sim/time/warp-delta");
575 // Misc. Temporary junk.
576 fgUntie("/sim/temp/winding-ccw");
577 fgUntie("/sim/temp/full-screen");
578 fgUntie("/sim/temp/fdm-data-logging");
582 FGProperties::update (double dt)
585 struct tm *t = globals->get_time_params()->getGmt();
587 fgSetInt("/sim/time/utc/year", t->tm_year + 1900);
588 fgSetInt("/sim/time/utc/month", t->tm_mon + 1);
589 fgSetInt("/sim/time/utc/day", t->tm_mday);
590 fgSetInt("/sim/time/utc/hour", t->tm_hour);
591 fgSetInt("/sim/time/utc/minute", t->tm_min);
592 fgSetInt("/sim/time/utc/second", t->tm_sec);
594 fgSetDouble("/sim/time/utc/day-seconds",
599 fgSetInt("/sim/time/local-offset",
600 globals->get_time_params()->get_local_offset());
605 ////////////////////////////////////////////////////////////////////////
607 ////////////////////////////////////////////////////////////////////////
611 * Save the current state of the simulator to a stream.
614 fgSaveFlight (ostream &output, bool write_all)
617 fgSetBool("/sim/presets/onground", false);
618 fgSetArchivable("/sim/presets/onground");
619 fgSetBool("/sim/presets/trim", false);
620 fgSetArchivable("/sim/presets/trim");
621 fgSetString("/sim/presets/speed-set", "UVW");
622 fgSetArchivable("/sim/presets/speed-set");
625 writeProperties(output, globals->get_props(), write_all);
626 } catch (const sg_exception &e) {
627 guiErrorMessage("Error saving flight: ", e);
635 * Restore the current state of the simulator from a stream.
638 fgLoadFlight (istream &input)
640 SGPropertyNode props;
642 readProperties(input, &props);
643 } catch (const sg_exception &e) {
644 guiErrorMessage("Error reading saved flight: ", e);
648 fgSetBool("/sim/presets/onground", false);
649 fgSetBool("/sim/presets/trim", false);
650 fgSetString("/sim/presets/speed-set", "UVW");
652 copyProperties(&props, globals->get_props());
653 // When loading a flight, make it the
654 // new initial state.
655 globals->saveInitialState();
661 fgLoadProps (const char * path, SGPropertyNode * props, bool in_fg_root, int default_mode)
665 SGPath loadpath(globals->get_fg_root());
666 loadpath.append(path);
667 fullpath = loadpath.str();
673 readProperties(fullpath, props, default_mode);
674 } catch (const sg_exception &e) {
675 guiErrorMessage("Error reading properties: ", e);
683 ////////////////////////////////////////////////////////////////////////
684 // Property convenience functions.
685 ////////////////////////////////////////////////////////////////////////
688 fgGetNode (const char * path, bool create)
690 return globals->get_props()->getNode(path, create);
694 fgGetNode (const char * path, int index, bool create)
696 return globals->get_props()->getNode(path, index, create);
700 fgHasNode (const char * path)
702 return (fgGetNode(path, false) != 0);
706 fgAddChangeListener (SGPropertyChangeListener * listener, const char * path)
708 fgGetNode(path, true)->addChangeListener(listener);
712 fgAddChangeListener (SGPropertyChangeListener * listener,
713 const char * path, int index)
715 fgGetNode(path, index, true)->addChangeListener(listener);
719 fgGetBool (const char * name, bool defaultValue)
721 return globals->get_props()->getBoolValue(name, defaultValue);
725 fgGetInt (const char * name, int defaultValue)
727 return globals->get_props()->getIntValue(name, defaultValue);
731 fgGetLong (const char * name, long defaultValue)
733 return globals->get_props()->getLongValue(name, defaultValue);
737 fgGetFloat (const char * name, float defaultValue)
739 return globals->get_props()->getFloatValue(name, defaultValue);
743 fgGetDouble (const char * name, double defaultValue)
745 return globals->get_props()->getDoubleValue(name, defaultValue);
749 fgGetString (const char * name, const char * defaultValue)
751 return globals->get_props()->getStringValue(name, defaultValue);
755 fgSetBool (const char * name, bool val)
757 return globals->get_props()->setBoolValue(name, val);
761 fgSetInt (const char * name, int val)
763 return globals->get_props()->setIntValue(name, val);
767 fgSetLong (const char * name, long val)
769 return globals->get_props()->setLongValue(name, val);
773 fgSetFloat (const char * name, float val)
775 return globals->get_props()->setFloatValue(name, val);
779 fgSetDouble (const char * name, double val)
781 return globals->get_props()->setDoubleValue(name, val);
785 fgSetString (const char * name, const char * val)
787 return globals->get_props()->setStringValue(name, val);
791 fgSetArchivable (const char * name, bool state)
793 SGPropertyNode * node = globals->get_props()->getNode(name);
795 SG_LOG(SG_GENERAL, SG_DEBUG,
796 "Attempt to set archive flag for non-existant property "
799 node->setAttribute(SGPropertyNode::ARCHIVE, state);
803 fgSetReadable (const char * name, bool state)
805 SGPropertyNode * node = globals->get_props()->getNode(name);
807 SG_LOG(SG_GENERAL, SG_DEBUG,
808 "Attempt to set read flag for non-existant property "
811 node->setAttribute(SGPropertyNode::READ, state);
815 fgSetWritable (const char * name, bool state)
817 SGPropertyNode * node = globals->get_props()->getNode(name);
819 SG_LOG(SG_GENERAL, SG_DEBUG,
820 "Attempt to set write flag for non-existant property "
823 node->setAttribute(SGPropertyNode::WRITE, state);
827 fgUntie (const char * name)
829 if (!globals->get_props()->untie(name))
830 SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
834 // end of fg_props.cxx