diff options
Diffstat (limited to 'docs/doxygen/nel/a03087.html')
| -rw-r--r-- | docs/doxygen/nel/a03087.html | 324 |
1 files changed, 324 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03087.html b/docs/doxygen/nel/a03087.html new file mode 100644 index 00000000..052e3619 --- /dev/null +++ b/docs/doxygen/nel/a03087.html @@ -0,0 +1,324 @@ +<!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: NL3D::CPlayListManagerUser class Reference</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 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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NL3D::CPlayListManagerUser Class Reference</h1><code>#include <<a class="el" href="a06176.html">play_list_manager_user.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::CPlayListManagerUser: +<p><center><img src="a03087.png" usemap="#NL3D::CPlayListManagerUser_map" border="0" alt=""></center> +<map name="NL3D::CPlayListManagerUser_map"> +<area href="a03936.html" alt="NL3D::UPlayListManager" shape="rect" coords="0,0,180,24"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="a03936.html">UPlayListManager</a> implementation <dl compact><dt><b>Author:</b></dt><dd>Lionel Berenguier <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06176.html#l00049">49</a> of file <a class="el" href="a06176.html">play_list_manager_user.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUsera0">animate</a> (<a class="el" href="a05363.html#a367">TGlobalAnimationTime</a> time)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUsera1">CPlayListManagerUser</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NL3D_1_1CPlayListManagerUsera1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03089.html">UPlayList</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUsera2">createPlayList</a> (<a class="el" href="a02212.html">UAnimationSet</a> *animSet)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUsera3">deletePlayList</a> (<a class="el" href="a03089.html">UPlayList</a> *playList)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUsera4">setup</a> (<a class="el" href="a05363.html#a367">TGlobalAnimationTime</a> time)</td></tr> + +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03085.html">CPlayListManager</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUserr0">_PlayListManager</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03262.html">CPtrSet</a>< <a class="el" href="a03088.html">CPlayListUser</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUserr1">_PlayLists</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagerUsera1" doxytag="NL3D::CPlayListManagerUser::CPlayListManagerUser" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NL3D::CPlayListManagerUser::CPlayListManagerUser </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="a06176.html#l00059">59</a> of file <a class="el" href="a06176.html">play_list_manager_user.h</a>. +<p> +References <a class="el" href="a06176.html#l00036">NL3D_MEM_PLAYLIST_MANAGER</a>. +<p> +<div class="fragment"><pre>00060 { +00061 <a class="code" href="a04753.html#a0">NL3D_MEM_PLAYLIST_MANAGER</a> +00062 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagerUsera0" doxytag="NL3D::CPlayListManagerUser::animate" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::CPlayListManagerUser::animate </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05363.html#a367">TGlobalAnimationTime</a> </td> + <td class="mdname1" valign="top" nowrap> <em>time</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Animate all the playlist. Only the globals channels are animated. NB: all AnimationTime are in second. +<p> +Implements <a class="el" href="a03936.html#NL3D_1_1UPlayListManagera0">NL3D::UPlayListManager</a>. +<p> +Definition at line <a class="el" href="a06175.html#l00065">65</a> of file <a class="el" href="a06175.html">play_list_manager_user.cpp</a>. +<p> +References <a class="el" href="a06176.html#l00052">_PlayListManager</a>, <a class="el" href="a06173.html#l00056">NL3D::CPlayListManager::animate()</a>, <a class="el" href="a05788.html#l00056">H_AUTO</a>, <a class="el" href="a06176.html#l00036">NL3D_MEM_PLAYLIST_MANAGER</a>, and <a class="el" href="a05454.html#l00045">NL3D::TGlobalAnimationTime</a>. +<p> +<div class="fragment"><pre>00066 { +00067 <a class="code" href="a04753.html#a0">NL3D_MEM_PLAYLIST_MANAGER</a> +00068 <a class="code" href="a04365.html#a4">H_AUTO</a>( NL3D_Render_PlayListMgr_Animate ); +00069 +00070 <a class="code" href="a03087.html#NL3D_1_1CPlayListManagerUserr0">_PlayListManager</a>.animate(time); +00071 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagerUsera2" doxytag="NL3D::CPlayListManagerUser::createPlayList" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03089.html">UPlayList</a> * NL3D::CPlayListManagerUser::createPlayList </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02212.html">UAnimationSet</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>animSet</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a playlist, instance of an animation set. nlerror if(animSet==NULL). +<p> +Implements <a class="el" href="a03936.html#NL3D_1_1UPlayListManagera1">NL3D::UPlayListManager</a>. +<p> +Definition at line <a class="el" href="a06175.html#l00038">38</a> of file <a class="el" href="a06175.html">play_list_manager_user.cpp</a>. +<p> +References <a class="el" href="a06178.html#l00054">NL3D::CPlayListUser::_ChannelMixer</a>, <a class="el" href="a06178.html#l00053">NL3D::CPlayListUser::_PlayList</a>, <a class="el" href="a06176.html#l00052">_PlayListManager</a>, <a class="el" href="a06176.html#l00053">_PlayLists</a>, <a class="el" href="a06173.html#l00036">NL3D::CPlayListManager::addPlaylist()</a>, <a class="el" href="a06290.html#l00064">NL3D::CPtrSet< CPlayListUser >::insert()</a>, <a class="el" href="a06176.html#l00036">NL3D_MEM_PLAYLIST_MANAGER</a>, and <a class="el" href="a05622.html#l00154">nlerror</a>. +<p> +<div class="fragment"><pre>00039 { +00040 <a class="code" href="a04753.html#a0">NL3D_MEM_PLAYLIST_MANAGER</a> +00041 <span class="keywordflow">if</span>(!animSet) +00042 <a class="code" href="a04199.html#a3">nlerror</a>(<span class="stringliteral">"createPlayList(): animSet==NULL"</span>); +00043 +00044 CPlayListUser *pl= <span class="keyword">new</span> CPlayListUser( safe_cast<CAnimationSetUser*>(animSet)->_AnimationSet ); +00045 <a class="code" href="a03087.html#NL3D_1_1CPlayListManagerUserr1">_PlayLists</a>.insert(pl); +00046 +00047 <a class="code" href="a03087.html#NL3D_1_1CPlayListManagerUserr0">_PlayListManager</a>.addPlaylist(&pl->_PlayList, &pl->_ChannelMixer); +00048 +00049 <span class="keywordflow">return</span> pl; +00050 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagerUsera3" doxytag="NL3D::CPlayListManagerUser::deletePlayList" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::CPlayListManagerUser::deletePlayList </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03089.html">UPlayList</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>playList</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Delete a playlist. nlerror if not found. no-op if playList==NULL. +<p> +Implements <a class="el" href="a03936.html#NL3D_1_1UPlayListManagera2">NL3D::UPlayListManager</a>. +<p> +Definition at line <a class="el" href="a06175.html#l00054">54</a> of file <a class="el" href="a06175.html">play_list_manager_user.cpp</a>. +<p> +References <a class="el" href="a06176.html#l00052">_PlayListManager</a>, <a class="el" href="a06176.html#l00053">_PlayLists</a>, <a class="el" href="a06290.html#l00072">NL3D::CPtrSet< CPlayListUser >::erase()</a>, <a class="el" href="a06176.html#l00036">NL3D_MEM_PLAYLIST_MANAGER</a>, and <a class="el" href="a06173.html#l00047">NL3D::CPlayListManager::removePlaylist()</a>. +<p> +<div class="fragment"><pre>00055 { +00056 <a class="code" href="a04753.html#a0">NL3D_MEM_PLAYLIST_MANAGER</a> +00057 CPlayListUser *pl= safe_cast<CPlayListUser*>(playList); +00058 +00059 <a class="code" href="a03087.html#NL3D_1_1CPlayListManagerUserr0">_PlayListManager</a>.removePlaylist(&pl->_PlayList); +00060 <a class="code" href="a03087.html#NL3D_1_1CPlayListManagerUserr1">_PlayLists</a>.erase(pl, <span class="stringliteral">"deletePlayList(): bad playList"</span>); +00061 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagerUsera4" doxytag="NL3D::CPlayListManagerUser::setup" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::CPlayListManagerUser::setup </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a05363.html#a367">TGlobalAnimationTime</a> </td> + <td class="mdname1" valign="top" nowrap> <em>time</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Setup all the playlist. NB: all AnimationTime are in second. +<p> +Implements <a class="el" href="a03936.html#NL3D_1_1UPlayListManagera3">NL3D::UPlayListManager</a>. +<p> +Definition at line <a class="el" href="a06175.html#l00075">75</a> of file <a class="el" href="a06175.html">play_list_manager_user.cpp</a>. +<p> +References <a class="el" href="a06176.html#l00052">_PlayListManager</a>, <a class="el" href="a05788.html#l00056">H_AUTO</a>, <a class="el" href="a06176.html#l00036">NL3D_MEM_PLAYLIST_MANAGER</a>, <a class="el" href="a06173.html#l00082">NL3D::CPlayListManager::setup()</a>, and <a class="el" href="a05454.html#l00045">NL3D::TGlobalAnimationTime</a>. +<p> +<div class="fragment"><pre>00076 { +00077 <a class="code" href="a04753.html#a0">NL3D_MEM_PLAYLIST_MANAGER</a> +00078 <a class="code" href="a04365.html#a4">H_AUTO</a>( NL3D_Render_PlayListMgr_Setup ); +00079 +00080 <a class="code" href="a03087.html#NL3D_1_1CPlayListManagerUserr0">_PlayListManager</a>.setup(time); +00081 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagerUserr0" doxytag="NL3D::CPlayListManagerUser::_PlayListManager" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03085.html">CPlayListManager</a> <a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUserr0">NL3D::CPlayListManagerUser::_PlayListManager</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06176.html#l00052">52</a> of file <a class="el" href="a06176.html">play_list_manager_user.h</a>. +<p> +Referenced by <a class="el" href="a06175.html#l00065">animate()</a>, <a class="el" href="a06175.html#l00038">createPlayList()</a>, <a class="el" href="a06175.html#l00054">deletePlayList()</a>, and <a class="el" href="a06175.html#l00075">setup()</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagerUserr1" doxytag="NL3D::CPlayListManagerUser::_PlayLists" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03262.html">CPtrSet</a><<a class="el" href="a03088.html">CPlayListUser</a>> <a class="el" href="a03087.html#NL3D_1_1CPlayListManagerUserr1">NL3D::CPlayListManagerUser::_PlayLists</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06176.html#l00053">53</a> of file <a class="el" href="a06176.html">play_list_manager_user.h</a>. +<p> +Referenced by <a class="el" href="a06175.html#l00038">createPlayList()</a>, and <a class="el" href="a06175.html#l00054">deletePlayList()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06176.html">play_list_manager_user.h</a><li><a class="el" href="a06175.html">play_list_manager_user.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:01:20 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> |