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 <Time/sunsolver.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);
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);
328 * Built-in command: load flight.
330 * file (optional): the name of the file to load (relative to current
331 * directory). Defaults to "fgfs.sav"
334 do_load (const SGPropertyNode * arg)
336 string file = arg->getStringValue("file", "fgfs.sav");
337 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
340 if (!fgValidatePath(file.c_str(), false)) {
341 SG_LOG(SG_IO, SG_ALERT, "load: reading '" << file << "' denied "
342 "(unauthorized access)");
346 ifstream input(file.c_str());
347 if (input.good() && fgLoadFlight(input)) {
349 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
352 SG_LOG(SG_INPUT, SG_WARN, "Cannot load flight from " << file);
359 * Built-in command: save flight.
361 * file (optional): the name of the file to save (relative to the
362 * current directory). Defaults to "fgfs.sav".
365 do_save (const SGPropertyNode * arg)
367 string file = arg->getStringValue("file", "fgfs.sav");
368 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
371 if (!fgValidatePath(file.c_str(), false)) {
372 SG_LOG(SG_IO, SG_ALERT, "save: writing '" << file << "' denied "
373 "(unauthorized access)");
377 bool write_all = arg->getBoolValue("write-all", false);
378 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
379 ofstream output(file.c_str());
380 if (output.good() && fgSaveFlight(output, write_all)) {
382 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
385 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
392 * Built-in command: (re)load the panel.
394 * path (optional): the file name to load the panel from
395 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
396 * and if that's unspecified, to "Panels/Default/default.xml".
399 do_panel_load (const SGPropertyNode * arg)
402 arg->getStringValue("path", fgGetString("/sim/panel/path"));
403 if (panel_path.empty()) {
407 FGPanel * new_panel = fgReadPanel(panel_path);
408 if (new_panel == 0) {
409 SG_LOG(SG_INPUT, SG_ALERT,
410 "Error reading new panel from " << panel_path);
413 SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
414 globals->get_current_panel()->unbind();
415 delete globals->get_current_panel();
416 globals->set_current_panel( new_panel );
417 globals->get_current_panel()->bind();
423 * Built-in command: pass a mouse click to the panel.
425 * button: the mouse button number, zero-based.
426 * is-down: true if the button is down, false if it is up.
427 * x-pos: the x position of the mouse click.
428 * y-pos: the y position of the mouse click.
431 do_panel_mouse_click (const SGPropertyNode * arg)
433 if (globals->get_current_panel() != 0)
434 return globals->get_current_panel()
435 ->doMouseAction(arg->getIntValue("button"),
436 arg->getBoolValue("is-down") ? PU_DOWN : PU_UP,
437 arg->getIntValue("x-pos"),
438 arg->getIntValue("y-pos"));
445 * Built-in command: (re)load preferences.
447 * path (optional): the file name to load the panel from (relative
448 * to FG_ROOT). Defaults to "preferences.xml".
451 do_preferences_load (const SGPropertyNode * arg)
454 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
455 globals->get_props());
456 } catch (const sg_exception &e) {
457 guiErrorMessage("Error reading global preferences: ", e);
460 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
467 globals->get_current_view()->setHeadingOffset_deg(0.0);
468 globals->get_viewmgr()->next_view();
474 globals->get_current_view()->setHeadingOffset_deg(0.0);
475 globals->get_viewmgr()->prev_view();
479 * Built-in command: cycle view.
482 do_view_cycle (const SGPropertyNode * arg)
484 globals->get_current_view()->setHeadingOffset_deg(0.0);
485 globals->get_viewmgr()->next_view();
490 * Built-in command: capture screen.
493 do_screen_capture (const SGPropertyNode * arg)
495 return fgDumpSnapShot();
499 do_reload_shaders (const SGPropertyNode*)
501 simgear::reload_shaders();
506 do_dump_scene_graph (const SGPropertyNode*)
513 do_dump_terrain_branch (const SGPropertyNode*)
515 fgDumpTerrainBranch();
517 double lon_deg = fgGetDouble("/position/longitude-deg");
518 double lat_deg = fgGetDouble("/position/latitude-deg");
519 SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
520 SGVec3d zero = SGVec3d::fromGeod(geodPos);
522 SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
523 SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
524 SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
530 do_print_visible_scene_info(const SGPropertyNode*)
532 fgPrintVisibleSceneInfoCommand();
537 * Built-in command: hires capture screen.
540 do_hires_screen_capture (const SGPropertyNode * arg)
548 * Reload the tile cache.
551 do_tile_cache_reload (const SGPropertyNode * arg)
553 static const SGPropertyNode *master_freeze
554 = fgGetNode("/sim/freeze/master");
555 bool freeze = master_freeze->getBoolValue();
556 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
558 fgSetBool("/sim/freeze/master", true);
561 globals->get_subsystem("tile-manager")->reinit();
564 fgSetBool("/sim/freeze/master", false);
571 These do_set_(some-environment-parameters) are deprecated and no longer
572 useful/functional - Torsten Dreyer, January 2011
574 * Set the sea level outside air temperature and assigning that to all
575 * boundary and aloft environment layers.
578 do_set_sea_level_degc ( double temp_sea_level_degc)
580 SGPropertyNode *node, *child;
583 node = fgGetNode( "/environment/config/boundary" );
584 if ( node != NULL ) {
586 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
587 child->setDoubleValue( "temperature-sea-level-degc",
588 temp_sea_level_degc );
594 node = fgGetNode( "/environment/config/aloft" );
595 if ( node != NULL ) {
597 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
598 child->setDoubleValue( "temperature-sea-level-degc",
599 temp_sea_level_degc );
608 do_set_sea_level_degc (const SGPropertyNode * arg)
610 return do_set_sea_level_degc( arg->getDoubleValue("temp-degc", 15.0) );
615 * Set the outside air temperature at the "current" altitude by first
616 * calculating the corresponding sea level temp, and assigning that to
617 * all boundary and aloft environment layers.
620 do_set_oat_degc (const SGPropertyNode * arg)
622 double oat_degc = arg->getDoubleValue("temp-degc", 15.0);
623 // check for an altitude specified in the arguments, otherwise use
624 // current aircraft altitude.
625 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
626 if ( altitude_ft == NULL ) {
627 altitude_ft = fgGetNode("/position/altitude-ft");
630 FGEnvironment dummy; // instantiate a dummy so we can leech a method
631 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
632 dummy.set_temperature_degc( oat_degc );
633 return do_set_sea_level_degc( dummy.get_temperature_sea_level_degc());
637 * Set the sea level outside air dewpoint and assigning that to all
638 * boundary and aloft environment layers.
641 do_set_dewpoint_sea_level_degc (double dewpoint_sea_level_degc)
644 SGPropertyNode *node, *child;
647 node = fgGetNode( "/environment/config/boundary" );
648 if ( node != NULL ) {
650 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
651 child->setDoubleValue( "dewpoint-sea-level-degc",
652 dewpoint_sea_level_degc );
658 node = fgGetNode( "/environment/config/aloft" );
659 if ( node != NULL ) {
661 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
662 child->setDoubleValue( "dewpoint-sea-level-degc",
663 dewpoint_sea_level_degc );
672 do_set_dewpoint_sea_level_degc (const SGPropertyNode * arg)
674 return do_set_dewpoint_sea_level_degc(arg->getDoubleValue("dewpoint-degc", 5.0));
678 * Set the outside air dewpoint at the "current" altitude by first
679 * calculating the corresponding sea level dewpoint, and assigning
680 * that to all boundary and aloft environment layers.
683 do_set_dewpoint_degc (const SGPropertyNode * arg)
685 double dewpoint_degc = arg->getDoubleValue("dewpoint-degc", 5.0);
687 // check for an altitude specified in the arguments, otherwise use
688 // current aircraft altitude.
689 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
690 if ( altitude_ft == NULL ) {
691 altitude_ft = fgGetNode("/position/altitude-ft");
694 FGEnvironment dummy; // instantiate a dummy so we can leech a method
695 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
696 dummy.set_dewpoint_degc( dewpoint_degc );
697 return do_set_dewpoint_sea_level_degc(dummy.get_dewpoint_sea_level_degc());
701 * Update the lighting manually.
704 do_timeofday (const SGPropertyNode * arg)
706 const string &offset_type = arg->getStringValue("timeofday", "noon");
708 static const SGPropertyNode *longitude
709 = fgGetNode("/position/longitude-deg");
710 static const SGPropertyNode *latitude
711 = fgGetNode("/position/latitude-deg");
713 int orig_warp = globals->get_warp();
714 SGTime *t = globals->get_time_params();
715 time_t cur_time = t->get_cur_time();
716 // cout << "cur_time = " << cur_time << endl;
717 // cout << "orig_warp = " << orig_warp << endl;
720 if ( offset_type == "real" ) {
722 } else if ( offset_type == "dawn" ) {
723 warp = fgTimeSecondsUntilSunAngle( cur_time,
724 longitude->getDoubleValue()
725 * SGD_DEGREES_TO_RADIANS,
726 latitude->getDoubleValue()
727 * SGD_DEGREES_TO_RADIANS,
729 } else if ( offset_type == "morning" ) {
730 warp = fgTimeSecondsUntilSunAngle( cur_time,
731 longitude->getDoubleValue()
732 * SGD_DEGREES_TO_RADIANS,
733 latitude->getDoubleValue()
734 * SGD_DEGREES_TO_RADIANS,
736 } else if ( offset_type == "noon" ) {
737 warp = fgTimeSecondsUntilSunAngle( cur_time,
738 longitude->getDoubleValue()
739 * SGD_DEGREES_TO_RADIANS,
740 latitude->getDoubleValue()
741 * SGD_DEGREES_TO_RADIANS,
743 } else if ( offset_type == "afternoon" ) {
744 warp = fgTimeSecondsUntilSunAngle( cur_time,
745 longitude->getDoubleValue()
746 * SGD_DEGREES_TO_RADIANS,
747 latitude->getDoubleValue()
748 * SGD_DEGREES_TO_RADIANS,
750 } else if ( offset_type == "dusk" ) {
751 warp = fgTimeSecondsUntilSunAngle( cur_time,
752 longitude->getDoubleValue()
753 * SGD_DEGREES_TO_RADIANS,
754 latitude->getDoubleValue()
755 * SGD_DEGREES_TO_RADIANS,
757 } else if ( offset_type == "evening" ) {
758 warp = fgTimeSecondsUntilSunAngle( cur_time,
759 longitude->getDoubleValue()
760 * SGD_DEGREES_TO_RADIANS,
761 latitude->getDoubleValue()
762 * SGD_DEGREES_TO_RADIANS,
764 } else if ( offset_type == "midnight" ) {
765 warp = fgTimeSecondsUntilSunAngle( cur_time,
766 longitude->getDoubleValue()
767 * SGD_DEGREES_TO_RADIANS,
768 latitude->getDoubleValue()
769 * SGD_DEGREES_TO_RADIANS,
774 fgSetInt("/sim/time/warp", orig_warp + warp);
781 * Built-in command: toggle a bool property value.
783 * property: The name of the property to toggle.
786 do_property_toggle (const SGPropertyNode * arg)
788 SGPropertyNode * prop = get_prop(arg);
789 return prop->setBoolValue(!prop->getBoolValue());
794 * Built-in command: assign a value to a property.
796 * property: the name of the property to assign.
797 * value: the value to assign; or
798 * property[1]: the property to copy from.
801 do_property_assign (const SGPropertyNode * arg)
803 SGPropertyNode * prop = get_prop(arg);
804 const SGPropertyNode * prop2 = get_prop2(arg);
805 const SGPropertyNode * value = arg->getNode("value");
808 return prop->setUnspecifiedValue(value->getStringValue());
810 return prop->setUnspecifiedValue(prop2->getStringValue());
817 * Built-in command: increment or decrement a property value.
819 * If the 'step' argument is present, it will be used; otherwise,
820 * the command uses 'offset' and 'factor', usually from the mouse.
822 * property: the name of the property to increment or decrement.
823 * step: the amount of the increment or decrement (default: 0).
824 * offset: offset from the current setting (used for the mouse; multiplied
826 * factor: scaling amount for the offset (defaults to 1).
827 * min: the minimum allowed value (default: no minimum).
828 * max: the maximum allowed value (default: no maximum).
829 * mask: 'integer' to apply only to the left of the decimal point,
830 * 'decimal' to apply only to the right of the decimal point,
831 * or 'all' to apply to the whole number (the default).
832 * wrap: true if the value should be wrapped when it passes min or max;
833 * both min and max must be present for this to work (default:
837 do_property_adjust (const SGPropertyNode * arg)
839 SGPropertyNode * prop = get_prop(arg);
842 if (arg->hasValue("step"))
843 amount = arg->getDoubleValue("step");
845 amount = (arg->getDoubleValue("factor", 1)
846 * arg->getDoubleValue("offset"));
848 double unmodifiable, modifiable;
849 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
850 &unmodifiable, &modifiable);
851 modifiable += amount;
852 limit_value(&modifiable, arg);
854 prop->setDoubleValue(unmodifiable + modifiable);
861 * Built-in command: multiply a property value.
863 * property: the name of the property to multiply.
864 * factor: the amount by which to multiply.
865 * min: the minimum allowed value (default: no minimum).
866 * max: the maximum allowed value (default: no maximum).
867 * mask: 'integer' to apply only to the left of the decimal point,
868 * 'decimal' to apply only to the right of the decimal point,
869 * or 'all' to apply to the whole number (the default).
870 * wrap: true if the value should be wrapped when it passes min or max;
871 * both min and max must be present for this to work (default:
875 do_property_multiply (const SGPropertyNode * arg)
877 SGPropertyNode * prop = get_prop(arg);
878 double factor = arg->getDoubleValue("factor", 1);
880 double unmodifiable, modifiable;
881 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
882 &unmodifiable, &modifiable);
883 modifiable *= factor;
884 limit_value(&modifiable, arg);
886 prop->setDoubleValue(unmodifiable + modifiable);
893 * Built-in command: swap two property values.
895 * property[0]: the name of the first property.
896 * property[1]: the name of the second property.
899 do_property_swap (const SGPropertyNode * arg)
901 SGPropertyNode * prop1 = get_prop(arg);
902 SGPropertyNode * prop2 = get_prop2(arg);
904 // FIXME: inefficient
905 const string & tmp = prop1->getStringValue();
906 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
907 prop2->setUnspecifiedValue(tmp.c_str()));
912 * Built-in command: Set a property to an axis or other moving input.
914 * property: the name of the property to set.
915 * setting: the current input setting, usually between -1.0 and 1.0.
916 * offset: the offset to shift by, before applying the factor.
917 * factor: the factor to multiply by (use negative to reverse).
920 do_property_scale (const SGPropertyNode * arg)
922 SGPropertyNode * prop = get_prop(arg);
923 double setting = arg->getDoubleValue("setting");
924 double offset = arg->getDoubleValue("offset", 0.0);
925 double factor = arg->getDoubleValue("factor", 1.0);
926 bool squared = arg->getBoolValue("squared", false);
927 int power = arg->getIntValue("power", (squared ? 2 : 1));
929 int sign = (setting < 0 ? -1 : 1);
935 setting = setting * setting * sign;
938 setting = setting * setting * setting;
941 setting = setting * setting * setting * setting * sign;
944 setting = pow(setting, power);
945 if ((power % 2) == 0)
950 return prop->setDoubleValue((setting + offset) * factor);
955 * Built-in command: cycle a property through a set of values.
957 * If the current value isn't in the list, the cycle will
958 * (re)start from the beginning.
960 * property: the name of the property to cycle.
961 * value[*]: the list of values to cycle through.
964 do_property_cycle (const SGPropertyNode * arg)
966 SGPropertyNode * prop = get_prop(arg);
967 vector<SGPropertyNode_ptr> values = arg->getChildren("value");
969 int nSelections = values.size();
971 if (nSelections < 1) {
972 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
976 // Try to find the current selection
977 for (int i = 0; i < nSelections; i++) {
978 if (compare_values(prop, values[i])) {
984 // Default or wrap to the first selection
985 if (selection < 0 || selection >= nSelections)
988 prop->setUnspecifiedValue(values[selection]->getStringValue());
994 * Built-in command: randomize a numeric property value.
996 * property: the name of the property value to randomize.
997 * min: the minimum allowed value.
998 * max: the maximum allowed value.
1001 do_property_randomize (const SGPropertyNode * arg)
1003 SGPropertyNode * prop = get_prop(arg);
1004 double min = arg->getDoubleValue("min", DBL_MIN);
1005 double max = arg->getDoubleValue("max", DBL_MAX);
1006 prop->setDoubleValue(sg_random() * (max - min) + min);
1012 * Built-in command: reinit the data logging system based on the
1013 * current contents of the /logger tree.
1016 do_data_logging_commit (const SGPropertyNode * arg)
1018 FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
1024 * Built-in command: Add a dialog to the GUI system. Does *not*
1025 * display the dialog. The property node should have the same format
1026 * as a dialog XML configuration. It must include:
1028 * name: the name of the GUI dialog for future reference.
1031 do_dialog_new (const SGPropertyNode * arg)
1033 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1035 // Note the casting away of const: this is *real*. Doing a
1036 // "dialog-apply" command later on will mutate this property node.
1037 // I'm not convinced that this isn't the Right Thing though; it
1038 // allows client to create a node, pass it to dialog-new, and get
1039 // the values back from the dialog by reading the same node.
1040 // Perhaps command arguments are not as "const" as they would
1042 gui->newDialog((SGPropertyNode*)arg);
1047 * Built-in command: Show an XML-configured dialog.
1049 * dialog-name: the name of the GUI dialog to display.
1052 do_dialog_show (const SGPropertyNode * arg)
1054 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1055 gui->showDialog(arg->getStringValue("dialog-name"));
1061 * Built-in Command: Hide the active XML-configured dialog.
1064 do_dialog_close (const SGPropertyNode * arg)
1066 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1067 if(arg->hasValue("dialog-name"))
1068 return gui->closeDialog(arg->getStringValue("dialog-name"));
1069 return gui->closeActiveDialog();
1074 * Update a value in the active XML-configured dialog.
1076 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1079 do_dialog_update (const SGPropertyNode * arg)
1081 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1083 if (arg->hasValue("dialog-name"))
1084 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1086 dialog = gui->getActiveDialog();
1089 dialog->updateValues(arg->getStringValue("object-name"));
1098 * Apply a value in the active XML-configured dialog.
1100 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1103 do_dialog_apply (const SGPropertyNode * arg)
1105 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1107 if (arg->hasValue("dialog-name"))
1108 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1110 dialog = gui->getActiveDialog();
1113 dialog->applyValues(arg->getStringValue("object-name"));
1122 * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1126 do_gui_redraw (const SGPropertyNode * arg)
1128 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1135 * Adds model to the scenery. The path to the added branch (/models/model[*])
1136 * is returned in property "property".
1139 do_add_model (const SGPropertyNode * arg)
1141 SGPropertyNode * model = fgGetNode("models", true);
1142 for (int i = 0;; i++) {
1145 if (!model->getChild("model", i, false)) {
1146 model = model->getChild("model", i, true);
1150 copyProperties(arg, model);
1151 if (model->hasValue("elevation-m"))
1152 model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1153 * SG_METER_TO_FEET);
1154 model->getNode("load", true);
1155 model->removeChildren("load");
1156 const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1162 * Set mouse cursor coordinates and cursor shape.
1165 do_set_cursor (const SGPropertyNode * arg)
1167 if (arg->hasValue("x") || arg->hasValue("y")) {
1168 SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
1169 SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
1170 int x = arg->getIntValue("x", mx->getIntValue());
1171 int y = arg->getIntValue("y", my->getIntValue());
1177 SGPropertyNode *cursor = const_cast<SGPropertyNode *>(arg)->getNode("cursor", true);
1178 if (cursor->getType() != simgear::props::NONE)
1179 fgSetMouseCursor(cursor->getIntValue());
1181 cursor->setIntValue(fgGetMouseCursor());
1187 * Built-in command: play an audio message (i.e. a wav file) This is
1188 * fire and forget. Call this once per message and it will get dumped
1189 * into a queue. Messages are played sequentially so they do not
1193 do_play_audio_sample (const SGPropertyNode * arg)
1195 string path = arg->getStringValue("path");
1196 string file = arg->getStringValue("file");
1197 float volume = arg->getFloatValue("volume");
1198 // cout << "playing " << path << " / " << file << endl;
1200 static FGSampleQueue *queue = 0;
1202 SGSoundMgr *smgr = globals->get_soundmgr();
1203 queue = new FGSampleQueue(smgr, "chatter");
1204 queue->tie_to_listener();
1207 SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1208 msg->set_volume( volume );
1213 } catch (const sg_io_exception&) {
1214 SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1215 "failed to load" << path << '/' << file);
1221 * Built-in command: commit presets (read from in /sim/presets/)
1224 do_presets_commit (const SGPropertyNode * arg)
1226 if (fgGetBool("/sim/initialized", false)) {
1227 fgReInitSubsystems();
1229 // Nasal can trigger this during initial init, which confuses
1230 // the logic in ReInitSubsystems, since initial state has not been
1231 // saved at that time. Short-circuit everything here.
1239 * Built-in command: set log level (0 ... 7)
1242 do_log_level (const SGPropertyNode * arg)
1244 sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1250 * Built-in command: replay the FDR buffer
1253 do_replay (const SGPropertyNode * arg)
1255 // freeze the fdm, resume from sim pause
1256 fgSetInt( "/sim/freeze/replay-state", 1 );
1257 fgSetBool("/sim/freeze/master", 0 );
1258 fgSetBool("/sim/freeze/clock", 0 );
1259 fgSetDouble( "/sim/replay/time", -1 );
1261 // cout << "start = " << r->get_start_time()
1262 // << " end = " << r->get_end_time() << endl;
1269 do_decrease_visibility (const SGPropertyNode * arg)
1271 Environment::Presets::VisibilitySingleton::instance()->adjust( 0.9 );
1276 do_increase_visibility (const SGPropertyNode * arg)
1278 Environment::Presets::VisibilitySingleton::instance()->adjust( 1.1 );
1283 * An fgcommand to allow loading of xml files via nasal,
1284 * the xml file's structure will be made available within
1285 * a property tree node defined under argument "targetnode",
1286 * or in the given argument tree under "data" otherwise.
1288 * @param filename a string to hold the complete path & filename of an XML file
1289 * @param targetnode a string pointing to a location within the property tree
1290 * where to store the parsed XML file. If <targetnode> is undefined, then the
1291 * file contents are stored under a node <data> in the argument tree.
1295 do_load_xml_to_proptree(const SGPropertyNode * arg)
1297 SGPath file(arg->getStringValue("filename"));
1298 if (file.str().empty())
1301 if (file.extension() != "xml")
1302 file.concat(".xml");
1304 if (file.isRelative()) {
1305 file = globals->resolve_maybe_aircraft_path(file.str());
1308 if (!fgValidatePath(file.c_str(), false)) {
1309 SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1310 "(unauthorized access)");
1314 SGPropertyNode *targetnode;
1315 if (arg->hasValue("targetnode"))
1316 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1318 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1321 readProperties(file.c_str(), targetnode, true);
1322 } catch (const sg_exception &e) {
1323 SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1332 * An fgcommand to allow saving of xml files via nasal,
1333 * the file's structure will be determined based on what's
1334 * encountered in the passed (source) property tree node
1336 * @param filename a string to hold the complete path & filename of the (new)
1338 * @param sourcenode a string pointing to a location within the property tree
1339 * where to find the nodes that should be written recursively into an XML file
1340 * @param data if no sourcenode is given, then the file contents are taken from
1341 * the argument tree's "data" node.
1345 do_save_xml_from_proptree(const SGPropertyNode * arg)
1347 SGPath file(arg->getStringValue("filename"));
1348 if (file.str().empty())
1351 if (file.extension() != "xml")
1352 file.concat(".xml");
1354 if (!fgValidatePath(file.c_str(), true)) {
1355 SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1356 "(unauthorized access)");
1360 SGPropertyNode *sourcenode;
1361 if (arg->hasValue("sourcenode"))
1362 sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1363 else if (arg->getNode("data", false))
1364 sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1369 writeProperties (file.c_str(), sourcenode, true);
1370 } catch (const sg_exception &e) {
1371 SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1379 do_press_cockpit_button (const SGPropertyNode *arg)
1381 const char *prefix = arg->getStringValue("prefix");
1383 if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1386 string prop = string(prefix) + "-button";
1389 if (arg->getBoolValue("latching"))
1390 value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1394 fgSetDouble(prop.c_str(), value);
1395 fgSetBool(arg->getStringValue("discrete"), value > 0);
1401 do_release_cockpit_button (const SGPropertyNode *arg)
1403 const char *prefix = arg->getStringValue("prefix");
1405 if (arg->getBoolValue("guarded")) {
1406 string prop = string(prefix) + "-guard";
1407 if (fgGetDouble(prop.c_str()) < 1) {
1408 fgSetDouble(prop.c_str(), 1);
1413 if (! arg->getBoolValue("latching")) {
1414 fgSetDouble((string(prefix) + "-button").c_str(), 0);
1415 fgSetBool(arg->getStringValue("discrete"), false);
1422 ////////////////////////////////////////////////////////////////////////
1424 ////////////////////////////////////////////////////////////////////////
1428 * Table of built-in commands.
1430 * New commands do not have to be added here; any module in the application
1431 * can add a new command using globals->get_commands()->addCommand(...).
1435 SGCommandMgr::command_t command;
1437 { "null", do_null },
1438 { "nasal", do_nasal },
1439 { "exit", do_exit },
1440 { "reset", do_reset },
1441 { "reinit", do_reinit },
1442 { "suspend", do_reinit },
1443 { "resume", do_reinit },
1444 { "pause", do_pause },
1445 { "load", do_load },
1446 { "save", do_save },
1447 { "panel-load", do_panel_load },
1448 { "panel-mouse-click", do_panel_mouse_click },
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 { "timeofday", do_timeofday },
1461 { "property-toggle", do_property_toggle },
1462 { "property-assign", do_property_assign },
1463 { "property-adjust", do_property_adjust },
1464 { "property-multiply", do_property_multiply },
1465 { "property-swap", do_property_swap },
1466 { "property-scale", do_property_scale },
1467 { "property-cycle", do_property_cycle },
1468 { "property-randomize", do_property_randomize },
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 { "gui-redraw", do_gui_redraw },
1476 { "add-model", do_add_model },
1477 { "set-cursor", do_set_cursor },
1478 { "play-audio-sample", do_play_audio_sample },
1479 { "presets-commit", do_presets_commit },
1480 { "log-level", do_log_level },
1481 { "replay", do_replay },
1483 { "decrease-visibility", do_decrease_visibility },
1484 { "increase-visibility", do_increase_visibility },
1486 { "loadxml", do_load_xml_to_proptree},
1487 { "savexml", do_save_xml_from_proptree },
1488 { "press-cockpit-button", do_press_cockpit_button },
1489 { "release-cockpit-button", do_release_cockpit_button },
1490 { "dump-scenegraph", do_dump_scene_graph },
1491 { "dump-terrainbranch", do_dump_terrain_branch },
1492 { "print-visible-scene", do_print_visible_scene_info },
1493 { "reload-shaders", do_reload_shaders },
1494 { 0, 0 } // zero-terminated
1499 * Initialize the default built-in commands.
1501 * Other commands may be added by other parts of the application.
1506 SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1507 for (int i = 0; built_ins[i].name != 0; i++) {
1508 SG_LOG(SG_GENERAL, SG_BULK, " " << built_ins[i].name);
1509 globals->get_commands()->addCommand(built_ins[i].name,
1510 built_ins[i].command);
1513 typedef bool (*dummy)();
1514 fgTie( "/command/view/next", dummy(0), do_view_next );
1515 fgTie( "/command/view/prev", dummy(0), do_view_prev );
1518 // end of fg_commands.cxx