<!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: vtkPropCollection 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>vtkPropCollection Class Reference</h1><!-- doxytag: class="vtkPropCollection" --><!-- doxytag: inherits="vtkCollection" --><code>#include <<a class="el" href="a03910.html">vtkPropCollection.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkPropCollection:</div> <div class="dynsection"> <p><center><img src="a13508.png" border="0" usemap="#a13509" alt="Inheritance graph"></center> <map name="a13509"> <area shape="rect" href="a00094.html" title="a list of 2D actors" alt="" coords="6,304,155,331"><area shape="rect" href="a00095.html" title="a list of actors" alt="" coords="179,304,312,331"><area shape="rect" href="a01319.html" title="a list of 3D props" alt="" coords="336,304,483,331"><area shape="rect" href="a01841.html" title="a list of volumes" alt="" coords="507,304,654,331"><area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="276,155,378,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="287,80,367,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="272,5,382,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkPropCollection:</div> <div class="dynsection"> <p><center><img src="a13510.png" border="0" usemap="#a13511" alt="Collaboration graph"></center> <map name="a13511"> <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="a13512.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> a list of Props <p> <a class="el" href="a01321.html" title="a list of Props">vtkPropCollection</a> represents and provides methods to manipulate a list of Props (i.e., <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</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="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> <a class="el" href="a00285.html" title="create and manipulate unsorted lists of objects">vtkCollection</a></dd></dl> <dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkPropCollection">vtkPropCollection (Tests)</a> </dd></dl> <p>Definition at line <a class="el" href="a03910.html#l00036">36</a> of file <a class="el" href="a03910.html">vtkPropCollection.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="a01321.html#ab6b24faf970e368b79df588c012cd71">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="a01321.html#53fc15eb0175b25b9b1d1fd43a741232">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="a01321.html#ccc39ffa111b4ca3a56d68d7be7a84c7">IsA</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#6dd962e765ce239e8158eb98ff432721">AddItem</a> (<a class="el" href="a01317.html">vtkProp</a> *a)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01317.html">vtkProp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#fc842bb537949c256b27e953c6f79491">GetNextProp</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01317.html">vtkProp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#ee63a75f343215c1b65d655984baae24">GetLastProp</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#aca1a51fd357747f535ed7951aa7f0d2">GetNumberOfPaths</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="a01317.html">vtkProp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#66468511215fdb783fcec59725eac136">GetNextProp</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="a01321.html">vtkPropCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#88d6590e55db3f86241a1b71e73084a8">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="a01321.html#c69b7d8e1633b675e2de7b25aa1a9a93">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01321.html">vtkPropCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#78110b5ddc8cfd1ce0de396d964c4903">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="a01321.html#a7b15bed3ed0913cd9d9273b61add403">vtkPropCollection</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01321.html#df4a867d52a6a4f72e68f0a899f00ed1">~vtkPropCollection</a> ()</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="ab6b24faf970e368b79df588c012cd71"></a><!-- doxytag: member="vtkPropCollection::Superclass" ref="ab6b24faf970e368b79df588c012cd71" 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">vtkPropCollection::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00285.html#6f58f8e81f0bf6117532fded21d224ec">vtkCollection</a>.</p> <p>Reimplemented in <a class="el" href="a00094.html#a21e4d6f37cab9b1394f3ca3c7eea154">vtkActor2DCollection</a>, <a class="el" href="a00095.html#66a0a88d335f6700317791a121375a80">vtkActorCollection</a>, <a class="el" href="a01319.html#4827de828682a3f23d409af546b12b44">vtkProp3DCollection</a>, and <a class="el" href="a01841.html#db5e739920025413425b6eae5c6bd0e9">vtkVolumeCollection</a>.</p> <p>Definition at line <a class="el" href="a03910.html#l00040">40</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a7b15bed3ed0913cd9d9273b61add403"></a><!-- doxytag: member="vtkPropCollection::vtkPropCollection" ref="a7b15bed3ed0913cd9d9273b61add403" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkPropCollection::vtkPropCollection </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="a03910.html#l00067">67</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="df4a867d52a6a4f72e68f0a899f00ed1"></a><!-- doxytag: member="vtkPropCollection::~vtkPropCollection" ref="df4a867d52a6a4f72e68f0a899f00ed1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkPropCollection::~vtkPropCollection </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="a03910.html#l00068">68</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="88d6590e55db3f86241a1b71e73084a8"></a><!-- doxytag: member="vtkPropCollection::New" ref="88d6590e55db3f86241a1b71e73084a8" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01321.html">vtkPropCollection</a>* vtkPropCollection::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> <p>Reimplemented in <a class="el" href="a00094.html#3864d737d021d23418cb85ac566d1aaa">vtkActor2DCollection</a>, <a class="el" href="a00095.html#508fb1233e07a09953660b335b6a1df4">vtkActorCollection</a>, <a class="el" href="a01319.html#6ca0287aade200c43f10be2c65eb6c37">vtkProp3DCollection</a>, and <a class="el" href="a01841.html#b0705c7ac78ba16efbb44ea78400713c">vtkVolumeCollection</a>.</p> </div> </div><p> <a class="anchor" name="53fc15eb0175b25b9b1d1fd43a741232"></a><!-- doxytag: member="vtkPropCollection::GetClassName" ref="53fc15eb0175b25b9b1d1fd43a741232" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkPropCollection::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> <p>Reimplemented in <a class="el" href="a00094.html#2533c91594d7107fb2f7cd144b1572f9">vtkActor2DCollection</a>, <a class="el" href="a00095.html#13d9e9bb791ad9faf94143798ca118b1">vtkActorCollection</a>, <a class="el" href="a01319.html#2dec22a94a2884bb812f09b81f80b085">vtkProp3DCollection</a>, and <a class="el" href="a01841.html#10d14df04336323a48279200bfd2a274">vtkVolumeCollection</a>.</p> </div> </div><p> <a class="anchor" name="c69b7d8e1633b675e2de7b25aa1a9a93"></a><!-- doxytag: member="vtkPropCollection::IsTypeOf" ref="c69b7d8e1633b675e2de7b25aa1a9a93" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkPropCollection::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> <p>Reimplemented in <a class="el" href="a00094.html#b2b2176f87acf36a4f5daa984d7a8694">vtkActor2DCollection</a>, <a class="el" href="a00095.html#ce3f92469f8c988d3da8332ccec4bce5">vtkActorCollection</a>, <a class="el" href="a01319.html#910e7902a7f76416b0e3013c5b245496">vtkProp3DCollection</a>, and <a class="el" href="a01841.html#57efe039bbbb67b4d9ba209aa3699c0f">vtkVolumeCollection</a>.</p> </div> </div><p> <a class="anchor" name="ccc39ffa111b4ca3a56d68d7be7a84c7"></a><!-- doxytag: member="vtkPropCollection::IsA" ref="ccc39ffa111b4ca3a56d68d7be7a84c7" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkPropCollection::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> <p>Reimplemented in <a class="el" href="a00094.html#0f3f97c73afb6e617f5e12942cd19b83">vtkActor2DCollection</a>, <a class="el" href="a00095.html#08c9b61cf9da219b273713a29d9ac610">vtkActorCollection</a>, <a class="el" href="a01319.html#f069940a78ae11b5e8423fa905a15f6c">vtkProp3DCollection</a>, and <a class="el" href="a01841.html#3cdd23c84b1082e0adf7d57e31988bf6">vtkVolumeCollection</a>.</p> </div> </div><p> <a class="anchor" name="78110b5ddc8cfd1ce0de396d964c4903"></a><!-- doxytag: member="vtkPropCollection::SafeDownCast" ref="78110b5ddc8cfd1ce0de396d964c4903" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01321.html">vtkPropCollection</a>* vtkPropCollection::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> <p>Reimplemented in <a class="el" href="a00094.html#9d97654097c03dd36f926f171d636e45">vtkActor2DCollection</a>, <a class="el" href="a00095.html#cce62ab29c14e3cd0eea08b9150f2ae9">vtkActorCollection</a>, <a class="el" href="a01319.html#bd4cf8c59bb475592ef127306512da96">vtkProp3DCollection</a>, and <a class="el" href="a01841.html#a4037ac818b2b6165491fd05c7be521b">vtkVolumeCollection</a>.</p> </div> </div><p> <a class="anchor" name="6dd962e765ce239e8158eb98ff432721"></a><!-- doxytag: member="vtkPropCollection::AddItem" ref="6dd962e765ce239e8158eb98ff432721" args="(vtkProp *a)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkPropCollection::AddItem </td> <td>(</td> <td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td> <td class="paramname"> <em>a</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add an Prop to the list. <p>Definition at line <a class="el" href="a03910.html#l00080">80</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="fc842bb537949c256b27e953c6f79491"></a><!-- doxytag: member="vtkPropCollection::GetNextProp" ref="fc842bb537949c256b27e953c6f79491" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01317.html">vtkProp</a> * vtkPropCollection::GetNextProp </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the next Prop in the list. <p>Definition at line <a class="el" href="a03910.html#l00085">85</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="ee63a75f343215c1b65d655984baae24"></a><!-- doxytag: member="vtkPropCollection::GetLastProp" ref="ee63a75f343215c1b65d655984baae24" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01317.html">vtkProp</a> * vtkPropCollection::GetLastProp </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the last Prop in the list. <p>Definition at line <a class="el" href="a03910.html#l00090">90</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <a class="anchor" name="aca1a51fd357747f535ed7951aa7f0d2"></a><!-- doxytag: member="vtkPropCollection::GetNumberOfPaths" ref="aca1a51fd357747f535ed7951aa7f0d2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int vtkPropCollection::GetNumberOfPaths </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get the number of paths contained in this list. (Recall that a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> can consist of multiple parts.) Used in picking and other activities to get the parts of composite entities like <a class="el" href="a00141.html" title="create hierarchies of vtkProp3Ds (transformable props)">vtkAssembly</a> or <a class="el" href="a01320.html" title="create hierarchies of props">vtkPropAssembly</a>. </div> </div><p> <a class="anchor" name="66468511215fdb783fcec59725eac136"></a><!-- doxytag: member="vtkPropCollection::GetNextProp" ref="66468511215fdb783fcec59725eac136" args="(vtkCollectionSimpleIterator &cookie)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01317.html">vtkProp</a>* vtkPropCollection::GetNextProp </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="a03910.html#l00061">61</a> of file <a class="el" href="a03910.html">vtkPropCollection.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/Common/<a class="el" href="a03910.html">vtkPropCollection.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:27:39 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>