AaronCameron.net
Because you all make me very, very tired.
Not a Member? - Login or Create an Account
Tuesday the 22nd of May 2012 @ 12:52am
Front Page Journal Projects Your Profile About
[]

LibN2L


Documentation
(n2l5)


Documentation
(libN2L-4)


Bugtracker


Related Things

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

gui

cGuiSound.h

Go to the documentation of this file.
00001 /************************************************************************
00002 Nova-2 Library (libN2L, or simply n2l) Game development C++ Library
00003 Copyright (C) 2002  Aaron Cameron
00004 
00005 This library is free software; you can redistribute it and/or
00006 modify it under the terms of the GNU Lesser General Public
00007 License as published by the Free Software Foundation; either
00008 version 2.1 of the License, or (at your option) any later version.
00009 
00010 This library is distributed in the hope that it will be useful,
00011 but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013 Lesser General Public License for more details.
00014 
00015 You should have received a copy of the GNU Lesser General Public
00016 License along with this library; if not, write to the Free Software
00017 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00018 
00019 A copy of the GNU Lesser General Public License has been provided with
00020 this library in the file 'COPYING'.
00021 
00022 Contact information for the author of this library has been provided
00023 with this library in the file 'AUTHOR'.
00024 ************************************************************************/
00025 #ifndef _n2l4_cGuiSound_H
00026 #define _n2l4_cGuiSound_H
00027 
00028 #include "n2l/n2l.h"
00029 
00030 #include "gui/types.h"
00031 
00032 namespace n2l
00033 {
00034     class cDynVar;
00035     class cVfsNodeInterface;
00036     class cAudioChunk;
00037 
00043     class cGuiSound
00044     {
00045     public:
00046         cGuiSound();
00047         cGuiSound( const cVfsNodeInterface &iNode );
00048         cGuiSound( const cDynVar& iDef );
00049         ~cGuiSound();
00050 
00051         void load( const cVfsNodeInterface &iNode );
00052         void load( const cDynVar &iDef );
00053 
00054         void lrBias( const tFloat &iVal );
00055         const tFloat &lrBias() const;
00056 
00057         void volume( const tFloat &iVal );
00058         const tFloat &volume() const;
00059 
00060         void sound( const cAutoPtr<const cAudioChunk> &iSound );
00061         const cAutoPtr<const cAudioChunk> &sound() const;
00062 
00063         void prop( const tString &iName, const cDynVar &iVal );
00064         const cDynVar prop( const tString &iName ) const;
00065 
00066         void play() const;
00067 
00068     private:
00069         tFloat mLRBias; // -1 (Left) --- +1 (Right)
00070         tFloat mVolume; // 0->1 clamped
00071         
00072         cAutoPtr<const cAudioChunk> mSound;
00073 
00074         void init();
00075 
00076      }; // class 
00077 
00078 } // namespace n2l
00079 
00080 #endif
©2012 Aaron Cameron