aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03527.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/a03527.html')
-rw-r--r--docs/doxygen/nel/a03527.html332
1 files changed, 332 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03527.html b/docs/doxygen/nel/a03527.html
new file mode 100644
index 00000000..eb95d349
--- /dev/null
+++ b/docs/doxygen/nel/a03527.html
@@ -0,0 +1,332 @@
+<!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::CTileLightInfluence 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::CTileLightInfluence Class Reference</h1><code>#include &lt;<a class="el" href="a06545.html">tile_light_influence.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+For landscape. A descriptor of light which influence a corner of a TessBlock: 2 lights Ids (points to PointLight in zone), with 2 diffuseLightFactor. <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="a06545.html#l00045">45</a> of file <a class="el" href="a06545.html">tile_light_influence.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>enum &nbsp;</td><td class="memItemRight" valign=bottom>{ <a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencew0NL3D_1_1CTileLightInfluencew1">NumLightPerCorner</a> = 2
+ }</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">We support only 2 light per corner. Should never be changed. <a href="#NL3D_1_1CTileLightInfluencew0">More...</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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencea0">CTileLightInfluence</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#NL3D_1_1CTileLightInfluencea0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a7">uint8</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencea1">getDiffuseLightFactor</a> (<a class="el" href="a04558.html#a15">uint</a> i) const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencea3">setDiffuseLightFactor()</a>. return uint8 E [0, 255] <a href="#NL3D_1_1CTileLightInfluencea1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencea2">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &amp;f)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencea3">setDiffuseLightFactor</a> (<a class="el" href="a04558.html#a15">uint</a> i, <a class="el" href="a04558.html#a7">uint8</a> factor)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">i: 0 or 1. factor E [0..255] is the factor of influence (gouraud) of the ith light. NB: stored on 4 bits. <a href="#NL3D_1_1CTileLightInfluencea3"></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><a class="el" href="a04558.html#a7">uint8</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03527.html#NL3D_1_1CTileLightInfluenceo0">Light</a> [NumLightPerCorner]</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="a04558.html#a7">uint8</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencer0">PackedLightFactor</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Packed. <a href="#NL3D_1_1CTileLightInfluencer0"></a><br><br></td></tr>
+</table>
+<hr><h2>Member Enumeration Documentation</h2>
+<a class="anchor" name="NL3D_1_1CTileLightInfluencew0" doxytag="NL3D::CTileLightInfluence::@33" ></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"> anonymous enum
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+We support only 2 light per corner. Should never be changed.
+<p>
+<dl compact><dt><b>Enumeration values: </b></dt><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em><a class="anchor" name="NL3D_1_1CTileLightInfluencew0NL3D_1_1CTileLightInfluencew1" doxytag="NumLightPerCorner" ></a>NumLightPerCorner</em>&nbsp;</td><td>
+</td></tr>
+</table>
+</dl>
+
+<p>
+Definition at line <a class="el" href="a06545.html#l00050">50</a> of file <a class="el" href="a06545.html">tile_light_influence.h</a>.
+<p>
+<div class="fragment"><pre>00050 {<a class="code" href="a03527.html#NL3D_1_1CTileLightInfluencew0NL3D_1_1CTileLightInfluencew1">NumLightPerCorner</a>= 2};
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NL3D_1_1CTileLightInfluencea0" doxytag="NL3D::CTileLightInfluence::CTileLightInfluence" ></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::CTileLightInfluence::CTileLightInfluence </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Constructor.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06545.html#l00054">54</a> of file <a class="el" href="a06545.html">tile_light_influence.h</a>.
+<p>
+<div class="fragment"><pre>00054 {}
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NL3D_1_1CTileLightInfluencea1" doxytag="NL3D::CTileLightInfluence::getDiffuseLightFactor" ></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="a04558.html#a7">uint8</a> NL3D::CTileLightInfluence::getDiffuseLightFactor </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a>&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>i</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const</td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+see <a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencea3">setDiffuseLightFactor()</a>. return uint8 E [0, 255]
+<p>
+
+<p>
+Definition at line <a class="el" href="a06544.html#l00053">53</a> of file <a class="el" href="a06544.html">tile_light_influence.cpp</a>.
+<p>
+References <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a06545.html#l00074">PackedLightFactor</a>, <a class="el" href="a05981.html#l00105">uint</a>, and <a class="el" href="a05981.html#l00096">uint8</a>.
+<p>
+<div class="fragment"><pre>00054 {
+00055 <a class="code" href="a04199.html#a6">nlassert</a>(CTileLightInfluence::NumLightPerCorner == 2);
+00056 <a class="code" href="a04199.html#a6">nlassert</a>(i == 0 || i == 1);
+00057
+00058 <span class="comment">// Choose what factor</span>
+00059 <a class="code" href="a04558.html#a7">uint8</a> ret= <a class="code" href="a03527.html#NL3D_1_1CTileLightInfluencer0">PackedLightFactor</a> &gt;&gt; (4*i);
+00060 ret&amp;= 0x0F;
+00061
+00062 <span class="comment">// expand to 0..255</span>
+00063 <span class="keywordflow">return</span> ret + (ret&lt;&lt;4);
+00064 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CTileLightInfluencea2" doxytag="NL3D::CTileLightInfluence::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" nowrap valign="top"> void NL3D::CTileLightInfluence::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></td>
+ </tr>
+
+ </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="a06544.html#l00067">67</a> of file <a class="el" href="a06544.html">tile_light_influence.cpp</a>.
+<p>
+References <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a06545.html#l00074">PackedLightFactor</a>, and <a class="el" href="a06462.html#l00232">NLMISC::IStream::serial()</a>.
+<p>
+<div class="fragment"><pre>00068 {
+00069 <a class="code" href="a04199.html#a6">nlassert</a>(CTileLightInfluence::NumLightPerCorner == 2);
+00070 <span class="comment">// No version for smaller size on disk !!</span>
+00071
+00072 f.<a class="code" href="a02270.html#NLMISC_1_1IStreama5">serial</a>(Light[0], Light[1], PackedLightFactor);
+00073 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CTileLightInfluencea3" doxytag="NL3D::CTileLightInfluence::setDiffuseLightFactor" ></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::CTileLightInfluence::setDiffuseLightFactor </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a>&nbsp;</td>
+ <td class="mdname" nowrap> <em>i</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap><a class="el" href="a04558.html#a7">uint8</a>&nbsp;</td>
+ <td class="mdname" nowrap> <em>factor</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+i: 0 or 1. factor E [0..255] is the factor of influence (gouraud) of the ith light. NB: stored on 4 bits.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06544.html#l00036">36</a> of file <a class="el" href="a06544.html">tile_light_influence.cpp</a>.
+<p>
+References <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a06545.html#l00074">PackedLightFactor</a>, <a class="el" href="a05981.html#l00105">uint</a>, and <a class="el" href="a05981.html#l00096">uint8</a>.
+<p>
+Referenced by <a class="el" href="a06768.html#l03346">NL3D::CZoneLighter::processZonePointLightRT()</a>.
+<p>
+<div class="fragment"><pre>00037 {
+00038 <a class="code" href="a04199.html#a6">nlassert</a>(CTileLightInfluence::NumLightPerCorner == 2);
+00039 <a class="code" href="a04199.html#a6">nlassert</a>(i == 0 || i == 1);
+00040
+00041 <span class="comment">// Divide by 16.</span>
+00042 factor&gt;&gt;=4;
+00043
+00044 <span class="comment">// set to the ith light.</span>
+00045 <a class="code" href="a04558.html#a7">uint8</a> mask= 0x0F &lt;&lt; (4*i);
+00046 <span class="comment">// clear.</span>
+00047 <a class="code" href="a03527.html#NL3D_1_1CTileLightInfluencer0">PackedLightFactor</a>&amp;= ~mask;
+00048 <span class="comment">// set.</span>
+00049 <a class="code" href="a03527.html#NL3D_1_1CTileLightInfluencer0">PackedLightFactor</a>|= factor &lt;&lt; (4*i);
+00050 }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NL3D_1_1CTileLightInfluenceo0" doxytag="NL3D::CTileLightInfluence::Light" ></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="a04558.html#a7">uint8</a> <a class="el" href="a03527.html#NL3D_1_1CTileLightInfluenceo0">NL3D::CTileLightInfluence::Light</a>[NumLightPerCorner]
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+List of lights. Id==0xFF =&gt; no light. if Light[i]==0xFF, then Light[j] with j&gt;i is supposed disalbed too.
+<p>
+Definition at line <a class="el" href="a06545.html#l00060">60</a> of file <a class="el" href="a06545.html">tile_light_influence.h</a>.
+<p>
+Referenced by <a class="el" href="a06157.html#l01543">NL3D::CPatch::appendTileLightInfluences()</a>, <a class="el" href="a06758.html#l00122">NL3D::CZone::build()</a>, and <a class="el" href="a06768.html#l03346">NL3D::CZoneLighter::processZonePointLightRT()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1CTileLightInfluencer0" doxytag="NL3D::CTileLightInfluence::PackedLightFactor" ></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="a04558.html#a7">uint8</a> <a class="el" href="a03527.html#NL3D_1_1CTileLightInfluencer0">NL3D::CTileLightInfluence::PackedLightFactor</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Packed.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06545.html#l00074">74</a> of file <a class="el" href="a06545.html">tile_light_influence.h</a>.
+<p>
+Referenced by <a class="el" href="a06544.html#l00053">getDiffuseLightFactor()</a>, <a class="el" href="a06544.html#l00067">serial()</a>, and <a class="el" href="a06544.html#l00036">setDiffuseLightFactor()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="a06545.html">tile_light_influence.h</a><li><a class="el" href="a06544.html">tile_light_influence.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:04:52 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>