---

StubSoundImplementation.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: StubSoundImplementation.h,v $
 * Date modified: $Date: 2003/12/01 21:55:42 $
 * Version:       $Revision: 1.18 $
 * -----------------------------------------------------------------
 *
 ****************** <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 SNXSTUBSOUNDIMPLEMENTATION_H
#define SNXSTUBSOUNDIMPLEMENTATION_H
#include <string>
#include <boost/concept_check.hpp>
#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/SoundImplementation.h"
#include "snx/SoundInfo.h"
#include "snx/SoundAPIInfo.h"
#include "snx/Util/Debug.h"

namespace snx
{

class StubSoundImplementation : public snx::SoundImplementation
{
public:
   StubSoundImplementation() : snx::SoundImplementation() { this->setName( "Stub" ); }

   virtual ~StubSoundImplementation()
   {
   }

   virtual void clone( snx::ISoundImplementation* &newCopy )
   {
      StubSoundImplementation* temp = new StubSoundImplementation;

      // copy state, so that we return a true "clone"
      temp->copy( *this );
      
      newCopy = temp;
   }
   
   virtual void trigger( const std::string & alias, const int & looping = 0 )
   {
      snx::SoundImplementation::trigger( alias, looping );
      this->lookup( alias ).triggerOnNextBind = true;
      // do nothing
      //std::cout << "[snx]Stub::trigger (does nothing)\n"<<std::flush;
   }

   virtual void stop( const std::string & alias )
   {
      snx::SoundImplementation::stop( alias );
      this->lookup( alias ).triggerOnNextBind = false;
      // do nothing
      //std::cout << "[snx]Stub::stop (does nothing)\n"<<std::flush;
   }

   virtual void setPosition( const std::string& alias, float x, float y, float z )
   {
      snx::SoundImplementation::setPosition( alias, x, y, z );
   }

   virtual void getPosition( const std::string& alias, float& x, float& y, float& z )
   {
      snx::SoundImplementation::getPosition( alias, x, y, z );
   }
   
   virtual void setListenerPosition( const gmtl::Matrix44f& mat )
   {
      snx::SoundImplementation::setListenerPosition( mat );
   }

   virtual void getListenerPosition( gmtl::Matrix44f& mat )
   {
      snx::SoundImplementation::getListenerPosition( mat );
   }
   
   virtual int startAPI()
   {
       vpr::DebugOutputGuard output1(snxDBG, vprDBG_CONFIG_LVL, std::string("Stub::startAPI (does nothing)\n"), std::string("\n"));
       return 1;
   }
   
   virtual void shutdownAPI()
   {
      vpr::DebugOutputGuard output2(snxDBG, vprDBG_CONFIG_LVL, std::string("Stub::shutdownAPI (does nothing)\n"), std::string("\n"));
   }   

   virtual bool isStarted() const
   {
      return true;
   }

   virtual void configure( const snx::SoundAPIInfo& sai )
   {
      // nothing to do, call the base impl...
      SoundImplementation::configure( sai );
   }   
   
   virtual void configure( const std::string& alias, const snx::SoundInfo& description )
   {
      snx::SoundImplementation::configure( alias, description );
      // do nothing
   }

   virtual void remove( const std::string& alias )
   {
      snx::SoundImplementation::remove( alias );
      // do nothing
   }

   virtual void clear()
   {
   }   
   
   virtual void bindAll()
   {
   }   

   virtual void unbindAll()
   {
   }

   virtual void bind( const std::string& alias )
   {
      boost::ignore_unused_variable_warning(alias);
   }   

   virtual void unbind( const std::string& alias )
   {
      boost::ignore_unused_variable_warning(alias);
   }

   virtual void step( const float & timeElapsed )
   {
      snx::SoundImplementation::step( timeElapsed );
      // do nothing
   }

   void operator delete(void* p)
   {
      ::operator delete(p);
   }

protected:
   virtual void destroy()
   {
      delete this;
   }

private:  

   /*#  snx::SoundInfo lnkSoundInfo; */

   /*#  snx::SoundAPIInfo lnkSoundAPIInfo; */
};

} // end namespace

#endif //SNXSTUBSOUNDIMPLEMENTATION_H

---