diff options
Diffstat (limited to 'docs/doxygen/nel/complex__sound_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/complex__sound_8h-source.html | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/docs/doxygen/nel/complex__sound_8h-source.html b/docs/doxygen/nel/complex__sound_8h-source.html new file mode 100644 index 00000000..e2adc0ef --- /dev/null +++ b/docs/doxygen/nel/complex__sound_8h-source.html @@ -0,0 +1,182 @@ +<!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> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </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> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </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> + + +<!-- 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> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <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> </center> +<hr><h1>complex_sound.h</h1><a href="complex__sound_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_COMPLEX_SOUND_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_COMPLEX_SOUND_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 <font class="preprocessor">#include "<a class="code" href="sound_8h.html">sound.h</a>"</font> +00031 <font class="preprocessor">#include <string></font> +00032 +00033 <font class="keyword">namespace </font>NLSOUND +00034 { +00035 +00036 <font class="keyword">class </font>ISoundController; +00037 +00038 +00039 <font class="keyword">typedef</font> std::basic_string<uint16> <a class="code" href="namespaceNLSOUND.html#a20">uint16_string</a>; +00040 +00041 +<a name="l00042"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html">00042</a> <font class="keyword">class </font>CComplexSound : <font class="keyword">public</font> CSound +00043 { +00044 <font class="keyword">public</font>: +00045 +<a name="l00046"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#s4">00046</a> <font class="keyword">enum</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4">TPATTERN_MODE</a> +00047 { +00048 <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4s0">MODE_UNDEFINED</a>, +00049 <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4s1">MODE_CHAINED</a>, +00050 <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4s2">MODE_ALL_IN_ONE</a>, +00051 <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4s3">MODE_SPARSE</a> +00052 }; +00053 +00054 <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a0">isDetailed</a>() <font class="keyword">const</font>; +00055 uint32 <a class="code" href="classNLSOUND_1_1CComplexSound.html#a1">getDuration</a>(); +00056 +00057 +<a name="l00058"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a2">00058</a> <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4">TPATTERN_MODE</a> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a2">getPatternMode</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o0">_PatternMode</a>;} +<a name="l00059"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a3">00059</a> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a3">setPatternMode</a>(<a class="code" href="classNLSOUND_1_1CComplexSound.html#s4">TPATTERN_MODE</a> patternMode) { <a class="code" href="classNLSOUND_1_1CComplexSound.html#o0">_PatternMode</a> = patternMode;} +00060 +<a name="l00061"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a4">00061</a> <font class="keyword">const</font> std::vector<uint32> &<a class="code" href="classNLSOUND_1_1CComplexSound.html#a4">getSoundSeq</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o3">_SoundSeq</a>;} +<a name="l00062"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a5">00062</a> <font class="keyword">const</font> std::vector<uint32> &<a class="code" href="classNLSOUND_1_1CComplexSound.html#a5">getDelaySeq</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o4">_DelaySeq</a>;} +<a name="l00063"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a6">00063</a> <font class="keyword">const</font> std::string &<a class="code" href="classNLSOUND_1_1CComplexSound.html#a6">getSound</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>)<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o1">_Sounds</a>[<a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>%<a class="code" href="classNLSOUND_1_1CComplexSound.html#o1">_Sounds</a>.size()];} +<a name="l00064"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a7">00064</a> <font class="keyword">const</font> std::vector<std::string> &<a class="code" href="classNLSOUND_1_1CComplexSound.html#a7">getSounds</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o1">_Sounds</a>;} +00065 +<a name="l00066"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a8">00066</a> uint32 <a class="code" href="classNLSOUND_1_1CComplexSound.html#a8">getFadeLenght</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o5">_XFadeLenght</a>;} +00067 +00069 <a class="code" href="classNLSOUND_1_1CComplexSound.html#a9">CComplexSound</a>(); +00070 +00072 <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a10">~CComplexSound</a>(); +00073 +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a11">importForm</a>(<font class="keyword">const</font> std::string& filename, <a class="code" href="classNLGEORGES_1_1UFormElm.html">NLGEORGES::UFormElm</a>& formRoot); +00076 +00078 +<a name="l00079"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#z963_0">00079</a> <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#z963_0">getTicksPerSecond</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o2">_TicksPerSeconds</a>; } +<a name="l00080"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#z963_1">00080</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#z963_1">setTicksPerSecond</a>(<font class="keywordtype">float</font> ticks) { <a class="code" href="classNLSOUND_1_1CComplexSound.html#o2">_TicksPerSeconds</a> = ticks; } +00082 +<a name="l00083"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a12">00083</a> <a class="code" href="classNLSOUND_1_1CSound.html#s4">TSOUND_TYPE</a> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a12">getSoundType</a>() {<font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#s4s1">SOUND_COMPLEX</a>;}; +00084 +00085 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a13">getSubSoundList</a>(std::vector<std::pair<std::string, CSound*> > &subsounds) <font class="keyword">const</font>; +<a name="l00086"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a14">00086</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a14">doFadeIn</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o6">_DoFadeIn</a>; } +<a name="l00087"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#a15">00087</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a15">doFadeOut</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o7">_DoFadeOut</a>; } +00088 +00089 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#a16">serial</a>(<a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a>); +00090 +00091 +00092 <font class="keyword">private</font>: +00093 +00094 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#c0">parseSequence</a>(<font class="keyword">const</font> std::string &str, std::vector<uint32> &seq, uint scale = 1); +00095 <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#c1">getMaxDistance</a>() <font class="keyword">const</font>; +00096 +<a name="l00097"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o0">00097</a> <a class="code" href="classNLSOUND_1_1CComplexSound.html#s4">TPATTERN_MODE</a> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o0">_PatternMode</a>; +<a name="l00098"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o1">00098</a> std::vector<std::string> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o1">_Sounds</a>; +<a name="l00099"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o2">00099</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o2">_TicksPerSeconds</a>; +<a name="l00100"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o3">00100</a> std::vector<uint32> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o3">_SoundSeq</a>; +<a name="l00102"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o4">00102</a> std::vector<uint32> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o4">_DelaySeq</a>; +00103 +<a name="l00105"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o5">00105</a> uint32 <a class="code" href="classNLSOUND_1_1CComplexSound.html#o5">_XFadeLenght</a>; +<a name="l00107"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o6">00107</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o6">_DoFadeIn</a>; +<a name="l00109"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o7">00109</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o7">_DoFadeOut</a>; +00110 +<a name="l00111"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o8">00111</a> <font class="keyword">mutable</font> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o8">_MaxDistValid</a>; +00112 +00113 <font class="comment">// Duration of sound.</font> +<a name="l00114"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o9">00114</a> uint32 <a class="code" href="classNLSOUND_1_1CComplexSound.html#o9">_Duration</a>; +00115 <font class="comment">// flag for validity of duration (after first evaluation).</font> +<a name="l00116"></a><a class="code" href="classNLSOUND_1_1CComplexSound.html#o10">00116</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CComplexSound.html#o10">_DurationValid</a>; +00117 }; +00118 +00119 } <font class="comment">// namespace</font> +00120 +00121 <font class="preprocessor">#endif // NL_COMPLEX_SOUND_H</font> +00122 <font class="preprocessor"></font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </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> |