root/juggler/tags/1.0.5/Sound/vjSoundHandle.h

/*
 * VR Juggler is (C) Copyright 1998, 1999, 2000 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.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date$
 * Version:       $Revision$
 * -----------------------------------------------------------------
 */

#ifndef _VJ_SOUND_HANDLE_H_
#define _VJ_SOUND_HANDLE_H_


//: handle to a sound
//  This class may be used in future versions of juggler, for now ignore it.
//!PUBLIC_API:
class vjSoundHandle
{
public:
   // creates stale by default...
        vjSoundHandle() : mIdentifier( 0 ), mStale( true ), mName( "no name" )
        {
        }
   
   const std::string& name() const { return mName; }
   const int&         id() const { return mIdentifier; }
   const bool&        isStale() const { return mStale; }
   
protected: 
   void               setName( const std::string& name ) { mName = name; }
        void               setId( const int& id ) { mIdentifier = id; }
   void               setStale( const bool& stale ) { mStale = stale; }
   
   friend class vjSoundManager;
   
private:
   bool mStale;
        int mIdentifier;
   std::string mName;
};


#endif