Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 1499

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkRIBLight Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</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>
    </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>
</div>
<div class="contents">
<h1>vtkRIBLight Class Reference</h1><!-- doxytag: class="vtkRIBLight" --><!-- doxytag: inherits="vtkLight" --><code>#include &lt;<a class="el" href="a04637.html">vtkRIBLight.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkRIBLight:</div>
<div class="dynsection">
<p><center><img src="a14206.png" border="0" usemap="#a14207" alt="Inheritance graph"></center>
<map name="a14207">
<area shape="rect" href="a00954.html" title="a virtual light for 3D rendering" alt="" coords="25,155,95,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="20,80,100,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,5,115,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkRIBLight:</div>
<div class="dynsection">
<p><center><img src="a14208.png" border="0" usemap="#a14209" alt="Collaboration graph"></center>
<map name="a14209">
<area shape="rect" href="a00954.html" title="a virtual light for 3D rendering" alt="" coords="108,264,178,291"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a00998.html" title="represent and manipulate 4x4 transformation matrices" alt="" coords="148,174,247,200"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="6,6,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,6,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a14210.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
RIP Light. 
<p>
<a class="el" href="a01496.html" title="RIP Light.">vtkRIBLight</a> is a subclass of <a class="el" href="a00954.html" title="a virtual light for 3D rendering">vtkLight</a> that allows the user to specify light source shaders and shadow casting lights for use with RenderMan.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01495.html" title="export a scene into RenderMan RIB format.">vtkRIBExporter</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_14.html#c2_vtk_t_vtkRIBLight">vtkRIBLight (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04637.html#l00035">35</a> of file <a class="el" href="a04637.html">vtkRIBLight.h</a>.</p>
<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 <a class="el" href="a00954.html">vtkLight</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#16b3709e696c27cc2d6802a9c747da1a">Superclass</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#1654369f1aeb0eb833c304ed9ae64f86">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#1cf78ba2f1c732cdae3dd10d7eb02d9b">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#1949fab8e985e1f43e9c2eeeccb6d2d4">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#3396f38bd37bb9bd044e46a3bc245d23">ShadowsOn</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#5865fa30dd5bd81b7d527e9544da36b8">ShadowsOff</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#df2507ea8315153460cebcfff456a04c">SetShadows</a> (int)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#59ed53108f1717827ddc126c8b11bdfe">GetShadows</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#a36df993f024de7dd1bda6b686cee8a2">Render</a> (<a class="el" href="a01480.html">vtkRenderer</a> *ren, int index)</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01496.html">vtkRIBLight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#d647c3750784bedba0c14e22e3cd638b">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#97deaeaafad27b3c63fb12399c724284">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01496.html">vtkRIBLight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#cdd3a5730176969b7919c8e3e6723918">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>

<tr><td colspan="2"><br><h2>Protected 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="a01496.html#43e6bd41b30dd92cbd77c446f9cc7589">vtkRIBLight</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#fd3428d9755bc0dcadfe93213b7a16c5">~vtkRIBLight</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00954.html">vtkLight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#dc10337b8a9e427c7e49792fc401dded">Light</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01496.html#a67a073aadc1de62c0a700b561a2875e">Shadows</a></td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="16b3709e696c27cc2d6802a9c747da1a"></a><!-- doxytag: member="vtkRIBLight::Superclass" ref="16b3709e696c27cc2d6802a9c747da1a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00954.html">vtkLight</a> <a class="el" href="a00954.html">vtkRIBLight::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00954.html#1973cbd3056dcf103835d5be3a299704">vtkLight</a>.</p>

<p>Definition at line <a class="el" href="a04637.html#l00039">39</a> of file <a class="el" href="a04637.html">vtkRIBLight.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="43e6bd41b30dd92cbd77c446f9cc7589"></a><!-- doxytag: member="vtkRIBLight::vtkRIBLight" ref="43e6bd41b30dd92cbd77c446f9cc7589" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkRIBLight::vtkRIBLight           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="fd3428d9755bc0dcadfe93213b7a16c5"></a><!-- doxytag: member="vtkRIBLight::~vtkRIBLight" ref="fd3428d9755bc0dcadfe93213b7a16c5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkRIBLight::~vtkRIBLight           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d647c3750784bedba0c14e22e3cd638b"></a><!-- doxytag: member="vtkRIBLight::New" ref="d647c3750784bedba0c14e22e3cd638b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01496.html">vtkRIBLight</a>* vtkRIBLight::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a light with the focal point at the origin and its position set to (0,0,1). The light is a SceneLight, its color is white (black ambient, white diffuse, white specular), intensity=1, the light is turned on, positional lighting is off, ConeAngle=30, AttenuationValues=(1,0,0), Exponent=1 and the TransformMatrix is NULL. 
<p>Reimplemented from <a class="el" href="a00954.html#07fe9d5a73dcede4db2af0cd792047c7">vtkLight</a>.</p>

</div>
</div><p>
<a class="anchor" name="1654369f1aeb0eb833c304ed9ae64f86"></a><!-- doxytag: member="vtkRIBLight::GetClassName" ref="1654369f1aeb0eb833c304ed9ae64f86" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkRIBLight::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00954.html#241048092ce952bf72ee9d0ab203f84c">vtkLight</a>.</p>

</div>
</div><p>
<a class="anchor" name="97deaeaafad27b3c63fb12399c724284"></a><!-- doxytag: member="vtkRIBLight::IsTypeOf" ref="97deaeaafad27b3c63fb12399c724284" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkRIBLight::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a00954.html#2627330249fb8c6a3e3ed4f6b8250a26">vtkLight</a>.</p>

</div>
</div><p>
<a class="anchor" name="1cf78ba2f1c732cdae3dd10d7eb02d9b"></a><!-- doxytag: member="vtkRIBLight::IsA" ref="1cf78ba2f1c732cdae3dd10d7eb02d9b" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkRIBLight::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a00954.html#a18cce6dde607984ef3d2aaef11bb416">vtkLight</a>.</p>

</div>
</div><p>
<a class="anchor" name="cdd3a5730176969b7919c8e3e6723918"></a><!-- doxytag: member="vtkRIBLight::SafeDownCast" ref="cdd3a5730176969b7919c8e3e6723918" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01496.html">vtkRIBLight</a>* vtkRIBLight::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00954.html#974162d0681c0692a6da930ed85487d6">vtkLight</a>.</p>

</div>
</div><p>
<a class="anchor" name="1949fab8e985e1f43e9c2eeeccb6d2d4"></a><!-- doxytag: member="vtkRIBLight::PrintSelf" ref="1949fab8e985e1f43e9c2eeeccb6d2d4" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkRIBLight::PrintSelf           </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a>&nbsp;</td>
          <td class="paramname"> <em>indent</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. 
<p>Reimplemented from <a class="el" href="a00954.html#079529ef2deea2280f750ea222fef9b9">vtkLight</a>.</p>

</div>
</div><p>
<a class="anchor" name="3396f38bd37bb9bd044e46a3bc245d23"></a><!-- doxytag: member="vtkRIBLight::ShadowsOn" ref="3396f38bd37bb9bd044e46a3bc245d23" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkRIBLight::ShadowsOn           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="5865fa30dd5bd81b7d527e9544da36b8"></a><!-- doxytag: member="vtkRIBLight::ShadowsOff" ref="5865fa30dd5bd81b7d527e9544da36b8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkRIBLight::ShadowsOff           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="df2507ea8315153460cebcfff456a04c"></a><!-- doxytag: member="vtkRIBLight::SetShadows" ref="df2507ea8315153460cebcfff456a04c" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkRIBLight::SetShadows           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="59ed53108f1717827ddc126c8b11bdfe"></a><!-- doxytag: member="vtkRIBLight::GetShadows" ref="59ed53108f1717827ddc126c8b11bdfe" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkRIBLight::GetShadows           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="a36df993f024de7dd1bda6b686cee8a2"></a><!-- doxytag: member="vtkRIBLight::Render" ref="a36df993f024de7dd1bda6b686cee8a2" args="(vtkRenderer *ren, int index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkRIBLight::Render           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01480.html">vtkRenderer</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Abstract interface to renderer. Each concrete subclass of <a class="el" href="a00954.html" title="a virtual light for 3D rendering">vtkLight</a> will load its data into the graphics system in response to this method invocation. The actual loading is performed by a vtkLightDevice subclass, which will get created automatically. 
<p>Reimplemented from <a class="el" href="a00954.html#bca3fb898f97bf72bda8ebaed6691d70">vtkLight</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="dc10337b8a9e427c7e49792fc401dded"></a><!-- doxytag: member="vtkRIBLight::Light" ref="dc10337b8a9e427c7e49792fc401dded" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00954.html">vtkLight</a>* <a class="el" href="a01496.html#dc10337b8a9e427c7e49792fc401dded">vtkRIBLight::Light</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04637.html#l00051">51</a> of file <a class="el" href="a04637.html">vtkRIBLight.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="a67a073aadc1de62c0a700b561a2875e"></a><!-- doxytag: member="vtkRIBLight::Shadows" ref="a67a073aadc1de62c0a700b561a2875e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="a01496.html#a67a073aadc1de62c0a700b561a2875e">vtkRIBLight::Shadows</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04637.html#l00052">52</a> of file <a class="el" href="a04637.html">vtkRIBLight.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Hybrid/<a class="el" href="a04637.html">vtkRIBLight.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:32:09 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>