aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02697.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a02697.html312
1 files changed, 312 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02697.html b/docs/doxygen/nel/a02697.html
new file mode 100644
index 00000000..d4aa541b
--- /dev/null
+++ b/docs/doxygen/nel/a02697.html
@@ -0,0 +1,312 @@
+<!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: TemplateNL3D::CKeyBezier&lt; T &gt; 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NL3D::CKeyBezier&lt; T &gt; Class Template Reference</h1><code>#include &lt;<a class="el" href="a05858.html">key.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NL3D::CKeyBezier&lt; T &gt;:
+<p><center><img src="a02697.png" usemap="#NL3D::CKeyBezier< T >_map" border="0" alt=""></center>
+<map name="NL3D::CKeyBezier< T >_map">
+<area href="a02695.html" alt="NL3D::CKey< T >" shape="rect" coords="0,0,148,24">
+</map>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+<h3>template&lt;class T&gt;<br>
+ class NL3D::CKeyBezier&lt; T &gt;</h3>
+
+Implementation of <a class="el" href="a02695.html">CKey</a> for Bezier keyframer.<p>
+<dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <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="a05858.html#l00137">137</a> of file <a class="el" href="a05858.html">key.h</a>.<table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>typedef T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02695.html#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4w0">TValueType</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">synonym for T. <a href="#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4w0"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02697.html#NL3D_1_1CKeyBeziera0">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &amp;f) throw (NLMISC::EStream)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serial. <a href="#NL3D_1_1CKeyBeziera0"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02695.html#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o12">OODeltaTime</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02695.html#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o15">Value</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The key value. <a href="#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o15"></a><br><br></td></tr>
+<tr><td colspan="2"><div class="groupHeader">Tangents.</div></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02697.html#NL3D_1_1CKeyBezierz233_0">InTan</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02697.html#NL3D_1_1CKeyBezierz233_1">OutTan</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02697.html#NL3D_1_1CKeyBezierz233_2">Step</a></td></tr>
+
+</table>
+<hr><h2>Member Typedef Documentation</h2>
+<a class="anchor" name="NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4w0" doxytag="NL3D::CKeyBezier::TValueType" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> typedef T <a class="el" href="a02695.html">NL3D::CKey</a>&lt; T &gt;::<a class="el" href="a02695.html#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4w0">TValueType</a><code> [inherited]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+synonym for T.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05858.html#l00054">54</a> of file <a class="el" href="a05858.html">key.h</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NL3D_1_1CKeyBeziera0" doxytag="NL3D::CKeyBezier::serial" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> void <a class="el" href="a02697.html">NL3D::CKeyBezier</a>&lt; T &gt;::serial </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>f</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> throw (<a class="el" href="a03781.html">NLMISC::EStream</a>)<code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Serial.
+<p>
+
+<p>
+Reimplemented from <a class="el" href="a02695.html#NL3D_1_1CKeya0">NL3D::CKey&lt; T &gt;</a>.
+<p>
+Definition at line <a class="el" href="a05858.html#l00142">142</a> of file <a class="el" href="a05858.html">key.h</a>.
+<p>
+References <a class="el" href="a05858.html#l00165">NL3D::CKeyBezier&lt; T &gt;::InTan</a>, <a class="el" href="a05858.html#l00166">NL3D::CKeyBezier&lt; T &gt;::OutTan</a>, and <a class="el" href="a05858.html#l00167">NL3D::CKeyBezier&lt; T &gt;::Step</a>.
+<p>
+<div class="fragment"><pre>00143 {
+00144 <span class="comment">// Version number</span>
+00145 (<span class="keywordtype">void</span>)f.<a class="code" href="a02270.html#NLMISC_1_1IStreamz2035_8">serialVersion</a> (0);
+00146
+00147 <span class="comment">// Serial the value</span>
+00148 f.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a> (Value);
+00149 f.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a> (InTan);
+00150 f.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a> (OutTan);
+00151 f.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a> (Step);
+00152 };
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NL3D_1_1CKeyBezierz233_0" doxytag="NL3D::CKeyBezier::InTan" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> T <a class="el" href="a02697.html">NL3D::CKeyBezier</a>&lt; T &gt;::<a class="el" href="a02697.html#NL3D_1_1CKeyBezierz233_0">InTan</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Those are NOT the true Bezier control points: they are tangents relative to Value, and relative to keyTime: CPIn= Value + InTan * dt0/3; <br>
+ CPOut= Value + OutTan * dt1/3; <br>
+ where: dt0= curKey.time - prevKey.time <br>
+ dt1= nextKey.time - curKey.time <br>
+<p>
+and when not possible (first/last key), dt= getRangeDelta() is used.
+<p>
+Definition at line <a class="el" href="a05858.html#l00165">165</a> of file <a class="el" href="a05858.html">key.h</a>.
+<p>
+Referenced by <a class="el" href="a06559.html#l00795">NL3D::CTCBTools&lt; CKeyTCBFloat, sint32, std::map&lt; TAnimationTime, CKeyTCBFloat &gt; &gt;::computeTCBFactors()</a>, and <a class="el" href="a05858.html#l00142">NL3D::CKeyBezier&lt; T &gt;::serial()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o12" doxytag="NL3D::CKeyBezier::OODeltaTime" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> float <a class="el" href="a02695.html">NL3D::CKey</a>&lt; T &gt;::<a class="el" href="a02695.html#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o12">OODeltaTime</a><code> [inherited]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a05858.html#l00076">76</a> of file <a class="el" href="a05858.html">key.h</a>.
+<p>
+Referenced by <a class="el" href="a06559.html#l00622">NL3D::CTrackKeyFramerLinear&lt; CKeyRGBA, NLMISC::CRGBA &gt;::evalKey()</a>, and <a class="el" href="a06559.html#l00576">NL3D::CTrackKeyFramerLinear&lt; CKeyQuat, CQuat &gt;::evalKey()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CKeyBezierz233_1" doxytag="NL3D::CKeyBezier::OutTan" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> T <a class="el" href="a02697.html">NL3D::CKeyBezier</a>&lt; T &gt;::<a class="el" href="a02697.html#NL3D_1_1CKeyBezierz233_1">OutTan</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Those are NOT the true Bezier control points: they are tangents relative to Value, and relative to keyTime: CPIn= Value + InTan * dt0/3; <br>
+ CPOut= Value + OutTan * dt1/3; <br>
+ where: dt0= curKey.time - prevKey.time <br>
+ dt1= nextKey.time - curKey.time <br>
+<p>
+and when not possible (first/last key), dt= getRangeDelta() is used.
+<p>
+Definition at line <a class="el" href="a05858.html#l00166">166</a> of file <a class="el" href="a05858.html">key.h</a>.
+<p>
+Referenced by <a class="el" href="a06559.html#l00795">NL3D::CTCBTools&lt; CKeyTCBFloat, sint32, std::map&lt; TAnimationTime, CKeyTCBFloat &gt; &gt;::computeTCBFactors()</a>, and <a class="el" href="a05858.html#l00142">NL3D::CKeyBezier&lt; T &gt;::serial()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CKeyBezierz233_2" doxytag="NL3D::CKeyBezier::Step" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> bool <a class="el" href="a02697.html">NL3D::CKeyBezier</a>&lt; T &gt;::<a class="el" href="a02697.html#NL3D_1_1CKeyBezierz233_2">Step</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Those are NOT the true Bezier control points: they are tangents relative to Value, and relative to keyTime: CPIn= Value + InTan * dt0/3; <br>
+ CPOut= Value + OutTan * dt1/3; <br>
+ where: dt0= curKey.time - prevKey.time <br>
+ dt1= nextKey.time - curKey.time <br>
+<p>
+and when not possible (first/last key), dt= getRangeDelta() is used.
+<p>
+Definition at line <a class="el" href="a05858.html#l00167">167</a> of file <a class="el" href="a05858.html">key.h</a>.
+<p>
+Referenced by <a class="el" href="a06559.html#l00795">NL3D::CTCBTools&lt; CKeyTCBFloat, sint32, std::map&lt; TAnimationTime, CKeyTCBFloat &gt; &gt;::computeTCBFactors()</a>, and <a class="el" href="a05858.html#l00142">NL3D::CKeyBezier&lt; T &gt;::serial()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o15" doxytag="NL3D::CKeyBezier::Value" ></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" colspan="4">
+template&lt;class T&gt; </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap valign="top"> T <a class="el" href="a02695.html">NL3D::CKey</a>&lt; T &gt;::<a class="el" href="a02695.html#NL3D_1_1CKeyTCB_3_01NLMISC_1_1CAngleAxis_01_4o15">Value</a><code> [inherited]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The key value.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05858.html#l00069">69</a> of file <a class="el" href="a05858.html">key.h</a>.
+<p>
+Referenced by <a class="el" href="a06559.html#l00795">NL3D::CTCBTools&lt; CKeyTCBFloat, sint32, std::map&lt; TAnimationTime, CKeyTCBFloat &gt; &gt;::computeTCBFactors()</a>, <a class="el" href="a06559.html#l00622">NL3D::CTrackKeyFramerLinear&lt; CKeyRGBA, NLMISC::CRGBA &gt;::evalKey()</a>, and <a class="el" href="a06559.html#l00576">NL3D::CTrackKeyFramerLinear&lt; CKeyQuat, CQuat &gt;::evalKey()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="a05858.html">key.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 06:48:06 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>