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 <simgear/misc/interpolator.hxx>
27 #include <simgear/io/HTTPRequest.hxx>
29 #include <FDM/flight.hxx>
31 #include <GUI/new_gui.hxx>
32 #include <GUI/dialog.hxx>
33 #include <Aircraft/replay.hxx>
34 #include <Scenery/scenery.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>
43 #include "fg_init.hxx"
46 #include "fg_commands.hxx"
47 #include "fg_props.hxx"
48 #include "globals.hxx"
52 #include "positioninit.hxx"
54 #include <boost/scoped_array.hpp>
62 ////////////////////////////////////////////////////////////////////////
63 // Static helper functions.
64 ////////////////////////////////////////////////////////////////////////
67 static inline SGPropertyNode *
68 get_prop (const SGPropertyNode * arg)
70 return fgGetNode(arg->getStringValue("property[0]", "/null"), true);
73 static inline SGPropertyNode *
74 get_prop2 (const SGPropertyNode * arg)
76 return fgGetNode(arg->getStringValue("property[1]", "/null"), true);
81 * Get a double value and split it as required.
84 split_value (double full_value, const char * mask,
85 double * unmodifiable, double * modifiable)
87 if (!strcmp("integer", mask)) {
88 *modifiable = (full_value < 0 ? ceil(full_value) : floor (full_value));
89 *unmodifiable = full_value - *modifiable;
90 } else if (!strcmp("decimal", mask)) {
91 *unmodifiable = (full_value < 0 ? ceil(full_value) : floor(full_value));
92 *modifiable = full_value - *unmodifiable;
94 if (strcmp("all", mask))
95 SG_LOG(SG_GENERAL, SG_ALERT, "Bad value " << mask << " for mask;"
96 << " assuming 'all'");
98 *modifiable = full_value;
104 * Clamp or wrap a value as specified.
107 limit_value (double * value, const SGPropertyNode * arg)
109 const SGPropertyNode * min_node = arg->getChild("min");
110 const SGPropertyNode * max_node = arg->getChild("max");
112 bool wrap = arg->getBoolValue("wrap");
114 if (min_node == 0 || max_node == 0)
117 if (wrap) { // wrap such that min <= x < max
118 double min_val = min_node->getDoubleValue();
119 double max_val = max_node->getDoubleValue();
120 double resolution = arg->getDoubleValue("resolution");
121 if (resolution > 0.0) {
122 // snap to (min + N*resolution), taking special care to handle imprecision
123 int n = (int)floor((*value - min_val) / resolution + 0.5);
124 int steps = (int)floor((max_val - min_val) / resolution + 0.5);
125 SG_NORMALIZE_RANGE(n, 0, steps);
126 *value = min_val + resolution * n;
128 // plain circular wrapping
129 SG_NORMALIZE_RANGE(*value, min_val, max_val);
131 } else { // clamp such that min <= x <= max
132 if ((min_node != 0) && (*value < min_node->getDoubleValue()))
133 *value = min_node->getDoubleValue();
134 else if ((max_node != 0) && (*value > max_node->getDoubleValue()))
135 *value = max_node->getDoubleValue();
140 compare_values (SGPropertyNode * value1, SGPropertyNode * value2)
142 switch (value1->getType()) {
143 case simgear::props::BOOL:
144 return (value1->getBoolValue() == value2->getBoolValue());
145 case simgear::props::INT:
146 return (value1->getIntValue() == value2->getIntValue());
147 case simgear::props::LONG:
148 return (value1->getLongValue() == value2->getLongValue());
149 case simgear::props::FLOAT:
150 return (value1->getFloatValue() == value2->getFloatValue());
151 case simgear::props::DOUBLE:
152 return (value1->getDoubleValue() == value2->getDoubleValue());
154 return !strcmp(value1->getStringValue(), value2->getStringValue());
160 ////////////////////////////////////////////////////////////////////////
161 // Command implementations.
162 ////////////////////////////////////////////////////////////////////////
166 * Built-in command: do nothing.
169 do_null (const SGPropertyNode * arg)
175 * Built-in command: run a Nasal script.
178 do_nasal (const SGPropertyNode * arg)
180 return ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(arg);
184 * Built-in command: exit FlightGear.
186 * status: the exit status to return to the operating system (defaults to 0)
189 do_exit (const SGPropertyNode * arg)
191 SG_LOG(SG_INPUT, SG_INFO, "Program exit requested.");
192 fgSetBool("/sim/signals/exit", true);
193 globals->saveUserSettings();
194 fgOSExit(arg->getIntValue("status", 0));
200 * Reset FlightGear (Shift-Escape or Menu->File->Reset)
203 do_reset (const SGPropertyNode * arg)
205 fgReInitSubsystems();
210 * Built-in command: replay the FDR buffer
213 do_replay (const SGPropertyNode * arg)
215 FGReplay *r = (FGReplay *)(globals->get_subsystem( "replay" ));
220 * Built-in command: pause/unpause the sim
223 do_pause (const SGPropertyNode * arg)
225 bool paused = fgGetBool("/sim/freeze/master",true) || fgGetBool("/sim/freeze/clock",true);
226 if (paused && (fgGetInt("/sim/freeze/replay-state",0)>0))
232 fgSetBool("/sim/freeze/master",!paused);
233 fgSetBool("/sim/freeze/clock",!paused);
239 * Built-in command: load flight.
241 * file (optional): the name of the file to load (relative to current
242 * directory). Defaults to "fgfs.sav"
245 do_load (const SGPropertyNode * arg)
247 string file = arg->getStringValue("file", "fgfs.sav");
248 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
251 if (!fgValidatePath(file.c_str(), false)) {
252 SG_LOG(SG_IO, SG_ALERT, "load: reading '" << file << "' denied "
253 "(unauthorized access)");
257 ifstream input(file.c_str());
258 if (input.good() && fgLoadFlight(input)) {
260 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
263 SG_LOG(SG_INPUT, SG_WARN, "Cannot load flight from " << file);
270 * Built-in command: save flight.
272 * file (optional): the name of the file to save (relative to the
273 * current directory). Defaults to "fgfs.sav".
276 do_save (const SGPropertyNode * arg)
278 string file = arg->getStringValue("file", "fgfs.sav");
279 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
282 if (!fgValidatePath(file.c_str(), false)) {
283 SG_LOG(SG_IO, SG_ALERT, "save: writing '" << file << "' denied "
284 "(unauthorized access)");
288 bool write_all = arg->getBoolValue("write-all", false);
289 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
290 ofstream output(file.c_str());
291 if (output.good() && fgSaveFlight(output, write_all)) {
293 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
296 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
302 * Built-in command: save flight recorder tape.
306 do_save_tape (const SGPropertyNode * arg)
308 FGReplay* replay = (FGReplay*) globals->get_subsystem("replay");
309 replay->saveTape(arg);
314 * Built-in command: load flight recorder tape.
318 do_load_tape (const SGPropertyNode * arg)
320 FGReplay* replay = (FGReplay*) globals->get_subsystem("replay");
321 replay->loadTape(arg);
327 * Built-in command: (re)load the panel.
329 * path (optional): the file name to load the panel from
330 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
331 * and if that's unspecified, to "Panels/Default/default.xml".
334 do_panel_load (const SGPropertyNode * arg)
336 string panel_path = arg->getStringValue("path");
337 if (!panel_path.empty()) {
338 // write to the standard property, which will force a load
339 fgSetString("/sim/panel/path", panel_path.c_str());
346 * Built-in command: (re)load preferences.
348 * path (optional): the file name to load the panel from (relative
349 * to FG_ROOT). Defaults to "preferences.xml".
352 do_preferences_load (const SGPropertyNode * arg)
355 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
356 globals->get_props());
357 } catch (const sg_exception &e) {
358 guiErrorMessage("Error reading global preferences: ", e);
361 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
368 globals->get_current_view()->setHeadingOffset_deg(0.0);
369 globals->get_viewmgr()->next_view();
375 globals->get_current_view()->setHeadingOffset_deg(0.0);
376 globals->get_viewmgr()->prev_view();
380 * Built-in command: cycle view.
383 do_view_cycle (const SGPropertyNode * arg)
385 globals->get_current_view()->setHeadingOffset_deg(0.0);
386 globals->get_viewmgr()->next_view();
391 * Built-in command: capture screen.
394 do_screen_capture (const SGPropertyNode * arg)
396 return fgDumpSnapShot();
400 do_reload_shaders (const SGPropertyNode*)
402 simgear::reload_shaders();
407 do_dump_scene_graph (const SGPropertyNode*)
414 do_dump_terrain_branch (const SGPropertyNode*)
416 fgDumpTerrainBranch();
418 double lon_deg = fgGetDouble("/position/longitude-deg");
419 double lat_deg = fgGetDouble("/position/latitude-deg");
420 SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
421 SGVec3d zero = SGVec3d::fromGeod(geodPos);
423 SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
424 SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
425 SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
431 do_print_visible_scene_info(const SGPropertyNode*)
433 fgPrintVisibleSceneInfoCommand();
438 * Built-in command: hires capture screen.
441 do_hires_screen_capture (const SGPropertyNode * arg)
449 * Reload the tile cache.
452 do_tile_cache_reload (const SGPropertyNode * arg)
454 static const SGPropertyNode *master_freeze
455 = fgGetNode("/sim/freeze/master");
456 bool freeze = master_freeze->getBoolValue();
457 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
459 fgSetBool("/sim/freeze/master", true);
462 globals->get_subsystem("tile-manager")->reinit();
465 fgSetBool("/sim/freeze/master", false);
471 * Reload the materials definition
474 do_materials_reload (const SGPropertyNode * arg)
476 SG_LOG(SG_INPUT, SG_INFO, "Reloading Materials");
477 SGMaterialLib* new_matlib = new SGMaterialLib;
478 SGPath mpath( globals->get_fg_root() );
479 mpath.append( fgGetString("/sim/rendering/materials-file") );
480 bool loaded = new_matlib->load(globals->get_fg_root(),
482 globals->get_props());
485 SG_LOG( SG_GENERAL, SG_ALERT,
486 "Error loading materials file " << mpath.str() );
490 globals->set_matlib(new_matlib);
496 These do_set_(some-environment-parameters) are deprecated and no longer
497 useful/functional - Torsten Dreyer, January 2011
499 * Set the sea level outside air temperature and assigning that to all
500 * boundary and aloft environment layers.
503 do_set_sea_level_degc ( double temp_sea_level_degc)
505 SGPropertyNode *node, *child;
508 node = fgGetNode( "/environment/config/boundary" );
509 if ( node != NULL ) {
511 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
512 child->setDoubleValue( "temperature-sea-level-degc",
513 temp_sea_level_degc );
519 node = fgGetNode( "/environment/config/aloft" );
520 if ( node != NULL ) {
522 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
523 child->setDoubleValue( "temperature-sea-level-degc",
524 temp_sea_level_degc );
533 do_set_sea_level_degc (const SGPropertyNode * arg)
535 return do_set_sea_level_degc( arg->getDoubleValue("temp-degc", 15.0) );
540 * Set the outside air temperature at the "current" altitude by first
541 * calculating the corresponding sea level temp, and assigning that to
542 * all boundary and aloft environment layers.
545 do_set_oat_degc (const SGPropertyNode * arg)
547 double oat_degc = arg->getDoubleValue("temp-degc", 15.0);
548 // check for an altitude specified in the arguments, otherwise use
549 // current aircraft altitude.
550 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
551 if ( altitude_ft == NULL ) {
552 altitude_ft = fgGetNode("/position/altitude-ft");
555 FGEnvironment dummy; // instantiate a dummy so we can leech a method
556 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
557 dummy.set_temperature_degc( oat_degc );
558 return do_set_sea_level_degc( dummy.get_temperature_sea_level_degc());
562 * Set the sea level outside air dewpoint and assigning that to all
563 * boundary and aloft environment layers.
566 do_set_dewpoint_sea_level_degc (double dewpoint_sea_level_degc)
569 SGPropertyNode *node, *child;
572 node = fgGetNode( "/environment/config/boundary" );
573 if ( node != NULL ) {
575 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
576 child->setDoubleValue( "dewpoint-sea-level-degc",
577 dewpoint_sea_level_degc );
583 node = fgGetNode( "/environment/config/aloft" );
584 if ( node != NULL ) {
586 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
587 child->setDoubleValue( "dewpoint-sea-level-degc",
588 dewpoint_sea_level_degc );
597 do_set_dewpoint_sea_level_degc (const SGPropertyNode * arg)
599 return do_set_dewpoint_sea_level_degc(arg->getDoubleValue("dewpoint-degc", 5.0));
603 * Set the outside air dewpoint at the "current" altitude by first
604 * calculating the corresponding sea level dewpoint, and assigning
605 * that to all boundary and aloft environment layers.
608 do_set_dewpoint_degc (const SGPropertyNode * arg)
610 double dewpoint_degc = arg->getDoubleValue("dewpoint-degc", 5.0);
612 // check for an altitude specified in the arguments, otherwise use
613 // current aircraft altitude.
614 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
615 if ( altitude_ft == NULL ) {
616 altitude_ft = fgGetNode("/position/altitude-ft");
619 FGEnvironment dummy; // instantiate a dummy so we can leech a method
620 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
621 dummy.set_dewpoint_degc( dewpoint_degc );
622 return do_set_dewpoint_sea_level_degc(dummy.get_dewpoint_sea_level_degc());
627 * Built-in command: toggle a bool property value.
629 * property: The name of the property to toggle.
632 do_property_toggle (const SGPropertyNode * arg)
634 SGPropertyNode * prop = get_prop(arg);
635 return prop->setBoolValue(!prop->getBoolValue());
640 * Built-in command: assign a value to a property.
642 * property: the name of the property to assign.
643 * value: the value to assign; or
644 * property[1]: the property to copy from.
647 do_property_assign (const SGPropertyNode * arg)
649 SGPropertyNode * prop = get_prop(arg);
650 const SGPropertyNode * value = arg->getNode("value");
653 return prop->setUnspecifiedValue(value->getStringValue());
656 const SGPropertyNode * prop2 = get_prop2(arg);
658 return prop->setUnspecifiedValue(prop2->getStringValue());
666 * Built-in command: increment or decrement a property value.
668 * If the 'step' argument is present, it will be used; otherwise,
669 * the command uses 'offset' and 'factor', usually from the mouse.
671 * property: the name of the property to increment or decrement.
672 * step: the amount of the increment or decrement (default: 0).
673 * offset: offset from the current setting (used for the mouse; multiplied
675 * factor: scaling amount for the offset (defaults to 1).
676 * min: the minimum allowed value (default: no minimum).
677 * max: the maximum allowed value (default: no maximum).
678 * mask: 'integer' to apply only to the left of the decimal point,
679 * 'decimal' to apply only to the right of the decimal point,
680 * or 'all' to apply to the whole number (the default).
681 * wrap: true if the value should be wrapped when it passes min or max;
682 * both min and max must be present for this to work (default:
686 do_property_adjust (const SGPropertyNode * arg)
688 SGPropertyNode * prop = get_prop(arg);
691 if (arg->hasValue("step"))
692 amount = arg->getDoubleValue("step");
694 amount = (arg->getDoubleValue("factor", 1)
695 * arg->getDoubleValue("offset"));
697 double unmodifiable, modifiable;
698 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
699 &unmodifiable, &modifiable);
700 modifiable += amount;
701 limit_value(&modifiable, arg);
703 prop->setDoubleValue(unmodifiable + modifiable);
710 * Built-in command: multiply a property value.
712 * property: the name of the property to multiply.
713 * factor: the amount by which to multiply.
714 * min: the minimum allowed value (default: no minimum).
715 * max: the maximum allowed value (default: no maximum).
716 * mask: 'integer' to apply only to the left of the decimal point,
717 * 'decimal' to apply only to the right of the decimal point,
718 * or 'all' to apply to the whole number (the default).
719 * wrap: true if the value should be wrapped when it passes min or max;
720 * both min and max must be present for this to work (default:
724 do_property_multiply (const SGPropertyNode * arg)
726 SGPropertyNode * prop = get_prop(arg);
727 double factor = arg->getDoubleValue("factor", 1);
729 double unmodifiable, modifiable;
730 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
731 &unmodifiable, &modifiable);
732 modifiable *= factor;
733 limit_value(&modifiable, arg);
735 prop->setDoubleValue(unmodifiable + modifiable);
742 * Built-in command: swap two property values.
744 * property[0]: the name of the first property.
745 * property[1]: the name of the second property.
748 do_property_swap (const SGPropertyNode * arg)
750 SGPropertyNode * prop1 = get_prop(arg);
751 SGPropertyNode * prop2 = get_prop2(arg);
753 // FIXME: inefficient
754 const string & tmp = prop1->getStringValue();
755 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
756 prop2->setUnspecifiedValue(tmp.c_str()));
761 * Built-in command: Set a property to an axis or other moving input.
763 * property: the name of the property to set.
764 * setting: the current input setting, usually between -1.0 and 1.0.
765 * offset: the offset to shift by, before applying the factor.
766 * factor: the factor to multiply by (use negative to reverse).
769 do_property_scale (const SGPropertyNode * arg)
771 SGPropertyNode * prop = get_prop(arg);
772 double setting = arg->getDoubleValue("setting");
773 double offset = arg->getDoubleValue("offset", 0.0);
774 double factor = arg->getDoubleValue("factor", 1.0);
775 bool squared = arg->getBoolValue("squared", false);
776 int power = arg->getIntValue("power", (squared ? 2 : 1));
778 int sign = (setting < 0 ? -1 : 1);
784 setting = setting * setting * sign;
787 setting = setting * setting * setting;
790 setting = setting * setting * setting * setting * sign;
793 setting = pow(setting, power);
794 if ((power % 2) == 0)
799 return prop->setDoubleValue((setting + offset) * factor);
804 * Built-in command: cycle a property through a set of values.
806 * If the current value isn't in the list, the cycle will
807 * (re)start from the beginning.
809 * property: the name of the property to cycle.
810 * value[*]: the list of values to cycle through.
813 do_property_cycle (const SGPropertyNode * arg)
815 SGPropertyNode * prop = get_prop(arg);
816 vector<SGPropertyNode_ptr> values = arg->getChildren("value");
818 int nSelections = values.size();
820 if (nSelections < 1) {
821 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
825 // Try to find the current selection
826 for (int i = 0; i < nSelections; i++) {
827 if (compare_values(prop, values[i])) {
833 // Default or wrap to the first selection
834 if (selection < 0 || selection >= nSelections)
837 prop->setUnspecifiedValue(values[selection]->getStringValue());
843 * Built-in command: randomize a numeric property value.
845 * property: the name of the property value to randomize.
846 * min: the minimum allowed value.
847 * max: the maximum allowed value.
850 do_property_randomize (const SGPropertyNode * arg)
852 SGPropertyNode * prop = get_prop(arg);
853 double min = arg->getDoubleValue("min", DBL_MIN);
854 double max = arg->getDoubleValue("max", DBL_MAX);
855 prop->setDoubleValue(sg_random() * (max - min) + min);
860 * Built-in command: interpolate a property value over time
862 * property: the name of the property value to interpolate.
863 * value[0..n] any number of constant values to interpolate
864 * time/rate[0..n] time between each value, number of time elements must
865 * match those of value elements. Instead of time also rate can
866 * be used which automatically calculates the time to change
867 * the property value at the given speed.
869 * property[1..n] any number of target values taken from named properties
870 * time/rate[0..n] time between each value, number of time elements must
871 * match those of value elements. Instead of time also rate can
872 * be used which automatically calculates the time to change
873 * the property value at the given speed.
876 do_property_interpolate (const SGPropertyNode * arg)
878 SGPropertyNode * prop = get_prop(arg);
880 simgear::PropertyList valueNodes = arg->getChildren( "value" );
881 simgear::PropertyList timeNodes = arg->getChildren( "time" );
882 simgear::PropertyList rateNodes = arg->getChildren( "rate" );
884 if( !timeNodes.empty() && !rateNodes.empty() )
885 // mustn't specify time and rate
888 simgear::PropertyList::size_type num_times = timeNodes.empty()
892 boost::scoped_array<double> value;
893 boost::scoped_array<double> time;
895 if( valueNodes.size() > 0 ) {
897 if( num_times != valueNodes.size() )
900 value.reset( new double[valueNodes.size()] );
901 for( simgear::PropertyList::size_type n = 0; n < valueNodes.size(); n++ ) {
902 value[n] = valueNodes[n]->getDoubleValue();
905 valueNodes = arg->getChildren("property");
906 // must have one more property node
907 if( valueNodes.size() - 1 != num_times )
910 value.reset( new double[valueNodes.size()-1] );
911 for( simgear::PropertyList::size_type n = 0; n < valueNodes.size()-1; n++ ) {
912 value[n] = fgGetNode(valueNodes[n+1]->getStringValue(), "/null")->getDoubleValue();
917 time.reset( new double[num_times] );
918 if( !timeNodes.empty() ) {
919 for( simgear::PropertyList::size_type n = 0; n < num_times; n++ ) {
920 time[n] = timeNodes[n]->getDoubleValue();
923 for( simgear::PropertyList::size_type n = 0; n < num_times; n++ ) {
924 double delta = value[n]
925 - (n > 0 ? value[n - 1] : prop->getDoubleValue());
926 time[n] = fabs(delta / rateNodes[n]->getDoubleValue());
930 ((SGInterpolator*)globals->get_subsystem_mgr()
931 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
932 ->interpolate(prop, num_times, value.get(), time.get() );
938 * Built-in command: reinit the data logging system based on the
939 * current contents of the /logger tree.
942 do_data_logging_commit (const SGPropertyNode * arg)
944 FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
950 * Built-in command: Add a dialog to the GUI system. Does *not*
951 * display the dialog. The property node should have the same format
952 * as a dialog XML configuration. It must include:
954 * name: the name of the GUI dialog for future reference.
957 do_dialog_new (const SGPropertyNode * arg)
959 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
964 // Note the casting away of const: this is *real*. Doing a
965 // "dialog-apply" command later on will mutate this property node.
966 // I'm not convinced that this isn't the Right Thing though; it
967 // allows client to create a node, pass it to dialog-new, and get
968 // the values back from the dialog by reading the same node.
969 // Perhaps command arguments are not as "const" as they would
971 gui->newDialog((SGPropertyNode*)arg);
976 * Built-in command: Show an XML-configured dialog.
978 * dialog-name: the name of the GUI dialog to display.
981 do_dialog_show (const SGPropertyNode * arg)
983 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
984 gui->showDialog(arg->getStringValue("dialog-name"));
990 * Built-in Command: Hide the active XML-configured dialog.
993 do_dialog_close (const SGPropertyNode * arg)
995 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
996 if(arg->hasValue("dialog-name"))
997 return gui->closeDialog(arg->getStringValue("dialog-name"));
998 return gui->closeActiveDialog();
1003 * Update a value in the active XML-configured dialog.
1005 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1008 do_dialog_update (const SGPropertyNode * arg)
1010 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1012 if (arg->hasValue("dialog-name"))
1013 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1015 dialog = gui->getActiveDialog();
1018 dialog->updateValues(arg->getStringValue("object-name"));
1026 do_open_browser (const SGPropertyNode * arg)
1029 if (arg->hasValue("path"))
1030 path = arg->getStringValue("path");
1032 if (arg->hasValue("url"))
1033 path = arg->getStringValue("url");
1037 return openBrowser(path);
1041 * Apply a value in the active XML-configured dialog.
1043 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1046 do_dialog_apply (const SGPropertyNode * arg)
1048 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1050 if (arg->hasValue("dialog-name"))
1051 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1053 dialog = gui->getActiveDialog();
1056 dialog->applyValues(arg->getStringValue("object-name"));
1065 * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1069 do_gui_redraw (const SGPropertyNode * arg)
1071 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1078 * Adds model to the scenery. The path to the added branch (/models/model[*])
1079 * is returned in property "property".
1082 do_add_model (const SGPropertyNode * arg)
1084 SGPropertyNode * model = fgGetNode("models", true);
1086 for (i = 0; model->hasChild("model",i); i++);
1087 model = model->getChild("model", i, true);
1088 copyProperties(arg, model);
1089 if (model->hasValue("elevation-m"))
1090 model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1091 * SG_METER_TO_FEET);
1092 model->getNode("load", true);
1093 model->removeChildren("load");
1094 const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1100 * Set mouse cursor coordinates and cursor shape.
1103 do_set_cursor (const SGPropertyNode * arg)
1105 if (arg->hasValue("x") || arg->hasValue("y")) {
1106 SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
1107 SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
1108 int x = arg->getIntValue("x", mx->getIntValue());
1109 int y = arg->getIntValue("y", my->getIntValue());
1115 SGPropertyNode *cursor = const_cast<SGPropertyNode *>(arg)->getNode("cursor", true);
1116 if (cursor->getType() != simgear::props::NONE)
1117 fgSetMouseCursor(cursor->getIntValue());
1119 cursor->setIntValue(fgGetMouseCursor());
1125 * Built-in command: play an audio message (i.e. a wav file) This is
1126 * fire and forget. Call this once per message and it will get dumped
1127 * into a queue. Messages are played sequentially so they do not
1131 do_play_audio_sample (const SGPropertyNode * arg)
1133 SGSoundMgr *smgr = globals->get_soundmgr();
1135 SG_LOG(SG_GENERAL, SG_WARN, "play-audio-sample: sound-manager not running");
1139 string path = arg->getStringValue("path");
1140 string file = arg->getStringValue("file");
1141 float volume = arg->getFloatValue("volume");
1142 // cout << "playing " << path << " / " << file << endl;
1144 static FGSampleQueue *queue = 0;
1146 queue = new FGSampleQueue(smgr, "chatter");
1147 queue->tie_to_listener();
1150 SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1151 msg->set_volume( volume );
1156 } catch (const sg_io_exception&) {
1157 SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1158 "failed to load" << path << '/' << file);
1164 * Built-in command: commit presets (read from in /sim/presets/)
1167 do_presets_commit (const SGPropertyNode * arg)
1169 if (fgGetBool("/sim/initialized", false)) {
1170 fgReInitSubsystems();
1172 // Nasal can trigger this during initial init, which confuses
1173 // the logic in ReInitSubsystems, since initial state has not been
1174 // saved at that time. Short-circuit everything here.
1175 flightgear::initPosition();
1182 * Built-in command: set log level (0 ... 7)
1185 do_log_level (const SGPropertyNode * arg)
1187 sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1194 do_decrease_visibility (const SGPropertyNode * arg)
1196 Environment::Presets::VisibilitySingleton::instance()->adjust( 0.9 );
1201 do_increase_visibility (const SGPropertyNode * arg)
1203 Environment::Presets::VisibilitySingleton::instance()->adjust( 1.1 );
1208 * An fgcommand to allow loading of xml files via nasal,
1209 * the xml file's structure will be made available within
1210 * a property tree node defined under argument "targetnode",
1211 * or in the given argument tree under "data" otherwise.
1213 * @param filename a string to hold the complete path & filename of an XML file
1214 * @param targetnode a string pointing to a location within the property tree
1215 * where to store the parsed XML file. If <targetnode> is undefined, then the
1216 * file contents are stored under a node <data> in the argument tree.
1220 do_load_xml_to_proptree(const SGPropertyNode * arg)
1222 SGPath file(arg->getStringValue("filename"));
1223 if (file.str().empty())
1226 if (file.extension() != "xml")
1227 file.concat(".xml");
1229 std::string icao = arg->getStringValue("icao");
1231 if (file.isRelative()) {
1232 SGPath absPath = globals->resolve_maybe_aircraft_path(file.str());
1233 if (!absPath.isNull())
1237 SG_LOG(SG_IO, SG_ALERT, "loadxml: Cannot find XML property file '"
1238 << file.str() << "'.");
1243 if (!XMLLoader::findAirportData(icao, file.str(), file)) {
1244 SG_LOG(SG_IO, SG_INFO, "loadxml: failed to find airport data for "
1245 << file.str() << " at ICAO:" << icao);
1250 if (!fgValidatePath(file.c_str(), false)) {
1251 SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1252 "(unauthorized access)");
1256 SGPropertyNode *targetnode;
1257 if (arg->hasValue("targetnode"))
1258 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1260 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1263 readProperties(file.c_str(), targetnode, true);
1264 } catch (const sg_exception &e) {
1265 SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1272 class RemoteXMLRequest : public simgear::HTTP::Request
1275 SGPropertyNode_ptr _complete;
1276 SGPropertyNode_ptr _status;
1277 SGPropertyNode_ptr _failed;
1278 SGPropertyNode_ptr _target;
1281 RemoteXMLRequest(const std::string& url, SGPropertyNode* targetNode) :
1282 simgear::HTTP::Request(url),
1287 void setCompletionProp(SGPropertyNode_ptr p)
1292 void setStatusProp(SGPropertyNode_ptr p)
1297 void setFailedProp(SGPropertyNode_ptr p)
1302 virtual void gotBodyData(const char* s, int n)
1304 propsData += string(s, n);
1307 virtual void responseComplete()
1309 int response = responseCode();
1310 bool failed = false;
1311 if (response == 200) {
1313 const char* buffer = propsData.c_str();
1314 readProperties(buffer, propsData.size(), _target, true);
1315 } catch (const sg_exception &e) {
1316 SG_LOG(SG_IO, SG_WARN, "parsing XML from remote, failed: " << e.getFormattedMessage());
1318 response = 406; // 'not acceptable', anything better?
1323 // now the response data is output, signal Nasal / listeners
1324 if (_complete) _complete->setBoolValue(true);
1325 if (_status) _status->setIntValue(response);
1326 if (_failed) _failed->setBoolValue(failed);
1332 do_load_xml_from_url(const SGPropertyNode * arg)
1334 std::string url(arg->getStringValue("url"));
1338 SGPropertyNode *targetnode;
1339 if (arg->hasValue("targetnode"))
1340 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1342 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1344 RemoteXMLRequest* req = new RemoteXMLRequest(url, targetnode);
1346 // connect up optional reporting properties
1347 if (arg->hasValue("complete"))
1348 req->setCompletionProp(fgGetNode(arg->getStringValue("complete"), true));
1349 if (arg->hasValue("failure"))
1350 req->setFailedProp(fgGetNode(arg->getStringValue("failure"), true));
1351 if (arg->hasValue("status"))
1352 req->setStatusProp(fgGetNode(arg->getStringValue("status"), true));
1354 FGHTTPClient::instance()->makeRequest(req);
1361 * An fgcommand to allow saving of xml files via nasal,
1362 * the file's structure will be determined based on what's
1363 * encountered in the passed (source) property tree node
1365 * @param filename a string to hold the complete path & filename of the (new)
1367 * @param sourcenode a string pointing to a location within the property tree
1368 * where to find the nodes that should be written recursively into an XML file
1369 * @param data if no sourcenode is given, then the file contents are taken from
1370 * the argument tree's "data" node.
1374 do_save_xml_from_proptree(const SGPropertyNode * arg)
1376 SGPath file(arg->getStringValue("filename"));
1377 if (file.str().empty())
1380 if (file.extension() != "xml")
1381 file.concat(".xml");
1383 if (!fgValidatePath(file.c_str(), true)) {
1384 SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1385 "(unauthorized access)");
1389 SGPropertyNode *sourcenode;
1390 if (arg->hasValue("sourcenode"))
1391 sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1392 else if (arg->getNode("data", false))
1393 sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1398 writeProperties (file.c_str(), sourcenode, true);
1399 } catch (const sg_exception &e) {
1400 SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1408 do_press_cockpit_button (const SGPropertyNode *arg)
1410 const char *prefix = arg->getStringValue("prefix");
1412 if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1415 string prop = string(prefix) + "-button";
1418 if (arg->getBoolValue("latching"))
1419 value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1423 fgSetDouble(prop.c_str(), value);
1424 fgSetBool(arg->getStringValue("discrete"), value > 0);
1430 do_release_cockpit_button (const SGPropertyNode *arg)
1432 const char *prefix = arg->getStringValue("prefix");
1434 if (arg->getBoolValue("guarded")) {
1435 string prop = string(prefix) + "-guard";
1436 if (fgGetDouble(prop.c_str()) < 1) {
1437 fgSetDouble(prop.c_str(), 1);
1442 if (! arg->getBoolValue("latching")) {
1443 fgSetDouble((string(prefix) + "-button").c_str(), 0);
1444 fgSetBool(arg->getStringValue("discrete"), false);
1450 ////////////////////////////////////////////////////////////////////////
1452 ////////////////////////////////////////////////////////////////////////
1456 * Table of built-in commands.
1458 * New commands do not have to be added here; any module in the application
1459 * can add a new command using globals->get_commands()->addCommand(...).
1463 SGCommandMgr::command_t command;
1465 { "null", do_null },
1466 { "nasal", do_nasal },
1467 { "exit", do_exit },
1468 { "reset", do_reset },
1469 { "pause", do_pause },
1470 { "load", do_load },
1471 { "save", do_save },
1472 { "save-tape", do_save_tape },
1473 { "load-tape", do_load_tape },
1474 { "panel-load", do_panel_load },
1475 { "preferences-load", do_preferences_load },
1476 { "view-cycle", do_view_cycle },
1477 { "screen-capture", do_screen_capture },
1478 { "hires-screen-capture", do_hires_screen_capture },
1479 { "tile-cache-reload", do_tile_cache_reload },
1481 { "set-sea-level-air-temp-degc", do_set_sea_level_degc },
1482 { "set-outside-air-temp-degc", do_set_oat_degc },
1483 { "set-dewpoint-sea-level-air-temp-degc", do_set_dewpoint_sea_level_degc },
1484 { "set-dewpoint-temp-degc", do_set_dewpoint_degc },
1486 { "property-toggle", do_property_toggle },
1487 { "property-assign", do_property_assign },
1488 { "property-adjust", do_property_adjust },
1489 { "property-multiply", do_property_multiply },
1490 { "property-swap", do_property_swap },
1491 { "property-scale", do_property_scale },
1492 { "property-cycle", do_property_cycle },
1493 { "property-randomize", do_property_randomize },
1494 { "property-interpolate", do_property_interpolate },
1495 { "data-logging-commit", do_data_logging_commit },
1496 { "dialog-new", do_dialog_new },
1497 { "dialog-show", do_dialog_show },
1498 { "dialog-close", do_dialog_close },
1499 { "dialog-update", do_dialog_update },
1500 { "dialog-apply", do_dialog_apply },
1501 { "open-browser", do_open_browser },
1502 { "gui-redraw", do_gui_redraw },
1503 { "add-model", do_add_model },
1504 { "set-cursor", do_set_cursor },
1505 { "play-audio-sample", do_play_audio_sample },
1506 { "presets-commit", do_presets_commit },
1507 { "log-level", do_log_level },
1508 { "replay", do_replay },
1510 { "decrease-visibility", do_decrease_visibility },
1511 { "increase-visibility", do_increase_visibility },
1513 { "loadxml", do_load_xml_to_proptree},
1514 { "savexml", do_save_xml_from_proptree },
1515 { "xmlhttprequest", do_load_xml_from_url },
1516 { "press-cockpit-button", do_press_cockpit_button },
1517 { "release-cockpit-button", do_release_cockpit_button },
1518 { "dump-scenegraph", do_dump_scene_graph },
1519 { "dump-terrainbranch", do_dump_terrain_branch },
1520 { "print-visible-scene", do_print_visible_scene_info },
1521 { "reload-shaders", do_reload_shaders },
1522 { "reload-materials", do_materials_reload },
1524 { 0, 0 } // zero-terminated
1529 * Initialize the default built-in commands.
1531 * Other commands may be added by other parts of the application.
1536 SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1537 for (int i = 0; built_ins[i].name != 0; i++) {
1538 SG_LOG(SG_GENERAL, SG_BULK, " " << built_ins[i].name);
1539 globals->get_commands()->addCommand(built_ins[i].name,
1540 built_ins[i].command);
1543 typedef bool (*dummy)();
1544 fgTie( "/command/view/next", dummy(0), do_view_next );
1545 fgTie( "/command/view/prev", dummy(0), do_view_prev );
1548 // end of fg_commands.cxx