Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 3171

crystalspace-doc-1.2.1-5mdv2010.0.i586.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>Crystal Space 1.2.1: iLightCallback Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iLightCallback Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__light.html">Lighting</a>]</small>
</h1><!-- doxytag: class="iLightCallback" --><!-- doxytag: inherits="iBase" -->Set a callback which is called when this light color is changed.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="light_8h-source.html">iengine/light.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iLightCallback:</div>
<div class="dynsection">
<p><center><img src="structiLightCallback__inherit__graph.png" border="0" usemap="#iLightCallback__inherit__map" alt="Inheritance graph"></center>
<map name="iLightCallback__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="32,7,88,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiLightCallback-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightCallback.html#8dda5759356b957b809a64ebf265d90b">OnAttenuationChange</a> (<a class="el" href="structiLight.html">iLight</a> *light, int newatt)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attenuation will be changed.  <a href="#8dda5759356b957b809a64ebf265d90b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightCallback.html#5d23046d08c75f0ada3645b88f0ee4df">OnColorChange</a> (<a class="el" href="structiLight.html">iLight</a> *light, const <a class="el" href="classcsColor.html">csColor</a> &amp;newcolor)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Light color will be changed.  <a href="#5d23046d08c75f0ada3645b88f0ee4df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightCallback.html#cbfd8c06700bfda6452b4c34e46af7ad">OnDestroy</a> (<a class="el" href="structiLight.html">iLight</a> *light)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Light will be destroyed.  <a href="#cbfd8c06700bfda6452b4c34e46af7ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightCallback.html#6c1b0de1ee49e6593f6ae0a723c7f7e9">OnPositionChange</a> (<a class="el" href="structiLight.html">iLight</a> *light, const <a class="el" href="classcsVector3.html">csVector3</a> &amp;newpos)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Light position will be changed.  <a href="#6c1b0de1ee49e6593f6ae0a723c7f7e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightCallback.html#1a930f010a89e7453fb68f910dc3416f">OnRadiusChange</a> (<a class="el" href="structiLight.html">iLight</a> *light, float newradius)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Radius will be changed.  <a href="#1a930f010a89e7453fb68f910dc3416f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightCallback.html#b543f84bd4985a6bbd6f3308c1972cf1">OnSectorChange</a> (<a class="el" href="structiLight.html">iLight</a> *light, <a class="el" href="structiSector.html">iSector</a> *newsector)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sector will be changed.  <a href="#b543f84bd4985a6bbd6f3308c1972cf1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Set a callback which is called when this light color is changed. 
<p>
The given context will be either an instance of <a class="el" href="structiRenderView.html" title="This interface represents all information needed to render some object in a current...">iRenderView</a>, <a class="el" href="structiFrustumView.html" title="This structure represents all information needed for the frustum visibility calculator...">iFrustumView</a>, or else 0.<p>
This callback is used by:<ul>
<li><a class="el" href="structiLight.html" title="The iLight interface is the SCF interface for the csLight class.">iLight</a> </li></ul>

<p>Definition at line <a class="el" href="light_8h-source.html#l00155">155</a> of file <a class="el" href="light_8h-source.html">light.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8dda5759356b957b809a64ebf265d90b"></a><!-- doxytag: member="iLightCallback::OnAttenuationChange" ref="8dda5759356b957b809a64ebf265d90b" args="(iLight *light, int newatt)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iLightCallback::OnAttenuationChange           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiLight.html">iLight</a> *&nbsp;</td>
          <td class="paramname"> <em>light</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>newatt</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Attenuation will be changed. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<a class="anchor" name="5d23046d08c75f0ada3645b88f0ee4df"></a><!-- doxytag: member="iLightCallback::OnColorChange" ref="5d23046d08c75f0ada3645b88f0ee4df" args="(iLight *light, const csColor &amp;newcolor)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iLightCallback::OnColorChange           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiLight.html">iLight</a> *&nbsp;</td>
          <td class="paramname"> <em>light</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>newcolor</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Light color will be changed. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<a class="anchor" name="cbfd8c06700bfda6452b4c34e46af7ad"></a><!-- doxytag: member="iLightCallback::OnDestroy" ref="cbfd8c06700bfda6452b4c34e46af7ad" args="(iLight *light)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iLightCallback::OnDestroy           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiLight.html">iLight</a> *&nbsp;</td>
          <td class="paramname"> <em>light</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Light will be destroyed. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<a class="anchor" name="6c1b0de1ee49e6593f6ae0a723c7f7e9"></a><!-- doxytag: member="iLightCallback::OnPositionChange" ref="6c1b0de1ee49e6593f6ae0a723c7f7e9" args="(iLight *light, const csVector3 &amp;newpos)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iLightCallback::OnPositionChange           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiLight.html">iLight</a> *&nbsp;</td>
          <td class="paramname"> <em>light</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>newpos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Light position will be changed. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<a class="anchor" name="1a930f010a89e7453fb68f910dc3416f"></a><!-- doxytag: member="iLightCallback::OnRadiusChange" ref="1a930f010a89e7453fb68f910dc3416f" args="(iLight *light, float newradius)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iLightCallback::OnRadiusChange           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiLight.html">iLight</a> *&nbsp;</td>
          <td class="paramname"> <em>light</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>newradius</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Radius will be changed. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<a class="anchor" name="b543f84bd4985a6bbd6f3308c1972cf1"></a><!-- doxytag: member="iLightCallback::OnSectorChange" ref="b543f84bd4985a6bbd6f3308c1972cf1" args="(iLight *light, iSector *newsector)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iLightCallback::OnSectorChange           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiLight.html">iLight</a> *&nbsp;</td>
          <td class="paramname"> <em>light</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiSector.html">iSector</a> *&nbsp;</td>
          <td class="paramname"> <em>newsector</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sector will be changed. 
<p>
It is safe to delete this callback in this function. 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="light_8h-source.html">light.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>