1 // fg_commands.cxx - internal FGFS commands.
7 #include <string.h> // strcmp()
9 #include <simgear/compiler.h>
14 #include <simgear/sg_inlines.h>
15 #include <simgear/debug/logstream.hxx>
16 #include <simgear/math/sg_random.h>
17 #include <simgear/scene/material/mat.hxx>
18 #include <simgear/scene/material/matlib.hxx>
19 #include <simgear/structure/exception.hxx>
20 #include <simgear/structure/commands.hxx>
21 #include <simgear/props/props.hxx>
22 #include <simgear/props/props_io.hxx>
23 #include <simgear/structure/event_mgr.hxx>
24 #include <simgear/sound/soundmgr_openal.hxx>
25 #include <simgear/timing/sg_time.hxx>
26 #include <Network/RemoteXMLRequest.hxx>
28 #include <FDM/flight.hxx>
30 #include <GUI/new_gui.hxx>
31 #include <GUI/dialog.hxx>
32 #include <Aircraft/replay.hxx>
33 #include <Scenery/scenery.hxx>
34 #include <Scenery/tilemgr.hxx>
35 #include <Scripting/NasalSys.hxx>
36 #include <Sound/sample_queue.hxx>
37 #include <Airports/xmlloader.hxx>
38 #include <Network/HTTPClient.hxx>
39 #include <Viewer/viewmgr.hxx>
40 #include <Viewer/viewer.hxx>
41 #include <Environment/presets.hxx>
42 #include <Navaids/NavDataCache.hxx>
44 #include "fg_init.hxx"
47 #include "fg_commands.hxx"
48 #include "fg_props.hxx"
49 #include "globals.hxx"
53 #include "positioninit.hxx"
55 #include <boost/scoped_array.hpp>
57 #if FG_HAVE_GPERFTOOLS
58 # include <google/profiler.h>
66 ////////////////////////////////////////////////////////////////////////
67 // Static helper functions.
68 ////////////////////////////////////////////////////////////////////////
71 static inline SGPropertyNode *
72 get_prop (const SGPropertyNode * arg)
74 return fgGetNode(arg->getStringValue("property[0]", "/null"), true);
77 static inline SGPropertyNode *
78 get_prop2 (const SGPropertyNode * arg)
80 return fgGetNode(arg->getStringValue("property[1]", "/null"), true);
85 * Get a double value and split it as required.
88 split_value (double full_value, const char * mask,
89 double * unmodifiable, double * modifiable)
91 if (!strcmp("integer", mask)) {
92 *modifiable = (full_value < 0 ? ceil(full_value) : floor (full_value));
93 *unmodifiable = full_value - *modifiable;
94 } else if (!strcmp("decimal", mask)) {
95 *unmodifiable = (full_value < 0 ? ceil(full_value) : floor(full_value));
96 *modifiable = full_value - *unmodifiable;
98 if (strcmp("all", mask))
99 SG_LOG(SG_GENERAL, SG_ALERT, "Bad value " << mask << " for mask;"
100 << " assuming 'all'");
102 *modifiable = full_value;
108 * Clamp or wrap a value as specified.
111 limit_value (double * value, const SGPropertyNode * arg)
113 const SGPropertyNode * min_node = arg->getChild("min");
114 const SGPropertyNode * max_node = arg->getChild("max");
116 bool wrap = arg->getBoolValue("wrap");
118 if (min_node == 0 || max_node == 0)
121 if (wrap) { // wrap such that min <= x < max
122 double min_val = min_node->getDoubleValue();
123 double max_val = max_node->getDoubleValue();
124 double resolution = arg->getDoubleValue("resolution");
125 if (resolution > 0.0) {
126 // snap to (min + N*resolution), taking special care to handle imprecision
127 int n = (int)floor((*value - min_val) / resolution + 0.5);
128 int steps = (int)floor((max_val - min_val) / resolution + 0.5);
129 SG_NORMALIZE_RANGE(n, 0, steps);
130 *value = min_val + resolution * n;
132 // plain circular wrapping
133 SG_NORMALIZE_RANGE(*value, min_val, max_val);
135 } else { // clamp such that min <= x <= max
136 if ((min_node != 0) && (*value < min_node->getDoubleValue()))
137 *value = min_node->getDoubleValue();
138 else if ((max_node != 0) && (*value > max_node->getDoubleValue()))
139 *value = max_node->getDoubleValue();
144 compare_values (SGPropertyNode * value1, SGPropertyNode * value2)
146 switch (value1->getType()) {
147 case simgear::props::BOOL:
148 return (value1->getBoolValue() == value2->getBoolValue());
149 case simgear::props::INT:
150 return (value1->getIntValue() == value2->getIntValue());
151 case simgear::props::LONG:
152 return (value1->getLongValue() == value2->getLongValue());
153 case simgear::props::FLOAT:
154 return (value1->getFloatValue() == value2->getFloatValue());
155 case simgear::props::DOUBLE:
156 return (value1->getDoubleValue() == value2->getDoubleValue());
158 return !strcmp(value1->getStringValue(), value2->getStringValue());
164 ////////////////////////////////////////////////////////////////////////
165 // Command implementations.
166 ////////////////////////////////////////////////////////////////////////
170 * Built-in command: do nothing.
173 do_null (const SGPropertyNode * arg)
179 * Built-in command: run a Nasal script.
182 do_nasal (const SGPropertyNode * arg)
184 return ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(arg);
188 * Built-in command: exit FlightGear.
190 * status: the exit status to return to the operating system (defaults to 0)
193 do_exit (const SGPropertyNode * arg)
195 SG_LOG(SG_INPUT, SG_INFO, "Program exit requested.");
196 fgSetBool("/sim/signals/exit", true);
197 globals->saveUserSettings();
198 fgOSExit(arg->getIntValue("status", 0));
204 * Reset FlightGear (Shift-Escape or Menu->File->Reset)
207 do_reset (const SGPropertyNode * arg)
218 do_switch_aircraft (const SGPropertyNode * arg)
220 fgSetString("/sim/aircraft", arg->getStringValue("aircraft"));
229 do_reposition (const SGPropertyNode * arg)
236 * Built-in command: replay the FDR buffer
239 do_replay (const SGPropertyNode * arg)
241 FGReplay *r = (FGReplay *)(globals->get_subsystem( "replay" ));
246 * Built-in command: pause/unpause the sim
249 do_pause (const SGPropertyNode * arg)
251 bool paused = fgGetBool("/sim/freeze/master",true) || fgGetBool("/sim/freeze/clock",true);
252 if (paused && (fgGetInt("/sim/freeze/replay-state",0)>0))
258 fgSetBool("/sim/freeze/master",!paused);
259 fgSetBool("/sim/freeze/clock",!paused);
262 SGPropertyNode_ptr args(new SGPropertyNode);
263 args->setStringValue("id", "sim-pause");
264 if (!paused && fgGetBool("/sim/view-name-popup")) {
265 args->setStringValue("label", "Simulation is paused");
266 globals->get_commands()->execute("show-message", args);
268 globals->get_commands()->execute("clear-message", args);
275 * Built-in command: load flight.
277 * file (optional): the name of the file to load (relative to current
278 * directory). Defaults to "fgfs.sav"
281 do_load (const SGPropertyNode * arg)
283 string file = arg->getStringValue("file", "fgfs.sav");
284 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
287 if (fgValidatePath(file, false).empty()) {
288 SG_LOG(SG_IO, SG_ALERT, "load: reading '" << file << "' denied "
289 "(unauthorized access)");
293 ifstream input(file.c_str());
294 if (input.good() && fgLoadFlight(input)) {
296 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
299 SG_LOG(SG_INPUT, SG_WARN, "Cannot load flight from " << file);
306 * Built-in command: save flight.
308 * file (optional): the name of the file to save (relative to the
309 * current directory). Defaults to "fgfs.sav".
312 do_save (const SGPropertyNode * arg)
314 string file = arg->getStringValue("file", "fgfs.sav");
315 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
318 if (fgValidatePath(file, false).empty()) {
319 SG_LOG(SG_IO, SG_ALERT, "save: writing '" << file << "' denied "
320 "(unauthorized access)");
324 bool write_all = arg->getBoolValue("write-all", false);
325 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
326 ofstream output(file.c_str());
327 if (output.good() && fgSaveFlight(output, write_all)) {
329 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
332 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
338 * Built-in command: save flight recorder tape.
342 do_save_tape (const SGPropertyNode * arg)
344 FGReplay* replay = (FGReplay*) globals->get_subsystem("replay");
345 replay->saveTape(arg);
350 * Built-in command: load flight recorder tape.
354 do_load_tape (const SGPropertyNode * arg)
356 FGReplay* replay = (FGReplay*) globals->get_subsystem("replay");
357 replay->loadTape(arg);
363 * Built-in command: (re)load the panel.
365 * path (optional): the file name to load the panel from
366 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
367 * and if that's unspecified, to "Panels/Default/default.xml".
370 do_panel_load (const SGPropertyNode * arg)
372 string panel_path = arg->getStringValue("path");
373 if (!panel_path.empty()) {
374 // write to the standard property, which will force a load
375 fgSetString("/sim/panel/path", panel_path.c_str());
382 * Built-in command: (re)load preferences.
384 * path (optional): the file name to load the panel from (relative
385 * to FG_ROOT). Defaults to "preferences.xml".
388 do_preferences_load (const SGPropertyNode * arg)
391 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
392 globals->get_props());
393 } catch (const sg_exception &e) {
394 guiErrorMessage("Error reading global preferences: ", e);
397 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
402 do_view_next(bool do_it)
404 // Only switch view if really requested to do so (and not for example while
405 // reset/reposition where /command/view/next is set to false)
408 globals->get_current_view()->setHeadingOffset_deg(0.0);
409 globals->get_viewmgr()->next_view();
414 do_view_prev(bool do_it)
418 globals->get_current_view()->setHeadingOffset_deg(0.0);
419 globals->get_viewmgr()->prev_view();
424 * An fgcommand to toggle fullscreen mode.
428 do_toggle_fullscreen(const SGPropertyNode *arg)
435 * Built-in command: cycle view.
438 do_view_cycle (const SGPropertyNode * arg)
440 globals->get_current_view()->setHeadingOffset_deg(0.0);
441 globals->get_viewmgr()->next_view();
446 * Built-in command: capture screen.
449 do_screen_capture (const SGPropertyNode * arg)
451 return fgDumpSnapShot();
455 do_reload_shaders (const SGPropertyNode*)
457 simgear::reload_shaders();
462 do_dump_scene_graph (const SGPropertyNode*)
469 do_dump_terrain_branch (const SGPropertyNode*)
471 fgDumpTerrainBranch();
473 double lon_deg = fgGetDouble("/position/longitude-deg");
474 double lat_deg = fgGetDouble("/position/latitude-deg");
475 SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
476 SGVec3d zero = SGVec3d::fromGeod(geodPos);
478 SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
479 SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
480 SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
486 do_print_visible_scene_info(const SGPropertyNode*)
488 fgPrintVisibleSceneInfoCommand();
493 * Built-in command: hires capture screen.
496 do_hires_screen_capture (const SGPropertyNode * arg)
504 * Reload the tile cache.
507 do_tile_cache_reload (const SGPropertyNode * arg)
509 SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
510 bool freeze = master_freeze->getBoolValue();
511 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
513 master_freeze->setBoolValue(true);
516 globals->get_subsystem("tile-manager")->reinit();
519 master_freeze->setBoolValue(false);
525 * Reload the materials definition
528 do_materials_reload (const SGPropertyNode * arg)
530 SG_LOG(SG_INPUT, SG_INFO, "Reloading Materials");
531 SGMaterialLib* new_matlib = new SGMaterialLib;
532 SGPath mpath( globals->get_fg_root() );
533 mpath.append( fgGetString("/sim/rendering/materials-file") );
534 bool loaded = new_matlib->load(globals->get_fg_root(),
536 globals->get_props());
539 SG_LOG( SG_GENERAL, SG_ALERT,
540 "Error loading materials file " << mpath.str() );
544 globals->set_matlib(new_matlib);
545 FGTileMgr* tileManager = static_cast<FGTileMgr*>(globals->get_subsystem("tile-manager"));
546 tileManager->materialLibChanged();
552 * Built-in command: toggle a bool property value.
554 * property: The name of the property to toggle.
557 do_property_toggle (const SGPropertyNode * arg)
559 SGPropertyNode * prop = get_prop(arg);
560 return prop->setBoolValue(!prop->getBoolValue());
565 * Built-in command: assign a value to a property.
567 * property: the name of the property to assign.
568 * value: the value to assign; or
569 * property[1]: the property to copy from.
572 do_property_assign (const SGPropertyNode * arg)
574 SGPropertyNode * prop = get_prop(arg);
575 const SGPropertyNode * value = arg->getNode("value");
578 return prop->setUnspecifiedValue(value->getStringValue());
581 const SGPropertyNode * prop2 = get_prop2(arg);
583 return prop->setUnspecifiedValue(prop2->getStringValue());
591 * Built-in command: increment or decrement a property value.
593 * If the 'step' argument is present, it will be used; otherwise,
594 * the command uses 'offset' and 'factor', usually from the mouse.
596 * property: the name of the property to increment or decrement.
597 * step: the amount of the increment or decrement (default: 0).
598 * offset: offset from the current setting (used for the mouse; multiplied
600 * factor: scaling amount for the offset (defaults to 1).
601 * min: the minimum allowed value (default: no minimum).
602 * max: the maximum allowed value (default: no maximum).
603 * mask: 'integer' to apply only to the left of the decimal point,
604 * 'decimal' to apply only to the right of the decimal point,
605 * or 'all' to apply to the whole number (the default).
606 * wrap: true if the value should be wrapped when it passes min or max;
607 * both min and max must be present for this to work (default:
611 do_property_adjust (const SGPropertyNode * arg)
613 SGPropertyNode * prop = get_prop(arg);
616 if (arg->hasValue("step"))
617 amount = arg->getDoubleValue("step");
619 amount = (arg->getDoubleValue("factor", 1)
620 * arg->getDoubleValue("offset"));
622 double unmodifiable, modifiable;
623 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
624 &unmodifiable, &modifiable);
625 modifiable += amount;
626 limit_value(&modifiable, arg);
628 prop->setDoubleValue(unmodifiable + modifiable);
635 * Built-in command: multiply a property value.
637 * property: the name of the property to multiply.
638 * factor: the amount by which to multiply.
639 * min: the minimum allowed value (default: no minimum).
640 * max: the maximum allowed value (default: no maximum).
641 * mask: 'integer' to apply only to the left of the decimal point,
642 * 'decimal' to apply only to the right of the decimal point,
643 * or 'all' to apply to the whole number (the default).
644 * wrap: true if the value should be wrapped when it passes min or max;
645 * both min and max must be present for this to work (default:
649 do_property_multiply (const SGPropertyNode * arg)
651 SGPropertyNode * prop = get_prop(arg);
652 double factor = arg->getDoubleValue("factor", 1);
654 double unmodifiable, modifiable;
655 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
656 &unmodifiable, &modifiable);
657 modifiable *= factor;
658 limit_value(&modifiable, arg);
660 prop->setDoubleValue(unmodifiable + modifiable);
667 * Built-in command: swap two property values.
669 * property[0]: the name of the first property.
670 * property[1]: the name of the second property.
673 do_property_swap (const SGPropertyNode * arg)
675 SGPropertyNode * prop1 = get_prop(arg);
676 SGPropertyNode * prop2 = get_prop2(arg);
678 // FIXME: inefficient
679 const string & tmp = prop1->getStringValue();
680 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
681 prop2->setUnspecifiedValue(tmp.c_str()));
686 * Built-in command: Set a property to an axis or other moving input.
688 * property: the name of the property to set.
689 * setting: the current input setting, usually between -1.0 and 1.0.
690 * offset: the offset to shift by, before applying the factor.
691 * factor: the factor to multiply by (use negative to reverse).
694 do_property_scale (const SGPropertyNode * arg)
696 SGPropertyNode * prop = get_prop(arg);
697 double setting = arg->getDoubleValue("setting");
698 double offset = arg->getDoubleValue("offset", 0.0);
699 double factor = arg->getDoubleValue("factor", 1.0);
700 bool squared = arg->getBoolValue("squared", false);
701 int power = arg->getIntValue("power", (squared ? 2 : 1));
703 int sign = (setting < 0 ? -1 : 1);
709 setting = setting * setting * sign;
712 setting = setting * setting * setting;
715 setting = setting * setting * setting * setting * sign;
718 setting = pow(setting, power);
719 if ((power % 2) == 0)
724 return prop->setDoubleValue((setting + offset) * factor);
729 * Built-in command: cycle a property through a set of values.
731 * If the current value isn't in the list, the cycle will
732 * (re)start from the beginning.
734 * property: the name of the property to cycle.
735 * value[*]: the list of values to cycle through.
738 do_property_cycle (const SGPropertyNode * arg)
740 SGPropertyNode * prop = get_prop(arg);
741 std::vector<SGPropertyNode_ptr> values = arg->getChildren("value");
743 bool wrap = arg->getBoolValue("wrap", true);
744 // compatible with knob/pick animations
745 int offset = arg->getIntValue("offset", 1);
748 int nSelections = values.size();
750 if (nSelections < 1) {
751 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
755 // Try to find the current selection
756 for (int i = 0; i < nSelections; i++) {
757 if (compare_values(prop, values[i])) {
763 if (selection < 0) { // default to first selection
768 selection = (selection + nSelections) % nSelections;
770 SG_CLAMP_RANGE(selection, 0, nSelections - 1);
774 prop->setUnspecifiedValue(values[selection]->getStringValue());
780 * Built-in command: randomize a numeric property value.
782 * property: the name of the property value to randomize.
783 * min: the minimum allowed value.
784 * max: the maximum allowed value.
787 do_property_randomize (const SGPropertyNode * arg)
789 SGPropertyNode * prop = get_prop(arg);
790 double min = arg->getDoubleValue("min", DBL_MIN);
791 double max = arg->getDoubleValue("max", DBL_MAX);
792 prop->setDoubleValue(sg_random() * (max - min) + min);
797 * Built-in command: interpolate a property value over time
799 * property: the name of the property value to interpolate.
800 * type: the interpolation type ("numeric", "color", etc.)
801 * easing: name of easing function (see http://easings.net/)
802 * value[0..n] any number of constant values to interpolate
803 * time/rate[0..n] time between each value, number of time elements must
804 * match those of value elements. Instead of time also rate can
805 * be used which automatically calculates the time to change
806 * the property value at the given speed.
808 * property[1..n+1] any number of target values taken from named properties
809 * time/rate[0..n] time between each value, number of time elements must
810 * match those of value elements. Instead of time also rate can
811 * be used which automatically calculates the time to change
812 * the property value at the given speed.
815 do_property_interpolate (const SGPropertyNode * arg)
817 SGPropertyNode * prop = get_prop(arg);
821 simgear::PropertyList time_nodes = arg->getChildren("time");
822 simgear::PropertyList rate_nodes = arg->getChildren("rate");
824 if( !time_nodes.empty() && !rate_nodes.empty() )
825 // mustn't specify time and rate
828 simgear::PropertyList::size_type num_times = time_nodes.empty()
832 simgear::PropertyList value_nodes = arg->getChildren("value");
833 if( value_nodes.empty() )
835 simgear::PropertyList prop_nodes = arg->getChildren("property");
837 // must have one more property node
838 if( prop_nodes.size() != num_times + 1 )
841 value_nodes.reserve(num_times);
842 for( size_t i = 1; i < prop_nodes.size(); ++i )
843 value_nodes.push_back( fgGetNode(prop_nodes[i]->getStringValue()) );
847 if( value_nodes.size() != num_times )
851 deltas.reserve(num_times);
853 if( !time_nodes.empty() )
855 for( size_t i = 0; i < num_times; ++i )
856 deltas.push_back( time_nodes[i]->getDoubleValue() );
860 for( size_t i = 0; i < num_times; ++i )
862 // TODO calculate delta based on property type
863 double delta = value_nodes[i]->getDoubleValue()
865 ? value_nodes[i - 1]->getDoubleValue()
866 : prop->getDoubleValue()
868 deltas.push_back( fabs(delta / rate_nodes[i]->getDoubleValue()) );
872 return prop->interpolate
874 arg->getStringValue("type", "numeric"),
877 arg->getStringValue("easing", "linear")
882 * Built-in command: reinit the data logging system based on the
883 * current contents of the /logger tree.
886 do_data_logging_commit (const SGPropertyNode * arg)
888 FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
894 * Built-in command: Add a dialog to the GUI system. Does *not*
895 * display the dialog. The property node should have the same format
896 * as a dialog XML configuration. It must include:
898 * name: the name of the GUI dialog for future reference.
901 do_dialog_new (const SGPropertyNode * arg)
903 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
908 // Note the casting away of const: this is *real*. Doing a
909 // "dialog-apply" command later on will mutate this property node.
910 // I'm not convinced that this isn't the Right Thing though; it
911 // allows client to create a node, pass it to dialog-new, and get
912 // the values back from the dialog by reading the same node.
913 // Perhaps command arguments are not as "const" as they would
915 gui->newDialog((SGPropertyNode*)arg);
920 * Built-in command: Show an XML-configured dialog.
922 * dialog-name: the name of the GUI dialog to display.
925 do_dialog_show (const SGPropertyNode * arg)
927 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
928 gui->showDialog(arg->getStringValue("dialog-name"));
934 * Built-in Command: Hide the active XML-configured dialog.
937 do_dialog_close (const SGPropertyNode * arg)
939 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
940 if(arg->hasValue("dialog-name"))
941 return gui->closeDialog(arg->getStringValue("dialog-name"));
942 return gui->closeActiveDialog();
947 * Update a value in the active XML-configured dialog.
949 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
952 do_dialog_update (const SGPropertyNode * arg)
954 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
956 if (arg->hasValue("dialog-name"))
957 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
959 dialog = gui->getActiveDialog();
962 dialog->updateValues(arg->getStringValue("object-name"));
970 do_open_browser (const SGPropertyNode * arg)
973 if (arg->hasValue("path"))
974 path = arg->getStringValue("path");
976 if (arg->hasValue("url"))
977 path = arg->getStringValue("url");
981 return openBrowser(path);
985 * Apply a value in the active XML-configured dialog.
987 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
990 do_dialog_apply (const SGPropertyNode * arg)
992 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
994 if (arg->hasValue("dialog-name"))
995 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
997 dialog = gui->getActiveDialog();
1000 dialog->applyValues(arg->getStringValue("object-name"));
1009 * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1013 do_gui_redraw (const SGPropertyNode * arg)
1015 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1022 * Adds model to the scenery. The path to the added branch (/models/model[*])
1023 * is returned in property "property".
1026 do_add_model (const SGPropertyNode * arg)
1028 SGPropertyNode * model = fgGetNode("models", true);
1030 for (i = 0; model->hasChild("model",i); i++);
1031 model = model->getChild("model", i, true);
1032 copyProperties(arg, model);
1033 if (model->hasValue("elevation-m"))
1034 model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1035 * SG_METER_TO_FEET);
1036 model->getNode("load", true);
1037 model->removeChildren("load");
1038 const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1043 * Built-in command: play an audio message (i.e. a wav file) This is
1044 * fire and forget. Call this once per message and it will get dumped
1045 * into a queue. Messages are played sequentially so they do not
1049 do_play_audio_sample (const SGPropertyNode * arg)
1051 SGSoundMgr *smgr = globals->get_soundmgr();
1053 SG_LOG(SG_GENERAL, SG_WARN, "play-audio-sample: sound-manager not running");
1057 string path = arg->getStringValue("path");
1058 string file = arg->getStringValue("file");
1059 float volume = arg->getFloatValue("volume");
1060 // cout << "playing " << path << " / " << file << endl;
1062 FGSampleQueue *queue = globals->get_chatter_queue();
1064 queue = new FGSampleQueue(smgr, "chatter");
1065 queue->tie_to_listener();
1066 globals->set_chatter_queue(queue);
1069 SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1070 msg->set_volume( volume );
1075 } catch (const sg_io_exception&) {
1076 SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1077 "failed to load" << path << '/' << file);
1083 * Built-in command: commit presets (read from in /sim/presets/)
1086 do_presets_commit (const SGPropertyNode * arg)
1088 if (fgGetBool("/sim/initialized", false)) {
1091 // Nasal can trigger this during initial init, which confuses
1092 // the logic in ReInitSubsystems, since initial state has not been
1093 // saved at that time. Short-circuit everything here.
1094 flightgear::initPosition();
1101 * Built-in command: set log level (0 ... 7)
1104 do_log_level (const SGPropertyNode * arg)
1106 sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1113 do_decrease_visibility (const SGPropertyNode * arg)
1115 Environment::Presets::VisibilitySingleton::instance()->adjust( 0.9 );
1120 do_increase_visibility (const SGPropertyNode * arg)
1122 Environment::Presets::VisibilitySingleton::instance()->adjust( 1.1 );
1127 * An fgcommand to allow loading of xml files via nasal,
1128 * the xml file's structure will be made available within
1129 * a property tree node defined under argument "targetnode",
1130 * or in the given argument tree under "data" otherwise.
1132 * @param filename a string to hold the complete path & filename of an XML file
1133 * @param targetnode a string pointing to a location within the property tree
1134 * where to store the parsed XML file. If <targetnode> is undefined, then the
1135 * file contents are stored under a node <data> in the argument tree.
1139 do_load_xml_to_proptree(const SGPropertyNode * arg)
1141 SGPath file(arg->getStringValue("filename"));
1142 if (file.str().empty())
1145 if (file.extension() != "xml")
1146 file.concat(".xml");
1148 std::string icao = arg->getStringValue("icao");
1150 if (file.isRelative()) {
1151 SGPath absPath = globals->resolve_maybe_aircraft_path(file.str());
1152 if (!absPath.isNull())
1156 SG_LOG(SG_IO, SG_ALERT, "loadxml: Cannot find XML property file '"
1157 << file.str() << "'.");
1162 if (!XMLLoader::findAirportData(icao, file.str(), file)) {
1163 SG_LOG(SG_IO, SG_INFO, "loadxml: failed to find airport data for "
1164 << file.str() << " at ICAO:" << icao);
1169 if (fgValidatePath(file, false).empty()) {
1170 SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1171 "(unauthorized access)");
1175 SGPropertyNode *targetnode;
1176 if (arg->hasValue("targetnode"))
1177 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1179 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1182 readProperties(file.c_str(), targetnode, true);
1183 } catch (const sg_exception &e) {
1184 SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1192 do_load_xml_from_url(const SGPropertyNode * arg)
1194 FGHTTPClient* http = static_cast<FGHTTPClient*>(globals->get_subsystem("http"));
1196 SG_LOG(SG_IO, SG_ALERT, "xmlhttprequest: HTTP client not running");
1200 std::string url(arg->getStringValue("url"));
1204 SGPropertyNode *targetnode;
1205 if (arg->hasValue("targetnode"))
1206 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1208 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1210 RemoteXMLRequest* req = new RemoteXMLRequest(url, targetnode);
1212 if (arg->hasChild("body"))
1213 req->setBodyData(arg->getChild("body"));
1215 // connect up optional reporting properties
1216 if (arg->hasValue("complete"))
1217 req->setCompletionProp(fgGetNode(arg->getStringValue("complete"), true));
1218 if (arg->hasValue("failure"))
1219 req->setFailedProp(fgGetNode(arg->getStringValue("failure"), true));
1220 if (arg->hasValue("status"))
1221 req->setStatusProp(fgGetNode(arg->getStringValue("status"), true));
1223 http->makeRequest(req);
1229 * An fgcommand to allow saving of xml files via nasal,
1230 * the file's structure will be determined based on what's
1231 * encountered in the passed (source) property tree node
1233 * @param filename a string to hold the complete path & filename of the (new)
1235 * @param sourcenode a string pointing to a location within the property tree
1236 * where to find the nodes that should be written recursively into an XML file
1237 * @param data if no sourcenode is given, then the file contents are taken from
1238 * the argument tree's "data" node.
1242 do_save_xml_from_proptree(const SGPropertyNode * arg)
1244 SGPath file(arg->getStringValue("filename"));
1245 if (file.str().empty())
1248 if (file.extension() != "xml")
1249 file.concat(".xml");
1251 if (fgValidatePath(file, true).empty()) {
1252 SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1253 "(unauthorized access)");
1257 SGPropertyNode *sourcenode;
1258 if (arg->hasValue("sourcenode"))
1259 sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1260 else if (arg->getNode("data", false))
1261 sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1266 writeProperties (file.c_str(), sourcenode, true);
1267 } catch (const sg_exception &e) {
1268 SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1276 do_press_cockpit_button (const SGPropertyNode *arg)
1278 const char *prefix = arg->getStringValue("prefix");
1280 if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1283 string prop = string(prefix) + "-button";
1286 if (arg->getBoolValue("latching"))
1287 value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1291 fgSetDouble(prop.c_str(), value);
1292 fgSetBool(arg->getStringValue("discrete"), value > 0);
1298 do_release_cockpit_button (const SGPropertyNode *arg)
1300 const char *prefix = arg->getStringValue("prefix");
1302 if (arg->getBoolValue("guarded")) {
1303 string prop = string(prefix) + "-guard";
1304 if (fgGetDouble(prop.c_str()) < 1) {
1305 fgSetDouble(prop.c_str(), 1);
1310 if (! arg->getBoolValue("latching")) {
1311 fgSetDouble((string(prefix) + "-button").c_str(), 0);
1312 fgSetBool(arg->getStringValue("discrete"), false);
1318 // Optional profiling commands using gperftools:
1319 // http://code.google.com/p/gperftools/
1321 #if !FG_HAVE_GPERFTOOLS
1323 no_profiling_support()
1329 "No profiling support! Install gperftools and reconfigure/rebuild fgfs."
1335 do_profiler_start(const SGPropertyNode *arg)
1337 #if FG_HAVE_GPERFTOOLS
1338 const char *filename = arg->getStringValue("filename", "fgfs.profile");
1339 ProfilerStart(filename);
1342 no_profiling_support();
1348 do_profiler_stop(const SGPropertyNode *arg)
1350 #if FG_HAVE_GPERFTOOLS
1354 no_profiling_support();
1361 do_set_scenery_paths(const SGPropertyNode* arg)
1363 SGPropertyNode* sim = fgGetNode("/sim", true);
1364 sim->removeChildren("fg-scenery");
1366 globals->clear_fg_scenery();
1368 std::string terrasyncPath(fgGetString("/sim/terrasync/scenery-dir"));
1369 bool seenTerrasyncPath = false;
1371 simgear::PropertyList paths = arg->getChildren("path");
1372 for (size_t i = 0; i < paths.size(); ++i) {
1373 std::string s = paths[i]->getStringValue();
1374 if (s == terrasyncPath) {
1375 seenTerrasyncPath = true;
1378 globals->append_fg_scenery(s);
1381 if (fgGetBool("/sim/terrasync/enabled") && !seenTerrasyncPath) {
1382 globals->append_fg_scenery(terrasyncPath);
1385 if (paths.empty()) {
1386 // no scenery paths set *at all*, use the data in FG_ROOT
1387 SGPath root(globals->get_fg_root());
1388 root.append("Scenery");
1389 globals->append_fg_scenery(root.str());
1392 // might need to drop ground-nets from the DB. Also need to drop
1393 // them from memory, but this is tricky since FGAirportDynamics holds
1394 // an instance directly, and AI code may have pointers to ground-net
1395 // nodes. For now we'll leave-in memory versions untouched.
1396 flightgear::NavDataCache::instance()->dropGroundnetsIfRequired();
1401 ////////////////////////////////////////////////////////////////////////
1403 ////////////////////////////////////////////////////////////////////////
1407 * Table of built-in commands.
1409 * New commands do not have to be added here; any module in the application
1410 * can add a new command using globals->get_commands()->addCommand(...).
1414 SGCommandMgr::command_t command;
1416 { "null", do_null },
1417 { "nasal", do_nasal },
1418 { "exit", do_exit },
1419 { "reset", do_reset },
1420 { "reposition", do_reposition },
1421 { "switch-aircraft", do_switch_aircraft },
1422 { "pause", do_pause },
1423 { "load", do_load },
1424 { "save", do_save },
1425 { "save-tape", do_save_tape },
1426 { "load-tape", do_load_tape },
1427 { "panel-load", do_panel_load },
1428 { "preferences-load", do_preferences_load },
1429 { "toggle-fullscreen", do_toggle_fullscreen },
1430 { "view-cycle", do_view_cycle },
1431 { "screen-capture", do_screen_capture },
1432 { "hires-screen-capture", do_hires_screen_capture },
1433 { "tile-cache-reload", do_tile_cache_reload },
1435 { "set-sea-level-air-temp-degc", do_set_sea_level_degc },
1436 { "set-outside-air-temp-degc", do_set_oat_degc },
1437 { "set-dewpoint-sea-level-air-temp-degc", do_set_dewpoint_sea_level_degc },
1438 { "set-dewpoint-temp-degc", do_set_dewpoint_degc },
1440 { "property-toggle", do_property_toggle },
1441 { "property-assign", do_property_assign },
1442 { "property-adjust", do_property_adjust },
1443 { "property-multiply", do_property_multiply },
1444 { "property-swap", do_property_swap },
1445 { "property-scale", do_property_scale },
1446 { "property-cycle", do_property_cycle },
1447 { "property-randomize", do_property_randomize },
1448 { "property-interpolate", do_property_interpolate },
1449 { "data-logging-commit", do_data_logging_commit },
1450 { "dialog-new", do_dialog_new },
1451 { "dialog-show", do_dialog_show },
1452 { "dialog-close", do_dialog_close },
1453 { "dialog-update", do_dialog_update },
1454 { "dialog-apply", do_dialog_apply },
1455 { "open-browser", do_open_browser },
1456 { "gui-redraw", do_gui_redraw },
1457 { "add-model", do_add_model },
1458 { "play-audio-sample", do_play_audio_sample },
1459 { "presets-commit", do_presets_commit },
1460 { "log-level", do_log_level },
1461 { "replay", do_replay },
1463 { "decrease-visibility", do_decrease_visibility },
1464 { "increase-visibility", do_increase_visibility },
1466 { "loadxml", do_load_xml_to_proptree},
1467 { "savexml", do_save_xml_from_proptree },
1468 { "xmlhttprequest", do_load_xml_from_url },
1469 { "press-cockpit-button", do_press_cockpit_button },
1470 { "release-cockpit-button", do_release_cockpit_button },
1471 { "dump-scenegraph", do_dump_scene_graph },
1472 { "dump-terrainbranch", do_dump_terrain_branch },
1473 { "print-visible-scene", do_print_visible_scene_info },
1474 { "reload-shaders", do_reload_shaders },
1475 { "reload-materials", do_materials_reload },
1476 { "set-scenery-paths", do_set_scenery_paths },
1478 { "profiler-start", do_profiler_start },
1479 { "profiler-stop", do_profiler_stop },
1481 { 0, 0 } // zero-terminated
1486 * Initialize the default built-in commands.
1488 * Other commands may be added by other parts of the application.
1493 SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1494 for (int i = 0; built_ins[i].name != 0; i++) {
1495 SG_LOG(SG_GENERAL, SG_BULK, " " << built_ins[i].name);
1496 globals->get_commands()->addCommand(built_ins[i].name,
1497 built_ins[i].command);
1500 typedef bool (*dummy)();
1501 fgTie( "/command/view/next", dummy(0), do_view_next );
1502 fgTie( "/command/view/prev", dummy(0), do_view_prev );
1504 globals->get_props()->setValueReadOnly( "/sim/debug/profiler-available",
1505 bool(FG_HAVE_GPERFTOOLS) );
1508 // end of fg_commands.cxx