src/Sound/fg_fx.hxx

   1 // fgfx.hxx -- Sound effect management class
   2 //
   3 // Started by David Megginson, October 2001
   4 // (Reuses some code from main.cxx, probably by Curtis Olson)
   5 //
   6 // Copyright (C) 2001  Curtis L. Olson - curt@flightgear.org
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 //
  22 // $Id$
  23
  24 #ifndef __FGFX_HXX
  25 #define __FGFX_HXX 1
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include <config.h>
  29 #endif
  30
  31 #include <simgear/compiler.h>
  32 #include <Main/fgfs.hxx>
  33 #include <Main/globals.hxx>
  34
  35 #include "soundmgr.hxx"
  36
  37
  38 /**
  39  * Generator for FlightGear sound effects.
  40  *
  41  * This module uses FGSoundMgr to generate sound effects based
  42  * on current flight conditions.  The sound manager must be initialized
  43  * before this object is.
  44  */
  45 class FGFX : public FGSubsystem
  46 {
  47
  48 public:
  49
  50   enum {
  51     MAX_ENGINES = 2,            // TODO: increase later
  52     MAX_GEAR = 20,
  53   };
  54
  55   FGFX ();
  56   virtual ~FGFX ();
  57
  58   virtual void init ();
  59   virtual void bind ();
  60   virtual void unbind ();
  61   virtual void update ();
  62
  63 private:
  64
  65   void set_playing (const char * soundName, bool state = true);
  66
  67   double _old_flap_position;
  68   double _old_gear_position;
  69
  70   bool _gear_on_ground[MAX_GEAR];
  71
  72                                 // looped sounds
  73   FGSimpleSound * _engine[MAX_ENGINES];
  74   FGSimpleSound * _crank[MAX_ENGINES];
  75   FGSimpleSound * _wind;
  76   FGSimpleSound * _stall;
  77   FGSimpleSound * _rumble;
  78
  79                                 // one-off sounds
  80   FGSimpleSound * _flaps;
  81   FGSimpleSound * _gear_up;
  82   FGSimpleSound * _gear_dn;
  83   FGSimpleSound * _squeal;
  84   FGSimpleSound * _click;
  85
  86                                 // Cached property nodes.
  87   const SGPropertyNode * _engine_running_prop[MAX_ENGINES];
  88   const SGPropertyNode * _engine_cranking_prop[MAX_ENGINES];
  89   const SGPropertyNode * _stall_warning_prop;
  90   const SGPropertyNode * _vc_prop;
  91   const SGPropertyNode * _flaps_prop;
  92   const SGPropertyNode * _gear_prop;
  93
  94 };
  95
  96
  97 #endif
  98
  99 // end of fgfx.hxx