Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > by-pkgid > 58828b263d8f56d90ac336dea07a4586 > files > 1036

irrlicht-doc-1.6.1-1mdv2010.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::video::SLight Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
  <tr valign="middle"> 
    <td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a> 
      | <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a> 
      | <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a> 
      | <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical 
      List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF"> 
      Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a> 
      | <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF"> 
      Namespace&nbsp;Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class 
      members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File 
      members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
  </tr>
</table>
<!-- Generated by Doxygen 1.5.6 -->
  <div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1video.html">video</a>::<a class="el" href="structirr_1_1video_1_1_s_light.html">SLight</a>
  </div>
<div class="contents">
<h1>irr::video::SLight Struct Reference</h1><!-- doxytag: class="irr::video::SLight" -->structure for holding data describing a dynamic point light.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="_s_light_8h-source.html">SLight.h</a>&gt;</code>
<p>

<p>
<a href="structirr_1_1video_1_1_s_light-members.html">List of all members.</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#61379791eafc4f05373461d02c8d3f43">SLight</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#120e9234a2141eb1fbe46cad23794e0e">AmbientColor</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ambient color emitted by the light.  <a href="#120e9234a2141eb1fbe46cad23794e0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classirr_1_1core_1_1vector3d.html">core::vector3df</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#06c10ab01b8ad1ee554b956bd5baeacc">Attenuation</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attenuation factors (constant, linear, quadratic).  <a href="#06c10ab01b8ad1ee554b956bd5baeacc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#fbc66ada0baaf9f642d165fb8b11118b">CastShadows</a>:1</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read-ONLY! Does the light cast shadows?  <a href="#fbc66ada0baaf9f642d165fb8b11118b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#226622e93aa1e249fe876fdb9d0186fe">DiffuseColor</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Diffuse color emitted by the light.  <a href="#226622e93aa1e249fe876fdb9d0186fe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classirr_1_1core_1_1vector3d.html">core::vector3df</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#226c488abec5696b995df6895ab42d41">Direction</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read-ONLY! Direction of the light.  <a href="#226c488abec5696b995df6895ab42d41"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#38cea8db5e6951a9d98802f2f249129d">Falloff</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The light strength's decrease between Outer and Inner cone.  <a href="#38cea8db5e6951a9d98802f2f249129d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#b079c170fbab1e0a191e8801839d6c83">InnerCone</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The angle of the spot's inner cone. Ignored for other lights.  <a href="#b079c170fbab1e0a191e8801839d6c83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#38ee805b9145d4ab1b1a889bbded9adc">OuterCone</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The angle of the spot's outer cone. Ignored for other lights.  <a href="#38ee805b9145d4ab1b1a889bbded9adc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classirr_1_1core_1_1vector3d.html">core::vector3df</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#c1f0fda0cc1780b09a2597adcfc9c946">Position</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read-ONLY! Position of the light.  <a href="#c1f0fda0cc1780b09a2597adcfc9c946"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#9f3fbdf2869d9beca604ba1cca7499cb">Radius</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read-ONLY! Radius of light. Everything within this radius be be lighted.  <a href="#9f3fbdf2869d9beca604ba1cca7499cb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#2d66ad28850a8588b2ba727103710604">SpecularColor</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specular color emitted by the light.  <a href="#2d66ad28850a8588b2ba727103710604"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr_1_1video.html#af0e02f6f83cc35cf9e764bf18400d39">E_LIGHT_TYPE</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1video_1_1_s_light.html#c06681bb78d4911775f50d33e21761b4">Type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read-ONLY! Type of the light. Default: ELT_POINT.  <a href="#c06681bb78d4911775f50d33e21761b4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
structure for holding data describing a dynamic point light. 
<p>
Irrlicht supports point lights, spot lights, and directional lights. 
<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00038">38</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="61379791eafc4f05373461d02c8d3f43"></a><!-- doxytag: member="irr::video::SLight::SLight" ref="61379791eafc4f05373461d02c8d3f43" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">irr::video::SLight::SLight           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00040">40</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="120e9234a2141eb1fbe46cad23794e0e"></a><!-- doxytag: member="irr::video::SLight::AmbientColor" ref="120e9234a2141eb1fbe46cad23794e0e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#120e9234a2141eb1fbe46cad23794e0e">irr::video::SLight::AmbientColor</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Ambient color emitted by the light. 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00048">48</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="06c10ab01b8ad1ee554b956bd5baeacc"></a><!-- doxytag: member="irr::video::SLight::Attenuation" ref="06c10ab01b8ad1ee554b956bd5baeacc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classirr_1_1core_1_1vector3d.html">core::vector3df</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#06c10ab01b8ad1ee554b956bd5baeacc">irr::video::SLight::Attenuation</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Attenuation factors (constant, linear, quadratic). 
<p>
Changes the light strength fading over distance. Can also be altered by setting the radius, Attenuation will change to (0,1.f/radius,0). Can be overridden after radius was set. 
<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00062">62</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fbc66ada0baaf9f642d165fb8b11118b"></a><!-- doxytag: member="irr::video::SLight::CastShadows" ref="fbc66ada0baaf9f642d165fb8b11118b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="structirr_1_1video_1_1_s_light.html#fbc66ada0baaf9f642d165fb8b11118b">irr::video::SLight::CastShadows</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read-ONLY! Does the light cast shadows? 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00088">88</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="226622e93aa1e249fe876fdb9d0186fe"></a><!-- doxytag: member="irr::video::SLight::DiffuseColor" ref="226622e93aa1e249fe876fdb9d0186fe" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#226622e93aa1e249fe876fdb9d0186fe">irr::video::SLight::DiffuseColor</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Diffuse color emitted by the light. 
<p>
This is the primary color you want to set. 
<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00052">52</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="226c488abec5696b995df6895ab42d41"></a><!-- doxytag: member="irr::video::SLight::Direction" ref="226c488abec5696b995df6895ab42d41" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classirr_1_1core_1_1vector3d.html">core::vector3df</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#226c488abec5696b995df6895ab42d41">irr::video::SLight::Direction</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read-ONLY! Direction of the light. 
<p>
If Type is ELT_POINT, it is ignored. Changed via light <a class="el" href="namespaceirr_1_1scene.html" title="All scene management can be found in this namespace: Mesh loading, special scene...">scene</a> node's rotation. 
<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00079">79</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="38cea8db5e6951a9d98802f2f249129d"></a><!-- doxytag: member="irr::video::SLight::Falloff" ref="38cea8db5e6951a9d98802f2f249129d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#38cea8db5e6951a9d98802f2f249129d">irr::video::SLight::Falloff</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The light strength's decrease between Outer and Inner cone. 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00071">71</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b079c170fbab1e0a191e8801839d6c83"></a><!-- doxytag: member="irr::video::SLight::InnerCone" ref="b079c170fbab1e0a191e8801839d6c83" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#b079c170fbab1e0a191e8801839d6c83">irr::video::SLight::InnerCone</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The angle of the spot's inner cone. Ignored for other lights. 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00068">68</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="38ee805b9145d4ab1b1a889bbded9adc"></a><!-- doxytag: member="irr::video::SLight::OuterCone" ref="38ee805b9145d4ab1b1a889bbded9adc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#38ee805b9145d4ab1b1a889bbded9adc">irr::video::SLight::OuterCone</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The angle of the spot's outer cone. Ignored for other lights. 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00065">65</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c1f0fda0cc1780b09a2597adcfc9c946"></a><!-- doxytag: member="irr::video::SLight::Position" ref="c1f0fda0cc1780b09a2597adcfc9c946" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classirr_1_1core_1_1vector3d.html">core::vector3df</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#c1f0fda0cc1780b09a2597adcfc9c946">irr::video::SLight::Position</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read-ONLY! Position of the light. 
<p>
If Type is ELT_DIRECTIONAL, it is ignored. Changed via light <a class="el" href="namespaceirr_1_1scene.html" title="All scene management can be found in this namespace: Mesh loading, special scene...">scene</a> node's position. 
<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00075">75</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="9f3fbdf2869d9beca604ba1cca7499cb"></a><!-- doxytag: member="irr::video::SLight::Radius" ref="9f3fbdf2869d9beca604ba1cca7499cb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#9f3fbdf2869d9beca604ba1cca7499cb">irr::video::SLight::Radius</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read-ONLY! Radius of light. Everything within this radius be be lighted. 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00082">82</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2d66ad28850a8588b2ba727103710604"></a><!-- doxytag: member="irr::video::SLight::SpecularColor" ref="2d66ad28850a8588b2ba727103710604" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classirr_1_1video_1_1_s_colorf.html">SColorf</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#2d66ad28850a8588b2ba727103710604">irr::video::SLight::SpecularColor</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Specular color emitted by the light. 
<p>
For details how to use specular highlights, see <a class="el" href="classirr_1_1video_1_1_s_material.html#877106a83108db6d1f30a38379d28494" title="Value affecting the size of specular highlights.">SMaterial::Shininess</a> 
<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00056">56</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c06681bb78d4911775f50d33e21761b4"></a><!-- doxytag: member="irr::video::SLight::Type" ref="c06681bb78d4911775f50d33e21761b4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr_1_1video.html#af0e02f6f83cc35cf9e764bf18400d39">E_LIGHT_TYPE</a> <a class="el" href="structirr_1_1video_1_1_s_light.html#c06681bb78d4911775f50d33e21761b4">irr::video::SLight::Type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read-ONLY! Type of the light. Default: ELT_POINT. 
<p>

<p>Definition at line <a class="el" href="_s_light_8h-source.html#l00085">85</a> of file <a class="el" href="_s_light_8h-source.html">SLight.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_s_light_8h-source.html">SLight.h</a></ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
  <tr> 
    <td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
    <td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht 
        Engine</a> Documentation &copy; 2003-2009 by Nikolaus Gebhardt. Generated 
        on Sun Jan 10 09:24:20 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a> 
        (1.5.6)</font></em></small></div></td>
  </tr>
</table>
<address style="align: right;">
</address>
</body>
</html>