aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a05470.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a05470.html108
1 files changed, 108 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a05470.html b/docs/doxygen/nel/a05470.html
new file mode 100644
index 00000000..5995a87b
--- /dev/null
+++ b/docs/doxygen/nel/a05470.html
@@ -0,0 +1,108 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: background_sound.h Source File</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>background_sound.h</h1><a href="a04047.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
+00006 <span class="comment">/* Copyright, 2001 Nevrax Ltd.</span>
+00007 <span class="comment"> *</span>
+00008 <span class="comment"> * This file is part of NEVRAX NEL.</span>
+00009 <span class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</span>
+00010 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
+00011 <span class="comment"> * the Free Software Foundation; either version 2, or (at your option)</span>
+00012 <span class="comment"> * any later version.</span>
+00013 <span class="comment"></span>
+00014 <span class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</span>
+00015 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+00016 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
+00017 <span class="comment"> * General Public License for more details.</span>
+00018 <span class="comment"></span>
+00019 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
+00020 <span class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</span>
+00021 <span class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</span>
+00022 <span class="comment"> * MA 02111-1307, USA.</span>
+00023 <span class="comment"> */</span>
+00024
+00025 <span class="preprocessor">#ifndef NL_BACKGROUND_SOUND_H</span>
+00026 <span class="preprocessor"></span><span class="preprocessor">#define NL_BACKGROUND_SOUND_H</span>
+00027 <span class="preprocessor"></span>
+00028 <span class="preprocessor">#include "<a class="code" href="a05047.html">nel/misc/string_mapper.h</a>"</span>
+00029 <span class="preprocessor">#include "<a class="code" href="a04984.html">sound.h</a>"</span>
+00030 <span class="preprocessor">#include "<a class="code" href="a05171.html">nel/sound/u_audio_mixer.h</a>"</span>
+00031
+00032 <span class="keyword">namespace </span>NLSOUND {
+00033
+00034 <span class="comment">//class ISoundDriver;</span>
+00035 <span class="comment">//class IBuffer;</span>
+00036 <span class="comment">//class CSound;</span>
+00037
+00038
+00039
+<a name="l00046"></a><a class="code" href="a02245.html">00046</a> <span class="keyword">class </span><a class="code" href="a02245.html">CBackgroundSound</a> : <span class="keyword">public</span> <a class="code" href="a02246.html">CSound</a>
+00047 {
+00048 <span class="keyword">public</span>:
+00050 <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda0">CBackgroundSound</a>();
+00052 <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda21">~CBackgroundSound</a>();
+00053
+<a name="l00054"></a><a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda13">00054</a> TSOUND_TYPE <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda13">getSoundType</a>() { <span class="keywordflow">return</span> SOUND_BACKGROUND;}
+00055
+00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda16">importForm</a>(<span class="keyword">const</span> std::string&amp; filename, <a class="code" href="a02551.html">NLGEORGES::UFormElm</a>&amp; formRoot);
+00058
+<a name="l00060"></a><a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda17">00060</a> <span class="keywordtype">bool</span> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda17">isDetailed</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>;}
+00062 <span class="keyword">virtual</span> <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda5">getDuration</a>();
+00064
+00066 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda14">getSubSoundList</a>(std::vector&lt;std::pair&lt;std::string, CSound*&gt; &gt; &amp;subsounds) <span class="keyword">const</span>;
+00067
+00068 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda8">getMaxDistance</a>() <span class="keyword">const</span>;
+00069
+00070 <span class="keywordtype">void</span> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda19">serial</a>(<a class="code" href="a02270.html">NLMISC::IStream</a> &amp;<a class="code" href="a04223.html#a626">s</a>);
+00071
+<a name="l00073"></a><a class="code" href="a02247.html">00073</a> <span class="keyword">struct </span><a class="code" href="a02247.html">TSoundInfo</a>
+00074 {
+<a name="l00075"></a><a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo1">00075</a> NLMISC::TStringId <a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo1">SoundName</a>;
+<a name="l00076"></a><a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo0">00076</a> <a class="code" href="a03921.html">UAudioMixer::TBackgroundFlags</a> <a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo0">Filter</a>;
+00077
+<a name="l00078"></a><a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoa0">00078</a> <span class="keywordtype">void</span> <a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoa0">serial</a>(<a class="code" href="a02270.html">NLMISC::IStream</a> &amp;<a class="code" href="a04223.html#a626">s</a>)
+00079 {
+00080 std::string soundName;
+00081 <span class="keywordflow">if</span> (<a class="code" href="a04223.html#a626">s</a>.isReading())
+00082 {
+00083 <a class="code" href="a04223.html#a626">s</a>.serial(soundName);
+00084 <a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo1">SoundName</a> = <a class="code" href="a03450.html#NLMISC_1_1CStringMappere3">NLMISC::CStringMapper::map</a>(soundName);
+00085 }
+00086 <span class="keywordflow">else</span>
+00087 {
+00088 soundName = <a class="code" href="a03450.html#NLMISC_1_1CStringMappere4">NLMISC::CStringMapper::unmap</a>(<a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo1">SoundName</a>);
+00089 <a class="code" href="a04223.html#a626">s</a>.serial(soundName);
+00090 }
+00091 <a class="code" href="a04223.html#a626">s</a>.serial(<a class="code" href="a02247.html#NLSOUND_1_1CBackgroundSound_1_1TSoundInfoo0">Filter</a>);
+00092 }
+00093 };
+00094
+<a name="l00095"></a><a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda12">00095</a> <span class="keyword">const</span> std::vector&lt;TSoundInfo&gt; &amp;<a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSounda12">getSounds</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _Sounds;}
+00096
+00097 <span class="keyword">private</span>:
+00098
+00099
+<a name="l00101"></a><a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSoundr2">00101</a> std::vector&lt;TSoundInfo&gt; _Sounds;
+00102
+00103
+00104 <span class="comment">// Duration of sound.</span>
+<a name="l00105"></a><a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSoundr0">00105</a> <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSoundr0">_Duration</a>;
+00106 <span class="comment">// flag for validity of duration (after first evaluation).</span>
+<a name="l00107"></a><a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSoundr1">00107</a> <span class="keywordtype">bool</span> <a class="code" href="a02245.html#NLSOUND_1_1CBackgroundSoundr1">_DurationValid</a>;
+00108 };
+00109
+00110 } <span class="comment">// NLSOUND</span>
+00111
+00112 <span class="preprocessor">#endif // NL_BACKGROUND_SOUND_H</span>
+00113 <span class="preprocessor"></span>
+</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 06:22:36 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>