diff options
Diffstat (limited to 'docs/doxygen/nel/a03085.html')
| -rw-r--r-- | docs/doxygen/nel/a03085.html | 409 |
1 files changed, 409 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03085.html b/docs/doxygen/nel/a03085.html new file mode 100644 index 00000000..2076a834 --- /dev/null +++ b/docs/doxygen/nel/a03085.html @@ -0,0 +1,409 @@ +<!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::CPlayListManager 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::CPlayListManager Class Reference</h1><code>#include <<a class="el" href="a06174.html">play_list_manager.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class handles a list of pair PlayList/ChannelMixer RefPointer. It is just a container, with a <a class="el" href="a03085.html#NL3D_1_1CPlayListManagera1">animate()</a> method. PlayList/ChannelMixer are sotred with RefPtr. They are auto-removed from the list if the playlist or the channelmixer is deleted (done in <a class="el" href="a03085.html#NL3D_1_1CPlayListManagera1">animate()</a>). <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="a06174.html#l00048">48</a> of file <a class="el" href="a06174.html">play_list_manager.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>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagera0">addPlaylist</a> (<a class="el" href="a02208.html">CAnimationPlaylist</a> *plist, <a class="el" href="a02335.html">CChannelMixer</a> *chanMixer)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">add a playlist/channelmixer to the manager. <a class="el" href="a04199.html#a6">nlassert(plist)</a>. chanMixer replaced if playlist already IN. <a href="#NL3D_1_1CPlayListManagera0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagera1">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="a03085.html#NL3D_1_1CPlayListManagera2">CPlayListManager</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NL3D_1_1CPlayListManagera2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagera3">deleteAll</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagera4">removePlaylist</a> (<a class="el" href="a02208.html">CAnimationPlaylist</a> *plist)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">remove a playlist/channelmixer from the manager. <a class="el" href="a04199.html#a6">nlassert(plist)</a>. no op if not here. <a href="#NL3D_1_1CPlayListManagera4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagera5">setup</a> (<a class="el" href="a05363.html#a367">TGlobalAnimationTime</a> time)</td></tr> + +<tr><td colspan=2><br><h2>Private Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map< <a class="el" href="a02208.html">CAnimationPlaylist</a> *,<br> + <a class="el" href="a03086.html">CNode</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagery0">TPlayListList</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">CAnimationPlaylist* is just the key. <a href="#NL3D_1_1CPlayListManagery0"></a><br><br></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#NL3D_1_1CPlayListManagery0">TPlayListList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a></td></tr> + +</table> +<hr><h2>Member Typedef Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagery0" doxytag="NL3D::CPlayListManager::TPlayListList" ></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"> typedef std::map<<a class="el" href="a02208.html">CAnimationPlaylist</a>*, <a class="el" href="a03086.html">CNode</a>> <a class="el" href="a03085.html#NL3D_1_1CPlayListManagery0">NL3D::CPlayListManager::TPlayListList</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +CAnimationPlaylist* is just the key. +<p> + +<p> +Definition at line <a class="el" href="a06174.html#l00090">90</a> of file <a class="el" href="a06174.html">play_list_manager.h</a>. </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagera2" doxytag="NL3D::CPlayListManager::CPlayListManager" ></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::CPlayListManager::CPlayListManager </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="a06174.html#l00053">53</a> of file <a class="el" href="a06174.html">play_list_manager.h</a>. +<p> +<div class="fragment"><pre>00053 {} +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagera0" doxytag="NL3D::CPlayListManager::addPlaylist" ></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::CPlayListManager::addPlaylist </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02208.html">CAnimationPlaylist</a> * </td> + <td class="mdname" nowrap> <em>plist</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02335.html">CChannelMixer</a> * </td> + <td class="mdname" nowrap> <em>chanMixer</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +add a playlist/channelmixer to the manager. <a class="el" href="a04199.html#a6">nlassert(plist)</a>. chanMixer replaced if playlist already IN. +<p> + +<p> +Definition at line <a class="el" href="a06173.html#l00036">36</a> of file <a class="el" href="a06173.html">play_list_manager.cpp</a>. +<p> +References <a class="el" href="a06174.html#l00091">_List</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>. +<p> +Referenced by <a class="el" href="a06175.html#l00038">NL3D::CPlayListManagerUser::createPlayList()</a>, and <a class="el" href="a06348.html#l01112">NL3D::CScene::setAutomaticAnimationSet()</a>. +<p> +<div class="fragment"><pre>00037 { +00038 <a class="code" href="a04199.html#a6">nlassert</a>(plist); +00039 <span class="keywordflow">if</span>(!chanMixer) +00040 <span class="keywordflow">return</span>; +00041 <span class="comment">// this do all the good things.</span> +00042 <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>[plist]= CNode(plist, chanMixer); +00043 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagera1" doxytag="NL3D::CPlayListManager::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::CPlayListManager::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></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +animate all the playlist: setupMixer() the channelMixer, and eval(false) (eval global part). If a playlist/channelmixer has been deleted (RefPtr), the node is removed from the list. +<p> +Definition at line <a class="el" href="a06173.html#l00056">56</a> of file <a class="el" href="a06173.html">play_list_manager.cpp</a>. +<p> +References <a class="el" href="a06174.html#l00091">_List</a>, <a class="el" href="a06174.html#l00079">NL3D::CPlayListManager::CNode::ChannelMixer</a>, <a class="el" href="a06174.html#l00078">NL3D::CPlayListManager::CNode::PlayList</a>, and <a class="el" href="a05454.html#l00045">NL3D::TGlobalAnimationTime</a>. +<p> +Referenced by <a class="el" href="a06348.html#l00710">NL3D::CScene::animate()</a>, and <a class="el" href="a06175.html#l00065">NL3D::CPlayListManagerUser::animate()</a>. +<p> +<div class="fragment"><pre>00057 { +00058 TPlayListList::iterator it; +00059 +00060 <span class="keywordflow">for</span>(it=<a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.begin();it!=<a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.end();) +00061 { +00062 CNode *node= &(it->second); +00063 <span class="comment">// Test refPtrs.</span> +00064 <span class="keywordflow">if</span>( node->PlayList==NULL || node->ChannelMixer==NULL) +00065 { +00066 <span class="comment">// erase it from map.</span> +00067 TPlayListList::iterator itDel= it++; +00068 <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.erase(itDel); +00069 } +00070 <span class="keywordflow">else</span> +00071 { +00072 <span class="comment">// animate!!</span> +00073 node->PlayList->setupMixer(*node->ChannelMixer, time); +00074 node->ChannelMixer->eval(<span class="keyword">false</span>); +00075 it++; +00076 } +00077 } +00078 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagera3" doxytag="NL3D::CPlayListManager::deleteAll" ></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::CPlayListManager::deleteAll </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Perform a deletion of all pair playlist channel mixer +<p> +Definition at line <a class="el" href="a06173.html#l00107">107</a> of file <a class="el" href="a06173.html">play_list_manager.cpp</a>. +<p> +References <a class="el" href="a06174.html#l00091">_List</a>, <a class="el" href="a06174.html#l00079">NL3D::CPlayListManager::CNode::ChannelMixer</a>, and <a class="el" href="a06174.html#l00078">NL3D::CPlayListManager::CNode::PlayList</a>. +<p> +Referenced by <a class="el" href="a06348.html#l00194">NL3D::CScene::release()</a>, and <a class="el" href="a06348.html#l01112">NL3D::CScene::setAutomaticAnimationSet()</a>. +<p> +<div class="fragment"><pre>00108 { +00109 TPlayListList::iterator it = <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.begin(); +00110 <span class="keywordflow">while</span> (it != <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.end()) +00111 { +00112 TPlayListList::iterator itDel = it; +00113 ++it; +00114 CNode *node= &(itDel->second); +00115 <span class="keyword">delete</span> node->ChannelMixer; +00116 <span class="keyword">delete</span> node->PlayList; +00117 <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.erase(itDel); +00118 } +00119 <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.clear(); +00120 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagera4" doxytag="NL3D::CPlayListManager::removePlaylist" ></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::CPlayListManager::removePlaylist </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02208.html">CAnimationPlaylist</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>plist</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +remove a playlist/channelmixer from the manager. <a class="el" href="a04199.html#a6">nlassert(plist)</a>. no op if not here. +<p> + +<p> +Definition at line <a class="el" href="a06173.html#l00047">47</a> of file <a class="el" href="a06173.html">play_list_manager.cpp</a>. +<p> +References <a class="el" href="a06174.html#l00091">_List</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>. +<p> +Referenced by <a class="el" href="a06175.html#l00054">NL3D::CPlayListManagerUser::deletePlayList()</a>. +<p> +<div class="fragment"><pre>00048 { +00049 <a class="code" href="a04199.html#a6">nlassert</a>(plist); +00050 <span class="comment">// this do all the good things.</span> +00051 <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.erase(plist); +00052 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPlayListManagera5" doxytag="NL3D::CPlayListManager::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::CPlayListManager::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></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +steup all the playlist: setupMixer() the channelMixer. If a playlist/channelmixer has been deleted (RefPtr), the node is removed from the list. +<p> +Definition at line <a class="el" href="a06173.html#l00082">82</a> of file <a class="el" href="a06173.html">play_list_manager.cpp</a>. +<p> +References <a class="el" href="a06174.html#l00091">_List</a>, <a class="el" href="a06174.html#l00079">NL3D::CPlayListManager::CNode::ChannelMixer</a>, <a class="el" href="a06174.html#l00078">NL3D::CPlayListManager::CNode::PlayList</a>, and <a class="el" href="a05454.html#l00045">NL3D::TGlobalAnimationTime</a>. +<p> +Referenced by <a class="el" href="a06175.html#l00075">NL3D::CPlayListManagerUser::setup()</a>. +<p> +<div class="fragment"><pre>00083 { +00084 TPlayListList::iterator it; +00085 +00086 <span class="keywordflow">for</span>(it=<a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.begin();it!=<a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.end();) +00087 { +00088 CNode *node= &(it->second); +00089 <span class="comment">// Test refPtrs.</span> +00090 <span class="keywordflow">if</span>( node->PlayList==NULL || node->ChannelMixer==NULL) +00091 { +00092 <span class="comment">// erase it from map.</span> +00093 TPlayListList::iterator itDel= it++; +00094 <a class="code" href="a03085.html#NL3D_1_1CPlayListManagerr0">_List</a>.erase(itDel); +00095 } +00096 <span class="keywordflow">else</span> +00097 { +00098 <span class="comment">// animate!!</span> +00099 node->PlayList->setupMixer(*node->ChannelMixer, time); +00100 it++; +00101 } +00102 } +00103 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1CPlayListManagerr0" doxytag="NL3D::CPlayListManager::_List" ></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#NL3D_1_1CPlayListManagery0">TPlayListList</a> <a class="el" href="a03085.html#NL3D_1_1CPlayListManagerr0">NL3D::CPlayListManager::_List</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="a06174.html#l00091">91</a> of file <a class="el" href="a06174.html">play_list_manager.h</a>. +<p> +Referenced by <a class="el" href="a06173.html#l00036">addPlaylist()</a>, <a class="el" href="a06173.html#l00056">animate()</a>, <a class="el" href="a06173.html#l00107">deleteAll()</a>, <a class="el" href="a06173.html#l00047">removePlaylist()</a>, and <a class="el" href="a06173.html#l00082">setup()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a06174.html">play_list_manager.h</a><li><a class="el" href="a06173.html">play_list_manager.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:01:18 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> |