Sophie

Sophie

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

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: vtkRendererCollection 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>vtkRendererCollection Class Reference</h1><!-- doxytag: class="vtkRendererCollection" --><!-- doxytag: inherits="vtkCollection" --><code>#include &lt;<a class="el" href="a05321.html">vtkRendererCollection.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkRendererCollection:</div>
<div class="dynsection">
<p><center><img src="a14133.png" border="0" usemap="#a14134" alt="Inheritance graph"></center>
<map name="a14134">
<area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="33,155,135,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="44,80,124,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="29,5,139,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkRendererCollection:</div>
<div class="dynsection">
<p><center><img src="a14135.png" border="0" usemap="#a14136" alt="Collaboration graph"></center>
<map name="a14136">
<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="a14137.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
a list of renderers 
<p>
<a class="el" href="a01481.html" title="a list of renderers">vtkRendererCollection</a> represents and provides methods to manipulate a list of renderers (i.e., <a class="el" href="a01480.html" title="abstract specification for renderers">vtkRenderer</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="a01480.html" title="abstract specification for renderers">vtkRenderer</a> <a class="el" href="a00285.html" title="create and manipulate unsorted lists of objects">vtkCollection</a> </dd></dl>

<p>Definition at line <a class="el" href="a05321.html#l00032">32</a> of file <a class="el" href="a05321.html">vtkRendererCollection.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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#8eeefa6b33cd0b802cc0f64f9c691172">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="a01481.html#5bed9801e582431c2361cc75fcf82d63">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="a01481.html#230b8b876bffb1cf91b16875e072841c">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="a01481.html#daa9cbd2277d8fe7d4279d18d1482745">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="a01481.html#2ffda77d165373a68c560865177f0993">Render</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01480.html">vtkRenderer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#6454656f361e364b6bc967e03e134a37">GetFirstRenderer</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#4a267ffcdf03d21fa6a2472f714d26c2">AddItem</a> (<a class="el" href="a01480.html">vtkRenderer</a> *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="a01480.html">vtkRenderer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#2e57b744983a5d7c72b5b7b9fe53e1ea">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="a01480.html">vtkRenderer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#f4167c7457d7a6e6f0f0f71053c8b54a">GetNextRenderer</a> (<a class="el" href="a01997.html#e6d08cf20cab6c3fff58d3854486e9e4">vtkCollectionSimpleIterator</a> &amp;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="a01481.html">vtkRendererCollection</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#b46219c3812aa925b1bcf1296e206d3d">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="a01481.html#81626fdfcfd761fcc33901988cf5efa6">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01481.html">vtkRendererCollection</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01481.html#5d1b4111589cd07adf025f77e121cae4">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="a01481.html#3f28b2e4e800b48be6b1968aa8b0a5de">vtkRendererCollection</a> ()</td></tr>

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

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="8eeefa6b33cd0b802cc0f64f9c691172"></a><!-- doxytag: member="vtkRendererCollection::Superclass" ref="8eeefa6b33cd0b802cc0f64f9c691172" 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">vtkRendererCollection::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="a05321.html#l00036">36</a> of file <a class="el" href="a05321.html">vtkRendererCollection.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="3f28b2e4e800b48be6b1968aa8b0a5de"></a><!-- doxytag: member="vtkRendererCollection::vtkRendererCollection" ref="3f28b2e4e800b48be6b1968aa8b0a5de" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkRendererCollection::vtkRendererCollection           </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="a05321.html#l00072">72</a> of file <a class="el" href="a05321.html">vtkRendererCollection.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="540823b202520a59d97b7183f33e1d89"></a><!-- doxytag: member="vtkRendererCollection::~vtkRendererCollection" ref="540823b202520a59d97b7183f33e1d89" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkRendererCollection::~vtkRendererCollection           </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="a05321.html#l00073">73</a> of file <a class="el" href="a05321.html">vtkRendererCollection.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b46219c3812aa925b1bcf1296e206d3d"></a><!-- doxytag: member="vtkRendererCollection::New" ref="b46219c3812aa925b1bcf1296e206d3d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01481.html">vtkRendererCollection</a>* vtkRendererCollection::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="5bed9801e582431c2361cc75fcf82d63"></a><!-- doxytag: member="vtkRendererCollection::GetClassName" ref="5bed9801e582431c2361cc75fcf82d63" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkRendererCollection::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="a00285.html#172b206cb7e0c4b08dde33523d678912">vtkCollection</a>.</p>

</div>
</div><p>
<a class="anchor" name="81626fdfcfd761fcc33901988cf5efa6"></a><!-- doxytag: member="vtkRendererCollection::IsTypeOf" ref="81626fdfcfd761fcc33901988cf5efa6" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkRendererCollection::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="a00285.html#642e1edd0682930b26264d148e5720af">vtkCollection</a>.</p>

</div>
</div><p>
<a class="anchor" name="230b8b876bffb1cf91b16875e072841c"></a><!-- doxytag: member="vtkRendererCollection::IsA" ref="230b8b876bffb1cf91b16875e072841c" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkRendererCollection::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="a00285.html#107affed7b654d49554898b4343565ba">vtkCollection</a>.</p>

</div>
</div><p>
<a class="anchor" name="5d1b4111589cd07adf025f77e121cae4"></a><!-- doxytag: member="vtkRendererCollection::SafeDownCast" ref="5d1b4111589cd07adf025f77e121cae4" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01481.html">vtkRendererCollection</a>* vtkRendererCollection::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="a00285.html#dee7db9bea4f5be7b87fd49f4b1fe007">vtkCollection</a>.</p>

</div>
</div><p>
<a class="anchor" name="daa9cbd2277d8fe7d4279d18d1482745"></a><!-- doxytag: member="vtkRendererCollection::PrintSelf" ref="daa9cbd2277d8fe7d4279d18d1482745" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkRendererCollection::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="a00285.html#712f7aac0d04f73c7002cd15ec3d8d11">vtkCollection</a>.</p>

</div>
</div><p>
<a class="anchor" name="4a267ffcdf03d21fa6a2472f714d26c2"></a><!-- doxytag: member="vtkRendererCollection::AddItem" ref="4a267ffcdf03d21fa6a2472f714d26c2" args="(vtkRenderer *a)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkRendererCollection::AddItem           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01480.html">vtkRenderer</a> *&nbsp;</td>
          <td class="paramname"> <em>a</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a Renderer to the list. 
<p>Definition at line <a class="el" href="a05321.html#l00041">41</a> of file <a class="el" href="a05321.html">vtkRendererCollection.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2e57b744983a5d7c72b5b7b9fe53e1ea"></a><!-- doxytag: member="vtkRendererCollection::GetNextItem" ref="2e57b744983a5d7c72b5b7b9fe53e1ea" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01480.html">vtkRenderer</a>* vtkRendererCollection::GetNextItem           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the next Renderer in the list. Return NULL when at the end of the list. 
<p>Definition at line <a class="el" href="a05321.html#l00051">51</a> of file <a class="el" href="a05321.html">vtkRendererCollection.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2ffda77d165373a68c560865177f0993"></a><!-- doxytag: member="vtkRendererCollection::Render" ref="2ffda77d165373a68c560865177f0993" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkRendererCollection::Render           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Forward the <a class="el" href="a01481.html#2ffda77d165373a68c560865177f0993">Render()</a> method to each renderer in the list. 
</div>
</div><p>
<a class="anchor" name="6454656f361e364b6bc967e03e134a37"></a><!-- doxytag: member="vtkRendererCollection::GetFirstRenderer" ref="6454656f361e364b6bc967e03e134a37" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01480.html">vtkRenderer</a>* vtkRendererCollection::GetFirstRenderer           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the first Renderer in the list. Return NULL when at the end of the list. 
</div>
</div><p>
<a class="anchor" name="f4167c7457d7a6e6f0f0f71053c8b54a"></a><!-- doxytag: member="vtkRendererCollection::GetNextRenderer" ref="f4167c7457d7a6e6f0f0f71053c8b54a" args="(vtkCollectionSimpleIterator &amp;cookie)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01480.html">vtkRenderer</a>* vtkRendererCollection::GetNextRenderer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01997.html#e6d08cf20cab6c3fff58d3854486e9e4">vtkCollectionSimpleIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>cookie</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></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. 
<p>Definition at line <a class="el" href="a05321.html#l00066">66</a> of file <a class="el" href="a05321.html">vtkRendererCollection.h</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="a05321.html">vtkRendererCollection.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:31:17 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>