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/structure/event_mgr.hxx>
23 #include <simgear/sound/soundmgr_openal.hxx>
24 #include <simgear/timing/sg_time.hxx>
26 #include <Cockpit/panel.hxx>
27 #include <Cockpit/panel_io.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 <Scripting/NasalSys.hxx>
35 #include <Sound/sample_queue.hxx>
36 #include <Airports/xmlloader.hxx>
38 #include "fg_init.hxx"
41 #include "fg_commands.hxx"
42 #include "fg_props.hxx"
43 #include "globals.hxx"
46 #include "viewmgr.hxx"
48 #include <Main/viewer.hxx>
49 #include <Environment/presets.hxx>
57 ////////////////////////////////////////////////////////////////////////
58 // Static helper functions.
59 ////////////////////////////////////////////////////////////////////////
62 static inline SGPropertyNode *
63 get_prop (const SGPropertyNode * arg)
65 return fgGetNode(arg->getStringValue("property[0]", "/null"), true);
68 static inline SGPropertyNode *
69 get_prop2 (const SGPropertyNode * arg)
71 return fgGetNode(arg->getStringValue("property[1]", "/null"), true);
76 * Get a double value and split it as required.
79 split_value (double full_value, const char * mask,
80 double * unmodifiable, double * modifiable)
82 if (!strcmp("integer", mask)) {
83 *modifiable = (full_value < 0 ? ceil(full_value) : floor (full_value));
84 *unmodifiable = full_value - *modifiable;
85 } else if (!strcmp("decimal", mask)) {
86 *unmodifiable = (full_value < 0 ? ceil(full_value) : floor(full_value));
87 *modifiable = full_value - *unmodifiable;
89 if (strcmp("all", mask))
90 SG_LOG(SG_GENERAL, SG_ALERT, "Bad value " << mask << " for mask;"
91 << " assuming 'all'");
93 *modifiable = full_value;
99 * Clamp or wrap a value as specified.
102 limit_value (double * value, const SGPropertyNode * arg)
104 const SGPropertyNode * min_node = arg->getChild("min");
105 const SGPropertyNode * max_node = arg->getChild("max");
107 bool wrap = arg->getBoolValue("wrap");
109 if (min_node == 0 || max_node == 0)
112 if (wrap) { // wrap such that min <= x < max
113 double min_val = min_node->getDoubleValue();
114 double max_val = max_node->getDoubleValue();
115 double resolution = arg->getDoubleValue("resolution");
116 if (resolution > 0.0) {
117 // snap to (min + N*resolution), taking special care to handle imprecision
118 int n = (int)floor((*value - min_val) / resolution + 0.5);
119 int steps = (int)floor((max_val - min_val) / resolution + 0.5);
120 SG_NORMALIZE_RANGE(n, 0, steps);
121 *value = min_val + resolution * n;
123 // plain circular wrapping
124 SG_NORMALIZE_RANGE(*value, min_val, max_val);
126 } else { // clamp such that min <= x <= max
127 if ((min_node != 0) && (*value < min_node->getDoubleValue()))
128 *value = min_node->getDoubleValue();
129 else if ((max_node != 0) && (*value > max_node->getDoubleValue()))
130 *value = max_node->getDoubleValue();
135 compare_values (SGPropertyNode * value1, SGPropertyNode * value2)
137 switch (value1->getType()) {
138 case simgear::props::BOOL:
139 return (value1->getBoolValue() == value2->getBoolValue());
140 case simgear::props::INT:
141 return (value1->getIntValue() == value2->getIntValue());
142 case simgear::props::LONG:
143 return (value1->getLongValue() == value2->getLongValue());
144 case simgear::props::FLOAT:
145 return (value1->getFloatValue() == value2->getFloatValue());
146 case simgear::props::DOUBLE:
147 return (value1->getDoubleValue() == value2->getDoubleValue());
149 return !strcmp(value1->getStringValue(), value2->getStringValue());
155 ////////////////////////////////////////////////////////////////////////
156 // Command implementations.
157 ////////////////////////////////////////////////////////////////////////
161 * Built-in command: do nothing.
164 do_null (const SGPropertyNode * arg)
170 * Built-in command: run a Nasal script.
173 do_nasal (const SGPropertyNode * arg)
175 return ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(arg);
179 * Built-in command: exit FlightGear.
181 * status: the exit status to return to the operating system (defaults to 0)
184 do_exit (const SGPropertyNode * arg)
186 SG_LOG(SG_INPUT, SG_INFO, "Program exit requested.");
187 fgSetBool("/sim/signals/exit", true);
189 if (fgGetBool("/sim/startup/save-on-exit")) {
191 char* envp = ::getenv( "APPDATA" );
192 if ( envp != NULL ) {
193 SGPath config( envp );
194 config.append( "flightgear.org" );
196 if ( homedir != NULL ) {
197 SGPath config( homedir );
198 config.append( ".fgfs" );
200 config.append( "autosave.xml" );
201 config.create_dir( 0700 );
202 SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << config.str());
204 writeProperties(config.str(), globals->get_props(), false, SGPropertyNode::USERARCHIVE);
205 } catch (const sg_exception &e) {
206 guiErrorMessage("Error writing autosave.xml: ", e);
209 SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
213 fgOSExit(arg->getIntValue("status", 0));
219 * Reset FlightGear (Shift-Escape or Menu->File->Reset)
222 do_reset (const SGPropertyNode * arg)
224 fgReInitSubsystems();
230 * Built-in command: reinitialize one or more subsystems.
232 * subsystem[*]: the name(s) of the subsystem(s) to reinitialize; if
233 * none is specified, reinitialize all of them.
236 do_reinit (const SGPropertyNode * arg)
240 vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
241 if (subsystems.size() == 0) {
242 globals->get_subsystem_mgr()->reinit();
244 for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
245 const char * name = subsystems[i]->getStringValue();
246 SGSubsystem * subsystem = globals->get_subsystem(name);
247 if (subsystem == 0) {
249 SG_LOG( SG_GENERAL, SG_ALERT,
250 "Subsystem " << name << " not found" );
257 globals->get_event_mgr()->reinit();
264 // these routines look useful ??? but are never used in the code ???
268 * Built-in command: suspend one or more subsystems.
270 * subsystem[*] - the name(s) of the subsystem(s) to suspend.
273 do_suspend (const SGPropertyNode * arg)
277 vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
278 for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
279 const char * name = subsystems[i]->getStringValue();
280 SGSubsystem * subsystem = globals->get_subsystem(name);
281 if (subsystem == 0) {
283 SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem " << name << " not found");
285 subsystem->suspend();
292 * Built-in command: suspend one or more subsystems.
294 * subsystem[*] - the name(s) of the subsystem(s) to suspend.
297 do_resume (const SGPropertyNode * arg)
301 vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
302 for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
303 const char * name = subsystems[i]->getStringValue();
304 SGSubsystem * subsystem = globals->get_subsystem(name);
305 if (subsystem == 0) {
307 SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem " << name << " not found");
318 do_pause (const SGPropertyNode * arg)
320 bool paused = fgGetBool("/sim/freeze/master",true) || fgGetBool("/sim/freeze/clock",true);
321 fgSetBool("/sim/freeze/master",!paused);
322 fgSetBool("/sim/freeze/clock",!paused);
323 if (fgGetBool("/sim/freeze/replay-state",false))
324 fgSetBool("/sim/replay/disable",true);
329 * Built-in command: load flight.
331 * file (optional): the name of the file to load (relative to current
332 * directory). Defaults to "fgfs.sav"
335 do_load (const SGPropertyNode * arg)
337 string file = arg->getStringValue("file", "fgfs.sav");
338 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
341 if (!fgValidatePath(file.c_str(), false)) {
342 SG_LOG(SG_IO, SG_ALERT, "load: reading '" << file << "' denied "
343 "(unauthorized access)");
347 ifstream input(file.c_str());
348 if (input.good() && fgLoadFlight(input)) {
350 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
353 SG_LOG(SG_INPUT, SG_WARN, "Cannot load flight from " << file);
360 * Built-in command: save flight.
362 * file (optional): the name of the file to save (relative to the
363 * current directory). Defaults to "fgfs.sav".
366 do_save (const SGPropertyNode * arg)
368 string file = arg->getStringValue("file", "fgfs.sav");
369 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
372 if (!fgValidatePath(file.c_str(), false)) {
373 SG_LOG(SG_IO, SG_ALERT, "save: writing '" << file << "' denied "
374 "(unauthorized access)");
378 bool write_all = arg->getBoolValue("write-all", false);
379 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
380 ofstream output(file.c_str());
381 if (output.good() && fgSaveFlight(output, write_all)) {
383 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
386 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
393 * Built-in command: (re)load the panel.
395 * path (optional): the file name to load the panel from
396 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
397 * and if that's unspecified, to "Panels/Default/default.xml".
400 do_panel_load (const SGPropertyNode * arg)
403 arg->getStringValue("path", fgGetString("/sim/panel/path"));
404 if (panel_path.empty()) {
408 FGPanel * new_panel = fgReadPanel(panel_path);
409 if (new_panel == 0) {
410 SG_LOG(SG_INPUT, SG_ALERT,
411 "Error reading new panel from " << panel_path);
414 SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
415 globals->get_current_panel()->unbind();
416 delete globals->get_current_panel();
417 globals->set_current_panel( new_panel );
418 globals->get_current_panel()->bind();
424 * Built-in command: pass a mouse click to the panel.
426 * button: the mouse button number, zero-based.
427 * is-down: true if the button is down, false if it is up.
428 * x-pos: the x position of the mouse click.
429 * y-pos: the y position of the mouse click.
432 do_panel_mouse_click (const SGPropertyNode * arg)
434 if (globals->get_current_panel() != 0)
435 return globals->get_current_panel()
436 ->doMouseAction(arg->getIntValue("button"),
437 arg->getBoolValue("is-down") ? PU_DOWN : PU_UP,
438 arg->getIntValue("x-pos"),
439 arg->getIntValue("y-pos"));
446 * Built-in command: (re)load preferences.
448 * path (optional): the file name to load the panel from (relative
449 * to FG_ROOT). Defaults to "preferences.xml".
452 do_preferences_load (const SGPropertyNode * arg)
455 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
456 globals->get_props());
457 } catch (const sg_exception &e) {
458 guiErrorMessage("Error reading global preferences: ", e);
461 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
468 globals->get_current_view()->setHeadingOffset_deg(0.0);
469 globals->get_viewmgr()->next_view();
475 globals->get_current_view()->setHeadingOffset_deg(0.0);
476 globals->get_viewmgr()->prev_view();
480 * Built-in command: cycle view.
483 do_view_cycle (const SGPropertyNode * arg)
485 globals->get_current_view()->setHeadingOffset_deg(0.0);
486 globals->get_viewmgr()->next_view();
491 * Built-in command: capture screen.
494 do_screen_capture (const SGPropertyNode * arg)
496 return fgDumpSnapShot();
500 do_reload_shaders (const SGPropertyNode*)
502 simgear::reload_shaders();
507 do_dump_scene_graph (const SGPropertyNode*)
514 do_dump_terrain_branch (const SGPropertyNode*)
516 fgDumpTerrainBranch();
518 double lon_deg = fgGetDouble("/position/longitude-deg");
519 double lat_deg = fgGetDouble("/position/latitude-deg");
520 SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
521 SGVec3d zero = SGVec3d::fromGeod(geodPos);
523 SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
524 SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
525 SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
531 do_print_visible_scene_info(const SGPropertyNode*)
533 fgPrintVisibleSceneInfoCommand();
538 * Built-in command: hires capture screen.
541 do_hires_screen_capture (const SGPropertyNode * arg)
549 * Reload the tile cache.
552 do_tile_cache_reload (const SGPropertyNode * arg)
554 static const SGPropertyNode *master_freeze
555 = fgGetNode("/sim/freeze/master");
556 bool freeze = master_freeze->getBoolValue();
557 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
559 fgSetBool("/sim/freeze/master", true);
562 globals->get_subsystem("tile-manager")->reinit();
565 fgSetBool("/sim/freeze/master", false);
572 These do_set_(some-environment-parameters) are deprecated and no longer
573 useful/functional - Torsten Dreyer, January 2011
575 * Set the sea level outside air temperature and assigning that to all
576 * boundary and aloft environment layers.
579 do_set_sea_level_degc ( double temp_sea_level_degc)
581 SGPropertyNode *node, *child;
584 node = fgGetNode( "/environment/config/boundary" );
585 if ( node != NULL ) {
587 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
588 child->setDoubleValue( "temperature-sea-level-degc",
589 temp_sea_level_degc );
595 node = fgGetNode( "/environment/config/aloft" );
596 if ( node != NULL ) {
598 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
599 child->setDoubleValue( "temperature-sea-level-degc",
600 temp_sea_level_degc );
609 do_set_sea_level_degc (const SGPropertyNode * arg)
611 return do_set_sea_level_degc( arg->getDoubleValue("temp-degc", 15.0) );
616 * Set the outside air temperature at the "current" altitude by first
617 * calculating the corresponding sea level temp, and assigning that to
618 * all boundary and aloft environment layers.
621 do_set_oat_degc (const SGPropertyNode * arg)
623 double oat_degc = arg->getDoubleValue("temp-degc", 15.0);
624 // check for an altitude specified in the arguments, otherwise use
625 // current aircraft altitude.
626 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
627 if ( altitude_ft == NULL ) {
628 altitude_ft = fgGetNode("/position/altitude-ft");
631 FGEnvironment dummy; // instantiate a dummy so we can leech a method
632 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
633 dummy.set_temperature_degc( oat_degc );
634 return do_set_sea_level_degc( dummy.get_temperature_sea_level_degc());
638 * Set the sea level outside air dewpoint and assigning that to all
639 * boundary and aloft environment layers.
642 do_set_dewpoint_sea_level_degc (double dewpoint_sea_level_degc)
645 SGPropertyNode *node, *child;
648 node = fgGetNode( "/environment/config/boundary" );
649 if ( node != NULL ) {
651 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
652 child->setDoubleValue( "dewpoint-sea-level-degc",
653 dewpoint_sea_level_degc );
659 node = fgGetNode( "/environment/config/aloft" );
660 if ( node != NULL ) {
662 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
663 child->setDoubleValue( "dewpoint-sea-level-degc",
664 dewpoint_sea_level_degc );
673 do_set_dewpoint_sea_level_degc (const SGPropertyNode * arg)
675 return do_set_dewpoint_sea_level_degc(arg->getDoubleValue("dewpoint-degc", 5.0));
679 * Set the outside air dewpoint at the "current" altitude by first
680 * calculating the corresponding sea level dewpoint, and assigning
681 * that to all boundary and aloft environment layers.
684 do_set_dewpoint_degc (const SGPropertyNode * arg)
686 double dewpoint_degc = arg->getDoubleValue("dewpoint-degc", 5.0);
688 // check for an altitude specified in the arguments, otherwise use
689 // current aircraft altitude.
690 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
691 if ( altitude_ft == NULL ) {
692 altitude_ft = fgGetNode("/position/altitude-ft");
695 FGEnvironment dummy; // instantiate a dummy so we can leech a method
696 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
697 dummy.set_dewpoint_degc( dewpoint_degc );
698 return do_set_dewpoint_sea_level_degc(dummy.get_dewpoint_sea_level_degc());
703 * Built-in command: toggle a bool property value.
705 * property: The name of the property to toggle.
708 do_property_toggle (const SGPropertyNode * arg)
710 SGPropertyNode * prop = get_prop(arg);
711 return prop->setBoolValue(!prop->getBoolValue());
716 * Built-in command: assign a value to a property.
718 * property: the name of the property to assign.
719 * value: the value to assign; or
720 * property[1]: the property to copy from.
723 do_property_assign (const SGPropertyNode * arg)
725 SGPropertyNode * prop = get_prop(arg);
726 const SGPropertyNode * prop2 = get_prop2(arg);
727 const SGPropertyNode * value = arg->getNode("value");
730 return prop->setUnspecifiedValue(value->getStringValue());
732 return prop->setUnspecifiedValue(prop2->getStringValue());
739 * Built-in command: increment or decrement a property value.
741 * If the 'step' argument is present, it will be used; otherwise,
742 * the command uses 'offset' and 'factor', usually from the mouse.
744 * property: the name of the property to increment or decrement.
745 * step: the amount of the increment or decrement (default: 0).
746 * offset: offset from the current setting (used for the mouse; multiplied
748 * factor: scaling amount for the offset (defaults to 1).
749 * min: the minimum allowed value (default: no minimum).
750 * max: the maximum allowed value (default: no maximum).
751 * mask: 'integer' to apply only to the left of the decimal point,
752 * 'decimal' to apply only to the right of the decimal point,
753 * or 'all' to apply to the whole number (the default).
754 * wrap: true if the value should be wrapped when it passes min or max;
755 * both min and max must be present for this to work (default:
759 do_property_adjust (const SGPropertyNode * arg)
761 SGPropertyNode * prop = get_prop(arg);
764 if (arg->hasValue("step"))
765 amount = arg->getDoubleValue("step");
767 amount = (arg->getDoubleValue("factor", 1)
768 * arg->getDoubleValue("offset"));
770 double unmodifiable, modifiable;
771 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
772 &unmodifiable, &modifiable);
773 modifiable += amount;
774 limit_value(&modifiable, arg);
776 prop->setDoubleValue(unmodifiable + modifiable);
783 * Built-in command: multiply a property value.
785 * property: the name of the property to multiply.
786 * factor: the amount by which to multiply.
787 * min: the minimum allowed value (default: no minimum).
788 * max: the maximum allowed value (default: no maximum).
789 * mask: 'integer' to apply only to the left of the decimal point,
790 * 'decimal' to apply only to the right of the decimal point,
791 * or 'all' to apply to the whole number (the default).
792 * wrap: true if the value should be wrapped when it passes min or max;
793 * both min and max must be present for this to work (default:
797 do_property_multiply (const SGPropertyNode * arg)
799 SGPropertyNode * prop = get_prop(arg);
800 double factor = arg->getDoubleValue("factor", 1);
802 double unmodifiable, modifiable;
803 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
804 &unmodifiable, &modifiable);
805 modifiable *= factor;
806 limit_value(&modifiable, arg);
808 prop->setDoubleValue(unmodifiable + modifiable);
815 * Built-in command: swap two property values.
817 * property[0]: the name of the first property.
818 * property[1]: the name of the second property.
821 do_property_swap (const SGPropertyNode * arg)
823 SGPropertyNode * prop1 = get_prop(arg);
824 SGPropertyNode * prop2 = get_prop2(arg);
826 // FIXME: inefficient
827 const string & tmp = prop1->getStringValue();
828 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
829 prop2->setUnspecifiedValue(tmp.c_str()));
834 * Built-in command: Set a property to an axis or other moving input.
836 * property: the name of the property to set.
837 * setting: the current input setting, usually between -1.0 and 1.0.
838 * offset: the offset to shift by, before applying the factor.
839 * factor: the factor to multiply by (use negative to reverse).
842 do_property_scale (const SGPropertyNode * arg)
844 SGPropertyNode * prop = get_prop(arg);
845 double setting = arg->getDoubleValue("setting");
846 double offset = arg->getDoubleValue("offset", 0.0);
847 double factor = arg->getDoubleValue("factor", 1.0);
848 bool squared = arg->getBoolValue("squared", false);
849 int power = arg->getIntValue("power", (squared ? 2 : 1));
851 int sign = (setting < 0 ? -1 : 1);
857 setting = setting * setting * sign;
860 setting = setting * setting * setting;
863 setting = setting * setting * setting * setting * sign;
866 setting = pow(setting, power);
867 if ((power % 2) == 0)
872 return prop->setDoubleValue((setting + offset) * factor);
877 * Built-in command: cycle a property through a set of values.
879 * If the current value isn't in the list, the cycle will
880 * (re)start from the beginning.
882 * property: the name of the property to cycle.
883 * value[*]: the list of values to cycle through.
886 do_property_cycle (const SGPropertyNode * arg)
888 SGPropertyNode * prop = get_prop(arg);
889 vector<SGPropertyNode_ptr> values = arg->getChildren("value");
891 int nSelections = values.size();
893 if (nSelections < 1) {
894 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
898 // Try to find the current selection
899 for (int i = 0; i < nSelections; i++) {
900 if (compare_values(prop, values[i])) {
906 // Default or wrap to the first selection
907 if (selection < 0 || selection >= nSelections)
910 prop->setUnspecifiedValue(values[selection]->getStringValue());
916 * Built-in command: randomize a numeric property value.
918 * property: the name of the property value to randomize.
919 * min: the minimum allowed value.
920 * max: the maximum allowed value.
923 do_property_randomize (const SGPropertyNode * arg)
925 SGPropertyNode * prop = get_prop(arg);
926 double min = arg->getDoubleValue("min", DBL_MIN);
927 double max = arg->getDoubleValue("max", DBL_MAX);
928 prop->setDoubleValue(sg_random() * (max - min) + min);
934 * Built-in command: reinit the data logging system based on the
935 * current contents of the /logger tree.
938 do_data_logging_commit (const SGPropertyNode * arg)
940 FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
946 * Built-in command: Add a dialog to the GUI system. Does *not*
947 * display the dialog. The property node should have the same format
948 * as a dialog XML configuration. It must include:
950 * name: the name of the GUI dialog for future reference.
953 do_dialog_new (const SGPropertyNode * arg)
955 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
957 // Note the casting away of const: this is *real*. Doing a
958 // "dialog-apply" command later on will mutate this property node.
959 // I'm not convinced that this isn't the Right Thing though; it
960 // allows client to create a node, pass it to dialog-new, and get
961 // the values back from the dialog by reading the same node.
962 // Perhaps command arguments are not as "const" as they would
964 gui->newDialog((SGPropertyNode*)arg);
969 * Built-in command: Show an XML-configured dialog.
971 * dialog-name: the name of the GUI dialog to display.
974 do_dialog_show (const SGPropertyNode * arg)
976 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
977 gui->showDialog(arg->getStringValue("dialog-name"));
983 * Built-in Command: Hide the active XML-configured dialog.
986 do_dialog_close (const SGPropertyNode * arg)
988 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
989 if(arg->hasValue("dialog-name"))
990 return gui->closeDialog(arg->getStringValue("dialog-name"));
991 return gui->closeActiveDialog();
996 * Update a value in the active XML-configured dialog.
998 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1001 do_dialog_update (const SGPropertyNode * arg)
1003 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1005 if (arg->hasValue("dialog-name"))
1006 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1008 dialog = gui->getActiveDialog();
1011 dialog->updateValues(arg->getStringValue("object-name"));
1020 * Apply a value in the active XML-configured dialog.
1022 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1025 do_dialog_apply (const SGPropertyNode * arg)
1027 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1029 if (arg->hasValue("dialog-name"))
1030 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1032 dialog = gui->getActiveDialog();
1035 dialog->applyValues(arg->getStringValue("object-name"));
1044 * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1048 do_gui_redraw (const SGPropertyNode * arg)
1050 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1057 * Adds model to the scenery. The path to the added branch (/models/model[*])
1058 * is returned in property "property".
1061 do_add_model (const SGPropertyNode * arg)
1063 SGPropertyNode * model = fgGetNode("models", true);
1064 for (int i = 0;; i++) {
1067 if (!model->getChild("model", i, false)) {
1068 model = model->getChild("model", i, true);
1072 copyProperties(arg, model);
1073 if (model->hasValue("elevation-m"))
1074 model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1075 * SG_METER_TO_FEET);
1076 model->getNode("load", true);
1077 model->removeChildren("load");
1078 const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1084 * Set mouse cursor coordinates and cursor shape.
1087 do_set_cursor (const SGPropertyNode * arg)
1089 if (arg->hasValue("x") || arg->hasValue("y")) {
1090 SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
1091 SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
1092 int x = arg->getIntValue("x", mx->getIntValue());
1093 int y = arg->getIntValue("y", my->getIntValue());
1099 SGPropertyNode *cursor = const_cast<SGPropertyNode *>(arg)->getNode("cursor", true);
1100 if (cursor->getType() != simgear::props::NONE)
1101 fgSetMouseCursor(cursor->getIntValue());
1103 cursor->setIntValue(fgGetMouseCursor());
1109 * Built-in command: play an audio message (i.e. a wav file) This is
1110 * fire and forget. Call this once per message and it will get dumped
1111 * into a queue. Messages are played sequentially so they do not
1115 do_play_audio_sample (const SGPropertyNode * arg)
1117 string path = arg->getStringValue("path");
1118 string file = arg->getStringValue("file");
1119 float volume = arg->getFloatValue("volume");
1120 // cout << "playing " << path << " / " << file << endl;
1122 static FGSampleQueue *queue = 0;
1124 SGSoundMgr *smgr = globals->get_soundmgr();
1125 queue = new FGSampleQueue(smgr, "chatter");
1126 queue->tie_to_listener();
1129 SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1130 msg->set_volume( volume );
1135 } catch (const sg_io_exception&) {
1136 SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1137 "failed to load" << path << '/' << file);
1143 * Built-in command: commit presets (read from in /sim/presets/)
1146 do_presets_commit (const SGPropertyNode * arg)
1148 if (fgGetBool("/sim/initialized", false)) {
1149 fgReInitSubsystems();
1151 // Nasal can trigger this during initial init, which confuses
1152 // the logic in ReInitSubsystems, since initial state has not been
1153 // saved at that time. Short-circuit everything here.
1161 * Built-in command: set log level (0 ... 7)
1164 do_log_level (const SGPropertyNode * arg)
1166 sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1172 * Built-in command: replay the FDR buffer
1175 do_replay (const SGPropertyNode * arg)
1177 // freeze the fdm, resume from sim pause
1178 fgSetInt( "/sim/freeze/replay-state", 1 );
1179 fgSetBool("/sim/freeze/master", 0 );
1180 fgSetBool("/sim/freeze/clock", 0 );
1181 fgSetDouble( "/sim/replay/time", -1 );
1183 // cout << "start = " << r->get_start_time()
1184 // << " end = " << r->get_end_time() << endl;
1191 do_decrease_visibility (const SGPropertyNode * arg)
1193 Environment::Presets::VisibilitySingleton::instance()->adjust( 0.9 );
1198 do_increase_visibility (const SGPropertyNode * arg)
1200 Environment::Presets::VisibilitySingleton::instance()->adjust( 1.1 );
1205 * An fgcommand to allow loading of xml files via nasal,
1206 * the xml file's structure will be made available within
1207 * a property tree node defined under argument "targetnode",
1208 * or in the given argument tree under "data" otherwise.
1210 * @param filename a string to hold the complete path & filename of an XML file
1211 * @param targetnode a string pointing to a location within the property tree
1212 * where to store the parsed XML file. If <targetnode> is undefined, then the
1213 * file contents are stored under a node <data> in the argument tree.
1217 do_load_xml_to_proptree(const SGPropertyNode * arg)
1219 SGPath file(arg->getStringValue("filename"));
1220 if (file.str().empty())
1223 if (file.extension() != "xml")
1224 file.concat(".xml");
1226 std::string icao = arg->getStringValue("icao");
1228 if (file.isRelative()) {
1229 file = globals->resolve_maybe_aircraft_path(file.str());
1232 if (!XMLLoader::findAirportData(icao, file.str(), file)) {
1233 SG_LOG(SG_IO, SG_INFO, "loadxml: failed to find airport data for "
1234 << file.str() << " at ICAO:" << icao);
1239 if (!fgValidatePath(file.c_str(), false)) {
1240 SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1241 "(unauthorized access)");
1245 SGPropertyNode *targetnode;
1246 if (arg->hasValue("targetnode"))
1247 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1249 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1252 readProperties(file.c_str(), targetnode, true);
1253 } catch (const sg_exception &e) {
1254 SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1263 * An fgcommand to allow saving of xml files via nasal,
1264 * the file's structure will be determined based on what's
1265 * encountered in the passed (source) property tree node
1267 * @param filename a string to hold the complete path & filename of the (new)
1269 * @param sourcenode a string pointing to a location within the property tree
1270 * where to find the nodes that should be written recursively into an XML file
1271 * @param data if no sourcenode is given, then the file contents are taken from
1272 * the argument tree's "data" node.
1276 do_save_xml_from_proptree(const SGPropertyNode * arg)
1278 SGPath file(arg->getStringValue("filename"));
1279 if (file.str().empty())
1282 if (file.extension() != "xml")
1283 file.concat(".xml");
1285 if (!fgValidatePath(file.c_str(), true)) {
1286 SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1287 "(unauthorized access)");
1291 SGPropertyNode *sourcenode;
1292 if (arg->hasValue("sourcenode"))
1293 sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1294 else if (arg->getNode("data", false))
1295 sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1300 writeProperties (file.c_str(), sourcenode, true);
1301 } catch (const sg_exception &e) {
1302 SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1310 do_press_cockpit_button (const SGPropertyNode *arg)
1312 const char *prefix = arg->getStringValue("prefix");
1314 if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1317 string prop = string(prefix) + "-button";
1320 if (arg->getBoolValue("latching"))
1321 value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1325 fgSetDouble(prop.c_str(), value);
1326 fgSetBool(arg->getStringValue("discrete"), value > 0);
1332 do_release_cockpit_button (const SGPropertyNode *arg)
1334 const char *prefix = arg->getStringValue("prefix");
1336 if (arg->getBoolValue("guarded")) {
1337 string prop = string(prefix) + "-guard";
1338 if (fgGetDouble(prop.c_str()) < 1) {
1339 fgSetDouble(prop.c_str(), 1);
1344 if (! arg->getBoolValue("latching")) {
1345 fgSetDouble((string(prefix) + "-button").c_str(), 0);
1346 fgSetBool(arg->getStringValue("discrete"), false);
1353 ////////////////////////////////////////////////////////////////////////
1355 ////////////////////////////////////////////////////////////////////////
1359 * Table of built-in commands.
1361 * New commands do not have to be added here; any module in the application
1362 * can add a new command using globals->get_commands()->addCommand(...).
1366 SGCommandMgr::command_t command;
1368 { "null", do_null },
1369 { "nasal", do_nasal },
1370 { "exit", do_exit },
1371 { "reset", do_reset },
1372 { "reinit", do_reinit },
1373 { "suspend", do_reinit },
1374 { "resume", do_reinit },
1375 { "pause", do_pause },
1376 { "load", do_load },
1377 { "save", do_save },
1378 { "panel-load", do_panel_load },
1379 { "panel-mouse-click", do_panel_mouse_click },
1380 { "preferences-load", do_preferences_load },
1381 { "view-cycle", do_view_cycle },
1382 { "screen-capture", do_screen_capture },
1383 { "hires-screen-capture", do_hires_screen_capture },
1384 { "tile-cache-reload", do_tile_cache_reload },
1386 { "set-sea-level-air-temp-degc", do_set_sea_level_degc },
1387 { "set-outside-air-temp-degc", do_set_oat_degc },
1388 { "set-dewpoint-sea-level-air-temp-degc", do_set_dewpoint_sea_level_degc },
1389 { "set-dewpoint-temp-degc", do_set_dewpoint_degc },
1391 { "property-toggle", do_property_toggle },
1392 { "property-assign", do_property_assign },
1393 { "property-adjust", do_property_adjust },
1394 { "property-multiply", do_property_multiply },
1395 { "property-swap", do_property_swap },
1396 { "property-scale", do_property_scale },
1397 { "property-cycle", do_property_cycle },
1398 { "property-randomize", do_property_randomize },
1399 { "data-logging-commit", do_data_logging_commit },
1400 { "dialog-new", do_dialog_new },
1401 { "dialog-show", do_dialog_show },
1402 { "dialog-close", do_dialog_close },
1403 { "dialog-update", do_dialog_update },
1404 { "dialog-apply", do_dialog_apply },
1405 { "gui-redraw", do_gui_redraw },
1406 { "add-model", do_add_model },
1407 { "set-cursor", do_set_cursor },
1408 { "play-audio-sample", do_play_audio_sample },
1409 { "presets-commit", do_presets_commit },
1410 { "log-level", do_log_level },
1411 { "replay", do_replay },
1413 { "decrease-visibility", do_decrease_visibility },
1414 { "increase-visibility", do_increase_visibility },
1416 { "loadxml", do_load_xml_to_proptree},
1417 { "savexml", do_save_xml_from_proptree },
1418 { "press-cockpit-button", do_press_cockpit_button },
1419 { "release-cockpit-button", do_release_cockpit_button },
1420 { "dump-scenegraph", do_dump_scene_graph },
1421 { "dump-terrainbranch", do_dump_terrain_branch },
1422 { "print-visible-scene", do_print_visible_scene_info },
1423 { "reload-shaders", do_reload_shaders },
1424 { 0, 0 } // zero-terminated
1429 * Initialize the default built-in commands.
1431 * Other commands may be added by other parts of the application.
1436 SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1437 for (int i = 0; built_ins[i].name != 0; i++) {
1438 SG_LOG(SG_GENERAL, SG_BULK, " " << built_ins[i].name);
1439 globals->get_commands()->addCommand(built_ins[i].name,
1440 built_ins[i].command);
1443 typedef bool (*dummy)();
1444 fgTie( "/command/view/next", dummy(0), do_view_next );
1445 fgTie( "/command/view/prev", dummy(0), do_view_prev );
1448 // end of fg_commands.cxx