<!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: vtkLightCollection 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 Page</span></a></li> <li><a href="pages.html"><span>Related 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 List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>vtkLightCollection Class Reference</h1><!-- doxytag: class="vtkLightCollection" --><!-- doxytag: inherits="vtkCollection" --><code>#include <<a class="el" href="a05241.html">vtkLightCollection.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkLightCollection:</div> <div class="dynsection"> <p><center><img src="a11777.png" border="0" usemap="#a11778" alt="Inheritance graph"></center> <map name="a11778"> <area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="20,155,121,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="31,80,111,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="16,5,125,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkLightCollection:</div> <div class="dynsection"> <p><center><img src="a11779.png" border="0" usemap="#a11780" alt="Collaboration graph"></center> <map name="a11780"> <area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="93,310,195,336"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a00286.html" title="vtkCollectionElement" alt="" coords="143,187,292,214"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,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="a11781.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> a list of lights <p> <a class="el" href="a00956.html" title="a list of lights">vtkLightCollection</a> represents and provides methods to manipulate a list of lights (i.e., <a class="el" href="a00954.html" title="a virtual light for 3D rendering">vtkLight</a> and subclasses). The list is unsorted and duplicate entries are not prevented.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00285.html" title="create and manipulate unsorted lists of objects">vtkCollection</a> <a class="el" href="a00954.html" title="a virtual light for 3D rendering">vtkLight</a></dd></dl> <dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_9.html#c2_vtk_t_vtkLightCollection">vtkLightCollection (Tests)</a> </dd></dl> <p>Definition at line <a class="el" href="a05241.html#l00036">36</a> of file <a class="el" href="a05241.html">vtkLightCollection.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="a00285.html">vtkCollection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#7e50b032486063435779e712d56ec73f">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 * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#87febf031acec5296f6e5dc862b32442">GetClassName</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#3ab5a0bde0242c84274d912959066472">IsA</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#cecf3ba0ffe0d869f77d288d977c235d">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#0531d54bd21e20f5db96e1a5c021dd25">AddItem</a> (<a class="el" href="a00954.html">vtkLight</a> *a)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00954.html">vtkLight</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#70b1b57c53f3a79b2f9a3b4e7ec25c88">GetNextItem</a> ()</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00954.html">vtkLight</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#a601c9010b92b2bbeb658a7d43ff3a9f">GetNextLight</a> (<a class="el" href="a01997.html#e6d08cf20cab6c3fff58d3854486e9e4">vtkCollectionSimpleIterator</a> &cookie)</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="a00956.html">vtkLightCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#ba449a21f260284443b3da6881787f6d">New</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#160516602a1e83cd2d4dca2ba2aa848f">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00956.html">vtkLightCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#af3df2cd0469e0f614c14e3b8194b121">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#be49d3d08d4b3b139c57a4bbbbffc2bf">vtkLightCollection</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00956.html#e7acb82e3ae452a493952223968d1304">~vtkLightCollection</a> ()</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="7e50b032486063435779e712d56ec73f"></a><!-- doxytag: member="vtkLightCollection::Superclass" ref="7e50b032486063435779e712d56ec73f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a00285.html">vtkCollection</a> <a class="el" href="a00285.html">vtkLightCollection::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00285.html#6f58f8e81f0bf6117532fded21d224ec">vtkCollection</a>.</p> <p>Definition at line <a class="el" href="a05241.html#l00040">40</a> of file <a class="el" href="a05241.html">vtkLightCollection.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="be49d3d08d4b3b139c57a4bbbbffc2bf"></a><!-- doxytag: member="vtkLightCollection::vtkLightCollection" ref="be49d3d08d4b3b139c57a4bbbbffc2bf" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkLightCollection::vtkLightCollection </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="a05241.html#l00059">59</a> of file <a class="el" href="a05241.html">vtkLightCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="e7acb82e3ae452a493952223968d1304"></a><!-- doxytag: member="vtkLightCollection::~vtkLightCollection" ref="e7acb82e3ae452a493952223968d1304" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkLightCollection::~vtkLightCollection </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="a05241.html#l00060">60</a> of file <a class="el" href="a05241.html">vtkLightCollection.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="ba449a21f260284443b3da6881787f6d"></a><!-- doxytag: member="vtkLightCollection::New" ref="ba449a21f260284443b3da6881787f6d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00956.html">vtkLightCollection</a>* vtkLightCollection::New </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct with empty list. <p>Reimplemented from <a class="el" href="a00285.html#8d47e38b592adfa195db9bf6ba1e3dc5">vtkCollection</a>.</p> </div> </div><p> <a class="anchor" name="87febf031acec5296f6e5dc862b32442"></a><!-- doxytag: member="vtkLightCollection::GetClassName" ref="87febf031acec5296f6e5dc862b32442" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkLightCollection::GetClassName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00285.html#172b206cb7e0c4b08dde33523d678912">vtkCollection</a>.</p> </div> </div><p> <a class="anchor" name="160516602a1e83cd2d4dca2ba2aa848f"></a><!-- doxytag: member="vtkLightCollection::IsTypeOf" ref="160516602a1e83cd2d4dca2ba2aa848f" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkLightCollection::IsTypeOf </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </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="a00285.html#642e1edd0682930b26264d148e5720af">vtkCollection</a>.</p> </div> </div><p> <a class="anchor" name="3ab5a0bde0242c84274d912959066472"></a><!-- doxytag: member="vtkLightCollection::IsA" ref="3ab5a0bde0242c84274d912959066472" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkLightCollection::IsA </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </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="a00285.html#107affed7b654d49554898b4343565ba">vtkCollection</a>.</p> </div> </div><p> <a class="anchor" name="af3df2cd0469e0f614c14e3b8194b121"></a><!-- doxytag: member="vtkLightCollection::SafeDownCast" ref="af3df2cd0469e0f614c14e3b8194b121" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00956.html">vtkLightCollection</a>* vtkLightCollection::SafeDownCast </td> <td>(</td> <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00285.html#dee7db9bea4f5be7b87fd49f4b1fe007">vtkCollection</a>.</p> </div> </div><p> <a class="anchor" name="cecf3ba0ffe0d869f77d288d977c235d"></a><!-- doxytag: member="vtkLightCollection::PrintSelf" ref="cecf3ba0ffe0d869f77d288d977c235d" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkLightCollection::PrintSelf </td> <td>(</td> <td class="paramtype">ostream & </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> </td> <td class="paramname"> <em>indent</em></td><td> </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="a00285.html#712f7aac0d04f73c7002cd15ec3d8d11">vtkCollection</a>.</p> </div> </div><p> <a class="anchor" name="0531d54bd21e20f5db96e1a5c021dd25"></a><!-- doxytag: member="vtkLightCollection::AddItem" ref="0531d54bd21e20f5db96e1a5c021dd25" args="(vtkLight *a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkLightCollection::AddItem </td> <td>(</td> <td class="paramtype"><a class="el" href="a00954.html">vtkLight</a> * </td> <td class="paramname"> <em>a</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Add a light to the list. </div> </div><p> <a class="anchor" name="70b1b57c53f3a79b2f9a3b4e7ec25c88"></a><!-- doxytag: member="vtkLightCollection::GetNextItem" ref="70b1b57c53f3a79b2f9a3b4e7ec25c88" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00954.html">vtkLight</a>* vtkLightCollection::GetNextItem </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get the next light in the list. NULL is returned when the collection is exhausted. </div> </div><p> <a class="anchor" name="a601c9010b92b2bbeb658a7d43ff3a9f"></a><!-- doxytag: member="vtkLightCollection::GetNextLight" ref="a601c9010b92b2bbeb658a7d43ff3a9f" args="(vtkCollectionSimpleIterator &cookie)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00954.html">vtkLight</a>* vtkLightCollection::GetNextLight </td> <td>(</td> <td class="paramtype"><a class="el" href="a01997.html#e6d08cf20cab6c3fff58d3854486e9e4">vtkCollectionSimpleIterator</a> & </td> <td class="paramname"> <em>cookie</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Reentrant safe way to get an object in a collection. Just pass the same cookie back and forth. </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/Rendering/<a class="el" href="a05241.html">vtkLightCollection.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:15:22 2009 for VTK by <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>