<!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: vtkVolumeCollection 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>vtkVolumeCollection Class Reference</h1><!-- doxytag: class="vtkVolumeCollection" --><!-- doxytag: inherits="vtkPropCollection" --><code>#include <<a class="el" href="a05365.html">vtkVolumeCollection.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkVolumeCollection:</div> <div class="dynsection"> <p><center><img src="a15775.png" border="0" usemap="#a15776" alt="Inheritance graph"></center> <map name="a15776"> <area shape="rect" href="a01321.html" title="a list of Props" alt="" coords="15,229,143,256"><area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="28,155,129,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="39,80,119,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="24,5,133,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkVolumeCollection:</div> <div class="dynsection"> <p><center><img src="a15777.png" border="0" usemap="#a15778" alt="Collaboration graph"></center> <map name="a15778"> <area shape="rect" href="a01321.html" title="a list of Props" alt="" coords="80,387,208,413"><area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="93,309,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,213"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,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="a15779.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> a list of volumes <p> <a class="el" href="a01841.html" title="a list of volumes">vtkVolumeCollection</a> represents and provides methods to manipulate a list of volumes (i.e., <a class="el" href="a01839.html" title="represents a volume (data & properties) in a rendered scene">vtkVolume</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="a01839.html" title="represents a volume (data & properties) in a rendered scene">vtkVolume</a> </dd></dl> <p>Definition at line <a class="el" href="a05365.html#l00033">33</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.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="a01321.html">vtkPropCollection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#db5e739920025413425b6eae5c6bd0e9">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="a01841.html#10d14df04336323a48279200bfd2a274">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="a01841.html#3cdd23c84b1082e0adf7d57e31988bf6">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="a01841.html#4f9df5c8fb872a317708817f743356d3">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01839.html">vtkVolume</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#f2dc85c442f2436cdd7ca6bba864be0f">GetNextItem</a> ()</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#dd7a78598cddf5149e9b2f63b235744e">AddItem</a> (<a class="el" href="a01839.html">vtkVolume</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="a01839.html">vtkVolume</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#1d6e57bcd79d14a067222db4b1b26ed6">GetNextVolume</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="a01839.html">vtkVolume</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#4b7b95cf1067071921311ec73266dd4e">GetNextVolume</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="a01841.html">vtkVolumeCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#b0705c7ac78ba16efbb44ea78400713c">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="a01841.html#57efe039bbbb67b4d9ba209aa3699c0f">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01841.html">vtkVolumeCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#a4037ac818b2b6165491fd05c7be521b">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="a01841.html#e38b505ac62bf9690394a9baa1175e47">vtkVolumeCollection</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01841.html#4d5d293a02350f8e0bcc25800b9579cc">~vtkVolumeCollection</a> ()</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="db5e739920025413425b6eae5c6bd0e9"></a><!-- doxytag: member="vtkVolumeCollection::Superclass" ref="db5e739920025413425b6eae5c6bd0e9" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a01321.html">vtkPropCollection</a> <a class="el" href="a01321.html">vtkVolumeCollection::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a01321.html#ab6b24faf970e368b79df588c012cd71">vtkPropCollection</a>.</p> <p>Definition at line <a class="el" href="a05365.html#l00037">37</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="e38b505ac62bf9690394a9baa1175e47"></a><!-- doxytag: member="vtkVolumeCollection::vtkVolumeCollection" ref="e38b505ac62bf9690394a9baa1175e47" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkVolumeCollection::vtkVolumeCollection </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="a05365.html#l00070">70</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="4d5d293a02350f8e0bcc25800b9579cc"></a><!-- doxytag: member="vtkVolumeCollection::~vtkVolumeCollection" ref="4d5d293a02350f8e0bcc25800b9579cc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkVolumeCollection::~vtkVolumeCollection </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="a05365.html#l00071">71</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="b0705c7ac78ba16efbb44ea78400713c"></a><!-- doxytag: member="vtkVolumeCollection::New" ref="b0705c7ac78ba16efbb44ea78400713c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01841.html">vtkVolumeCollection</a>* vtkVolumeCollection::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="a01321.html#88d6590e55db3f86241a1b71e73084a8">vtkPropCollection</a>.</p> </div> </div><p> <a class="anchor" name="10d14df04336323a48279200bfd2a274"></a><!-- doxytag: member="vtkVolumeCollection::GetClassName" ref="10d14df04336323a48279200bfd2a274" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkVolumeCollection::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="a01321.html#53fc15eb0175b25b9b1d1fd43a741232">vtkPropCollection</a>.</p> </div> </div><p> <a class="anchor" name="57efe039bbbb67b4d9ba209aa3699c0f"></a><!-- doxytag: member="vtkVolumeCollection::IsTypeOf" ref="57efe039bbbb67b4d9ba209aa3699c0f" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkVolumeCollection::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="a01321.html#c69b7d8e1633b675e2de7b25aa1a9a93">vtkPropCollection</a>.</p> </div> </div><p> <a class="anchor" name="3cdd23c84b1082e0adf7d57e31988bf6"></a><!-- doxytag: member="vtkVolumeCollection::IsA" ref="3cdd23c84b1082e0adf7d57e31988bf6" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkVolumeCollection::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="a01321.html#ccc39ffa111b4ca3a56d68d7be7a84c7">vtkPropCollection</a>.</p> </div> </div><p> <a class="anchor" name="a4037ac818b2b6165491fd05c7be521b"></a><!-- doxytag: member="vtkVolumeCollection::SafeDownCast" ref="a4037ac818b2b6165491fd05c7be521b" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01841.html">vtkVolumeCollection</a>* vtkVolumeCollection::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="a01321.html#78110b5ddc8cfd1ce0de396d964c4903">vtkPropCollection</a>.</p> </div> </div><p> <a class="anchor" name="4f9df5c8fb872a317708817f743356d3"></a><!-- doxytag: member="vtkVolumeCollection::PrintSelf" ref="4f9df5c8fb872a317708817f743356d3" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkVolumeCollection::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="dd7a78598cddf5149e9b2f63b235744e"></a><!-- doxytag: member="vtkVolumeCollection::AddItem" ref="dd7a78598cddf5149e9b2f63b235744e" args="(vtkVolume *a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkVolumeCollection::AddItem </td> <td>(</td> <td class="paramtype"><a class="el" href="a01839.html">vtkVolume</a> * </td> <td class="paramname"> <em>a</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add a Volume to the list. <p>Definition at line <a class="el" href="a05365.html#l00042">42</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="1d6e57bcd79d14a067222db4b1b26ed6"></a><!-- doxytag: member="vtkVolumeCollection::GetNextVolume" ref="1d6e57bcd79d14a067222db4b1b26ed6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01839.html">vtkVolume</a>* vtkVolumeCollection::GetNextVolume </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the next Volume in the list. Return NULL when at the end of the list. <p>Definition at line <a class="el" href="a05365.html#l00051">51</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="f2dc85c442f2436cdd7ca6bba864be0f"></a><!-- doxytag: member="vtkVolumeCollection::GetNextItem" ref="f2dc85c442f2436cdd7ca6bba864be0f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01839.html">vtkVolume</a>* vtkVolumeCollection::GetNextItem </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Access routine provided for compatibility with previous versions of VTK. Please use the <a class="el" href="a01841.html#1d6e57bcd79d14a067222db4b1b26ed6">GetNextVolume()</a> variant where possible. <p>Definition at line <a class="el" href="a05365.html#l00058">58</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="4b7b95cf1067071921311ec73266dd4e"></a><!-- doxytag: member="vtkVolumeCollection::GetNextVolume" ref="4b7b95cf1067071921311ec73266dd4e" args="(vtkCollectionSimpleIterator &cookie)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01839.html">vtkVolume</a>* vtkVolumeCollection::GetNextVolume </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><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="a05365.html#l00064">64</a> of file <a class="el" href="a05365.html">vtkVolumeCollection.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="a05365.html">vtkVolumeCollection.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:44:32 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>