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 <Aircraft/aircraft.hxx>
39 #include <FDM/flight.hxx>
41 #include <Time/tmp.hxx>
42 #include <Environment/environment.hxx>
46 #include "globals.hxx"
47 #include "fg_props.hxx"
52 static bool winding_ccw = true; // FIXME: temporary
54 static bool fdm_data_logging = false; // FIXME: temporary
56 static bool frozen = false; // FIXME: temporary
60 ////////////////////////////////////////////////////////////////////////
61 // Default property bindings (not yet handled by any module).
62 ////////////////////////////////////////////////////////////////////////
64 struct LogClassMapping {
67 LogClassMapping(sgDebugClass cc, string nname) { c = cc; name = nname; }
70 LogClassMapping log_class_mappings [] = {
71 LogClassMapping(SG_NONE, "none"),
72 LogClassMapping(SG_TERRAIN, "terrain"),
73 LogClassMapping(SG_ASTRO, "astro"),
74 LogClassMapping(SG_FLIGHT, "flight"),
75 LogClassMapping(SG_INPUT, "input"),
76 LogClassMapping(SG_GL, "gl"),
77 LogClassMapping(SG_VIEW, "view"),
78 LogClassMapping(SG_COCKPIT, "cockpit"),
79 LogClassMapping(SG_GENERAL, "general"),
80 LogClassMapping(SG_MATH, "math"),
81 LogClassMapping(SG_EVENT, "event"),
82 LogClassMapping(SG_AIRCRAFT, "aircraft"),
83 LogClassMapping(SG_AUTOPILOT, "autopilot"),
84 LogClassMapping(SG_IO, "io"),
85 LogClassMapping(SG_CLIPPER, "clipper"),
86 LogClassMapping(SG_NETWORK, "network"),
87 LogClassMapping(SG_INSTR, "instrumentation"),
88 LogClassMapping(SG_SYSTEMS, "systems"),
89 LogClassMapping(SG_UNDEFD, "")
94 * Get the logging classes.
99 sgDebugClass classes = logbuf::get_log_classes();
100 static string result;
102 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
103 if ((classes&log_class_mappings[i].c) > 0) {
106 result += log_class_mappings[i].name;
109 return result.c_str();
114 addLoggingClass (const string &name)
116 sgDebugClass classes = logbuf::get_log_classes();
117 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
118 if (name == log_class_mappings[i].name) {
119 logbuf::set_log_classes(sgDebugClass(classes|log_class_mappings[i].c));
123 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging class: " << name);
128 * Set the logging classes.
131 setLoggingClasses (const char * c)
134 logbuf::set_log_classes(SG_NONE);
136 if (classes == "none") {
137 SG_LOG(SG_GENERAL, SG_INFO, "Disabled all logging classes");
141 if (classes.empty() || classes == "all") { // default
142 logbuf::set_log_classes(SG_ALL);
143 SG_LOG(SG_GENERAL, SG_INFO, "Enabled all logging classes: "
144 << getLoggingClasses());
148 string rest = classes;
150 int sep = rest.find('|');
152 name = rest.substr(0, sep);
153 rest = rest.substr(sep+1);
154 addLoggingClass(name);
155 sep = rest.find('|');
157 addLoggingClass(rest);
158 SG_LOG(SG_GENERAL, SG_INFO, "Set logging classes to "
159 << getLoggingClasses());
164 * Get the logging priority.
167 getLoggingPriority ()
169 switch (logbuf::get_log_priority()) {
181 SG_LOG(SG_GENERAL, SG_WARN, "Internal: Unknown logging priority number: "
182 << logbuf::get_log_priority());
189 * Set the logging priority.
192 setLoggingPriority (const char * p)
197 if (priority == "bulk") {
198 logbuf::set_log_priority(SG_BULK);
199 } else if (priority == "debug") {
200 logbuf::set_log_priority(SG_DEBUG);
201 } else if (priority.empty() || priority == "info") { // default
202 logbuf::set_log_priority(SG_INFO);
203 } else if (priority == "warn") {
204 logbuf::set_log_priority(SG_WARN);
205 } else if (priority == "alert") {
206 logbuf::set_log_priority(SG_ALERT);
208 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
210 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << getLoggingPriority());
215 * Return the current frozen state.
225 * Set the current frozen state.
232 // Stop sound on a pause
233 SGSoundMgr *s = globals->get_soundmgr();
237 } else if (!fgGetBool("/sim/sound/pause")) {
245 * Return the number of milliseconds elapsed since simulation started.
248 getElapsedTime_sec ()
250 return globals->get_sim_time_sec();
255 * Return the current Zulu time.
260 static char buf[64]; // FIXME
261 struct tm * t = globals->get_time_params()->getGmt();
262 sprintf(buf, "%.4d-%.2d-%.2dT%.2d:%.2d:%.2d",
263 t->tm_year + 1900, t->tm_mon + 1, t->tm_mday,
264 t->tm_hour, t->tm_min, t->tm_sec);
270 * Set the current Zulu time.
273 setDateString (const char * date_string)
275 static const SGPropertyNode *cur_time_override
276 = fgGetNode("/sim/time/cur-time-override", true);
278 SGTime * st = globals->get_time_params();
279 struct tm * current_time = st->getGmt();
282 // Scan for basic ISO format
283 // YYYY-MM-DDTHH:MM:SS
284 int ret = sscanf(date_string, "%d-%d-%dT%d:%d:%d",
285 &(new_time.tm_year), &(new_time.tm_mon),
286 &(new_time.tm_mday), &(new_time.tm_hour),
287 &(new_time.tm_min), &(new_time.tm_sec));
289 // Be pretty picky about this, so
290 // that strange things don't happen
291 // if the save file has been edited
294 SG_LOG(SG_INPUT, SG_WARN, "Date/time string " << date_string
295 << " not in YYYY-MM-DDTHH:MM:SS format; skipped");
299 // OK, it looks like we got six
300 // values, one way or another.
301 new_time.tm_year -= 1900;
302 new_time.tm_mon -= 1;
304 // Now, tell flight gear to use
305 // the new time. This was far
306 // too difficult, by the way.
308 mktime(&new_time) - mktime(current_time) + globals->get_warp();
309 double lon = current_aircraft.fdm_state->get_Longitude();
310 double lat = current_aircraft.fdm_state->get_Latitude();
311 globals->set_warp(warp);
312 st->update(lon, lat, cur_time_override->getLongValue(), warp);
316 * Return the GMT as a string.
322 struct tm *t = globals->get_time_params()->getGmt();
323 snprintf(buf, 16, "%.2d:%.2d:%.2d",
324 t->tm_hour, t->tm_min, t->tm_sec);
329 * Return the magnetic variation
334 return globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
339 * Return the magnetic dip
344 return globals->get_mag()->get_magdip() * SGD_RADIANS_TO_DEGREES;
349 * Return the current heading in degrees.
355 magheading = current_aircraft.fdm_state->get_Psi() * SGD_RADIANS_TO_DEGREES - getMagVar();
356 if (magheading < 0) magheading += 360;
363 return globals->get_warp();
369 globals->set_warp(warp);
375 return globals->get_warp_delta();
379 setWarpDelta (long delta)
381 globals->set_warp_delta(delta);
391 setWindingCCW (bool state)
395 glFrontFace ( GL_CCW );
397 glFrontFace ( GL_CW );
403 return fdm_data_logging;
407 setFDMDataLogging (bool state)
409 // kludge; no getter or setter available
410 if (state != fdm_data_logging) {
411 fgToggleFDMdataLogging();
412 fdm_data_logging = state;
417 getLongitudeString ()
419 static SGConstPropertyNode_ptr n = fgGetNode("/position/longitude-deg", true);
420 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
422 double d = n->getDoubleValue();
423 int format = f->getIntValue();
424 char c = d < 0.0 ? 'W' : 'E';
427 snprintf(buf, 32, "%3.6f%c", d, c);
429 } else if (format == 1) {
430 // dd mm.mmm' (DMM-Format) -- uses a round-off factor tailored to the
431 // required precision of the minutes field (three decimal places),
432 // preventing minute values of 60.
433 double deg = fabs(d) + 5.0E-4 / 60.0;
434 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
435 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
438 // mm'ss.s'' (DMS-Format) -- uses a round-off factor tailored to the
439 // required precision of the seconds field (one decimal place),
440 // preventing second values of 60.
441 double deg = fabs(d) + 0.05 / 3600.0;
442 double min = (deg - int(deg)) * 60.0;
443 double sec = (min - int(min)) * 60.0 - 0.049;
444 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
445 int(min), fabs(sec), c);
454 static SGConstPropertyNode_ptr n = fgGetNode("/position/latitude-deg", true);
455 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
457 double d = n->getDoubleValue();
458 int format = f->getIntValue();
459 char c = d < 0.0 ? 'S' : 'N';
462 snprintf(buf, 32, "%3.6f%c", d, c);
464 } else if (format == 1) {
465 double deg = fabs(d) + 5.0E-4 / 60.0;
466 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
467 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
470 double deg = fabs(d) + 0.05 / 3600.0;
471 double min = (deg - int(deg)) * 60.0;
472 double sec = (min - int(min)) * 60.0 - 0.049;
473 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
474 int(min), fabs(sec), c);
483 ////////////////////////////////////////////////////////////////////////
484 // Tie the properties.
485 ////////////////////////////////////////////////////////////////////////
487 FGProperties::FGProperties ()
491 FGProperties::~FGProperties ()
496 FGProperties::init ()
501 FGProperties::bind ()
504 fgTie("/sim/logging/priority", getLoggingPriority, setLoggingPriority);
505 fgTie("/sim/logging/classes", getLoggingClasses, setLoggingClasses);
506 fgTie("/sim/freeze/master", getFreeze, setFreeze);
508 fgTie("/sim/time/elapsed-sec", getElapsedTime_sec);
509 fgTie("/sim/time/gmt", getDateString, setDateString);
510 fgSetArchivable("/sim/time/gmt");
511 fgTie("/sim/time/gmt-string", getGMTString);
514 fgTie("/position/latitude-string", getLatitudeString);
515 fgTie("/position/longitude-string", getLongitudeString);
518 fgTie("/orientation/heading-magnetic-deg", getHeadingMag);
520 fgTie("/environment/magnetic-variation-deg", getMagVar);
521 fgTie("/environment/magnetic-dip-deg", getMagDip);
523 fgTie("/sim/time/warp", getWarp, setWarp, false);
524 fgTie("/sim/time/warp-delta", getWarpDelta, setWarpDelta);
526 // Misc. Temporary junk.
527 fgTie("/sim/temp/winding-ccw", getWindingCCW, setWindingCCW, false);
528 fgTie("/sim/temp/fdm-data-logging", getFDMDataLogging, setFDMDataLogging);
532 FGProperties::unbind ()
535 fgUntie("/sim/logging/priority");
536 fgUntie("/sim/logging/classes");
537 fgUntie("/sim/freeze/master");
539 fgUntie("/sim/time/elapsed-sec");
540 fgUntie("/sim/time/gmt");
541 fgUntie("/sim/time/gmt-string");
543 fgUntie("/position/latitude-string");
544 fgUntie("/position/longitude-string");
547 fgUntie("/orientation/heading-magnetic-deg");
550 fgUntie("/environment/magnetic-variation-deg");
551 fgUntie("/environment/magnetic-dip-deg");
553 fgUntie("/sim/time/warp");
554 fgUntie("/sim/time/warp-delta");
556 // Misc. Temporary junk.
557 fgUntie("/sim/temp/winding-ccw");
558 fgUntie("/sim/temp/full-screen");
559 fgUntie("/sim/temp/fdm-data-logging");
563 FGProperties::update (double dt)
566 struct tm *t = globals->get_time_params()->getGmt();
568 fgSetInt("/sim/time/utc/year", t->tm_year + 1900);
569 fgSetInt("/sim/time/utc/month", t->tm_mon + 1);
570 fgSetInt("/sim/time/utc/day", t->tm_mday);
571 fgSetInt("/sim/time/utc/hour", t->tm_hour);
572 fgSetInt("/sim/time/utc/minute", t->tm_min);
573 fgSetInt("/sim/time/utc/second", t->tm_sec);
575 fgSetDouble("/sim/time/utc/day-seconds",
580 fgSetInt("/sim/time/local-offset",
581 globals->get_time_params()->get_local_offset());
586 ////////////////////////////////////////////////////////////////////////
588 ////////////////////////////////////////////////////////////////////////
592 * Save the current state of the simulator to a stream.
595 fgSaveFlight (ostream &output, bool write_all)
598 fgSetBool("/sim/presets/onground", false);
599 fgSetArchivable("/sim/presets/onground");
600 fgSetBool("/sim/presets/trim", false);
601 fgSetArchivable("/sim/presets/trim");
602 fgSetString("/sim/presets/speed-set", "UVW");
603 fgSetArchivable("/sim/presets/speed-set");
606 writeProperties(output, globals->get_props(), write_all);
607 } catch (const sg_exception &e) {
608 guiErrorMessage("Error saving flight: ", e);
616 * Restore the current state of the simulator from a stream.
619 fgLoadFlight (istream &input)
621 SGPropertyNode props;
623 readProperties(input, &props);
624 } catch (const sg_exception &e) {
625 guiErrorMessage("Error reading saved flight: ", e);
629 fgSetBool("/sim/presets/onground", false);
630 fgSetBool("/sim/presets/trim", false);
631 fgSetString("/sim/presets/speed-set", "UVW");
633 copyProperties(&props, globals->get_props());
634 // When loading a flight, make it the
635 // new initial state.
636 globals->saveInitialState();
642 fgLoadProps (const char * path, SGPropertyNode * props, bool in_fg_root, int default_mode)
646 SGPath loadpath(globals->get_fg_root());
647 loadpath.append(path);
648 fullpath = loadpath.str();
654 readProperties(fullpath, props, default_mode);
655 } catch (const sg_exception &e) {
656 guiErrorMessage("Error reading properties: ", e);
664 ////////////////////////////////////////////////////////////////////////
665 // Property convenience functions.
666 ////////////////////////////////////////////////////////////////////////
669 fgGetNode (const char * path, bool create)
671 return globals->get_props()->getNode(path, create);
675 fgGetNode (const char * path, int index, bool create)
677 return globals->get_props()->getNode(path, index, create);
681 fgHasNode (const char * path)
683 return (fgGetNode(path, false) != 0);
687 fgAddChangeListener (SGPropertyChangeListener * listener, const char * path)
689 fgGetNode(path, true)->addChangeListener(listener);
693 fgAddChangeListener (SGPropertyChangeListener * listener,
694 const char * path, int index)
696 fgGetNode(path, index, true)->addChangeListener(listener);
700 fgGetBool (const char * name, bool defaultValue)
702 return globals->get_props()->getBoolValue(name, defaultValue);
706 fgGetInt (const char * name, int defaultValue)
708 return globals->get_props()->getIntValue(name, defaultValue);
712 fgGetLong (const char * name, long defaultValue)
714 return globals->get_props()->getLongValue(name, defaultValue);
718 fgGetFloat (const char * name, float defaultValue)
720 return globals->get_props()->getFloatValue(name, defaultValue);
724 fgGetDouble (const char * name, double defaultValue)
726 return globals->get_props()->getDoubleValue(name, defaultValue);
730 fgGetString (const char * name, const char * defaultValue)
732 return globals->get_props()->getStringValue(name, defaultValue);
736 fgSetBool (const char * name, bool val)
738 return globals->get_props()->setBoolValue(name, val);
742 fgSetInt (const char * name, int val)
744 return globals->get_props()->setIntValue(name, val);
748 fgSetLong (const char * name, long val)
750 return globals->get_props()->setLongValue(name, val);
754 fgSetFloat (const char * name, float val)
756 return globals->get_props()->setFloatValue(name, val);
760 fgSetDouble (const char * name, double val)
762 return globals->get_props()->setDoubleValue(name, val);
766 fgSetString (const char * name, const char * val)
768 return globals->get_props()->setStringValue(name, val);
772 fgSetArchivable (const char * name, bool state)
774 SGPropertyNode * node = globals->get_props()->getNode(name);
776 SG_LOG(SG_GENERAL, SG_DEBUG,
777 "Attempt to set archive flag for non-existant property "
780 node->setAttribute(SGPropertyNode::ARCHIVE, state);
784 fgSetReadable (const char * name, bool state)
786 SGPropertyNode * node = globals->get_props()->getNode(name);
788 SG_LOG(SG_GENERAL, SG_DEBUG,
789 "Attempt to set read flag for non-existant property "
792 node->setAttribute(SGPropertyNode::READ, state);
796 fgSetWritable (const char * name, bool state)
798 SGPropertyNode * node = globals->get_props()->getNode(name);
800 SG_LOG(SG_GENERAL, SG_DEBUG,
801 "Attempt to set write flag for non-existant property "
804 node->setAttribute(SGPropertyNode::WRITE, state);
808 fgUntie (const char * name)
810 if (!globals->get_props()->untie(name))
811 SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
815 // end of fg_props.cxx