src/Controls/controls.hxx

   1 // controls.hxx -- defines a standard interface to all flight sim controls
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _CONTROLS_HXX
  25 #define _CONTROLS_HXX
  26
  27 #include <simgear/props/props.hxx>
  28 #include <simgear/structure/subsystem_mgr.hxx>
  29
  30 #include <Main/globals.hxx>
  31
  32 #ifndef __cplusplus
  33 # error This library requires C++
  34 #endif
  35
  36
  37 // Define a structure containing the control parameters
  38
  39 class FGControls : public SGSubsystem
  40 {
  41
  42 public:
  43
  44     enum {
  45         ALL_ENGINES = -1,
  46         MAX_ENGINES = 10
  47     };
  48
  49     enum {
  50         ALL_WHEELS = -1,
  51         MAX_WHEELS = 3
  52     };
  53
  54     enum {
  55         ALL_TANKS = -1,
  56         MAX_TANKS = 8
  57     };
  58
  59     enum {
  60         ALL_BOOSTPUMPS = -1,
  61         MAX_BOOSTPUMPS = 2
  62     };
  63
  64     enum {
  65         ALL_HYD_SYSTEMS = -1,
  66         MAX_HYD_SYSTEMS = 4
  67     };
  68
  69     enum {
  70         ALL_PACKS = -1,
  71         MAX_PACKS = 4
  72     };
  73
  74     enum {
  75         ALL_LIGHTS = -1,
  76         MAX_LIGHTS = 4
  77     };
  78
  79     enum {
  80         ALL_STATIONS = -1,
  81         MAX_STATIONS = 12
  82     };
  83
  84     enum {
  85         ALL_AUTOPILOTS = -1,
  86         MAX_AUTOPILOTS = 3
  87     };
  88
  89     enum {
  90         ALL_EJECTION_SEATS = -1,
  91         MAX_EJECTION_SEATS = 10
  92     };
  93
  94     enum {
  95         SEAT_SAFED = -1,
  96         SEAT_ARMED = 0,
  97         SEAT_FAIL = 1
  98     };
  99
 100     enum {
 101         CMD_SEL_NORM = -1,
 102         CMD_SEL_AFT = 0,
 103         CMD_SEL_SOLO = 1
 104     };
 105
 106 private:
 107     // controls/flight/
 108     double aileron;
 109     double aileron_trim;
 110     double elevator;
 111     double elevator_trim;
 112     double rudder;
 113     double rudder_trim;
 114     double flaps;
 115     double slats;
 116     bool BLC;          // Boundary Layer Control
 117     double spoilers;
 118     double speedbrake;
 119     double wing_sweep;
 120     bool wing_fold;
 121     bool drag_chute;
 122
 123     // controls/engines/
 124     bool throttle_idle;
 125
 126     // controls/engines/engine[n]/
 127     double throttle[MAX_ENGINES];
 128     bool starter[MAX_ENGINES];
 129     bool fuel_pump[MAX_ENGINES];
 130     bool fire_switch[MAX_ENGINES];
 131     bool fire_bottle_discharge[MAX_ENGINES];
 132     bool cutoff[MAX_ENGINES];
 133     double mixture[MAX_ENGINES];
 134     double prop_advance[MAX_ENGINES];
 135     int magnetos[MAX_ENGINES];
 136     bool nitrous_injection[MAX_ENGINES];  // War Emergency Power
 137     double cowl_flaps_norm[MAX_ENGINES];
 138     bool feather[MAX_ENGINES];
 139     int ignition[MAX_ENGINES];
 140     bool augmentation[MAX_ENGINES];
 141     bool reverser[MAX_ENGINES];
 142     bool water_injection[MAX_ENGINES];
 143     double condition[MAX_ENGINES];           // turboprop speed select
 144
 145     // controls/fuel/
 146     bool dump_valve;
 147
 148     // controls/fuel/tank[n]/
 149     bool fuel_selector[MAX_TANKS];
 150     int to_engine[MAX_TANKS];
 151     int to_tank[MAX_TANKS];
 152
 153     // controls/fuel/tank[n]/pump[p]/
 154     bool boost_pump[MAX_TANKS * MAX_BOOSTPUMPS];
 155
 156     // controls/gear/
 157     double brake_left;
 158     double brake_right;
 159     double copilot_brake_left;
 160     double copilot_brake_right;
 161     double brake_parking;
 162     double steering;
 163     bool gear_down;
 164     bool antiskid;
 165     bool tailhook;
 166     bool tailwheel_lock;
 167
 168     // controls/gear/wheel[n]/
 169     bool alternate_extension[MAX_WHEELS];
 170
 171     // controls/anti-ice/
 172     bool wing_heat;
 173     bool pitot_heat;
 174     int wiper;
 175     bool window_heat;
 176
 177     // controls/anti-ice/engine[n]/
 178     bool carb_heat[MAX_ENGINES];
 179     bool inlet_heat[MAX_ENGINES];
 180
 181     // controls/hydraulic/system[n]/
 182     bool engine_pump[MAX_HYD_SYSTEMS];
 183     bool electric_pump[MAX_HYD_SYSTEMS];
 184
 185     // controls/electric/
 186     bool battery_switch;
 187     bool external_power;
 188     bool APU_generator;
 189
 190     // controls/electric/engine[n]/
 191     bool generator_breaker[MAX_ENGINES];
 192     bool bus_tie[MAX_ENGINES];
 193
 194     // controls/pneumatic/
 195     bool APU_bleed;
 196
 197     // controls/pneumatic/engine[n]/
 198     bool engine_bleed[MAX_ENGINES];
 199
 200     // controls/pressurization/
 201     int mode;
 202     bool dump;
 203     double outflow_valve;
 204
 205     // controls/pressurization/pack[n]/
 206     bool pack_on[MAX_PACKS];
 207
 208     // controls/lighting/
 209     bool landing_lights;
 210     bool turn_off_lights;
 211     bool taxi_light;
 212     bool logo_lights;
 213     bool nav_lights;
 214     bool beacon;
 215     bool strobe;
 216     double panel_norm;
 217     double instruments_norm;
 218     double dome_norm;
 219
 220     // controls/armament/
 221     bool master_arm;
 222     int station_select;
 223     bool release_ALL;
 224
 225     // controls/armament/station[n]/
 226     int stick_size[MAX_STATIONS];
 227     bool release_stick[MAX_STATIONS];
 228     bool release_all[MAX_STATIONS];
 229     bool jettison_all[MAX_STATIONS];
 230
 231     // controls/seat/
 232     double vertical_adjust;
 233     double fore_aft_adjust;
 234     bool eject[MAX_EJECTION_SEATS];
 235     int eseat_status[MAX_EJECTION_SEATS];
 236     int cmd_selector_valve;
 237
 238     // controls/APU/
 239     int off_start_run;
 240     bool APU_fire_switch;
 241
 242     // controls/autoflight/autopilot[n]/
 243     bool autopilot_engage[MAX_AUTOPILOTS];
 244
 245     // controls/autoflight/
 246     bool autothrottle_arm;
 247     bool autothrottle_engage;
 248     double heading_select;
 249     double altitude_select;
 250     double bank_angle_select;
 251     double vertical_speed_select;
 252     double speed_select;
 253     double mach_select;
 254     int vertical_mode;
 255     int lateral_mode;
 256
 257
 258     SGPropertyNode * auto_coordination;
 259
 260 public:
 261
 262     FGControls();
 263     ~FGControls();
 264
 265     // Implementation of SGSubsystem.
 266     void init ();
 267     void bind ();
 268     void unbind ();
 269     void update (double dt);
 270
 271     // Reset function
 272     void reset_all(void);
 273
 274     // Query functions
 275     // controls/flight/
 276     inline double get_aileron() const { return aileron; }
 277     inline double get_aileron_trim() const { return aileron_trim; }
 278     inline double get_elevator() const { return elevator; }
 279     inline double get_elevator_trim() const { return elevator_trim; }
 280     inline double get_rudder() const { return rudder; }
 281     inline double get_rudder_trim() const { return rudder_trim; }
 282     inline double get_flaps() const { return flaps; }
 283     inline double get_slats() const { return slats; }
 284     inline bool get_BLC() const { return BLC; }
 285     inline double get_spoilers() const { return spoilers; }
 286     inline double get_speedbrake() const { return speedbrake; }
 287     inline double get_wing_sweep() const { return wing_sweep; }
 288     inline bool get_wing_fold() const { return wing_fold; }
 289     inline bool get_drag_chute() const { return drag_chute; }
 290
 291     // controls/engines/
 292     inline bool get_throttle_idle() const { return throttle_idle; }
 293
 294     // controls/engines/engine[n]/
 295     inline double get_throttle(int engine) const { return throttle[engine]; }
 296     inline bool get_starter(int engine) const { return starter[engine]; }
 297     inline bool get_fuel_pump(int engine) const { return fuel_pump[engine]; }
 298     inline bool get_fire_switch(int engine) const { return fire_switch[engine]; }
 299     inline bool get_fire_bottle_discharge(int engine) const {
 300         return fire_bottle_discharge[engine];
 301     }
 302     inline bool get_cutoff(int engine) const { return cutoff[engine]; }
 303     inline double get_mixture(int engine) const { return mixture[engine]; }
 304     inline double get_prop_advance(int engine) const {
 305         return prop_advance[engine];
 306     }
 307     inline int get_magnetos(int engine) const { return magnetos[engine]; }
 308     inline bool get_nitrous_injection(int engine) const {
 309         return nitrous_injection[engine];
 310     }
 311     inline double get_cowl_flaps_norm(int engine) const {
 312         return cowl_flaps_norm[engine];
 313     }
 314     inline bool get_feather(int engine) const { return feather[engine]; }
 315     inline int get_ignition(int engine) const { return ignition[engine]; }
 316     inline bool get_augmentation(int engine) const { return augmentation[engine]; }
 317     inline bool get_reverser(int engine) const { return reverser[engine]; }
 318     inline bool get_water_injection(int engine) const {
 319         return water_injection[engine];
 320     }
 321     inline double get_condition(int engine) const { return condition[engine]; }
 322
 323     // controls/fuel/
 324     inline bool get_dump_valve() const { return dump_valve; }
 325
 326     // controls/fuel/tank[n]/
 327     inline bool get_fuel_selector(int tank) const {
 328         return fuel_selector[tank];
 329     }
 330     inline int get_to_engine(int tank) const { return to_engine[tank]; }
 331     inline int get_to_tank(int tank) const { return to_tank[tank]; }
 332
 333     // controls/fuel/tank[n]/pump[p]/
 334     inline bool get_boost_pump(int index) const {
 335         return boost_pump[index];
 336     }
 337
 338     // controls/gear/
 339     inline double get_brake_left() const { return brake_left; }
 340     inline double get_brake_right() const { return brake_right; }
 341     inline double get_copilot_brake_left() const { return copilot_brake_left; }
 342     inline double get_copilot_brake_right() const { return copilot_brake_right; }
 343     inline double get_brake_parking() const { return brake_parking; }
 344     inline double get_steering() const { return steering; }
 345     inline bool get_gear_down() const { return gear_down; }
 346     inline bool get_antiskid() const { return antiskid; }
 347     inline bool get_tailhook() const { return tailhook; }
 348     inline bool get_tailwheel_lock() const { return tailwheel_lock; }
 349
 350     // controls/gear/wheel[n]/
 351     inline bool get_alternate_extension(int wheel) const {
 352         return alternate_extension[wheel];
 353     }
 354
 355     // controls/anti-ice/
 356     inline bool get_wing_heat() const { return wing_heat; }
 357     inline bool get_pitot_heat() const { return pitot_heat; }
 358     inline int get_wiper() const { return wiper; }
 359     inline bool get_window_heat() const { return window_heat; }
 360
 361     // controls/anti-ice/engine[n]/
 362     inline bool get_carb_heat(int engine) const { return carb_heat[engine]; }
 363     inline bool get_inlet_heat(int engine) const { return inlet_heat[engine]; }
 364
 365     // controls/hydraulic/system[n]/
 366     inline bool get_engine_pump(int system) const { return engine_pump[system]; }
 367     inline bool get_electric_pump(int system) const { return electric_pump[system]; }
 368
 369     // controls/electric/
 370     inline bool get_battery_switch() const { return battery_switch; }
 371     inline bool get_external_power() const { return external_power; }
 372     inline bool get_APU_generator() const { return APU_generator; }
 373
 374     // controls/electric/engine[n]/
 375     inline bool get_generator_breaker(int engine) const {
 376         return generator_breaker[engine];
 377     }
 378     inline bool get_bus_tie(int engine) const { return bus_tie[engine]; }
 379
 380     // controls/pneumatic/
 381     inline bool get_APU_bleed() const { return APU_bleed; }
 382
 383     // controls/pneumatic/engine[n]/
 384     inline bool get_engine_bleed(int engine) const { return engine_bleed[engine]; }
 385
 386     // controls/pressurization/
 387     inline int get_mode() const { return mode; }
 388     inline double get_outflow_valve() const { return outflow_valve; }
 389     inline bool get_dump() const { return dump; }
 390
 391     // controls/pressurization/pack[n]/
 392     inline bool get_pack_on(int pack) const { return pack_on[pack]; }
 393
 394     // controls/lighting/
 395     inline bool get_landing_lights() const { return landing_lights; }
 396     inline bool get_turn_off_lights() const { return  turn_off_lights; }
 397     inline bool get_taxi_light() const { return taxi_light; }
 398     inline bool get_logo_lights() const { return logo_lights; }
 399     inline bool get_nav_lights() const { return nav_lights; }
 400     inline bool get_beacon() const { return beacon; }
 401     inline bool get_strobe() const { return strobe; }
 402     inline double get_panel_norm() const { return panel_norm; }
 403     inline double get_instruments_norm() const { return instruments_norm; }
 404     inline double get_dome_norm() const { return dome_norm; }
 405
 406 #ifdef FG_HAVE_ARMAMENT
 407     // controls/armament/
 408     inline bool get_master_arm() const { return master_arm; }
 409     inline int get_station_select() const { return station_select; }
 410     inline bool get_release_ALL() const { return release_ALL; }
 411
 412       // controls/armament/station[n]/
 413     inline int get_stick_size(int station) const { return stick_size[station]; }
 414     inline bool get_release_stick(int station) const { return release_stick[station]; }
 415     inline bool get_release_all(int station) const { return release_all[station]; }
 416     inline bool get_jettison_all(int station) const { return jettison_all[station]; }
 417 #endif
 418
 419     // controls/seat/
 420     inline double get_vertical_adjust() const { return vertical_adjust; }
 421     inline double get_fore_aft_adjust() const { return fore_aft_adjust; }
 422     inline bool get_ejection_seat( int which_seat ) const {
 423         return eject[which_seat];
 424     }
 425     inline int get_eseat_status( int which_seat ) const {
 426         return eseat_status[which_seat];
 427     }
 428     inline int get_cmd_selector_valve() const { return cmd_selector_valve; }
 429
 430
 431     // controls/APU/
 432     inline int get_off_start_run() const { return off_start_run; }
 433     inline bool get_APU_fire_switch() const { return APU_fire_switch; }
 434
 435     // controls/autoflight/
 436     inline bool get_autothrottle_arm() const { return autothrottle_arm; }
 437     inline bool get_autothrottle_engage() const { return autothrottle_engage; }
 438     inline double get_heading_select() const { return heading_select; }
 439     inline double get_altitude_select() const { return altitude_select; }
 440     inline double get_bank_angle_select() const { return bank_angle_select; }
 441     inline double get_vertical_speed_select() const {
 442         return vertical_speed_select;
 443     }
 444     inline double get_speed_select() const { return speed_select; }
 445     inline double get_mach_select() const { return mach_select; }
 446     inline int get_vertical_mode() const { return vertical_mode; }
 447     inline int get_lateral_mode() const { return lateral_mode; }
 448
 449     // controls/autoflight/autopilot[n]/
 450     inline bool get_autopilot_engage(int ap) const {
 451         return autopilot_engage[ap];
 452     }
 453
 454
 455     // Update functions
 456     // controls/flight/
 457     void set_aileron( double pos );
 458     void move_aileron( double amt );
 459     void set_aileron_trim( double pos );
 460     void move_aileron_trim( double amt );
 461     void set_elevator( double pos );
 462     void move_elevator( double amt );
 463     void set_elevator_trim( double pos );
 464     void move_elevator_trim( double amt );
 465     void set_rudder( double pos );
 466     void move_rudder( double amt );
 467     void set_rudder_trim( double pos );
 468     void move_rudder_trim( double amt );
 469     void set_flaps( double pos );
 470     void move_flaps( double amt );
 471     void set_slats( double pos );
 472     void move_slats( double amt );
 473     void set_BLC( bool val );
 474     void set_spoilers( double pos );
 475     void move_spoilers( double amt );
 476     void set_speedbrake( double pos );
 477     void move_speedbrake( double amt );
 478     void set_wing_sweep( double pos );
 479     void move_wing_sweep( double amt );
 480     void set_wing_fold( bool val );
 481     void set_drag_chute( bool val );
 482
 483     // controls/engines/
 484     void set_throttle_idle( bool val );
 485
 486     // controls/engines/engine[n]/
 487     void set_throttle( int engine, double pos );
 488     void move_throttle( int engine, double amt );
 489     void set_starter( int engine, bool flag );
 490     void set_fuel_pump( int engine, bool val );
 491     void set_fire_switch( int engine, bool val );
 492     void set_fire_bottle_discharge( int engine, bool val );
 493     void set_cutoff( int engine, bool val );
 494     void set_mixture( int engine, double pos );
 495     void move_mixture( int engine, double amt );
 496     void set_prop_advance( int engine, double pos );
 497     void move_prop_advance( int engine, double amt );
 498     void set_magnetos( int engine, int pos );
 499     void move_magnetos( int engine, int amt );
 500     void set_nitrous_injection( int engine, bool val );
 501     void set_cowl_flaps_norm( int engine, double pos );
 502     void move_cowl_flaps_norm( int engine, double amt );
 503     void set_feather( int engine, bool val );
 504     void set_ignition( int engine, int val );
 505     void set_augmentation( int engine, bool val );
 506     void set_reverser( int engine, bool val );
 507     void set_water_injection( int engine, bool val );
 508     void set_condition( int engine, double val );
 509
 510     // controls/fuel
 511     void set_dump_valve( bool val );
 512
 513     // controls/fuel/tank[n]/
 514     void set_fuel_selector( int tank, bool pos );
 515     void set_to_engine( int tank, int engine );
 516     void set_to_tank( int tank, int dest_tank );
 517
 518     // controls/fuel/tank[n]/pump[p]
 519     void set_boost_pump( int index, bool val );
 520
 521     // controls/gear/
 522     void set_brake_left( double pos );
 523     void move_brake_left( double amt );
 524     void set_brake_right( double pos );
 525     void move_brake_right( double amt );
 526     void set_copilot_brake_left( double pos );
 527     void set_copilot_brake_right( double pos );
 528     void set_brake_parking( double pos );
 529     void set_steering( double pos );
 530     void move_steering( double amt );
 531     void set_gear_down( bool gear );
 532     void set_antiskid( bool val );
 533     void set_tailhook( bool val );
 534     void set_tailwheel_lock( bool val );
 535
 536     // controls/gear/wheel[n]/
 537     void set_alternate_extension( int wheel, bool val );
 538
 539     // controls/anti-ice/
 540     void set_wing_heat( bool val );
 541     void set_pitot_heat( bool val );
 542     void set_wiper( int speed );
 543     void set_window_heat( bool val );
 544
 545     // controls/anti-ice/engine[n]/
 546     void set_carb_heat( int engine, bool val );
 547     void set_inlet_heat( int engine, bool val );
 548
 549     // controls/hydraulic/system[n]/
 550     void set_engine_pump( int system, bool val );
 551     void set_electric_pump( int system, bool val );
 552
 553     // controls/electric/
 554     void set_battery_switch( bool val );
 555     void set_external_power( bool val );
 556     void set_APU_generator( bool val );
 557
 558     // controls/electric/engine[n]/
 559     void set_generator_breaker( int engine, bool val );
 560     void set_bus_tie( int engine, bool val );
 561
 562     // controls/pneumatic/
 563     void set_APU_bleed( bool val );
 564
 565     // controls/pneumatic/engine[n]/
 566     void set_engine_bleed( int engine, bool val );
 567
 568     // controls/pressurization/
 569     void set_mode( int mode );
 570     void set_outflow_valve( double pos );
 571     void move_outflow_valve( double amt );
 572     void set_dump( bool val );
 573
 574     // controls/pressurization/pack[n]/
 575     void set_pack_on( int pack, bool val );
 576
 577     // controls/lighting/
 578     void set_landing_lights( bool val );
 579     void set_turn_off_lights( bool val );
 580     void set_taxi_light( bool val );
 581     void set_logo_lights( bool val );
 582     void set_nav_lights( bool val );
 583     void set_beacon( bool val );
 584     void set_strobe( bool val );
 585     void set_panel_norm( double intensity );
 586     void move_panel_norm( double amt );
 587     void set_instruments_norm( double intensity );
 588     void move_instruments_norm( double amt );
 589     void set_dome_norm( double intensity );
 590     void move_dome_norm( double amt );
 591
 592 #ifdef FG_HAVE_ARMAMENT
 593     // controls/armament/
 594     void set_master_arm( bool val );
 595     void set_station_select( int station );
 596     void set_release_ALL( bool val );
 597
 598     // controls/armament/station[n]/
 599     void set_stick_size( int station, int size );
 600     void set_release_stick( int station, bool val );
 601     void set_release_all( int station, bool val );
 602     void set_jettison_all( int station, bool val );
 603 #endif
 604
 605     // controls/seat/
 606     void set_vertical_adjust( double pos );
 607     void move_vertical_adjust( double amt );
 608     void set_fore_aft_adjust( double pos );
 609     void move_fore_aft_adjust( double amt );
 610     void set_ejection_seat( int which_seat, bool val );
 611     void set_eseat_status( int which_seat, int val );
 612     void set_cmd_selector_valve( int val );
 613
 614     // controls/APU/
 615     void set_off_start_run( int pos );
 616     void set_APU_fire_switch( bool val );
 617
 618     // controls/autoflight/
 619     void set_autothrottle_arm( bool val );
 620     void set_autothrottle_engage( bool val );
 621     void set_heading_select( double heading );
 622     void move_heading_select( double amt );
 623     void set_altitude_select( double altitude );
 624     void move_altitude_select( double amt );
 625     void set_bank_angle_select( double angle );
 626     void move_bank_angle_select( double amt );
 627     void set_vertical_speed_select( double vs );
 628     void move_vertical_speed_select( double amt );
 629     void set_speed_select( double speed );
 630     void move_speed_select( double amt );
 631     void set_mach_select( double mach );
 632     void move_mach_select( double amt );
 633     void set_vertical_mode( int mode );
 634     void set_lateral_mode( int mode );
 635
 636     // controls/autoflight/autopilot[n]/
 637     void set_autopilot_engage( int ap, bool val );
 638
 639 };
 640
 641
 642 #endif // _CONTROLS_HXX
 643
 644