---

sonix.h

Go to the documentation of this file.

/****************** <SNX heading BEGIN do not edit this line> *****************
 *
 * sonix
 *
 * Original Authors:
 *   Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: sonix.h,v $
 * Date modified: $Date: 2003/06/07 21:20:48 $
 * Version:       $Revision: 1.19 $
 * -----------------------------------------------------------------
 *
 ****************** <SNX heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2003 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

/* Generated by Together */

#ifndef SONIX___H
#define SONIX___H

#include <snx/snxConfig.h>

#include <stdlib.h>
#include <string>
#include <gmtl/Matrix.h>
#include <vpr/Util/Singleton.h>

#include "snx/SoundInfo.h"
#include "snx/SoundImplementation.h"
#include "snx/SoundAPIInfo.h"

class SNX_CLASS_API sonix
{
protected:
   //: default constructor
   sonix() : mImplementation( NULL )
   {
   }

   //: virtual destructor
   virtual ~sonix();

public:

   virtual void trigger( const std::string& alias, const int& repeat = 1 );
   
   virtual bool isPlaying( const std::string& alias );

   /*
    * when sound is already playing then you call trigger,
    * does the sound restart from beginning?
    */
   virtual void setRetriggerable( const std::string& alias, bool onOff );

   virtual bool isRetriggerable( const std::string& alias );

   virtual void stop( const std::string& alias );

   virtual void pause( const std::string& alias );

   virtual void unpause( const std::string& alias );
   
   virtual bool isPaused( const std::string& alias );
   
   virtual void setAmbient( const std::string& alias, bool setting = false );

   virtual bool isAmbient( const std::string& alias );

   virtual void setPitchBend( const std::string& alias, float amount );

   virtual void setVolume( const std::string& alias, float amount );
   
   virtual void setCutoff( const std::string& alias, float amount );
   
   virtual void setPosition( const std::string& alias, const float& x, const float& y, const float& z );

   virtual void getPosition( const std::string& alias, float& x, float& y, float& z );

   virtual void setListenerPosition( const gmtl::Matrix44f& mat );

   virtual void getListenerPosition( gmtl::Matrix44f& mat );


   virtual void changeAPI( const std::string& apiName );

   /*
    * configure the sound API global settings
    */
   virtual void configure( const snx::SoundAPIInfo& sai );

   virtual void configure( const std::string& alias, const snx::SoundInfo& description );

   virtual void remove( const std::string alias );

   virtual void step( const float& timeElapsed );
   
protected:
   snx::ISoundImplementation& impl();

private:
   /*#  snx::SoundFactory lnkSoundFactory; */

   snx::ISoundImplementation* mImplementation;
        
   /*#  snx::SoundInfo lnkSoundInfo; */

   /*#  snx::SoundAPIInfo lnksnx::SoundAPIInfo; */

   vprSingletonHeader(sonix);
};

#endif //SONIX___H

---