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>
28 #include <simgear/structure/exception.hxx>
29 #include <simgear/props/props_io.hxx>
31 #include <simgear/magvar/magvar.hxx>
32 #include <simgear/timing/sg_time.hxx>
33 #include <simgear/misc/sg_path.hxx>
34 #include <simgear/sound/soundmgr_openal.hxx>
36 #include <Aircraft/aircraft.hxx>
37 #include <FDM/flight.hxx>
40 #include "globals.hxx"
41 #include "fg_props.hxx"
44 static bool winding_ccw = true; // FIXME: temporary
46 static bool fdm_data_logging = false; // FIXME: temporary
48 static bool frozen = false; // FIXME: temporary
52 ////////////////////////////////////////////////////////////////////////
53 // Default property bindings (not yet handled by any module).
54 ////////////////////////////////////////////////////////////////////////
56 struct LogClassMapping {
59 LogClassMapping(sgDebugClass cc, string nname) { c = cc; name = nname; }
62 LogClassMapping log_class_mappings [] = {
63 LogClassMapping(SG_NONE, "none"),
64 LogClassMapping(SG_TERRAIN, "terrain"),
65 LogClassMapping(SG_ASTRO, "astro"),
66 LogClassMapping(SG_FLIGHT, "flight"),
67 LogClassMapping(SG_INPUT, "input"),
68 LogClassMapping(SG_GL, "gl"),
69 LogClassMapping(SG_VIEW, "view"),
70 LogClassMapping(SG_COCKPIT, "cockpit"),
71 LogClassMapping(SG_GENERAL, "general"),
72 LogClassMapping(SG_MATH, "math"),
73 LogClassMapping(SG_EVENT, "event"),
74 LogClassMapping(SG_AIRCRAFT, "aircraft"),
75 LogClassMapping(SG_AUTOPILOT, "autopilot"),
76 LogClassMapping(SG_IO, "io"),
77 LogClassMapping(SG_CLIPPER, "clipper"),
78 LogClassMapping(SG_NETWORK, "network"),
79 LogClassMapping(SG_INSTR, "instrumentation"),
80 LogClassMapping(SG_SYSTEMS, "systems"),
81 LogClassMapping(SG_UNDEFD, "")
86 * Get the logging classes.
88 // XXX Making the result buffer be global is a band-aid that hopefully
89 // delays its destruction 'til after its last use.
98 sgDebugClass classes = logbuf::get_log_classes();
99 loggingResult.clear();
100 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
101 if ((classes&log_class_mappings[i].c) > 0) {
102 if (!loggingResult.empty())
103 loggingResult += '|';
104 loggingResult += log_class_mappings[i].name;
107 return loggingResult.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 *smgr = globals->get_soundmgr();
232 if ( smgr != NULL ) {
235 } else if (fgGetBool("/sim/sound/working")) {
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.
320 struct tm *t = globals->get_time_params()->getGmt();
321 snprintf(buf, 16, "%.2d:%.2d:%.2d",
322 t->tm_hour, t->tm_min, t->tm_sec);
327 * Return the magnetic variation
332 return globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
337 * Return the magnetic dip
342 return globals->get_mag()->get_magdip() * SGD_RADIANS_TO_DEGREES;
347 * Return the current heading in degrees.
353 magheading = current_aircraft.fdm_state->get_Psi() * SGD_RADIANS_TO_DEGREES - getMagVar();
354 if (magheading < 0) magheading += 360;
359 * Return the current track in degrees.
365 magtrack = current_aircraft.fdm_state->get_Track() - getMagVar();
366 if (magtrack < 0) magtrack += 360;
373 return globals->get_warp();
379 globals->set_warp(warp);
385 return globals->get_warp_delta();
389 setWarpDelta (long delta)
391 globals->set_warp_delta(delta);
401 setWindingCCW (bool state)
405 glFrontFace ( GL_CCW );
407 glFrontFace ( GL_CW );
413 return fdm_data_logging;
417 setFDMDataLogging (bool state)
419 // kludge; no getter or setter available
420 if (state != fdm_data_logging) {
421 fgToggleFDMdataLogging();
422 fdm_data_logging = state;
427 getLongitudeString ()
429 static SGConstPropertyNode_ptr n = fgGetNode("/position/longitude-deg", true);
430 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
432 double d = n->getDoubleValue();
433 int format = f->getIntValue();
434 char c = d < 0.0 ? 'W' : 'E';
437 snprintf(buf, 32, "%3.6f%c", d, c);
439 } else if (format == 1) {
440 // dd mm.mmm' (DMM-Format) -- uses a round-off factor tailored to the
441 // required precision of the minutes field (three decimal places),
442 // preventing minute values of 60.
443 double deg = fabs(d) + 5.0E-4 / 60.0;
444 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
445 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
448 // mm'ss.s'' (DMS-Format) -- uses a round-off factor tailored to the
449 // required precision of the seconds field (one decimal place),
450 // preventing second values of 60.
451 double deg = fabs(d) + 0.05 / 3600.0;
452 double min = (deg - int(deg)) * 60.0;
453 double sec = (min - int(min)) * 60.0 - 0.049;
454 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
455 int(min), fabs(sec), c);
464 static SGConstPropertyNode_ptr n = fgGetNode("/position/latitude-deg", true);
465 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
467 double d = n->getDoubleValue();
468 int format = f->getIntValue();
469 char c = d < 0.0 ? 'S' : 'N';
472 snprintf(buf, 32, "%3.6f%c", d, c);
474 } else if (format == 1) {
475 double deg = fabs(d) + 5.0E-4 / 60.0;
476 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
477 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
480 double deg = fabs(d) + 0.05 / 3600.0;
481 double min = (deg - int(deg)) * 60.0;
482 double sec = (min - int(min)) * 60.0 - 0.049;
483 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
484 int(min), fabs(sec), c);
493 ////////////////////////////////////////////////////////////////////////
494 // Tie the properties.
495 ////////////////////////////////////////////////////////////////////////
497 FGProperties::FGProperties ()
501 FGProperties::~FGProperties ()
506 FGProperties::init ()
511 FGProperties::bind ()
514 fgTie("/sim/logging/priority", getLoggingPriority, setLoggingPriority);
515 fgTie("/sim/logging/classes", getLoggingClasses, setLoggingClasses);
516 fgTie("/sim/freeze/master", getFreeze, setFreeze);
518 fgTie("/sim/time/elapsed-sec", getElapsedTime_sec);
519 fgTie("/sim/time/gmt", getDateString, setDateString);
520 fgSetArchivable("/sim/time/gmt");
521 fgTie("/sim/time/gmt-string", getGMTString);
524 fgTie("/position/latitude-string", getLatitudeString);
525 fgTie("/position/longitude-string", getLongitudeString);
528 fgTie("/orientation/heading-magnetic-deg", getHeadingMag);
529 fgTie("/orientation/track-magnetic-deg", getTrackMag);
531 fgTie("/environment/magnetic-variation-deg", getMagVar);
532 fgTie("/environment/magnetic-dip-deg", getMagDip);
534 fgTie("/sim/time/warp", getWarp, setWarp, false);
535 fgTie("/sim/time/warp-delta", getWarpDelta, setWarpDelta);
537 // Misc. Temporary junk.
538 fgTie("/sim/temp/winding-ccw", getWindingCCW, setWindingCCW, false);
539 fgTie("/sim/temp/fdm-data-logging", getFDMDataLogging, setFDMDataLogging);
543 FGProperties::unbind ()
546 fgUntie("/sim/logging/priority");
547 fgUntie("/sim/logging/classes");
548 fgUntie("/sim/freeze/master");
550 fgUntie("/sim/time/elapsed-sec");
551 fgUntie("/sim/time/gmt");
552 fgUntie("/sim/time/gmt-string");
554 fgUntie("/position/latitude-string");
555 fgUntie("/position/longitude-string");
558 fgUntie("/orientation/heading-magnetic-deg");
559 fgUntie("/orientation/track-magnetic-deg");
562 fgUntie("/environment/magnetic-variation-deg");
563 fgUntie("/environment/magnetic-dip-deg");
565 fgUntie("/sim/time/warp");
566 fgUntie("/sim/time/warp-delta");
568 // Misc. Temporary junk.
569 fgUntie("/sim/temp/winding-ccw");
570 fgUntie("/sim/temp/full-screen");
571 fgUntie("/sim/temp/fdm-data-logging");
575 FGProperties::update (double dt)
577 static SGPropertyNode_ptr offset = fgGetNode("/sim/time/local-offset", true);
578 offset->setIntValue(globals->get_time_params()->get_local_offset());
582 static SGPropertyNode_ptr uyear = fgGetNode("/sim/time/utc/year", true);
583 static SGPropertyNode_ptr umonth = fgGetNode("/sim/time/utc/month", true);
584 static SGPropertyNode_ptr uday = fgGetNode("/sim/time/utc/day", true);
585 static SGPropertyNode_ptr uhour = fgGetNode("/sim/time/utc/hour", true);
586 static SGPropertyNode_ptr umin = fgGetNode("/sim/time/utc/minute", true);
587 static SGPropertyNode_ptr usec = fgGetNode("/sim/time/utc/second", true);
588 static SGPropertyNode_ptr uwday = fgGetNode("/sim/time/utc/weekday", true);
589 static SGPropertyNode_ptr udsec = fgGetNode("/sim/time/utc/day-seconds", true);
591 struct tm *u = globals->get_time_params()->getGmt();
592 uyear->setIntValue(u->tm_year + 1900);
593 umonth->setIntValue(u->tm_mon + 1);
594 uday->setIntValue(u->tm_mday);
595 uhour->setIntValue(u->tm_hour);
596 umin->setIntValue(u->tm_min);
597 usec->setIntValue(u->tm_sec);
598 uwday->setIntValue(u->tm_wday);
600 udsec->setIntValue(u->tm_hour * 3600 + u->tm_min * 60 + u->tm_sec);
603 // real local date/time
604 static SGPropertyNode_ptr ryear = fgGetNode("/sim/time/real/year", true);
605 static SGPropertyNode_ptr rmonth = fgGetNode("/sim/time/real/month", true);
606 static SGPropertyNode_ptr rday = fgGetNode("/sim/time/real/day", true);
607 static SGPropertyNode_ptr rhour = fgGetNode("/sim/time/real/hour", true);
608 static SGPropertyNode_ptr rmin = fgGetNode("/sim/time/real/minute", true);
609 static SGPropertyNode_ptr rsec = fgGetNode("/sim/time/real/second", true);
610 static SGPropertyNode_ptr rwday = fgGetNode("/sim/time/real/weekday", true);
612 time_t real = time(0);
613 struct tm *r = localtime(&real);
614 ryear->setIntValue(r->tm_year + 1900);
615 rmonth->setIntValue(r->tm_mon + 1);
616 rday->setIntValue(r->tm_mday);
617 rhour->setIntValue(r->tm_hour);
618 rmin->setIntValue(r->tm_min);
619 rsec->setIntValue(r->tm_sec);
620 rwday->setIntValue(r->tm_wday);
625 ////////////////////////////////////////////////////////////////////////
627 ////////////////////////////////////////////////////////////////////////
631 * Save the current state of the simulator to a stream.
634 fgSaveFlight (std::ostream &output, bool write_all)
637 fgSetBool("/sim/presets/onground", false);
638 fgSetArchivable("/sim/presets/onground");
639 fgSetBool("/sim/presets/trim", false);
640 fgSetArchivable("/sim/presets/trim");
641 fgSetString("/sim/presets/speed-set", "UVW");
642 fgSetArchivable("/sim/presets/speed-set");
645 writeProperties(output, globals->get_props(), write_all);
646 } catch (const sg_exception &e) {
647 guiErrorMessage("Error saving flight: ", e);
655 * Restore the current state of the simulator from a stream.
658 fgLoadFlight (std::istream &input)
660 SGPropertyNode props;
662 readProperties(input, &props);
663 } catch (const sg_exception &e) {
664 guiErrorMessage("Error reading saved flight: ", e);
668 fgSetBool("/sim/presets/onground", false);
669 fgSetBool("/sim/presets/trim", false);
670 fgSetString("/sim/presets/speed-set", "UVW");
672 copyProperties(&props, globals->get_props());
673 // When loading a flight, make it the
674 // new initial state.
675 globals->saveInitialState();
681 fgLoadProps (const char * path, SGPropertyNode * props, bool in_fg_root, int default_mode)
685 SGPath loadpath(globals->get_fg_root());
686 loadpath.append(path);
687 fullpath = loadpath.str();
693 readProperties(fullpath, props, default_mode);
694 } catch (const sg_exception &e) {
695 guiErrorMessage("Error reading properties: ", e);
703 ////////////////////////////////////////////////////////////////////////
704 // Property convenience functions.
705 ////////////////////////////////////////////////////////////////////////
708 fgGetNode (const char * path, bool create)
710 return globals->get_props()->getNode(path, create);
714 fgGetNode (const char * path, int index, bool create)
716 return globals->get_props()->getNode(path, index, create);
720 fgHasNode (const char * path)
722 return (fgGetNode(path, false) != 0);
726 fgAddChangeListener (SGPropertyChangeListener * listener, const char * path)
728 fgGetNode(path, true)->addChangeListener(listener);
732 fgAddChangeListener (SGPropertyChangeListener * listener,
733 const char * path, int index)
735 fgGetNode(path, index, true)->addChangeListener(listener);
739 fgGetBool (const char * name, bool defaultValue)
741 return globals->get_props()->getBoolValue(name, defaultValue);
745 fgGetInt (const char * name, int defaultValue)
747 return globals->get_props()->getIntValue(name, defaultValue);
751 fgGetLong (const char * name, long defaultValue)
753 return globals->get_props()->getLongValue(name, defaultValue);
757 fgGetFloat (const char * name, float defaultValue)
759 return globals->get_props()->getFloatValue(name, defaultValue);
763 fgGetDouble (const char * name, double defaultValue)
765 return globals->get_props()->getDoubleValue(name, defaultValue);
769 fgGetString (const char * name, const char * defaultValue)
771 return globals->get_props()->getStringValue(name, defaultValue);
775 fgSetBool (const char * name, bool val)
777 return globals->get_props()->setBoolValue(name, val);
781 fgSetInt (const char * name, int val)
783 return globals->get_props()->setIntValue(name, val);
787 fgSetLong (const char * name, long val)
789 return globals->get_props()->setLongValue(name, val);
793 fgSetFloat (const char * name, float val)
795 return globals->get_props()->setFloatValue(name, val);
799 fgSetDouble (const char * name, double val)
801 return globals->get_props()->setDoubleValue(name, val);
805 fgSetString (const char * name, const char * val)
807 return globals->get_props()->setStringValue(name, val);
811 fgSetArchivable (const char * name, bool state)
813 SGPropertyNode * node = globals->get_props()->getNode(name);
815 SG_LOG(SG_GENERAL, SG_DEBUG,
816 "Attempt to set archive flag for non-existant property "
819 node->setAttribute(SGPropertyNode::ARCHIVE, state);
823 fgSetReadable (const char * name, bool state)
825 SGPropertyNode * node = globals->get_props()->getNode(name);
827 SG_LOG(SG_GENERAL, SG_DEBUG,
828 "Attempt to set read flag for non-existant property "
831 node->setAttribute(SGPropertyNode::READ, state);
835 fgSetWritable (const char * name, bool state)
837 SGPropertyNode * node = globals->get_props()->getNode(name);
839 SG_LOG(SG_GENERAL, SG_DEBUG,
840 "Attempt to set write flag for non-existant property "
843 node->setAttribute(SGPropertyNode::WRITE, state);
847 fgUntie (const char * name)
849 if (!globals->get_props()->untie(name))
850 SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
854 // end of fg_props.cxx