aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/background__sound_8h-source.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/background__sound_8h-source.html180
1 files changed, 180 insertions, 0 deletions
diff --git a/docs/doxygen/nel/background__sound_8h-source.html b/docs/doxygen/nel/background__sound_8h-source.html
new file mode 100644
index 00000000..66dc97f6
--- /dev/null
+++ b/docs/doxygen/nel/background__sound_8h-source.html
@@ -0,0 +1,180 @@
+<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+<HTML>
+<HEAD>
+ <TITLE>nevrax.org : docs</TITLE>
+ <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css">
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
+</HEAD>
+<BODY MARGINHEIGHT="0" MARGINWIDTH="0">
+
+<!-- uplinks -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
+ </TR>
+</TABLE>
+
+<!-- banner Nevrax -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%>
+ <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
+</TABLE>
+
+<!-- main table -->
+<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%>
+ <TR>
+ <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
+ <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+ <!------ Begin Box ------>
+ <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
+ <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF>
+ <TABLE cellspacing=0 cellpadding=1 border=0>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
+ <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr>
+ </TABLE>
+ </TD></TR></TABLE></TD></TR></TABLE>
+ <!------ End Box ------>
+
+ </TD>
+ <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
+ <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
+
+<!-- title -->
+<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td>
+<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
+</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
+</td></tr></table>
+&nbsp;
+
+<!-- block -->
+<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD>
+ <TD><B>Documentation</B></TD>
+ <TD ALIGN=RIGHT>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
+<hr><h1>background_sound.h</h1><a href="background__sound_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
+00006 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font>
+00007 <font class="comment"> *</font>
+00008 <font class="comment"> * This file is part of NEVRAX NEL.</font>
+00009 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font>
+00010 <font class="comment"> * it under the terms of the GNU General Public License as published by</font>
+00011 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font>
+00012 <font class="comment"> * any later version.</font>
+00013 <font class="comment"></font>
+00014 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font>
+00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
+00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
+00017 <font class="comment"> * General Public License for more details.</font>
+00018 <font class="comment"></font>
+00019 <font class="comment"> * You should have received a copy of the GNU General Public License</font>
+00020 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font>
+00021 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font>
+00022 <font class="comment"> * MA 02111-1307, USA.</font>
+00023 <font class="comment"> */</font>
+00024
+00025 <font class="preprocessor">#ifndef NL_BACKGROUND_SOUND_H</font>
+00026 <font class="preprocessor"></font><font class="preprocessor">#define NL_BACKGROUND_SOUND_H</font>
+00027 <font class="preprocessor"></font>
+00028 <font class="preprocessor">#include "<a class="code" href="sound_8h.html">sound.h</a>"</font>
+00029
+00030 <font class="keyword">namespace </font>NLSOUND {
+00031
+00032 <font class="comment">//class ISoundDriver;</font>
+00033 <font class="comment">//class IBuffer;</font>
+00034 <font class="comment">//class CSound;</font>
+00035
+00036
+00037
+<a name="l00044"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html">00044</a> <font class="keyword">class </font>CBackgroundSound : <font class="keyword">public</font> CSound
+00045 {
+00046 <font class="keyword">public</font>:
+00048 <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a0">CBackgroundSound</a>();
+00050 <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a1">~CBackgroundSound</a>();
+00051
+<a name="l00052"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a2">00052</a> <a class="code" href="classNLSOUND_1_1CSound.html#s4">TSOUND_TYPE</a> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a2">getSoundType</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#s4s2">SOUND_BACKGROUND</a>;}
+00053
+00055 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a3">importForm</a>(<font class="keyword">const</font> std::string&amp; filename, <a class="code" href="classNLGEORGES_1_1UFormElm.html">NLGEORGES::UFormElm</a>&amp; formRoot);
+00056
+<a name="l00058"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a4">00058</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a4">isDetailed</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <font class="keyword">false</font>;}
+00060 <font class="keyword">virtual</font> uint32 <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a5">getDuration</a>();
+00062
+00064 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a6">getSubSoundList</a>(std::vector&lt;std::pair&lt;std::string, CSound*&gt; &gt; &amp;subsounds) <font class="keyword">const</font>;
+00065
+00066 <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a7">getMaxDistance</a>() <font class="keyword">const</font>;
+00067
+00068 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a8">serial</a>(<a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &amp;<a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a>);
+00069
+00070
+00071
+00077 <font class="comment">/* struct TBackgroundFilter</font>
+00078 <font class="comment"> {</font>
+00079 <font class="comment"> bool Day;</font>
+00080 <font class="comment"> bool Night;</font>
+00081 <font class="comment"> bool Spring;</font>
+00082 <font class="comment"> bool Summer;</font>
+00083 <font class="comment"> bool Autumn;</font>
+00084 <font class="comment"> bool Winter;</font>
+00085 <font class="comment"> bool Sunny;</font>
+00086 <font class="comment"> bool Cloudy;</font>
+00087 <font class="comment"> bool Foggy;</font>
+00088 <font class="comment"> bool Rainy;</font>
+00089 <font class="comment"> bool Snow;</font>
+00090 <font class="comment"> bool Storm;</font>
+00091 <font class="comment"> bool BadAtmosphere;</font>
+00092 <font class="comment"> bool GoodAtmosphere;</font>
+00093 <font class="comment"> };</font>
+00094 <font class="comment">*/</font>
+<a name="l00096"></a><a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html">00096</a> <font class="keyword">struct </font>TSoundInfo
+00097 {
+<a name="l00098"></a><a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m0">00098</a> std::string <a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m0">SoundName</a>;
+<a name="l00100"></a><a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m1">00100</a> uint32 <a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m1">FilterFadeIn</a>;
+<a name="l00102"></a><a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m2">00102</a> uint32 <a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m2">FilterFadeOut</a>;
+<a name="l00103"></a><a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m3">00103</a> UAudioMixer::TBackgroundFlags <a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m3">Filter</a>;
+00104
+<a name="l00105"></a><a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#a0">00105</a> <font class="keywordtype">void</font> <a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#a0">serial</a>(<a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &amp;<a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a>)
+00106 {
+00107 s.<a class="code" href="classNLMISC_1_1IStream.html#a5">serial</a>(<a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m0">SoundName</a>);
+00108 s.<a class="code" href="classNLMISC_1_1IStream.html#a5">serial</a>(<a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m1">FilterFadeIn</a>);
+00109 s.<a class="code" href="classNLMISC_1_1IStream.html#a5">serial</a>(<a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m2">FilterFadeOut</a>);
+00110 s.<a class="code" href="classNLMISC_1_1IStream.html#a5">serial</a>(<a class="code" href="structNLSOUND_1_1CBackgroundSound_1_1TSoundInfo.html#m3">Filter</a>);
+00111 }
+00112 };
+00113
+<a name="l00114"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a9">00114</a> <font class="keyword">const</font> std::vector&lt;TSoundInfo&gt; &amp;<a class="code" href="classNLSOUND_1_1CBackgroundSound.html#a9">getSounds</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o0">_Sounds</a>;}
+00115
+00116 <font class="keyword">private</font>:
+00117
+00118
+<a name="l00120"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o0">00120</a> std::vector&lt;TSoundInfo&gt; <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o0">_Sounds</a>;
+00121
+00122
+00123 <font class="comment">// Duration of sound.</font>
+<a name="l00124"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o1">00124</a> uint32 <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o1">_Duration</a>;
+00125 <font class="comment">// flag for validity of duration (after first evaluation).</font>
+<a name="l00126"></a><a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o2">00126</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CBackgroundSound.html#o2">_DurationValid</a>;
+00127 };
+00128
+00129 } <font class="comment">// NLSOUND</font>
+00130
+00131 <font class="preprocessor">#endif // NL_BACKGROUND_SOUND_H</font>
+00132 <font class="preprocessor"></font>
+</pre></div>
+
+<!-- footer -->
+<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
+</TD>
+<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
+</TR>
+</TABLE>
+</BODY>
+</HTML>