---

SoundHandle.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: SoundHandle.h,v $
 * Date modified: $Date: 2003/06/30 16:36:19 $
 * Version:       $Revision: 1.13 $
 * -----------------------------------------------------------------
 *
 ****************** <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 SOUND_HANDLE
#define SOUND_HANDLE

#include <string>
#include <gmtl/Math.h>
#include <gmtl/Matrix.h>
#include <gmtl/Vec.h>
#include <gmtl/MatrixOps.h>
#include <gmtl/VecOps.h>
#include <gmtl/Xforms.h>

#include <snx/sonix.h>

namespace snx
{
   class SoundHandle
   {
   public:
      
      SoundHandle() : mDefaultName( "unnamed_sound_handle" ), mAlias( mDefaultName )
      {
      }
      
      SoundHandle( const std::string& myUniqueName ) : mAlias( myUniqueName )
      {
      }
      
      void init( const std::string& myUniqueName )
      {
         mAlias = myUniqueName;
      }
      
      std::string getName() const { return mAlias; }
      
      //: virtual destructor
      virtual ~SoundHandle()
      {
         mAlias = "deleted";
      }

   public:

      virtual void trigger( const int& repeat = 1 )
      {
         sonix::instance()->trigger( mAlias, repeat );
      }
      
      virtual bool isPlaying()
      {
         return sonix::instance()->isPlaying( mAlias );
      }  

      /* specify whether sound retriggers from beginning when triggered while playing.
       * when sound is already playing then you call trigger,
       * does the sound restart from beginning?
       */
      virtual void setRetriggerable( bool onOff )
      {
         sonix::instance()->setRetriggerable( mAlias, onOff );
      }
      
      virtual bool isRetriggerable()
      {
         return sonix::instance()->isRetriggerable( mAlias );
      }

      virtual void stop()
      {
         sonix::instance()->stop( mAlias );
      }

      virtual void pause()
      {
         sonix::instance()->pause( mAlias );
      }

      virtual void unpause()
      {
         sonix::instance()->unpause( mAlias );
      }
      
      virtual bool isPaused()
      {
         return sonix::instance()->isPaused( mAlias );
      } 

      virtual void setAmbient( bool setting = false )
      {
         sonix::instance()->setAmbient( mAlias, setting );
      }
      
      virtual bool isAmbient()
      {
         return sonix::instance()->isAmbient( mAlias );
      }

      virtual void setPitchBend( float amount )
      {
         sonix::instance()->setPitchBend( mAlias, amount );
      }
      
      virtual void setVolume( float amount )
      {
         sonix::instance()->setVolume( mAlias, amount );
      }

      virtual void setCutoff( float amount )
      {
         sonix::instance()->setCutoff( mAlias, amount );
      }
      
      virtual void setPosition( const float& x, const float& y, const float& z )
      {
         sonix::instance()->setPosition( mAlias, x, y, z );
      }

      virtual void getPosition( float& x, float& y, float& z )
      {
         sonix::instance()->getPosition( mAlias, x, y, z );
      }

      virtual void setListenerPosition( const gmtl::Matrix44f& mat )
      {
         sonix::instance()->setListenerPosition( mat );
      }

      virtual void getListenerPosition( gmtl::Matrix44f& mat )
      {
         sonix::instance()->getListenerPosition( mat );
      }

      virtual void configure( const snx::SoundInfo& description )
      {
         assert( mAlias != mDefaultName && "you must call init to set your sound's name" );
         sonix::instance()->configure( mAlias, description );
      }

      virtual void remove()
      {
         sonix::instance()->remove( mAlias );
      }   
      
   private:
      std::string mDefaultName;
      std::string mAlias;
   };
}

#endif

---