Sophie

Sophie

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

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: vtkOpenGLLight 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>vtkOpenGLLight Class Reference</h1><!-- doxytag: class="vtkOpenGLLight" --><!-- doxytag: inherits="vtkLight" --><code>#include &lt;<a class="el" href="a05283.html">vtkOpenGLLight.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkOpenGLLight:</div>
<div class="dynsection">
<p><center><img src="a12500.png" border="0" usemap="#a12501" alt="Inheritance graph"></center>
<map name="a12501">
<area shape="rect" href="a00954.html" title="a virtual light for 3D rendering" alt="" coords="31,155,100,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="26,80,106,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="11,5,120,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkOpenGLLight:</div>
<div class="dynsection">
<p><center><img src="a12502.png" border="0" usemap="#a12503" alt="Collaboration graph"></center>
<map name="a12503">
<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,173,247,200"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="6,5,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,5,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a12504.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
OpenGL light. 
<p>
<a class="el" href="a01111.html" title="OpenGL light.">vtkOpenGLLight</a> is a concrete implementation of the abstract class <a class="el" href="a00954.html" title="a virtual light for 3D rendering">vtkLight</a>. <a class="el" href="a01111.html" title="OpenGL light.">vtkOpenGLLight</a> interfaces to the OpenGL rendering library. 
<p>Definition at line <a class="el" href="a05283.html#l00029">29</a> of file <a class="el" href="a05283.html">vtkOpenGLLight.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="a01111.html#760eb019350084e8311314a118d7661d">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="a01111.html#ed6f8b29fffe8345a76913d088f97556">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="a01111.html#54c9b4086c2b88ddec689d49cfc43009">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01111.html#bc94577930962d7e94b03a247db58e3b">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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01111.html#980521d6bdd4852d500758b326ca8c74">Render</a> (<a class="el" href="a01480.html">vtkRenderer</a> *ren, int light_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="a01111.html">vtkOpenGLLight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01111.html#e72441c6ad10529d90c0983bf6587ed2">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="a01111.html#91c5324b64a2f9d898afcd4cd69b8e82">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01111.html">vtkOpenGLLight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01111.html#696217893a685d846823805b676edc8b">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="a01111.html#cbf7244488c443af0674e9887dc7c7c6">vtkOpenGLLight</a> ()</td></tr>

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

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="760eb019350084e8311314a118d7661d"></a><!-- doxytag: member="vtkOpenGLLight::Superclass" ref="760eb019350084e8311314a118d7661d" 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">vtkOpenGLLight::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="a05283.html#l00033">33</a> of file <a class="el" href="a05283.html">vtkOpenGLLight.h</a>.</p>

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

<p>

<p>Definition at line <a class="el" href="a05283.html#l00040">40</a> of file <a class="el" href="a05283.html">vtkOpenGLLight.h</a>.</p>

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

<p>

<p>Definition at line <a class="el" href="a05283.html#l00041">41</a> of file <a class="el" href="a05283.html">vtkOpenGLLight.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e72441c6ad10529d90c0983bf6587ed2"></a><!-- doxytag: member="vtkOpenGLLight::New" ref="e72441c6ad10529d90c0983bf6587ed2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01111.html">vtkOpenGLLight</a>* vtkOpenGLLight::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="ed6f8b29fffe8345a76913d088f97556"></a><!-- doxytag: member="vtkOpenGLLight::GetClassName" ref="ed6f8b29fffe8345a76913d088f97556" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkOpenGLLight::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="91c5324b64a2f9d898afcd4cd69b8e82"></a><!-- doxytag: member="vtkOpenGLLight::IsTypeOf" ref="91c5324b64a2f9d898afcd4cd69b8e82" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkOpenGLLight::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="54c9b4086c2b88ddec689d49cfc43009"></a><!-- doxytag: member="vtkOpenGLLight::IsA" ref="54c9b4086c2b88ddec689d49cfc43009" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkOpenGLLight::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="696217893a685d846823805b676edc8b"></a><!-- doxytag: member="vtkOpenGLLight::SafeDownCast" ref="696217893a685d846823805b676edc8b" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01111.html">vtkOpenGLLight</a>* vtkOpenGLLight::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="bc94577930962d7e94b03a247db58e3b"></a><!-- doxytag: member="vtkOpenGLLight::PrintSelf" ref="bc94577930962d7e94b03a247db58e3b" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkOpenGLLight::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="980521d6bdd4852d500758b326ca8c74"></a><!-- doxytag: member="vtkOpenGLLight::Render" ref="980521d6bdd4852d500758b326ca8c74" args="(vtkRenderer *ren, int light_index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkOpenGLLight::Render           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01480.html">vtkRenderer</a> *&nbsp;</td>
          <td class="paramname"> <em>ren</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>light_index</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>
Implement base class method. 
<p>Reimplemented from <a class="el" href="a00954.html#bca3fb898f97bf72bda8ebaed6691d70">vtkLight</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Rendering/<a class="el" href="a05283.html">vtkOpenGLLight.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:20:30 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>