diff options
Diffstat (limited to '')
-rw-r--r-- | docs/doxygen/nel/animatable_8h-source.html | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/docs/doxygen/nel/animatable_8h-source.html b/docs/doxygen/nel/animatable_8h-source.html new file mode 100644 index 00000000..6cea4bc0 --- /dev/null +++ b/docs/doxygen/nel/animatable_8h-source.html @@ -0,0 +1,214 @@ +<!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>animatable.h</h1><a href="animatable_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_ANIMATABLE_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_ANIMATABLE_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="bit__set_8h.html">nel/misc/bit_set.h</a>"</font> +00031 <font class="preprocessor">#include <string></font> +00032 <font class="preprocessor">#include <vector></font> +00033 <font class="preprocessor">#include <map></font> +00034 +00035 +00036 <font class="keyword">namespace </font>NL3D +00037 { +00038 +00039 <font class="keyword">class </font>ITrack; +00040 <font class="keyword">class </font>CChannelMixer; +00041 +00042 +<a name="l00073"></a><a class="code" href="classNL3D_1_1IAnimatable.html">00073</a> <font class="keyword">class </font>IAnimatable +00074 { +<a name="l00075"></a><a class="code" href="classNL3D_1_1IAnimatable.html#l0">00075</a> <font class="keyword">friend</font> <font class="keyword">class </font><a class="code" href="classNL3D_1_1IAnimatable.html#l0">IAnimatedValue</a>; +00076 <font class="keyword">public</font>: +00077 +<a name="l00083"></a><a class="code" href="classNL3D_1_1IAnimatable.html#a0">00083</a> <a class="code" href="classNL3D_1_1IAnimatable.html#a0">IAnimatable</a> () +00084 { +00085 <a class="code" href="classNL3D_1_1IAnimatable.html#o1">_Father</a>= NULL; +00086 } +00087 +<a name="l00088"></a><a class="code" href="classNL3D_1_1IAnimatable.html#a1">00088</a> <font class="keyword">virtual</font> <a class="code" href="classNL3D_1_1IAnimatable.html#a1">~IAnimatable</a>() {} +00090 <font class="comment">// @{</font> +<a name="l00096"></a><a class="code" href="classNL3D_1_1IAnimatable.html#z367_0">00096</a> <font class="comment"></font> <font class="keyword">enum</font> <a class="code" href="classNL3D_1_1IAnimatable.html#z367_0">TAnimValues</a> +00097 { +00098 <a class="code" href="classNL3D_1_1IAnimatable.html#z367_0s0">AnimValueLast</a>=0, +00099 }; +00100 +00107 <font class="keyword">virtual</font> <a class="code" href="classNL3D_1_1IAnimatable.html#l0">IAnimatedValue</a>* <a class="code" href="classNL3D_1_1IAnimatable.html#z367_1">getValue</a> (uint valueId) =0; +00108 +00115 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="classNL3D_1_1IAnimatable.html#z367_2">getValueName</a> (uint valueId) <font class="keyword">const</font> =0; +00116 +00123 <font class="keyword">virtual</font> ITrack* <a class="code" href="classNL3D_1_1IAnimatable.html#z367_3">getDefaultTrack</a> (uint valueId) =0; +00124 +00135 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1IAnimatable.html#z367_4">registerToChannelMixer</a>(CChannelMixer *chanMixer, <font class="keyword">const</font> std::string &prefix=std::string()) =0; +00136 +00137 <font class="comment">// @}</font> +00138 +00139 +00140 +00142 <font class="comment">// @{</font> +00143 +<a name="l00151"></a><a class="code" href="classNL3D_1_1IAnimatable.html#z368_0">00151</a> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1IAnimatable.html#z368_0">setFather</a>(<a class="code" href="classNL3D_1_1IAnimatable.html#a0">IAnimatable</a> *father, uint fatherOwnerBit) +00152 { +00153 <a class="code" href="classNL3D_1_1IAnimatable.html#o1">_Father</a>= father; <a class="code" href="classNL3D_1_1IAnimatable.html#o2">_FatherOwnerBit</a>= fatherOwnerBit; +00154 +00155 <font class="comment">// propagate the touch to the fathers.</font> +00156 <a class="code" href="classNL3D_1_1IAnimatable.html#c0">propagateTouch</a>(); +00157 } +00158 +00159 +<a name="l00166"></a><a class="code" href="classNL3D_1_1IAnimatable.html#z368_1">00166</a> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1IAnimatable.html#z368_1">touch</a> (uint valueId, uint ownerValueId) +00167 { +00168 <font class="comment">// Set the bit</font> +00169 <a class="code" href="classNL3D_1_1IAnimatable.html#o0">bitSet</a>.<a class="code" href="classNLMISC_1_1CBitSet.html#z272_4">set</a> (valueId); +00170 <font class="comment">// Set the owner bit</font> +00171 <a class="code" href="classNL3D_1_1IAnimatable.html#o0">bitSet</a>.<a class="code" href="classNLMISC_1_1CBitSet.html#z272_4">set</a> (ownerValueId); +00172 +00173 <font class="comment">// propagate the touch to the fathers.</font> +00174 <a class="code" href="classNL3D_1_1IAnimatable.html#c0">propagateTouch</a>(); +00175 } +00176 +<a name="l00182"></a><a class="code" href="classNL3D_1_1IAnimatable.html#z368_2">00182</a> <font class="keywordtype">bool</font> <a class="code" href="classNL3D_1_1IAnimatable.html#z368_2">isTouched</a> (uint valueId)<font class="keyword"> const</font> +00183 <font class="keyword"> </font>{ +00184 <font class="keywordflow">return</font> <a class="code" href="classNL3D_1_1IAnimatable.html#o0">bitSet</a>[valueId]; +00185 } +00186 +00187 +<a name="l00193"></a><a class="code" href="classNL3D_1_1IAnimatable.html#z368_3">00193</a> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1IAnimatable.html#z368_3">resize</a> (uint count) +00194 { +00195 <font class="comment">// Bit are reseted after resize (doc), nothing invalidate</font> +00196 <a class="code" href="classNL3D_1_1IAnimatable.html#o0">bitSet</a>.<a class="code" href="classNLMISC_1_1CBitSet.html#z272_1">resizeNoReset</a> (count); +00197 } +00198 <font class="comment">// @}</font> +00199 +00200 +00201 <font class="keyword">private</font>: +00202 +00203 <font class="comment">// Use a CBitSet to manage the flags</font> +<a name="l00204"></a><a class="code" href="classNL3D_1_1IAnimatable.html#o0">00204</a> <a class="code" href="classNLMISC_1_1CBitSet.html">NLMISC::CBitSet</a> <a class="code" href="classNL3D_1_1IAnimatable.html#o0">bitSet</a>; +00205 <font class="comment">// The owner of this IAnimatable.</font> +<a name="l00206"></a><a class="code" href="classNL3D_1_1IAnimatable.html#o1">00206</a> <a class="code" href="classNL3D_1_1IAnimatable.html#a0">IAnimatable</a> *<a class="code" href="classNL3D_1_1IAnimatable.html#o1">_Father</a>; +00207 <font class="comment">// What bit of father which must set when we are updated.</font> +<a name="l00208"></a><a class="code" href="classNL3D_1_1IAnimatable.html#o2">00208</a> uint <a class="code" href="classNL3D_1_1IAnimatable.html#o2">_FatherOwnerBit</a>; +00209 +<a name="l00210"></a><a class="code" href="classNL3D_1_1IAnimatable.html#c0">00210</a> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1IAnimatable.html#c0">propagateTouch</a>() +00211 { +00212 <a class="code" href="classNL3D_1_1IAnimatable.html#a0">IAnimatable</a> *pCur= <font class="keyword">this</font>; +00213 <font class="comment">// Stop when no father, or when father is already touched (and so the grandfather...!!!).</font> +00214 <font class="keywordflow">while</font>(pCur->_Father && !pCur->_Father->isTouched(<a class="code" href="classNL3D_1_1IAnimatable.html#o2">_FatherOwnerBit</a>)) +00215 { +00216 <font class="comment">// The Owner bit is the "something is touched" flag. touch it.</font> +00217 pCur->_Father->bitSet.set (pCur->_FatherOwnerBit); +00218 pCur= pCur->_Father; +00219 } +00220 } +00221 +00222 +00223 <font class="keyword">protected</font>: +00228 sint <a class="code" href="classNL3D_1_1IAnimatable.html#b0">addValue</a>(CChannelMixer *chanMixer, uint valueId, uint ownerValueId, <font class="keyword">const</font> std::string &prefix, <font class="keywordtype">bool</font> detail); +00229 +<a name="l00231"></a><a class="code" href="classNL3D_1_1IAnimatable.html#b1">00231</a> <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1IAnimatable.html#b1">clearFlag</a>(uint valueId) +00232 { +00233 bitSet.<a class="code" href="classNLMISC_1_1CBitSet.html#z272_2">clear</a>(valueId); +00234 } +00235 +00236 }; +00237 +00238 +00239 } <font class="comment">// NL3D</font> +00240 +00241 <font class="preprocessor">#endif // NL_ANIMATABLE_H</font> +00242 <font class="preprocessor"></font> +00243 <font class="comment">/* End of animatable.h */</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> |