Split up FGFX into a dedicated effects class (FGFX) and a sample queue class. Registe...

[flightgear.git] / src / Sound / fg_fx.hxx

diff --git a/src/Sound/fg_fx.hxx b/src/Sound/fg_fx.hxx
index e3c1e7bc6e8e973428685b7a367e3b83494c1f69..62e111076ba3fb06671acc30e4ed12f4f42d900d 100644 (file)
--- a/src/Sound/fg_fx.hxx
+++ b/src/Sound/fg_fx.hxx
@@ -3,7 +3,7 @@
 // Started by David Megginson, October 2001
 // (Reuses some code from main.cxx, probably by Curtis Olson)
 //
-// Copyright (C) 2001  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 2001  Curtis L. Olson - http://www.flightgear.org/~curt
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -17,41 +17,53 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #ifndef __FGFX_HXX
 #define __FGFX_HXX 1
 
-#include <Main/fgfs.hxx>
+#include <simgear/compiler.h>
 
-class FGSound;
+#include <vector>
+
+#include <simgear/structure/subsystem_mgr.hxx>
+#include <simgear/sound/sample_group.hxx>
+
+class SGXmlSound;
 
 /**
  * Generator for FlightGear sound effects.
  *
- * This module uses FGSoundMgr to generate sound effects based
- * on current flight conditions.  The sound manager must be initialized
+ * This module uses a FGSampleGroup class to generate sound effects based
+ * on current flight conditions. The sound manager must be initialized
  * before this object is.
+ *
+ *    This module will load and play a set of sound effects defined in an
+ *    xml file and tie them to various property states.
  */
-class FGFX : public FGSubsystem
+class FGFX : public SGSampleGroup
 {
 
 public:
 
-  FGFX ();
-  virtual ~FGFX ();
+    FGFX ( SGSoundMgr *smgr, const string &refname );
+    virtual ~FGFX ();
 
-  virtual void init ();
-  virtual void bind ();
-  virtual void unbind ();
-  virtual void update (double dt);
+    virtual void init ();
+    virtual void reinit ();
+    virtual void update (double dt);
 
 private:
 
-  vector<FGSound *> _sound;
+    std::vector<SGXmlSound *> _sound;
+
+    bool last_pause;
+    double last_volume;
 
+    SGPropertyNode_ptr _pause;
+    SGPropertyNode_ptr _volume;
 };