diff options
Diffstat (limited to 'Doc/doxygen/html/_music_track_8h_source.html')
| -rw-r--r-- | Doc/doxygen/html/_music_track_8h_source.html | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_music_track_8h_source.html b/Doc/doxygen/html/_music_track_8h_source.html new file mode 100644 index 0000000..a5e8b1e --- /dev/null +++ b/Doc/doxygen/html/_music_track_8h_source.html @@ -0,0 +1,194 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>Starshatter_Open: D:/SRC/StarshatterSVN/Stars45/MusicTrack.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_music_track_8h.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">MusicTrack.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_music_track_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Project Starshatter 4.5</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Destroyer Studios LLC</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright © 1997-2004. All Rights Reserved.</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> SUBSYSTEM: Stars.exe</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> FILE: MusicTrack.h</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> AUTHOR: John DiCamillo</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> OVERVIEW</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ========</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MusicTrack class</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifndef MusicTrack_h</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span><span class="preprocessor">#define MusicTrack_h</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="_types_8h.html">Types.h</a>"</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="_list_8h.html">List.h</a>"</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="_text_8h.html">Text.h</a>"</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// +-------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span><a class="code" href="class_sound.html">Sound</a>;</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// +-------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> +<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="class_music_track.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="class_music_track.html">MusicTrack</a></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65baef7733b76f3b20f554d0e8e1fbdcf0e5"> 32</a></span>  <span class="keyword">enum</span> <a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65b">STATE</a> { <a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65bade79c2ce20787fb1b87991639cafb0b5">NONE</a>, <a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65ba6592038f00893bfb7161d75e52217ad6">FADE_IN</a>, <a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65bab6627de887697f80eae7a7b1b2993a68">PLAY</a>, <a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65ba9ee79cb802e1288cc7e13e029be1f443">FADE_OUT</a>, <a class="code" href="class_music_track.html#a1fbc880a36f8fda232294b8eab10e65baef7733b76f3b20f554d0e8e1fbdcf0e5">STOP</a> };</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="class_music_track.html#abf475ba7db34318d7d71b1e69b4d3dc0">MusicTrack</a>(<span class="keyword">const</span> <a class="code" href="class_text.html">Text</a>& <a class="code" href="class_music_track.html#a4589d17d6225de5065bda02fdd32bcb9">name</a>, <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#aa6a1d398a980325ebf63c51798230145">mode</a>=0, <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#abe4815fd5f8b8bdeff8c1bb707dea6d9">index</a>=0);</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <a class="code" href="class_music_track.html#a1f11989410f3cf59438cc1516a52bb02">~MusicTrack</a>();</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Operations:</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#af5ac209180b89990ccba56c50d5e3e73">ExecFrame</a>();</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#a7550192322553030cff90b8a2ae74740">Play</a>();</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#a0e007451e365940a092b0bf4432506ba">Stop</a>();</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#a71358c727441a6425fae523435a16ab5">FadeIn</a>();</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#a8b9c9589f602885bb340c44356091759">FadeOut</a>();</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// accessors / mutators</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="class_music_track.html#a6d057b32fe43049a288bbff8acec0ef5"> 46</a></span>  <span class="keyword">const</span> <a class="code" href="class_text.html">Text</a>& <a class="code" href="class_music_track.html#a6d057b32fe43049a288bbff8acec0ef5">Name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_music_track.html#a4589d17d6225de5065bda02fdd32bcb9">name</a>; }</div> +<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_music_track.html#a6df8ee2523814c6063c1ae3ec015e14d"> 47</a></span>  <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_music_track.html#a6df8ee2523814c6063c1ae3ec015e14d">GetSound</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_music_track.html#a268b09f23cf84b7a47aaf3df600833ba">sound</a>; }</div> +<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="class_music_track.html#a0035b88a250a1bf4d30ac78454f8dd07"> 48</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#a0035b88a250a1bf4d30ac78454f8dd07">GetState</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_music_track.html#ac1802b043f308ccd9dad2403b0416223">state</a>; }</div> +<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="class_music_track.html#ab77701118608e2049bdfd54fd1440e2e"> 49</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#ab77701118608e2049bdfd54fd1440e2e">GetMode</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_music_track.html#aa6a1d398a980325ebf63c51798230145">mode</a>; }</div> +<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_music_track.html#a06195cef4991f022f61eb4f48cb77add"> 50</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#a06195cef4991f022f61eb4f48cb77add">GetIndex</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_music_track.html#abe4815fd5f8b8bdeff8c1bb707dea6d9">index</a>; }</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#a27dcf2bea908de243e8c3e66bb4d801e">IsReady</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#ad104135395ee9a7bcd749d325c38d676">IsPlaying</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#aeec389510277efc8957c417a52c34b5f">IsDone</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#a4c40de8a5031060aaf387627846c682d">IsLooped</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="class_music_track.html#a0050b761da7ef4d301ef4475aa4d8ad2">GetVolume</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#a6a333cc3b0fbf0e1f9483957ce12e544">SetVolume</a>(<span class="keywordtype">long</span> v);</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_music_track.html#af5e17629e2dc930107fd90d867bb0d81">GetTotalTime</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_music_track.html#a4344c96eea7e52782a69bd38a6dfec1c">GetTimeRemaining</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_music_track.html#a42f60442fe9b89ac9fd7ef5984238f78">GetTimeElapsed</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> +<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="class_music_track.html#a4ec6b840940570d5c42844c94b7e53c5"> 64</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_music_track.html#a4ec6b840940570d5c42844c94b7e53c5">GetFadeTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_music_track.html#a7648745cad7491bab9f5050f21653d38">fade_time</a>; }</div> +<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="class_music_track.html#a23c583e3e695ad4ac03fd78e394a8040"> 65</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_music_track.html#a23c583e3e695ad4ac03fd78e394a8040">SetFadeTime</a>(<span class="keywordtype">double</span> t) { <a class="code" href="class_music_track.html#a7648745cad7491bab9f5050f21653d38">fade_time</a> = t; }</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="class_music_track.html#a4589d17d6225de5065bda02fdd32bcb9"> 68</a></span>  <a class="code" href="class_text.html">Text</a> <a class="code" href="class_music_track.html#a4589d17d6225de5065bda02fdd32bcb9">name</a>;</div> +<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="class_music_track.html#a268b09f23cf84b7a47aaf3df600833ba"> 69</a></span>  <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_music_track.html#a268b09f23cf84b7a47aaf3df600833ba">sound</a>;</div> +<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="class_music_track.html#ac1802b043f308ccd9dad2403b0416223"> 70</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#ac1802b043f308ccd9dad2403b0416223">state</a>;</div> +<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="class_music_track.html#aa6a1d398a980325ebf63c51798230145"> 71</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#aa6a1d398a980325ebf63c51798230145">mode</a>;</div> +<div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="class_music_track.html#abe4815fd5f8b8bdeff8c1bb707dea6d9"> 72</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_music_track.html#abe4815fd5f8b8bdeff8c1bb707dea6d9">index</a>;</div> +<div class="line"><a name="l00073"></a><span class="lineno"><a class="code" href="class_music_track.html#a31b9cd93e18cc022a1f3d28b4e329926"> 73</a></span>  <span class="keywordtype">double</span> <a class="code" href="class_music_track.html#a31b9cd93e18cc022a1f3d28b4e329926">fade</a>;</div> +<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="class_music_track.html#a7648745cad7491bab9f5050f21653d38"> 74</a></span>  <span class="keywordtype">double</span> <a class="code" href="class_music_track.html#a7648745cad7491bab9f5050f21653d38">fade_time</a>;</div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif MusicTrack_h</span></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_ea1b58c809a5070716d7c602998a95b0.html">Stars45</a></li><li class="navelem"><a class="el" href="_music_track_8h.html">MusicTrack.h</a></li> + <li class="footer">Generated on Thu May 31 2012 16:31:12 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |