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);
303 * Built-in command: (re)load the panel.
305 * path (optional): the file name to load the panel from
306 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
307 * and if that's unspecified, to "Panels/Default/default.xml".
310 do_panel_load (const SGPropertyNode * arg)
312 string panel_path = arg->getStringValue("path");
313 if (!panel_path.empty()) {
314 // write to the standard property, which will force a load
315 fgSetString("/sim/panel/path", panel_path.c_str());
322 * Built-in command: (re)load preferences.
324 * path (optional): the file name to load the panel from (relative
325 * to FG_ROOT). Defaults to "preferences.xml".
328 do_preferences_load (const SGPropertyNode * arg)
331 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
332 globals->get_props());
333 } catch (const sg_exception &e) {
334 guiErrorMessage("Error reading global preferences: ", e);
337 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
344 globals->get_current_view()->setHeadingOffset_deg(0.0);
345 globals->get_viewmgr()->next_view();
351 globals->get_current_view()->setHeadingOffset_deg(0.0);
352 globals->get_viewmgr()->prev_view();
356 * Built-in command: cycle view.
359 do_view_cycle (const SGPropertyNode * arg)
361 globals->get_current_view()->setHeadingOffset_deg(0.0);
362 globals->get_viewmgr()->next_view();
367 * Built-in command: capture screen.
370 do_screen_capture (const SGPropertyNode * arg)
372 return fgDumpSnapShot();
376 do_reload_shaders (const SGPropertyNode*)
378 simgear::reload_shaders();
383 do_dump_scene_graph (const SGPropertyNode*)
390 do_dump_terrain_branch (const SGPropertyNode*)
392 fgDumpTerrainBranch();
394 double lon_deg = fgGetDouble("/position/longitude-deg");
395 double lat_deg = fgGetDouble("/position/latitude-deg");
396 SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
397 SGVec3d zero = SGVec3d::fromGeod(geodPos);
399 SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
400 SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
401 SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
407 do_print_visible_scene_info(const SGPropertyNode*)
409 fgPrintVisibleSceneInfoCommand();
414 * Built-in command: hires capture screen.
417 do_hires_screen_capture (const SGPropertyNode * arg)
425 * Reload the tile cache.
428 do_tile_cache_reload (const SGPropertyNode * arg)
430 static const SGPropertyNode *master_freeze
431 = fgGetNode("/sim/freeze/master");
432 bool freeze = master_freeze->getBoolValue();
433 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
435 fgSetBool("/sim/freeze/master", true);
438 globals->get_subsystem("tile-manager")->reinit();
441 fgSetBool("/sim/freeze/master", false);
447 * Reload the materials definition
450 do_materials_reload (const SGPropertyNode * arg)
452 SG_LOG(SG_INPUT, SG_INFO, "Reloading Materials");
453 SGMaterialLib* new_matlib = new SGMaterialLib;
454 SGPath mpath( globals->get_fg_root() );
455 mpath.append( fgGetString("/sim/rendering/materials-file") );
456 bool loaded = new_matlib->load(globals->get_fg_root(),
458 globals->get_props());
461 SG_LOG( SG_GENERAL, SG_ALERT,
462 "Error loading materials file " << mpath.str() );
466 globals->set_matlib(new_matlib);
472 These do_set_(some-environment-parameters) are deprecated and no longer
473 useful/functional - Torsten Dreyer, January 2011
475 * Set the sea level outside air temperature and assigning that to all
476 * boundary and aloft environment layers.
479 do_set_sea_level_degc ( double temp_sea_level_degc)
481 SGPropertyNode *node, *child;
484 node = fgGetNode( "/environment/config/boundary" );
485 if ( node != NULL ) {
487 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
488 child->setDoubleValue( "temperature-sea-level-degc",
489 temp_sea_level_degc );
495 node = fgGetNode( "/environment/config/aloft" );
496 if ( node != NULL ) {
498 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
499 child->setDoubleValue( "temperature-sea-level-degc",
500 temp_sea_level_degc );
509 do_set_sea_level_degc (const SGPropertyNode * arg)
511 return do_set_sea_level_degc( arg->getDoubleValue("temp-degc", 15.0) );
516 * Set the outside air temperature at the "current" altitude by first
517 * calculating the corresponding sea level temp, and assigning that to
518 * all boundary and aloft environment layers.
521 do_set_oat_degc (const SGPropertyNode * arg)
523 double oat_degc = arg->getDoubleValue("temp-degc", 15.0);
524 // check for an altitude specified in the arguments, otherwise use
525 // current aircraft altitude.
526 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
527 if ( altitude_ft == NULL ) {
528 altitude_ft = fgGetNode("/position/altitude-ft");
531 FGEnvironment dummy; // instantiate a dummy so we can leech a method
532 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
533 dummy.set_temperature_degc( oat_degc );
534 return do_set_sea_level_degc( dummy.get_temperature_sea_level_degc());
538 * Set the sea level outside air dewpoint and assigning that to all
539 * boundary and aloft environment layers.
542 do_set_dewpoint_sea_level_degc (double dewpoint_sea_level_degc)
545 SGPropertyNode *node, *child;
548 node = fgGetNode( "/environment/config/boundary" );
549 if ( node != NULL ) {
551 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
552 child->setDoubleValue( "dewpoint-sea-level-degc",
553 dewpoint_sea_level_degc );
559 node = fgGetNode( "/environment/config/aloft" );
560 if ( node != NULL ) {
562 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
563 child->setDoubleValue( "dewpoint-sea-level-degc",
564 dewpoint_sea_level_degc );
573 do_set_dewpoint_sea_level_degc (const SGPropertyNode * arg)
575 return do_set_dewpoint_sea_level_degc(arg->getDoubleValue("dewpoint-degc", 5.0));
579 * Set the outside air dewpoint at the "current" altitude by first
580 * calculating the corresponding sea level dewpoint, and assigning
581 * that to all boundary and aloft environment layers.
584 do_set_dewpoint_degc (const SGPropertyNode * arg)
586 double dewpoint_degc = arg->getDoubleValue("dewpoint-degc", 5.0);
588 // check for an altitude specified in the arguments, otherwise use
589 // current aircraft altitude.
590 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
591 if ( altitude_ft == NULL ) {
592 altitude_ft = fgGetNode("/position/altitude-ft");
595 FGEnvironment dummy; // instantiate a dummy so we can leech a method
596 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
597 dummy.set_dewpoint_degc( dewpoint_degc );
598 return do_set_dewpoint_sea_level_degc(dummy.get_dewpoint_sea_level_degc());
603 * Built-in command: toggle a bool property value.
605 * property: The name of the property to toggle.
608 do_property_toggle (const SGPropertyNode * arg)
610 SGPropertyNode * prop = get_prop(arg);
611 return prop->setBoolValue(!prop->getBoolValue());
616 * Built-in command: assign a value to a property.
618 * property: the name of the property to assign.
619 * value: the value to assign; or
620 * property[1]: the property to copy from.
623 do_property_assign (const SGPropertyNode * arg)
625 SGPropertyNode * prop = get_prop(arg);
626 const SGPropertyNode * value = arg->getNode("value");
629 return prop->setUnspecifiedValue(value->getStringValue());
632 const SGPropertyNode * prop2 = get_prop2(arg);
634 return prop->setUnspecifiedValue(prop2->getStringValue());
642 * Built-in command: increment or decrement a property value.
644 * If the 'step' argument is present, it will be used; otherwise,
645 * the command uses 'offset' and 'factor', usually from the mouse.
647 * property: the name of the property to increment or decrement.
648 * step: the amount of the increment or decrement (default: 0).
649 * offset: offset from the current setting (used for the mouse; multiplied
651 * factor: scaling amount for the offset (defaults to 1).
652 * min: the minimum allowed value (default: no minimum).
653 * max: the maximum allowed value (default: no maximum).
654 * mask: 'integer' to apply only to the left of the decimal point,
655 * 'decimal' to apply only to the right of the decimal point,
656 * or 'all' to apply to the whole number (the default).
657 * wrap: true if the value should be wrapped when it passes min or max;
658 * both min and max must be present for this to work (default:
662 do_property_adjust (const SGPropertyNode * arg)
664 SGPropertyNode * prop = get_prop(arg);
667 if (arg->hasValue("step"))
668 amount = arg->getDoubleValue("step");
670 amount = (arg->getDoubleValue("factor", 1)
671 * arg->getDoubleValue("offset"));
673 double unmodifiable, modifiable;
674 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
675 &unmodifiable, &modifiable);
676 modifiable += amount;
677 limit_value(&modifiable, arg);
679 prop->setDoubleValue(unmodifiable + modifiable);
686 * Built-in command: multiply a property value.
688 * property: the name of the property to multiply.
689 * factor: the amount by which to multiply.
690 * min: the minimum allowed value (default: no minimum).
691 * max: the maximum allowed value (default: no maximum).
692 * mask: 'integer' to apply only to the left of the decimal point,
693 * 'decimal' to apply only to the right of the decimal point,
694 * or 'all' to apply to the whole number (the default).
695 * wrap: true if the value should be wrapped when it passes min or max;
696 * both min and max must be present for this to work (default:
700 do_property_multiply (const SGPropertyNode * arg)
702 SGPropertyNode * prop = get_prop(arg);
703 double factor = arg->getDoubleValue("factor", 1);
705 double unmodifiable, modifiable;
706 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
707 &unmodifiable, &modifiable);
708 modifiable *= factor;
709 limit_value(&modifiable, arg);
711 prop->setDoubleValue(unmodifiable + modifiable);
718 * Built-in command: swap two property values.
720 * property[0]: the name of the first property.
721 * property[1]: the name of the second property.
724 do_property_swap (const SGPropertyNode * arg)
726 SGPropertyNode * prop1 = get_prop(arg);
727 SGPropertyNode * prop2 = get_prop2(arg);
729 // FIXME: inefficient
730 const string & tmp = prop1->getStringValue();
731 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
732 prop2->setUnspecifiedValue(tmp.c_str()));
737 * Built-in command: Set a property to an axis or other moving input.
739 * property: the name of the property to set.
740 * setting: the current input setting, usually between -1.0 and 1.0.
741 * offset: the offset to shift by, before applying the factor.
742 * factor: the factor to multiply by (use negative to reverse).
745 do_property_scale (const SGPropertyNode * arg)
747 SGPropertyNode * prop = get_prop(arg);
748 double setting = arg->getDoubleValue("setting");
749 double offset = arg->getDoubleValue("offset", 0.0);
750 double factor = arg->getDoubleValue("factor", 1.0);
751 bool squared = arg->getBoolValue("squared", false);
752 int power = arg->getIntValue("power", (squared ? 2 : 1));
754 int sign = (setting < 0 ? -1 : 1);
760 setting = setting * setting * sign;
763 setting = setting * setting * setting;
766 setting = setting * setting * setting * setting * sign;
769 setting = pow(setting, power);
770 if ((power % 2) == 0)
775 return prop->setDoubleValue((setting + offset) * factor);
780 * Built-in command: cycle a property through a set of values.
782 * If the current value isn't in the list, the cycle will
783 * (re)start from the beginning.
785 * property: the name of the property to cycle.
786 * value[*]: the list of values to cycle through.
789 do_property_cycle (const SGPropertyNode * arg)
791 SGPropertyNode * prop = get_prop(arg);
792 vector<SGPropertyNode_ptr> values = arg->getChildren("value");
794 int nSelections = values.size();
796 if (nSelections < 1) {
797 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
801 // Try to find the current selection
802 for (int i = 0; i < nSelections; i++) {
803 if (compare_values(prop, values[i])) {
809 // Default or wrap to the first selection
810 if (selection < 0 || selection >= nSelections)
813 prop->setUnspecifiedValue(values[selection]->getStringValue());
819 * Built-in command: randomize a numeric property value.
821 * property: the name of the property value to randomize.
822 * min: the minimum allowed value.
823 * max: the maximum allowed value.
826 do_property_randomize (const SGPropertyNode * arg)
828 SGPropertyNode * prop = get_prop(arg);
829 double min = arg->getDoubleValue("min", DBL_MIN);
830 double max = arg->getDoubleValue("max", DBL_MAX);
831 prop->setDoubleValue(sg_random() * (max - min) + min);
836 * Built-in command: interpolate a property value over time
838 * property: the name of the property value to interpolate.
839 * value[0..n] any number of constant values to interpolate
840 * time/rate[0..n] time between each value, number of time elements must
841 * match those of value elements. Instead of time also rate can
842 * be used which automatically calculates the time to change
843 * the property value at the given speed.
845 * property[1..n] any number of target values taken from named properties
846 * time/rate[0..n] time between each value, number of time elements must
847 * match those of value elements. Instead of time also rate can
848 * be used which automatically calculates the time to change
849 * the property value at the given speed.
852 do_property_interpolate (const SGPropertyNode * arg)
854 SGPropertyNode * prop = get_prop(arg);
856 simgear::PropertyList valueNodes = arg->getChildren( "value" );
857 simgear::PropertyList timeNodes = arg->getChildren( "time" );
858 simgear::PropertyList rateNodes = arg->getChildren( "rate" );
860 if( !timeNodes.empty() && !rateNodes.empty() )
861 // mustn't specify time and rate
864 simgear::PropertyList::size_type num_times = timeNodes.empty()
868 boost::scoped_array<double> value;
869 boost::scoped_array<double> time;
871 if( valueNodes.size() > 0 ) {
873 if( num_times != valueNodes.size() )
876 value.reset( new double[valueNodes.size()] );
877 for( simgear::PropertyList::size_type n = 0; n < valueNodes.size(); n++ ) {
878 value[n] = valueNodes[n]->getDoubleValue();
881 valueNodes = arg->getChildren("property");
882 // must have one more property node
883 if( valueNodes.size() - 1 != num_times )
886 value.reset( new double[valueNodes.size()-1] );
887 for( simgear::PropertyList::size_type n = 0; n < valueNodes.size()-1; n++ ) {
888 value[n] = fgGetNode(valueNodes[n+1]->getStringValue(), "/null")->getDoubleValue();
893 time.reset( new double[num_times] );
894 if( !timeNodes.empty() ) {
895 for( simgear::PropertyList::size_type n = 0; n < num_times; n++ ) {
896 time[n] = timeNodes[n]->getDoubleValue();
899 for( simgear::PropertyList::size_type n = 0; n < num_times; n++ ) {
900 double delta = value[n]
901 - (n > 0 ? value[n - 1] : prop->getDoubleValue());
902 time[n] = fabs(delta / rateNodes[n]->getDoubleValue());
906 ((SGInterpolator*)globals->get_subsystem_mgr()
907 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
908 ->interpolate(prop, num_times, value.get(), time.get() );
914 * Built-in command: reinit the data logging system based on the
915 * current contents of the /logger tree.
918 do_data_logging_commit (const SGPropertyNode * arg)
920 FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
926 * Built-in command: Add a dialog to the GUI system. Does *not*
927 * display the dialog. The property node should have the same format
928 * as a dialog XML configuration. It must include:
930 * name: the name of the GUI dialog for future reference.
933 do_dialog_new (const SGPropertyNode * arg)
935 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
940 // Note the casting away of const: this is *real*. Doing a
941 // "dialog-apply" command later on will mutate this property node.
942 // I'm not convinced that this isn't the Right Thing though; it
943 // allows client to create a node, pass it to dialog-new, and get
944 // the values back from the dialog by reading the same node.
945 // Perhaps command arguments are not as "const" as they would
947 gui->newDialog((SGPropertyNode*)arg);
952 * Built-in command: Show an XML-configured dialog.
954 * dialog-name: the name of the GUI dialog to display.
957 do_dialog_show (const SGPropertyNode * arg)
959 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
960 gui->showDialog(arg->getStringValue("dialog-name"));
966 * Built-in Command: Hide the active XML-configured dialog.
969 do_dialog_close (const SGPropertyNode * arg)
971 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
972 if(arg->hasValue("dialog-name"))
973 return gui->closeDialog(arg->getStringValue("dialog-name"));
974 return gui->closeActiveDialog();
979 * Update a value in the active XML-configured dialog.
981 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
984 do_dialog_update (const SGPropertyNode * arg)
986 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
988 if (arg->hasValue("dialog-name"))
989 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
991 dialog = gui->getActiveDialog();
994 dialog->updateValues(arg->getStringValue("object-name"));
1002 do_open_browser (const SGPropertyNode * arg)
1005 if (arg->hasValue("path"))
1006 path = arg->getStringValue("path");
1008 if (arg->hasValue("url"))
1009 path = arg->getStringValue("url");
1013 return openBrowser(path);
1017 * Apply a value in the active XML-configured dialog.
1019 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1022 do_dialog_apply (const SGPropertyNode * arg)
1024 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1026 if (arg->hasValue("dialog-name"))
1027 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1029 dialog = gui->getActiveDialog();
1032 dialog->applyValues(arg->getStringValue("object-name"));
1041 * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1045 do_gui_redraw (const SGPropertyNode * arg)
1047 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1054 * Adds model to the scenery. The path to the added branch (/models/model[*])
1055 * is returned in property "property".
1058 do_add_model (const SGPropertyNode * arg)
1060 SGPropertyNode * model = fgGetNode("models", true);
1062 for (i = 0; model->hasChild("model",i); i++);
1063 model = model->getChild("model", i, true);
1064 copyProperties(arg, model);
1065 if (model->hasValue("elevation-m"))
1066 model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1067 * SG_METER_TO_FEET);
1068 model->getNode("load", true);
1069 model->removeChildren("load");
1070 const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1076 * Set mouse cursor coordinates and cursor shape.
1079 do_set_cursor (const SGPropertyNode * arg)
1081 if (arg->hasValue("x") || arg->hasValue("y")) {
1082 SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
1083 SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
1084 int x = arg->getIntValue("x", mx->getIntValue());
1085 int y = arg->getIntValue("y", my->getIntValue());
1091 SGPropertyNode *cursor = const_cast<SGPropertyNode *>(arg)->getNode("cursor", true);
1092 if (cursor->getType() != simgear::props::NONE)
1093 fgSetMouseCursor(cursor->getIntValue());
1095 cursor->setIntValue(fgGetMouseCursor());
1101 * Built-in command: play an audio message (i.e. a wav file) This is
1102 * fire and forget. Call this once per message and it will get dumped
1103 * into a queue. Messages are played sequentially so they do not
1107 do_play_audio_sample (const SGPropertyNode * arg)
1109 SGSoundMgr *smgr = globals->get_soundmgr();
1111 SG_LOG(SG_GENERAL, SG_WARN, "play-audio-sample: sound-manager not running");
1115 string path = arg->getStringValue("path");
1116 string file = arg->getStringValue("file");
1117 float volume = arg->getFloatValue("volume");
1118 // cout << "playing " << path << " / " << file << endl;
1120 static FGSampleQueue *queue = 0;
1122 queue = new FGSampleQueue(smgr, "chatter");
1123 queue->tie_to_listener();
1126 SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1127 msg->set_volume( volume );
1132 } catch (const sg_io_exception&) {
1133 SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1134 "failed to load" << path << '/' << file);
1140 * Built-in command: commit presets (read from in /sim/presets/)
1143 do_presets_commit (const SGPropertyNode * arg)
1145 if (fgGetBool("/sim/initialized", false)) {
1146 fgReInitSubsystems();
1148 // Nasal can trigger this during initial init, which confuses
1149 // the logic in ReInitSubsystems, since initial state has not been
1150 // saved at that time. Short-circuit everything here.
1151 flightgear::initPosition();
1158 * Built-in command: set log level (0 ... 7)
1161 do_log_level (const SGPropertyNode * arg)
1163 sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1170 do_decrease_visibility (const SGPropertyNode * arg)
1172 Environment::Presets::VisibilitySingleton::instance()->adjust( 0.9 );
1177 do_increase_visibility (const SGPropertyNode * arg)
1179 Environment::Presets::VisibilitySingleton::instance()->adjust( 1.1 );
1184 * An fgcommand to allow loading of xml files via nasal,
1185 * the xml file's structure will be made available within
1186 * a property tree node defined under argument "targetnode",
1187 * or in the given argument tree under "data" otherwise.
1189 * @param filename a string to hold the complete path & filename of an XML file
1190 * @param targetnode a string pointing to a location within the property tree
1191 * where to store the parsed XML file. If <targetnode> is undefined, then the
1192 * file contents are stored under a node <data> in the argument tree.
1196 do_load_xml_to_proptree(const SGPropertyNode * arg)
1198 SGPath file(arg->getStringValue("filename"));
1199 if (file.str().empty())
1202 if (file.extension() != "xml")
1203 file.concat(".xml");
1205 std::string icao = arg->getStringValue("icao");
1207 if (file.isRelative()) {
1208 SGPath absPath = globals->resolve_maybe_aircraft_path(file.str());
1209 if (!absPath.isNull())
1213 SG_LOG(SG_IO, SG_ALERT, "loadxml: Cannot find XML property file '"
1214 << file.str() << "'.");
1219 if (!XMLLoader::findAirportData(icao, file.str(), file)) {
1220 SG_LOG(SG_IO, SG_INFO, "loadxml: failed to find airport data for "
1221 << file.str() << " at ICAO:" << icao);
1226 if (!fgValidatePath(file.c_str(), false)) {
1227 SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1228 "(unauthorized access)");
1232 SGPropertyNode *targetnode;
1233 if (arg->hasValue("targetnode"))
1234 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1236 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1239 readProperties(file.c_str(), targetnode, true);
1240 } catch (const sg_exception &e) {
1241 SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1248 class RemoteXMLRequest : public simgear::HTTP::Request
1251 SGPropertyNode_ptr _complete;
1252 SGPropertyNode_ptr _status;
1253 SGPropertyNode_ptr _failed;
1254 SGPropertyNode_ptr _target;
1257 RemoteXMLRequest(const std::string& url, SGPropertyNode* targetNode) :
1258 simgear::HTTP::Request(url),
1263 void setCompletionProp(SGPropertyNode_ptr p)
1268 void setStatusProp(SGPropertyNode_ptr p)
1273 void setFailedProp(SGPropertyNode_ptr p)
1278 virtual void gotBodyData(const char* s, int n)
1280 propsData += string(s, n);
1283 virtual void responseComplete()
1285 int response = responseCode();
1286 bool failed = false;
1287 if (response == 200) {
1289 const char* buffer = propsData.c_str();
1290 readProperties(buffer, propsData.size(), _target, true);
1291 } catch (const sg_exception &e) {
1292 SG_LOG(SG_IO, SG_WARN, "parsing XML from remote, failed: " << e.getFormattedMessage());
1294 response = 406; // 'not acceptable', anything better?
1299 // now the response data is output, signal Nasal / listeners
1300 if (_complete) _complete->setBoolValue(true);
1301 if (_status) _status->setIntValue(response);
1302 if (_failed) _failed->setBoolValue(failed);
1308 do_load_xml_from_url(const SGPropertyNode * arg)
1310 std::string url(arg->getStringValue("url"));
1314 SGPropertyNode *targetnode;
1315 if (arg->hasValue("targetnode"))
1316 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1318 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1320 RemoteXMLRequest* req = new RemoteXMLRequest(url, targetnode);
1322 // connect up optional reporting properties
1323 if (arg->hasValue("complete"))
1324 req->setCompletionProp(fgGetNode(arg->getStringValue("complete"), true));
1325 if (arg->hasValue("failure"))
1326 req->setFailedProp(fgGetNode(arg->getStringValue("failure"), true));
1327 if (arg->hasValue("status"))
1328 req->setStatusProp(fgGetNode(arg->getStringValue("status"), true));
1330 FGHTTPClient::instance()->makeRequest(req);
1337 * An fgcommand to allow saving of xml files via nasal,
1338 * the file's structure will be determined based on what's
1339 * encountered in the passed (source) property tree node
1341 * @param filename a string to hold the complete path & filename of the (new)
1343 * @param sourcenode a string pointing to a location within the property tree
1344 * where to find the nodes that should be written recursively into an XML file
1345 * @param data if no sourcenode is given, then the file contents are taken from
1346 * the argument tree's "data" node.
1350 do_save_xml_from_proptree(const SGPropertyNode * arg)
1352 SGPath file(arg->getStringValue("filename"));
1353 if (file.str().empty())
1356 if (file.extension() != "xml")
1357 file.concat(".xml");
1359 if (!fgValidatePath(file.c_str(), true)) {
1360 SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1361 "(unauthorized access)");
1365 SGPropertyNode *sourcenode;
1366 if (arg->hasValue("sourcenode"))
1367 sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1368 else if (arg->getNode("data", false))
1369 sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1374 writeProperties (file.c_str(), sourcenode, true);
1375 } catch (const sg_exception &e) {
1376 SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1384 do_press_cockpit_button (const SGPropertyNode *arg)
1386 const char *prefix = arg->getStringValue("prefix");
1388 if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1391 string prop = string(prefix) + "-button";
1394 if (arg->getBoolValue("latching"))
1395 value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1399 fgSetDouble(prop.c_str(), value);
1400 fgSetBool(arg->getStringValue("discrete"), value > 0);
1406 do_release_cockpit_button (const SGPropertyNode *arg)
1408 const char *prefix = arg->getStringValue("prefix");
1410 if (arg->getBoolValue("guarded")) {
1411 string prop = string(prefix) + "-guard";
1412 if (fgGetDouble(prop.c_str()) < 1) {
1413 fgSetDouble(prop.c_str(), 1);
1418 if (! arg->getBoolValue("latching")) {
1419 fgSetDouble((string(prefix) + "-button").c_str(), 0);
1420 fgSetBool(arg->getStringValue("discrete"), false);
1426 ////////////////////////////////////////////////////////////////////////
1428 ////////////////////////////////////////////////////////////////////////
1432 * Table of built-in commands.
1434 * New commands do not have to be added here; any module in the application
1435 * can add a new command using globals->get_commands()->addCommand(...).
1439 SGCommandMgr::command_t command;
1441 { "null", do_null },
1442 { "nasal", do_nasal },
1443 { "exit", do_exit },
1444 { "reset", do_reset },
1445 { "pause", do_pause },
1446 { "load", do_load },
1447 { "save", do_save },
1448 { "panel-load", do_panel_load },
1449 { "preferences-load", do_preferences_load },
1450 { "view-cycle", do_view_cycle },
1451 { "screen-capture", do_screen_capture },
1452 { "hires-screen-capture", do_hires_screen_capture },
1453 { "tile-cache-reload", do_tile_cache_reload },
1455 { "set-sea-level-air-temp-degc", do_set_sea_level_degc },
1456 { "set-outside-air-temp-degc", do_set_oat_degc },
1457 { "set-dewpoint-sea-level-air-temp-degc", do_set_dewpoint_sea_level_degc },
1458 { "set-dewpoint-temp-degc", do_set_dewpoint_degc },
1460 { "property-toggle", do_property_toggle },
1461 { "property-assign", do_property_assign },
1462 { "property-adjust", do_property_adjust },
1463 { "property-multiply", do_property_multiply },
1464 { "property-swap", do_property_swap },
1465 { "property-scale", do_property_scale },
1466 { "property-cycle", do_property_cycle },
1467 { "property-randomize", do_property_randomize },
1468 { "property-interpolate", do_property_interpolate },
1469 { "data-logging-commit", do_data_logging_commit },
1470 { "dialog-new", do_dialog_new },
1471 { "dialog-show", do_dialog_show },
1472 { "dialog-close", do_dialog_close },
1473 { "dialog-update", do_dialog_update },
1474 { "dialog-apply", do_dialog_apply },
1475 { "open-browser", do_open_browser },
1476 { "gui-redraw", do_gui_redraw },
1477 { "add-model", do_add_model },
1478 { "set-cursor", do_set_cursor },
1479 { "play-audio-sample", do_play_audio_sample },
1480 { "presets-commit", do_presets_commit },
1481 { "log-level", do_log_level },
1482 { "replay", do_replay },
1484 { "decrease-visibility", do_decrease_visibility },
1485 { "increase-visibility", do_increase_visibility },
1487 { "loadxml", do_load_xml_to_proptree},
1488 { "savexml", do_save_xml_from_proptree },
1489 { "xmlhttprequest", do_load_xml_from_url },
1490 { "press-cockpit-button", do_press_cockpit_button },
1491 { "release-cockpit-button", do_release_cockpit_button },
1492 { "dump-scenegraph", do_dump_scene_graph },
1493 { "dump-terrainbranch", do_dump_terrain_branch },
1494 { "print-visible-scene", do_print_visible_scene_info },
1495 { "reload-shaders", do_reload_shaders },
1496 { "reload-materials", do_materials_reload },
1498 { 0, 0 } // zero-terminated
1503 * Initialize the default built-in commands.
1505 * Other commands may be added by other parts of the application.
1510 SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1511 for (int i = 0; built_ins[i].name != 0; i++) {
1512 SG_LOG(SG_GENERAL, SG_BULK, " " << built_ins[i].name);
1513 globals->get_commands()->addCommand(built_ins[i].name,
1514 built_ins[i].command);
1517 typedef bool (*dummy)();
1518 fgTie( "/command/view/next", dummy(0), do_view_next );
1519 fgTie( "/command/view/prev", dummy(0), do_view_prev );
1522 // end of fg_commands.cxx