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 <Environment/environment.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/tilemgr.hxx>
35 #include <Scenery/scenery.hxx>
36 #include <Scripting/NasalSys.hxx>
37 #include <Sound/sample_queue.hxx>
38 #include <Time/sunsolver.hxx>
40 #include "fg_init.hxx"
43 #include "fg_commands.hxx"
44 #include "fg_props.hxx"
45 #include "globals.hxx"
48 #include "viewmgr.hxx"
50 #include <Main/viewer.hxx>
58 ////////////////////////////////////////////////////////////////////////
59 // Static helper functions.
60 ////////////////////////////////////////////////////////////////////////
63 static inline SGPropertyNode *
64 get_prop (const SGPropertyNode * arg)
66 return fgGetNode(arg->getStringValue("property[0]", "/null"), true);
69 static inline SGPropertyNode *
70 get_prop2 (const SGPropertyNode * arg)
72 return fgGetNode(arg->getStringValue("property[1]", "/null"), true);
77 * Get a double value and split it as required.
80 split_value (double full_value, const char * mask,
81 double * unmodifiable, double * modifiable)
83 if (!strcmp("integer", mask)) {
84 *modifiable = (full_value < 0 ? ceil(full_value) : floor (full_value));
85 *unmodifiable = full_value - *modifiable;
86 } else if (!strcmp("decimal", mask)) {
87 *unmodifiable = (full_value < 0 ? ceil(full_value) : floor(full_value));
88 *modifiable = full_value - *unmodifiable;
90 if (strcmp("all", mask))
91 SG_LOG(SG_GENERAL, SG_ALERT, "Bad value " << mask << " for mask;"
92 << " assuming 'all'");
94 *modifiable = full_value;
100 * Clamp or wrap a value as specified.
103 limit_value (double * value, const SGPropertyNode * arg)
105 const SGPropertyNode * min_node = arg->getChild("min");
106 const SGPropertyNode * max_node = arg->getChild("max");
108 bool wrap = arg->getBoolValue("wrap");
110 if (min_node == 0 || max_node == 0)
113 if (wrap) { // wrap such that min <= x < max
114 double min_val = min_node->getDoubleValue();
115 double max_val = max_node->getDoubleValue();
116 double resolution = arg->getDoubleValue("resolution");
117 if (resolution > 0.0) {
118 // snap to (min + N*resolution), taking special care to handle imprecision
119 int n = (int)floor((*value - min_val) / resolution + 0.5);
120 int steps = (int)floor((max_val - min_val) / resolution + 0.5);
121 SG_NORMALIZE_RANGE(n, 0, steps);
122 *value = min_val + resolution * n;
124 // plain circular wrapping
125 SG_NORMALIZE_RANGE(*value, min_val, max_val);
127 } else { // clamp such that min <= x <= max
128 if ((min_node != 0) && (*value < min_node->getDoubleValue()))
129 *value = min_node->getDoubleValue();
130 else if ((max_node != 0) && (*value > max_node->getDoubleValue()))
131 *value = max_node->getDoubleValue();
136 compare_values (SGPropertyNode * value1, SGPropertyNode * value2)
138 switch (value1->getType()) {
139 case simgear::props::BOOL:
140 return (value1->getBoolValue() == value2->getBoolValue());
141 case simgear::props::INT:
142 return (value1->getIntValue() == value2->getIntValue());
143 case simgear::props::LONG:
144 return (value1->getLongValue() == value2->getLongValue());
145 case simgear::props::FLOAT:
146 return (value1->getFloatValue() == value2->getFloatValue());
147 case simgear::props::DOUBLE:
148 return (value1->getDoubleValue() == value2->getDoubleValue());
150 return !strcmp(value1->getStringValue(), value2->getStringValue());
156 ////////////////////////////////////////////////////////////////////////
157 // Command implementations.
158 ////////////////////////////////////////////////////////////////////////
162 * Built-in command: do nothing.
165 do_null (const SGPropertyNode * arg)
171 * Built-in command: run a Nasal script.
174 do_nasal (const SGPropertyNode * arg)
176 return ((FGNasalSys*)globals->get_subsystem("nasal"))->handleCommand(arg);
180 * Built-in command: exit FlightGear.
182 * status: the exit status to return to the operating system (defaults to 0)
185 do_exit (const SGPropertyNode * arg)
187 SG_LOG(SG_INPUT, SG_INFO, "Program exit requested.");
188 fgSetBool("/sim/signals/exit", true);
190 if (fgGetBool("/sim/startup/save-on-exit")) {
192 char* envp = ::getenv( "APPDATA" );
193 if ( envp != NULL ) {
194 SGPath config( envp );
195 config.append( "flightgear.org" );
197 if ( homedir != NULL ) {
198 SGPath config( homedir );
199 config.append( ".fgfs" );
201 config.append( "autosave.xml" );
202 config.create_dir( 0700 );
203 SG_LOG(SG_IO, SG_INFO, "Saving user settings to " << config.str());
205 writeProperties(config.str(), globals->get_props(), false, SGPropertyNode::USERARCHIVE);
206 } catch (const sg_exception &e) {
207 guiErrorMessage("Error writing autosave.xml: ", e);
210 SG_LOG(SG_INPUT, SG_DEBUG, "Finished Saving user settings");
214 fgOSExit(arg->getIntValue("status", 0));
220 * Reset FlightGear (Shift-Escape or Menu->File->Reset)
223 do_reset (const SGPropertyNode * arg)
231 * Built-in command: reinitialize one or more subsystems.
233 * subsystem[*]: the name(s) of the subsystem(s) to reinitialize; if
234 * none is specified, reinitialize all of them.
237 do_reinit (const SGPropertyNode * arg)
241 vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
242 if (subsystems.size() == 0) {
243 globals->get_subsystem_mgr()->reinit();
245 for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
246 const char * name = subsystems[i]->getStringValue();
247 SGSubsystem * subsystem = globals->get_subsystem(name);
248 if (subsystem == 0) {
250 SG_LOG( SG_GENERAL, SG_ALERT,
251 "Subsystem " << name << "not found" );
258 globals->get_event_mgr()->reinit();
265 // these routines look useful ??? but are never used in the code ???
269 * Built-in command: suspend one or more subsystems.
271 * subsystem[*] - the name(s) of the subsystem(s) to suspend.
274 do_suspend (const SGPropertyNode * arg)
278 vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
279 for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
280 const char * name = subsystems[i]->getStringValue();
281 SGSubsystem * subsystem = globals->get_subsystem(name);
282 if (subsystem == 0) {
284 SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem " << name << "not found");
286 subsystem->suspend();
293 * Built-in command: suspend one or more subsystems.
295 * subsystem[*] - the name(s) of the subsystem(s) to suspend.
298 do_resume (const SGPropertyNode * arg)
302 vector<SGPropertyNode_ptr> subsystems = arg->getChildren("subsystem");
303 for ( unsigned int i = 0; i < subsystems.size(); i++ ) {
304 const char * name = subsystems[i]->getStringValue();
305 SGSubsystem * subsystem = globals->get_subsystem(name);
306 if (subsystem == 0) {
308 SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem " << name << "not found");
320 * Built-in command: load flight.
322 * file (optional): the name of the file to load (relative to current
323 * directory). Defaults to "fgfs.sav"
326 do_load (const SGPropertyNode * arg)
328 string file = arg->getStringValue("file", "fgfs.sav");
329 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
332 if (!fgValidatePath(file.c_str(), false)) {
333 SG_LOG(SG_IO, SG_ALERT, "load: reading '" << file << "' denied "
334 "(unauthorized access)");
338 ifstream input(file.c_str());
339 if (input.good() && fgLoadFlight(input)) {
341 SG_LOG(SG_INPUT, SG_INFO, "Restored flight from " << file);
344 SG_LOG(SG_INPUT, SG_WARN, "Cannot load flight from " << file);
351 * Built-in command: save flight.
353 * file (optional): the name of the file to save (relative to the
354 * current directory). Defaults to "fgfs.sav".
357 do_save (const SGPropertyNode * arg)
359 string file = arg->getStringValue("file", "fgfs.sav");
360 if (file.size() < 4 || file.substr(file.size() - 4) != ".sav")
363 if (!fgValidatePath(file.c_str(), false)) {
364 SG_LOG(SG_IO, SG_ALERT, "save: writing '" << file << "' denied "
365 "(unauthorized access)");
369 bool write_all = arg->getBoolValue("write-all", false);
370 SG_LOG(SG_INPUT, SG_INFO, "Saving flight");
371 ofstream output(file.c_str());
372 if (output.good() && fgSaveFlight(output, write_all)) {
374 SG_LOG(SG_INPUT, SG_INFO, "Saved flight to " << file);
377 SG_LOG(SG_INPUT, SG_ALERT, "Cannot save flight to " << file);
384 * Built-in command: (re)load the panel.
386 * path (optional): the file name to load the panel from
387 * (relative to FG_ROOT). Defaults to the value of /sim/panel/path,
388 * and if that's unspecified, to "Panels/Default/default.xml".
391 do_panel_load (const SGPropertyNode * arg)
394 arg->getStringValue("path", fgGetString("/sim/panel/path"));
395 if (panel_path.empty()) {
399 FGPanel * new_panel = fgReadPanel(panel_path);
400 if (new_panel == 0) {
401 SG_LOG(SG_INPUT, SG_ALERT,
402 "Error reading new panel from " << panel_path);
405 SG_LOG(SG_INPUT, SG_INFO, "Loaded new panel from " << panel_path);
406 globals->get_current_panel()->unbind();
407 delete globals->get_current_panel();
408 globals->set_current_panel( new_panel );
409 globals->get_current_panel()->bind();
415 * Built-in command: pass a mouse click to the panel.
417 * button: the mouse button number, zero-based.
418 * is-down: true if the button is down, false if it is up.
419 * x-pos: the x position of the mouse click.
420 * y-pos: the y position of the mouse click.
423 do_panel_mouse_click (const SGPropertyNode * arg)
425 if (globals->get_current_panel() != 0)
426 return globals->get_current_panel()
427 ->doMouseAction(arg->getIntValue("button"),
428 arg->getBoolValue("is-down") ? PU_DOWN : PU_UP,
429 arg->getIntValue("x-pos"),
430 arg->getIntValue("y-pos"));
437 * Built-in command: (re)load preferences.
439 * path (optional): the file name to load the panel from (relative
440 * to FG_ROOT). Defaults to "preferences.xml".
443 do_preferences_load (const SGPropertyNode * arg)
446 fgLoadProps(arg->getStringValue("path", "preferences.xml"),
447 globals->get_props());
448 } catch (const sg_exception &e) {
449 guiErrorMessage("Error reading global preferences: ", e);
452 SG_LOG(SG_INPUT, SG_INFO, "Successfully read global preferences.");
459 globals->get_current_view()->setHeadingOffset_deg(0.0);
460 globals->get_viewmgr()->next_view();
466 globals->get_current_view()->setHeadingOffset_deg(0.0);
467 globals->get_viewmgr()->prev_view();
471 * Built-in command: cycle view.
474 do_view_cycle (const SGPropertyNode * arg)
476 globals->get_current_view()->setHeadingOffset_deg(0.0);
477 globals->get_viewmgr()->next_view();
482 * Built-in command: capture screen.
485 do_screen_capture (const SGPropertyNode * arg)
487 return fgDumpSnapShot();
491 do_reload_shaders (const SGPropertyNode*)
493 simgear::reload_shaders();
498 do_dump_scene_graph (const SGPropertyNode*)
505 do_dump_terrain_branch (const SGPropertyNode*)
507 fgDumpTerrainBranch();
509 double lon_deg = fgGetDouble("/position/longitude-deg");
510 double lat_deg = fgGetDouble("/position/latitude-deg");
511 SGGeod geodPos = SGGeod::fromDegFt(lon_deg, lat_deg, 0.0);
512 SGVec3d zero = SGVec3d::fromGeod(geodPos);
514 SG_LOG(SG_INPUT, SG_INFO, "Model parameters:");
515 SG_LOG(SG_INPUT, SG_INFO, "Center: " << zero.x() << ", " << zero.y() << ", " << zero.z() );
516 SG_LOG(SG_INPUT, SG_INFO, "Rotation: " << lat_deg << ", " << lon_deg );
522 * Built-in command: hires capture screen.
525 do_hires_screen_capture (const SGPropertyNode * arg)
533 * Reload the tile cache.
536 do_tile_cache_reload (const SGPropertyNode * arg)
538 static const SGPropertyNode *master_freeze
539 = fgGetNode("/sim/freeze/master");
540 bool freeze = master_freeze->getBoolValue();
541 SG_LOG(SG_INPUT, SG_INFO, "ReIniting TileCache");
543 fgSetBool("/sim/freeze/master", true);
546 globals->get_subsystem("tile-manager")->reinit();
549 fgSetBool("/sim/freeze/master", false);
556 * Set the sea level outside air temperature and assigning that to all
557 * boundary and aloft environment layers.
560 do_set_sea_level_degc ( double temp_sea_level_degc)
562 SGPropertyNode *node, *child;
565 node = fgGetNode( "/environment/config/boundary" );
566 if ( node != NULL ) {
568 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
569 child->setDoubleValue( "temperature-sea-level-degc",
570 temp_sea_level_degc );
576 node = fgGetNode( "/environment/config/aloft" );
577 if ( node != NULL ) {
579 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
580 child->setDoubleValue( "temperature-sea-level-degc",
581 temp_sea_level_degc );
590 do_set_sea_level_degc (const SGPropertyNode * arg)
592 return do_set_sea_level_degc( arg->getDoubleValue("temp-degc", 15.0) );
597 * Set the outside air temperature at the "current" altitude by first
598 * calculating the corresponding sea level temp, and assigning that to
599 * all boundary and aloft environment layers.
602 do_set_oat_degc (const SGPropertyNode * arg)
604 double oat_degc = arg->getDoubleValue("temp-degc", 15.0);
605 // check for an altitude specified in the arguments, otherwise use
606 // current aircraft altitude.
607 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
608 if ( altitude_ft == NULL ) {
609 altitude_ft = fgGetNode("/position/altitude-ft");
612 FGEnvironment dummy; // instantiate a dummy so we can leech a method
613 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
614 dummy.set_temperature_degc( oat_degc );
615 return do_set_sea_level_degc( dummy.get_temperature_sea_level_degc());
619 * Set the sea level outside air dewpoint and assigning that to all
620 * boundary and aloft environment layers.
623 do_set_dewpoint_sea_level_degc (double dewpoint_sea_level_degc)
626 SGPropertyNode *node, *child;
629 node = fgGetNode( "/environment/config/boundary" );
630 if ( node != NULL ) {
632 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
633 child->setDoubleValue( "dewpoint-sea-level-degc",
634 dewpoint_sea_level_degc );
640 node = fgGetNode( "/environment/config/aloft" );
641 if ( node != NULL ) {
643 while ( ( child = node->getNode( "entry", i ) ) != NULL ) {
644 child->setDoubleValue( "dewpoint-sea-level-degc",
645 dewpoint_sea_level_degc );
654 do_set_dewpoint_sea_level_degc (const SGPropertyNode * arg)
656 return do_set_dewpoint_sea_level_degc(arg->getDoubleValue("dewpoint-degc", 5.0));
660 * Set the outside air dewpoint at the "current" altitude by first
661 * calculating the corresponding sea level dewpoint, and assigning
662 * that to all boundary and aloft environment layers.
665 do_set_dewpoint_degc (const SGPropertyNode * arg)
667 double dewpoint_degc = arg->getDoubleValue("dewpoint-degc", 5.0);
669 // check for an altitude specified in the arguments, otherwise use
670 // current aircraft altitude.
671 const SGPropertyNode *altitude_ft = arg->getChild("altitude-ft");
672 if ( altitude_ft == NULL ) {
673 altitude_ft = fgGetNode("/position/altitude-ft");
676 FGEnvironment dummy; // instantiate a dummy so we can leech a method
677 dummy.set_elevation_ft( altitude_ft->getDoubleValue() );
678 dummy.set_dewpoint_degc( dewpoint_degc );
679 return do_set_dewpoint_sea_level_degc(dummy.get_dewpoint_sea_level_degc());
683 * Update the lighting manually.
686 do_timeofday (const SGPropertyNode * arg)
688 const string &offset_type = arg->getStringValue("timeofday", "noon");
690 static const SGPropertyNode *longitude
691 = fgGetNode("/position/longitude-deg");
692 static const SGPropertyNode *latitude
693 = fgGetNode("/position/latitude-deg");
694 static const SGPropertyNode *cur_time_override
695 = fgGetNode("/sim/time/cur-time-override", true);
697 int orig_warp = globals->get_warp();
698 SGTime *t = globals->get_time_params();
699 time_t cur_time = t->get_cur_time();
700 // cout << "cur_time = " << cur_time << endl;
701 // cout << "orig_warp = " << orig_warp << endl;
704 if ( offset_type == "real" ) {
706 } else if ( offset_type == "dawn" ) {
707 warp = fgTimeSecondsUntilSunAngle( cur_time,
708 longitude->getDoubleValue()
709 * SGD_DEGREES_TO_RADIANS,
710 latitude->getDoubleValue()
711 * SGD_DEGREES_TO_RADIANS,
713 } else if ( offset_type == "morning" ) {
714 warp = fgTimeSecondsUntilSunAngle( cur_time,
715 longitude->getDoubleValue()
716 * SGD_DEGREES_TO_RADIANS,
717 latitude->getDoubleValue()
718 * SGD_DEGREES_TO_RADIANS,
720 } else if ( offset_type == "noon" ) {
721 warp = fgTimeSecondsUntilSunAngle( cur_time,
722 longitude->getDoubleValue()
723 * SGD_DEGREES_TO_RADIANS,
724 latitude->getDoubleValue()
725 * SGD_DEGREES_TO_RADIANS,
727 } else if ( offset_type == "afternoon" ) {
728 warp = fgTimeSecondsUntilSunAngle( cur_time,
729 longitude->getDoubleValue()
730 * SGD_DEGREES_TO_RADIANS,
731 latitude->getDoubleValue()
732 * SGD_DEGREES_TO_RADIANS,
734 } else if ( offset_type == "dusk" ) {
735 warp = fgTimeSecondsUntilSunAngle( cur_time,
736 longitude->getDoubleValue()
737 * SGD_DEGREES_TO_RADIANS,
738 latitude->getDoubleValue()
739 * SGD_DEGREES_TO_RADIANS,
741 } else if ( offset_type == "evening" ) {
742 warp = fgTimeSecondsUntilSunAngle( cur_time,
743 longitude->getDoubleValue()
744 * SGD_DEGREES_TO_RADIANS,
745 latitude->getDoubleValue()
746 * SGD_DEGREES_TO_RADIANS,
748 } else if ( offset_type == "midnight" ) {
749 warp = fgTimeSecondsUntilSunAngle( cur_time,
750 longitude->getDoubleValue()
751 * SGD_DEGREES_TO_RADIANS,
752 latitude->getDoubleValue()
753 * SGD_DEGREES_TO_RADIANS,
756 // cout << "warp = " << warp << endl;
757 globals->set_warp( orig_warp + warp );
759 t->update( longitude->getDoubleValue() * SGD_DEGREES_TO_RADIANS,
760 latitude->getDoubleValue() * SGD_DEGREES_TO_RADIANS,
761 cur_time_override->getLongValue(),
762 globals->get_warp() );
769 * Built-in command: toggle a bool property value.
771 * property: The name of the property to toggle.
774 do_property_toggle (const SGPropertyNode * arg)
776 SGPropertyNode * prop = get_prop(arg);
777 return prop->setBoolValue(!prop->getBoolValue());
782 * Built-in command: assign a value to a property.
784 * property: the name of the property to assign.
785 * value: the value to assign; or
786 * property[1]: the property to copy from.
789 do_property_assign (const SGPropertyNode * arg)
791 SGPropertyNode * prop = get_prop(arg);
792 const SGPropertyNode * prop2 = get_prop2(arg);
793 const SGPropertyNode * value = arg->getNode("value");
796 return prop->setUnspecifiedValue(value->getStringValue());
798 return prop->setUnspecifiedValue(prop2->getStringValue());
805 * Built-in command: increment or decrement a property value.
807 * If the 'step' argument is present, it will be used; otherwise,
808 * the command uses 'offset' and 'factor', usually from the mouse.
810 * property: the name of the property to increment or decrement.
811 * step: the amount of the increment or decrement (default: 0).
812 * offset: offset from the current setting (used for the mouse; multiplied
814 * factor: scaling amount for the offset (defaults to 1).
815 * min: the minimum allowed value (default: no minimum).
816 * max: the maximum allowed value (default: no maximum).
817 * mask: 'integer' to apply only to the left of the decimal point,
818 * 'decimal' to apply only to the right of the decimal point,
819 * or 'all' to apply to the whole number (the default).
820 * wrap: true if the value should be wrapped when it passes min or max;
821 * both min and max must be present for this to work (default:
825 do_property_adjust (const SGPropertyNode * arg)
827 SGPropertyNode * prop = get_prop(arg);
830 if (arg->hasValue("step"))
831 amount = arg->getDoubleValue("step");
833 amount = (arg->getDoubleValue("factor", 1)
834 * arg->getDoubleValue("offset"));
836 double unmodifiable, modifiable;
837 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
838 &unmodifiable, &modifiable);
839 modifiable += amount;
840 limit_value(&modifiable, arg);
842 prop->setDoubleValue(unmodifiable + modifiable);
849 * Built-in command: multiply a property value.
851 * property: the name of the property to multiply.
852 * factor: the amount by which to multiply.
853 * min: the minimum allowed value (default: no minimum).
854 * max: the maximum allowed value (default: no maximum).
855 * mask: 'integer' to apply only to the left of the decimal point,
856 * 'decimal' to apply only to the right of the decimal point,
857 * or 'all' to apply to the whole number (the default).
858 * wrap: true if the value should be wrapped when it passes min or max;
859 * both min and max must be present for this to work (default:
863 do_property_multiply (const SGPropertyNode * arg)
865 SGPropertyNode * prop = get_prop(arg);
866 double factor = arg->getDoubleValue("factor", 1);
868 double unmodifiable, modifiable;
869 split_value(prop->getDoubleValue(), arg->getStringValue("mask", "all"),
870 &unmodifiable, &modifiable);
871 modifiable *= factor;
872 limit_value(&modifiable, arg);
874 prop->setDoubleValue(unmodifiable + modifiable);
881 * Built-in command: swap two property values.
883 * property[0]: the name of the first property.
884 * property[1]: the name of the second property.
887 do_property_swap (const SGPropertyNode * arg)
889 SGPropertyNode * prop1 = get_prop(arg);
890 SGPropertyNode * prop2 = get_prop2(arg);
892 // FIXME: inefficient
893 const string & tmp = prop1->getStringValue();
894 return (prop1->setUnspecifiedValue(prop2->getStringValue()) &&
895 prop2->setUnspecifiedValue(tmp.c_str()));
900 * Built-in command: Set a property to an axis or other moving input.
902 * property: the name of the property to set.
903 * setting: the current input setting, usually between -1.0 and 1.0.
904 * offset: the offset to shift by, before applying the factor.
905 * factor: the factor to multiply by (use negative to reverse).
908 do_property_scale (const SGPropertyNode * arg)
910 SGPropertyNode * prop = get_prop(arg);
911 double setting = arg->getDoubleValue("setting");
912 double offset = arg->getDoubleValue("offset", 0.0);
913 double factor = arg->getDoubleValue("factor", 1.0);
914 bool squared = arg->getBoolValue("squared", false);
915 int power = arg->getIntValue("power", (squared ? 2 : 1));
917 int sign = (setting < 0 ? -1 : 1);
923 setting = setting * setting * sign;
926 setting = setting * setting * setting;
929 setting = setting * setting * setting * setting * sign;
932 setting = pow(setting, power);
933 if ((power % 2) == 0)
938 return prop->setDoubleValue((setting + offset) * factor);
943 * Built-in command: cycle a property through a set of values.
945 * If the current value isn't in the list, the cycle will
946 * (re)start from the beginning.
948 * property: the name of the property to cycle.
949 * value[*]: the list of values to cycle through.
952 do_property_cycle (const SGPropertyNode * arg)
954 SGPropertyNode * prop = get_prop(arg);
955 vector<SGPropertyNode_ptr> values = arg->getChildren("value");
957 int nSelections = values.size();
959 if (nSelections < 1) {
960 SG_LOG(SG_GENERAL, SG_ALERT, "No values for property-cycle");
964 // Try to find the current selection
965 for (int i = 0; i < nSelections; i++) {
966 if (compare_values(prop, values[i])) {
972 // Default or wrap to the first selection
973 if (selection < 0 || selection >= nSelections)
976 prop->setUnspecifiedValue(values[selection]->getStringValue());
982 * Built-in command: randomize a numeric property value.
984 * property: the name of the property value to randomize.
985 * min: the minimum allowed value.
986 * max: the maximum allowed value.
989 do_property_randomize (const SGPropertyNode * arg)
991 SGPropertyNode * prop = get_prop(arg);
992 double min = arg->getDoubleValue("min", DBL_MIN);
993 double max = arg->getDoubleValue("max", DBL_MAX);
994 prop->setDoubleValue(sg_random() * (max - min) + min);
1000 * Built-in command: reinit the data logging system based on the
1001 * current contents of the /logger tree.
1004 do_data_logging_commit (const SGPropertyNode * arg)
1006 FGLogger *log = (FGLogger *)globals->get_subsystem("logger");
1012 * Built-in command: Add a dialog to the GUI system. Does *not*
1013 * display the dialog. The property node should have the same format
1014 * as a dialog XML configuration. It must include:
1016 * name: the name of the GUI dialog for future reference.
1019 do_dialog_new (const SGPropertyNode * arg)
1021 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1023 // Note the casting away of const: this is *real*. Doing a
1024 // "dialog-apply" command later on will mutate this property node.
1025 // I'm not convinced that this isn't the Right Thing though; it
1026 // allows client to create a node, pass it to dialog-new, and get
1027 // the values back from the dialog by reading the same node.
1028 // Perhaps command arguments are not as "const" as they would
1030 gui->newDialog((SGPropertyNode*)arg);
1035 * Built-in command: Show an XML-configured dialog.
1037 * dialog-name: the name of the GUI dialog to display.
1040 do_dialog_show (const SGPropertyNode * arg)
1042 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1043 gui->showDialog(arg->getStringValue("dialog-name"));
1049 * Built-in Command: Hide the active XML-configured dialog.
1052 do_dialog_close (const SGPropertyNode * arg)
1054 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1055 if(arg->hasValue("dialog-name"))
1056 return gui->closeDialog(arg->getStringValue("dialog-name"));
1057 return gui->closeActiveDialog();
1062 * Update a value in the active XML-configured dialog.
1064 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1067 do_dialog_update (const SGPropertyNode * arg)
1069 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1071 if (arg->hasValue("dialog-name"))
1072 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1074 dialog = gui->getActiveDialog();
1077 dialog->updateValues(arg->getStringValue("object-name"));
1086 * Apply a value in the active XML-configured dialog.
1088 * object-name: The name of the GUI object(s) (all GUI objects if omitted).
1091 do_dialog_apply (const SGPropertyNode * arg)
1093 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1095 if (arg->hasValue("dialog-name"))
1096 dialog = gui->getDialog(arg->getStringValue("dialog-name"));
1098 dialog = gui->getActiveDialog();
1101 dialog->applyValues(arg->getStringValue("object-name"));
1110 * Redraw GUI (applying new widget colors). Doesn't reload the dialogs,
1114 do_gui_redraw (const SGPropertyNode * arg)
1116 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
1123 * Adds model to the scenery. The path to the added branch (/models/model[*])
1124 * is returned in property "property".
1127 do_add_model (const SGPropertyNode * arg)
1129 SGPropertyNode * model = fgGetNode("models", true);
1130 for (int i = 0;; i++) {
1133 if (!model->getChild("model", i, false)) {
1134 model = model->getChild("model", i, true);
1138 copyProperties(arg, model);
1139 if (model->hasValue("elevation-m"))
1140 model->setDoubleValue("elevation-ft", model->getDoubleValue("elevation-m")
1141 * SG_METER_TO_FEET);
1142 model->getNode("load", true);
1143 model->removeChildren("load");
1144 const_cast<SGPropertyNode *>(arg)->setStringValue("property", model->getPath());
1150 * Set mouse cursor coordinates and cursor shape.
1153 do_set_cursor (const SGPropertyNode * arg)
1155 if (arg->hasValue("x") || arg->hasValue("y")) {
1156 SGPropertyNode *mx = fgGetNode("/devices/status/mice/mouse/x", true);
1157 SGPropertyNode *my = fgGetNode("/devices/status/mice/mouse/y", true);
1158 int x = arg->getIntValue("x", mx->getIntValue());
1159 int y = arg->getIntValue("y", my->getIntValue());
1165 SGPropertyNode *cursor = const_cast<SGPropertyNode *>(arg)->getNode("cursor", true);
1166 if (cursor->getType() != simgear::props::NONE)
1167 fgSetMouseCursor(cursor->getIntValue());
1169 cursor->setIntValue(fgGetMouseCursor());
1175 * Built-in command: play an audio message (i.e. a wav file) This is
1176 * fire and forget. Call this once per message and it will get dumped
1177 * into a queue. Messages are played sequentially so they do not
1181 do_play_audio_sample (const SGPropertyNode * arg)
1183 string path = arg->getStringValue("path");
1184 string file = arg->getStringValue("file");
1185 float volume = arg->getFloatValue("volume");
1186 // cout << "playing " << path << " / " << file << endl;
1188 static FGSampleQueue *queue = 0;
1190 SGSoundMgr *smgr = globals->get_soundmgr();
1191 queue = new FGSampleQueue(smgr, "chatter");
1192 queue->tie_to_listener();
1195 SGSoundSample *msg = new SGSoundSample(file.c_str(), path);
1196 msg->set_volume( volume );
1201 } catch (const sg_io_exception&) {
1202 SG_LOG(SG_GENERAL, SG_ALERT, "play-audio-sample: "
1203 "failed to load" << path << '/' << file);
1209 * Built-in command: commit presets (read from in /sim/presets/)
1212 do_presets_commit (const SGPropertyNode * arg)
1214 fgReInitSubsystems();
1219 * Built-in command: set log level (0 ... 7)
1222 do_log_level (const SGPropertyNode * arg)
1224 sglog().setLogLevels( SG_ALL, (sgDebugPriority)arg->getIntValue() );
1230 * Built-in command: replay the FDR buffer
1233 do_replay (const SGPropertyNode * arg)
1235 // freeze the master fdm
1236 fgSetInt( "/sim/freeze/replay-state", 1 );
1238 FGReplay *r = (FGReplay *)(globals->get_subsystem( "replay" ));
1240 fgSetDouble( "/sim/replay/start-time", r->get_start_time() );
1241 fgSetDouble( "/sim/replay/end-time", r->get_end_time() );
1242 double duration = fgGetDouble( "/sim/replay/duration" );
1243 if( duration && duration < (r->get_end_time() - r->get_start_time()) ) {
1244 fgSetDouble( "/sim/replay/time", r->get_end_time() - duration );
1246 fgSetDouble( "/sim/replay/time", r->get_start_time() );
1249 // cout << "start = " << r->get_start_time()
1250 // << " end = " << r->get_end_time() << endl;
1257 do_decrease_visibility (const SGPropertyNode * arg)
1259 double new_value = fgGetDouble("/environment/visibility-m") * 0.9;
1260 fgSetDouble("/environment/visibility-m", new_value);
1261 fgDefaultWeatherValue("visibility-m", new_value);
1262 globals->get_subsystem("environment")->reinit();
1268 do_increase_visibility (const SGPropertyNode * arg)
1270 double new_value = fgGetDouble("/environment/visibility-m") * 1.1;
1271 fgSetDouble("/environment/visibility-m", new_value);
1272 fgDefaultWeatherValue("visibility-m", new_value);
1273 globals->get_subsystem("environment")->reinit();
1279 * An fgcommand to allow loading of xml files via nasal,
1280 * the xml file's structure will be made available within
1281 * a property tree node defined under argument "targetnode",
1282 * or in the given argument tree under "data" otherwise.
1284 * @param filename a string to hold the complete path & filename of an XML file
1285 * @param targetnode a string pointing to a location within the property tree
1286 * where to store the parsed XML file. If <targetnode> is undefined, then the
1287 * file contents are stored under a node <data> in the argument tree.
1291 do_load_xml_to_proptree(const SGPropertyNode * arg)
1293 SGPath file(arg->getStringValue("filename"));
1294 if (file.str().empty())
1297 if (file.extension() != "xml")
1298 file.concat(".xml");
1300 if (file.isRelative()) {
1301 file = globals->resolve_maybe_aircraft_path(file.str());
1304 if (!fgValidatePath(file.c_str(), false)) {
1305 SG_LOG(SG_IO, SG_ALERT, "loadxml: reading '" << file.str() << "' denied "
1306 "(unauthorized access)");
1310 SGPropertyNode *targetnode;
1311 if (arg->hasValue("targetnode"))
1312 targetnode = fgGetNode(arg->getStringValue("targetnode"), true);
1314 targetnode = const_cast<SGPropertyNode *>(arg)->getNode("data", true);
1317 readProperties(file.c_str(), targetnode, true);
1318 } catch (const sg_exception &e) {
1319 SG_LOG(SG_IO, SG_WARN, "loadxml: " << e.getFormattedMessage());
1328 * An fgcommand to allow saving of xml files via nasal,
1329 * the file's structure will be determined based on what's
1330 * encountered in the passed (source) property tree node
1332 * @param filename a string to hold the complete path & filename of the (new)
1334 * @param sourcenode a string pointing to a location within the property tree
1335 * where to find the nodes that should be written recursively into an XML file
1336 * @param data if no sourcenode is given, then the file contents are taken from
1337 * the argument tree's "data" node.
1341 do_save_xml_from_proptree(const SGPropertyNode * arg)
1343 SGPath file(arg->getStringValue("filename"));
1344 if (file.str().empty())
1347 if (file.extension() != "xml")
1348 file.concat(".xml");
1350 if (!fgValidatePath(file.c_str(), true)) {
1351 SG_LOG(SG_IO, SG_ALERT, "savexml: writing to '" << file.str() << "' denied "
1352 "(unauthorized access)");
1356 SGPropertyNode *sourcenode;
1357 if (arg->hasValue("sourcenode"))
1358 sourcenode = fgGetNode(arg->getStringValue("sourcenode"), true);
1359 else if (arg->getNode("data", false))
1360 sourcenode = const_cast<SGPropertyNode *>(arg)->getNode("data");
1365 writeProperties (file.c_str(), sourcenode, true);
1366 } catch (const sg_exception &e) {
1367 SG_LOG(SG_IO, SG_WARN, "savexml: " << e.getFormattedMessage());
1375 do_press_cockpit_button (const SGPropertyNode *arg)
1377 const char *prefix = arg->getStringValue("prefix");
1379 if (arg->getBoolValue("guarded") && fgGetDouble((string(prefix) + "-guard").c_str()) < 1)
1382 string prop = string(prefix) + "-button";
1385 if (arg->getBoolValue("latching"))
1386 value = fgGetDouble(prop.c_str()) > 0 ? 0 : 1;
1390 fgSetDouble(prop.c_str(), value);
1391 fgSetBool(arg->getStringValue("discrete"), value > 0);
1397 do_release_cockpit_button (const SGPropertyNode *arg)
1399 const char *prefix = arg->getStringValue("prefix");
1401 if (arg->getBoolValue("guarded")) {
1402 string prop = string(prefix) + "-guard";
1403 if (fgGetDouble(prop.c_str()) < 1) {
1404 fgSetDouble(prop.c_str(), 1);
1409 if (! arg->getBoolValue("latching")) {
1410 fgSetDouble((string(prefix) + "-button").c_str(), 0);
1411 fgSetBool(arg->getStringValue("discrete"), false);
1418 ////////////////////////////////////////////////////////////////////////
1420 ////////////////////////////////////////////////////////////////////////
1424 * Table of built-in commands.
1426 * New commands do not have to be added here; any module in the application
1427 * can add a new command using globals->get_commands()->addCommand(...).
1431 SGCommandMgr::command_t command;
1433 { "null", do_null },
1434 { "nasal", do_nasal },
1435 { "exit", do_exit },
1436 { "reset", do_reset },
1437 { "reinit", do_reinit },
1438 { "suspend", do_reinit },
1439 { "resume", do_reinit },
1440 { "load", do_load },
1441 { "save", do_save },
1442 { "panel-load", do_panel_load },
1443 { "panel-mouse-click", do_panel_mouse_click },
1444 { "preferences-load", do_preferences_load },
1445 { "view-cycle", do_view_cycle },
1446 { "screen-capture", do_screen_capture },
1447 { "hires-screen-capture", do_hires_screen_capture },
1448 { "tile-cache-reload", do_tile_cache_reload },
1449 { "set-sea-level-air-temp-degc", do_set_sea_level_degc },
1450 { "set-outside-air-temp-degc", do_set_oat_degc },
1451 { "set-dewpoint-sea-level-air-temp-degc", do_set_dewpoint_sea_level_degc },
1452 { "set-dewpoint-temp-degc", do_set_dewpoint_degc },
1453 { "timeofday", do_timeofday },
1454 { "property-toggle", do_property_toggle },
1455 { "property-assign", do_property_assign },
1456 { "property-adjust", do_property_adjust },
1457 { "property-multiply", do_property_multiply },
1458 { "property-swap", do_property_swap },
1459 { "property-scale", do_property_scale },
1460 { "property-cycle", do_property_cycle },
1461 { "property-randomize", do_property_randomize },
1462 { "data-logging-commit", do_data_logging_commit },
1463 { "dialog-new", do_dialog_new },
1464 { "dialog-show", do_dialog_show },
1465 { "dialog-close", do_dialog_close },
1466 { "dialog-update", do_dialog_update },
1467 { "dialog-apply", do_dialog_apply },
1468 { "gui-redraw", do_gui_redraw },
1469 { "add-model", do_add_model },
1470 { "set-cursor", do_set_cursor },
1471 { "play-audio-sample", do_play_audio_sample },
1472 { "presets-commit", do_presets_commit },
1473 { "log-level", do_log_level },
1474 { "replay", do_replay },
1475 { "decrease-visibility", do_decrease_visibility },
1476 { "increase-visibility", do_increase_visibility },
1477 { "loadxml", do_load_xml_to_proptree},
1478 { "savexml", do_save_xml_from_proptree },
1479 { "press-cockpit-button", do_press_cockpit_button },
1480 { "release-cockpit-button", do_release_cockpit_button },
1481 { "dump-scenegraph", do_dump_scene_graph },
1482 { "dump-terrainbranch", do_dump_terrain_branch },
1483 { "reload-shaders", do_reload_shaders },
1484 { 0, 0 } // zero-terminated
1489 * Initialize the default built-in commands.
1491 * Other commands may be added by other parts of the application.
1496 SG_LOG(SG_GENERAL, SG_BULK, "Initializing basic built-in commands:");
1497 for (int i = 0; built_ins[i].name != 0; i++) {
1498 SG_LOG(SG_GENERAL, SG_BULK, " " << built_ins[i].name);
1499 globals->get_commands()->addCommand(built_ins[i].name,
1500 built_ins[i].command);
1503 typedef bool (*dummy)();
1504 fgTie( "/command/view/next", dummy(0), do_view_next );
1505 fgTie( "/command/view/prev", dummy(0), do_view_prev );
1508 // end of fg_commands.cxx