---

ISoundImplementation.h

Go to the documentation of this file.

/****************** <SNX heading BEGIN do not edit this line> *****************
 *
 * sonix
 *
 * Original Authors:
 *   Kevin Meinert
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: ISoundImplementation.h,v $
 * Date modified: $Date: 2003/12/06 03:19:21 $
 * Version:       $Revision: 1.8 $
 * -----------------------------------------------------------------
 *
 ****************** <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> ***************/

#ifndef SNXSOUNDIMPLEMENTATION_INTERFACE_H
#define SNXSOUNDIMPLEMENTATION_INTERFACE_H

#include <snx/snxConfig.h>

#include <string>
#include <gmtl/Matrix.h>
#include <vpr/vpr.h>

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

namespace snx
{

class ISoundImplementation
{
public:
   ISoundImplementation() {}

   virtual void clone( ISoundImplementation* &newCopy ) = 0; 
   
   virtual ~ISoundImplementation() {}

public:

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

   virtual bool isPlaying( const std::string& alias ) = 0;
   
   virtual void setRetriggerable( const std::string& alias, bool onOff ) = 0;
   
   virtual bool isRetriggerable( const std::string& alias ) = 0;

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

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

   virtual void unpause( const std::string& alias ) = 0;

   virtual bool isPaused( const std::string& alias ) = 0;
   
   virtual void setAmbient( const std::string& alias, bool ambient = false ) = 0;
   
   virtual bool isAmbient( const std::string& alias ) = 0;

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

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

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

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

   virtual int startAPI() = 0;

   virtual bool isStarted() const = 0;   
   
   virtual void shutdownAPI() = 0;

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

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

   virtual void remove(const std::string& alias) = 0;

   virtual void step( const float& timeElapsed ) = 0;

   virtual void clear() = 0;

   virtual void bindAll() = 0;

   virtual void unbindAll() = 0;

   virtual void bind( const std::string& alias ) = 0;

   virtual void unbind( const std::string& alias ) = 0;

   virtual snx::SoundInfo& lookup( const std::string& alias ) = 0;

   virtual void setName( const std::string& name ) = 0;
   
   virtual std::string& name() = 0;

#ifdef VPR_OS_Win32

   void operator delete(void* p)
   {
      if ( NULL != p )
      {
         ISoundImplementation* sound_ptr = static_cast<ISoundImplementation*>(p);
         sound_ptr->destroy();
      }
   }
#endif

protected:
   virtual void destroy() = 0;
};

} // end namespace

#endif //SNXSOUNDIMPLEMENTATION_INTERFACE_H

---