<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>SFML - Simple and Fast Multimedia Library</title> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="tabs.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="logo"> <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> </div> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.htm"><span>Main Page</span></a></li> <li><a href="modules.htm"><span>Modules</span></a></li> <li><a href="annotated.htm"><span>Classes</span></a></li> <li class="current"><a href="files.htm"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.htm"><span>File List</span></a></li> </ul> </div> <h1>SoundSource.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <a name="l00002"></a>00002 <span class="comment">//</span> <a name="l00003"></a>00003 <span class="comment">// SFML - Simple and Fast Multimedia Library</span> <a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)</span> <a name="l00005"></a>00005 <span class="comment">//</span> <a name="l00006"></a>00006 <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span> <a name="l00007"></a>00007 <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span> <a name="l00008"></a>00008 <span class="comment">//</span> <a name="l00009"></a>00009 <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span> <a name="l00010"></a>00010 <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span> <a name="l00011"></a>00011 <span class="comment">// subject to the following restrictions:</span> <a name="l00012"></a>00012 <span class="comment">//</span> <a name="l00013"></a>00013 <span class="comment">// 1. The origin of this software must not be misrepresented;</span> <a name="l00014"></a>00014 <span class="comment">// you must not claim that you wrote the original software.</span> <a name="l00015"></a>00015 <span class="comment">// If you use this software in a product, an acknowledgment</span> <a name="l00016"></a>00016 <span class="comment">// in the product documentation would be appreciated but is not required.</span> <a name="l00017"></a>00017 <span class="comment">//</span> <a name="l00018"></a>00018 <span class="comment">// 2. Altered source versions must be plainly marked as such,</span> <a name="l00019"></a>00019 <span class="comment">// and must not be misrepresented as being the original software.</span> <a name="l00020"></a>00020 <span class="comment">//</span> <a name="l00021"></a>00021 <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span> <a name="l00022"></a>00022 <span class="comment">//</span> <a name="l00024"></a>00024 <span class="comment"></span> <a name="l00025"></a>00025 <span class="preprocessor">#ifndef SFML_SOUNDSOURCE_HPP</span> <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define SFML_SOUNDSOURCE_HPP</span> <a name="l00027"></a>00027 <span class="preprocessor"></span> <a name="l00029"></a>00029 <span class="comment">// Headers</span> <a name="l00031"></a>00031 <span class="comment"></span><span class="preprocessor">#include <SFML/Config.hpp></span> <a name="l00032"></a>00032 <span class="preprocessor">#include <SFML/System/Vector3.hpp></span> <a name="l00033"></a>00033 <a name="l00034"></a>00034 <a name="l00035"></a>00035 <span class="keyword">namespace </span>sf <a name="l00036"></a>00036 { <a name="l00041"></a><a class="code" href="classsf_1_1SoundSource.htm">00041</a> <span class="keyword">class </span>SFML_API <a class="code" href="classsf_1_1SoundSource.htm" title="Base class defining a sound&#39;s properties.">SoundSource</a> <a name="l00042"></a>00042 { <a name="l00043"></a>00043 <span class="keyword">public</span> : <a name="l00044"></a>00044 <a name="l00049"></a><a class="code" href="classsf_1_1SoundSource.htm#ac43af72c98c077500b239bc75b812f03">00049</a> <span class="keyword">enum</span> <a class="code" href="classsf_1_1SoundSource.htm#ac43af72c98c077500b239bc75b812f03" title="Enumeration of the sound source states.">Status</a> <a name="l00050"></a>00050 { <a name="l00051"></a><a class="code" href="classsf_1_1SoundSource.htm#ac43af72c98c077500b239bc75b812f03adabb01e8aa85b2f54b344890addf764a">00051</a> Stopped, <a name="l00052"></a><a class="code" href="classsf_1_1SoundSource.htm#ac43af72c98c077500b239bc75b812f03ac3ca1fcc0394267c9bdbe3dc0a8a7e41">00052</a> Paused, <a name="l00053"></a><a class="code" href="classsf_1_1SoundSource.htm#ac43af72c98c077500b239bc75b812f03af07bdea9f70ef7606dfc9f955beeee18">00053</a> Playing <a name="l00054"></a>00054 }; <a name="l00055"></a>00055 <a name="l00062"></a>00062 <a class="code" href="classsf_1_1SoundSource.htm" title="Base class defining a sound&#39;s properties.">SoundSource</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1SoundSource.htm" title="Base class defining a sound&#39;s properties.">SoundSource</a>& copy); <a name="l00063"></a>00063 <a name="l00068"></a>00068 <span class="keyword">virtual</span> ~<a class="code" href="classsf_1_1SoundSource.htm" title="Base class defining a sound&#39;s properties.">SoundSource</a>(); <a name="l00069"></a>00069 <a name="l00084"></a>00084 <span class="keywordtype">void</span> SetPitch(<span class="keywordtype">float</span> pitch); <a name="l00085"></a>00085 <a name="l00097"></a>00097 <span class="keywordtype">void</span> SetVolume(<span class="keywordtype">float</span> volume); <a name="l00098"></a>00098 <a name="l00113"></a>00113 <span class="keywordtype">void</span> SetPosition(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> z); <a name="l00114"></a>00114 <a name="l00127"></a>00127 <span class="keywordtype">void</span> SetPosition(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Utility template class for manipulating 3-dimensional vectors.">Vector3f</a>& position); <a name="l00128"></a>00128 <a name="l00143"></a>00143 <span class="keywordtype">void</span> SetRelativeToListener(<span class="keywordtype">bool</span> relative); <a name="l00144"></a>00144 <a name="l00160"></a>00160 <span class="keywordtype">void</span> SetMinDistance(<span class="keywordtype">float</span> distance); <a name="l00161"></a>00161 <a name="l00179"></a>00179 <span class="keywordtype">void</span> SetAttenuation(<span class="keywordtype">float</span> attenuation); <a name="l00180"></a>00180 <a name="l00189"></a>00189 <span class="keywordtype">float</span> GetPitch() <span class="keyword">const</span>; <a name="l00190"></a>00190 <a name="l00199"></a>00199 <span class="keywordtype">float</span> GetVolume() <span class="keyword">const</span>; <a name="l00200"></a>00200 <a name="l00209"></a>00209 <a class="code" href="classsf_1_1Vector3.htm" title="Utility template class for manipulating 3-dimensional vectors.">Vector3f</a> GetPosition() <span class="keyword">const</span>; <a name="l00210"></a>00210 <a name="l00220"></a>00220 <span class="keywordtype">bool</span> IsRelativeToListener() <span class="keyword">const</span>; <a name="l00221"></a>00221 <a name="l00230"></a>00230 <span class="keywordtype">float</span> GetMinDistance() <span class="keyword">const</span>; <a name="l00231"></a>00231 <a name="l00240"></a>00240 <span class="keywordtype">float</span> GetAttenuation() <span class="keyword">const</span>; <a name="l00241"></a>00241 <a name="l00242"></a>00242 <span class="keyword">protected</span> : <a name="l00243"></a>00243 <a name="l00250"></a>00250 <a class="code" href="classsf_1_1SoundSource.htm" title="Base class defining a sound&#39;s properties.">SoundSource</a>(); <a name="l00251"></a>00251 <a name="l00258"></a>00258 Status GetStatus() <span class="keyword">const</span>; <a name="l00259"></a>00259 <a name="l00261"></a>00261 <span class="comment">// Member data</span> <a name="l00263"></a><a class="code" href="classsf_1_1SoundSource.htm#a120babd5020a80002a51c1da631f73d8">00263</a> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mySource; <a name="l00264"></a>00264 }; <a name="l00265"></a>00265 <a name="l00266"></a>00266 } <span class="comment">// namespace sf</span> <a name="l00267"></a>00267 <a name="l00268"></a>00268 <a name="l00269"></a>00269 <span class="preprocessor">#endif // SFML_SOUNDSOURCE_HPP</span> <a name="l00270"></a>00270 <span class="preprocessor"></span> <a name="l00271"></a>00271 </pre></div></div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> :: </p> </body> </html>