source: GTP/trunk/App/Demos/Illum/Rain/docs/html/classRainLight.html @ 2221

Revision 2221, 6.5 KB checked in by plemenos, 18 years ago (diff)
  • Property svn:executable set to *
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>gametools-rain: RainLight Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
12    <li><a href="files.html"><span>Files</span></a></li>
13  </ul></div>
14<div class="tabs">
15  <ul>
16    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
17    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
18    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
19  </ul></div>
20<h1>RainLight Class Reference</h1><!-- doxytag: class="RainLight" --><code>#include &lt;<a class="el" href="RainLight_8h-source.html">RainLight.h</a>&gt;</code>
21<p>
22<a href="classRainLight-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
23<a class="el" href="classRainLight.html">RainLight</a> class enables a change of appearance of raindrops close to a light source
24<p>
25<table border="0" cellpadding="0" cellspacing="0">
26<tr><td></td></tr>
27<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRainLight.html#3f7303451d4241cba55324c9eeb7ef00">RainLight</a> (SceneManager *sceneMgr, int lightNumber=0, ColourValue col=ColourValue::Red, Vector3 LightPos=Vector3(0, 0, 0), float LightAttenuation=150)</td></tr>
29
30<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74bc77e3b3a397f2b169b13d9f239c62"></a><!-- doxytag: member="RainLight::animate" ref="74bc77e3b3a397f2b169b13d9f239c62" args="()" -->
31void&nbsp;</td><td class="memItemRight" valign="bottom"><b>animate</b> ()</td></tr>
32
33<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dbb03025b8fd524a31f3e0e8b13c9f5d"></a><!-- doxytag: member="RainLight::getColour" ref="dbb03025b8fd524a31f3e0e8b13c9f5d" args="()" -->
34ColourValue&nbsp;</td><td class="memItemRight" valign="bottom"><b>getColour</b> ()</td></tr>
35
36<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28afdaf038a531fb8511b73b6292dda3"></a><!-- doxytag: member="RainLight::getPosition" ref="28afdaf038a531fb8511b73b6292dda3" args="()" -->
37Vector3&nbsp;</td><td class="memItemRight" valign="bottom"><b>getPosition</b> ()</td></tr>
38
39<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="508bea3a523740baa4913737773a8c95"></a><!-- doxytag: member="RainLight::getDirection" ref="508bea3a523740baa4913737773a8c95" args="()" -->
40Vector3&nbsp;</td><td class="memItemRight" valign="bottom"><b>getDirection</b> ()</td></tr>
41
42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="250476ac8bc9c299d37e8d4c0e6ac1ef"></a><!-- doxytag: member="RainLight::getCutoff" ref="250476ac8bc9c299d37e8d4c0e6ac1ef" args="()" -->
43float&nbsp;</td><td class="memItemRight" valign="bottom"><b>getCutoff</b> ()</td></tr>
44
45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14854fc41dcc34ad7dece5ee1a1238ea"></a><!-- doxytag: member="RainLight::getAttenuation" ref="14854fc41dcc34ad7dece5ee1a1238ea" args="()" -->
46float&nbsp;</td><td class="memItemRight" valign="bottom"><b>getAttenuation</b> ()</td></tr>
47
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22d2f9ce11e8e65caf85457649b2b1b2"></a><!-- doxytag: member="RainLight::getIsAnimated" ref="22d2f9ce11e8e65caf85457649b2b1b2" args="()" -->
49bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>getIsAnimated</b> ()</td></tr>
50
51</table>
52<hr><h2>Constructor &amp; Destructor Documentation</h2>
53<a class="anchor" name="3f7303451d4241cba55324c9eeb7ef00"></a><!-- doxytag: member="RainLight::RainLight" ref="3f7303451d4241cba55324c9eeb7ef00" args="(SceneManager *sceneMgr, int lightNumber=0, ColourValue col=ColourValue::Red, Vector3 LightPos=Vector3(0, 0, 0), float LightAttenuation=150)" --><p>
54<table class="mdTable" cellpadding="2" cellspacing="0">
55  <tr>
56    <td class="mdRow">
57      <table cellpadding="0" cellspacing="0" border="0">
58        <tr>
59          <td class="md" nowrap valign="top">RainLight::RainLight           </td>
60          <td class="md" valign="top">(&nbsp;</td>
61          <td class="md" nowrap valign="top">SceneManager *&nbsp;</td>
62          <td class="mdname" nowrap> <em>sceneMgr</em>, </td>
63        </tr>
64        <tr>
65          <td class="md" nowrap align="right"></td>
66          <td class="md"></td>
67          <td class="md" nowrap>int&nbsp;</td>
68          <td class="mdname" nowrap> <em>lightNumber</em> = <code>0</code>, </td>
69        </tr>
70        <tr>
71          <td class="md" nowrap align="right"></td>
72          <td class="md"></td>
73          <td class="md" nowrap>ColourValue&nbsp;</td>
74          <td class="mdname" nowrap> <em>col</em> = <code>ColourValue::Red</code>, </td>
75        </tr>
76        <tr>
77          <td class="md" nowrap align="right"></td>
78          <td class="md"></td>
79          <td class="md" nowrap>Vector3&nbsp;</td>
80          <td class="mdname" nowrap> <em>LightPos</em> = <code>Vector3(0,&nbsp;0,&nbsp;0)</code>, </td>
81        </tr>
82        <tr>
83          <td class="md" nowrap align="right"></td>
84          <td class="md"></td>
85          <td class="md" nowrap>float&nbsp;</td>
86          <td class="mdname" nowrap> <em>LightAttenuation</em> = <code>150</code></td>
87        </tr>
88        <tr>
89          <td class="md"></td>
90          <td class="md">)&nbsp;</td>
91          <td class="md" colspan="2"></td>
92        </tr>
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing="5" cellpadding="0" border="0">
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105Constructor for street light. Should not be called directly. Use RainLightManager-&gt;addStreetLight() instead.     </td>
106  </tr>
107</table>
108<hr>The documentation for this class was generated from the following files:<ul>
109<li><a class="el" href="RainLight_8h-source.html">RainLight.h</a><li>RainLight.cpp</ul>
110<hr size="1"><address style="align: right;"><small>Generated on Wed May 17 16:55:30 2006 for gametools-rain by&nbsp;
111<a href="http://www.doxygen.org/index.html">
112<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
113</body>
114</html>
Note: See TracBrowser for help on using the repository browser.