Sophie

Sophie

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

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: vtkCollapseGraph 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>vtkCollapseGraph Class Reference</h1><!-- doxytag: class="vtkCollapseGraph" --><!-- doxytag: inherits="vtkGraphAlgorithm" --><code>#include &lt;<a class="el" href="a04795.html">vtkCollapseGraph.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkCollapseGraph:</div>
<div class="dynsection">
<p><center><img src="a08647.png" border="0" usemap="#a08648" alt="Inheritance graph"></center>
<map name="a08648">
<area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="6,229,142,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="24,155,123,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="34,80,114,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="19,5,128,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkCollapseGraph:</div>
<div class="dynsection">
<p><center><img src="a08649.png" border="0" usemap="#a08650" alt="Collaboration graph"></center>
<map name="a08650">
<area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="183,499,319,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="281,381,380,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="477,499,576,525"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="407,173,487,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="404,264,553,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="212,264,321,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="164,5,273,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="5,173,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="153,83,284,109"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,417,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,173,373,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a08651.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
"Collapses" vertices onto their neighbors. 
<p>
<a class="el" href="a00283.html" title="&quot;Collapses&quot; vertices onto their neighbors.">vtkCollapseGraph</a> "collapses" vertices onto their neighbors, while maintaining connectivity. Two inputs are required - a graph (directed or undirected), and a vertex selection that can be converted to indices.<p>
Conceptually, each of the vertices specified in the input selection expands, "swallowing" adacent vertices. Edges to-or-from the "swallowed" vertices become edges to-or-from the expanding vertices, maintaining the overall graph connectivity.<p>
In the case of directed graphs, expanding vertices only swallow vertices that are connected via out edges. This rule provides intuitive behavior when working with trees, so that "child" vertices collapse into their parents when the parents are part of the input selection.<p>
Input port 0: graph Input port 1: selection 
<p>Definition at line <a class="el" href="a04795.html#l00047">47</a> of file <a class="el" href="a04795.html">vtkCollapseGraph.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="a00656.html">vtkGraphAlgorithm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#26911d7783cc4e20a67c2cb4e87646b9">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="a00283.html#d513c00798f56f11f7e6f39db40db369">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="a00283.html#ed366bd01d407f81bc96b4db62db3852">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#3e5117a4926c35711af9c1318c24d4e5">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="a00283.html#4bd014f41a6608552666ea9ae1db6c28">SetGraphConnection</a> (<a class="el" href="a00102.html">vtkAlgorithmOutput</a> *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience function provided for setting the graph input.  <a href="#4bd014f41a6608552666ea9ae1db6c28"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#454c154599fd6668cea0adb6a0056863">SetSelectionConnection</a> (<a class="el" href="a00102.html">vtkAlgorithmOutput</a> *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convenience function provided for setting the selection input.  <a href="#454c154599fd6668cea0adb6a0056863"></a><br></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="a00283.html">vtkCollapseGraph</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#35c93c3c2cfd58c495a5d87d2eec65c6">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="a00283.html#11eea3192f5c47dedbe66571f36f6585">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00283.html">vtkCollapseGraph</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#67b10989dc86ae8b12a5077788e13671">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="a00283.html#762c583f3023393ea80d0748df219c0e">vtkCollapseGraph</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#940a9d98c45443202999195f84789aef">~vtkCollapseGraph</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#633280735a2af6ab88a57c1fd05e76df">FillInputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00283.html#4416c9d08a04bbe963271d8ff1e3e762">RequestData</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="26911d7783cc4e20a67c2cb4e87646b9"></a><!-- doxytag: member="vtkCollapseGraph::Superclass" ref="26911d7783cc4e20a67c2cb4e87646b9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00656.html">vtkGraphAlgorithm</a> <a class="el" href="a00656.html">vtkCollapseGraph::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00656.html#65ff0af97f9d847799accd57f8814926">vtkGraphAlgorithm</a>.</p>

<p>Definition at line <a class="el" href="a04795.html#l00051">51</a> of file <a class="el" href="a04795.html">vtkCollapseGraph.h</a>.</p>

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

<p>

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

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="35c93c3c2cfd58c495a5d87d2eec65c6"></a><!-- doxytag: member="vtkCollapseGraph::New" ref="35c93c3c2cfd58c495a5d87d2eec65c6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00283.html">vtkCollapseGraph</a>* vtkCollapseGraph::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 an object with Debug turned off, modified time initialized to zero, and reference counting on. 
<p>Reimplemented from <a class="el" href="a00656.html#1cff1f253656090acf628631b4e0b36e">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="d513c00798f56f11f7e6f39db40db369"></a><!-- doxytag: member="vtkCollapseGraph::GetClassName" ref="d513c00798f56f11f7e6f39db40db369" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkCollapseGraph::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="a00656.html#19fd761c1a7702d463ecd187d224ddef">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="11eea3192f5c47dedbe66571f36f6585"></a><!-- doxytag: member="vtkCollapseGraph::IsTypeOf" ref="11eea3192f5c47dedbe66571f36f6585" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkCollapseGraph::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="a00656.html#82cb3fc0686797578cce635b27df2b2e">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="ed366bd01d407f81bc96b4db62db3852"></a><!-- doxytag: member="vtkCollapseGraph::IsA" ref="ed366bd01d407f81bc96b4db62db3852" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkCollapseGraph::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="a00656.html#d7389dfdd1ab2579c3109c589b6a2a5d">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="67b10989dc86ae8b12a5077788e13671"></a><!-- doxytag: member="vtkCollapseGraph::SafeDownCast" ref="67b10989dc86ae8b12a5077788e13671" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00283.html">vtkCollapseGraph</a>* vtkCollapseGraph::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="a00656.html#f837b1caa1cdbb31f677e59af1a8895c">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="3e5117a4926c35711af9c1318c24d4e5"></a><!-- doxytag: member="vtkCollapseGraph::PrintSelf" ref="3e5117a4926c35711af9c1318c24d4e5" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkCollapseGraph::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="a00656.html#f107f75f6b708a81fe0bf11114824a71">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="4bd014f41a6608552666ea9ae1db6c28"></a><!-- doxytag: member="vtkCollapseGraph::SetGraphConnection" ref="4bd014f41a6608552666ea9ae1db6c28" args="(vtkAlgorithmOutput *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkCollapseGraph::SetGraphConnection           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00102.html">vtkAlgorithmOutput</a> *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience function provided for setting the graph input. 
<p>

</div>
</div><p>
<a class="anchor" name="454c154599fd6668cea0adb6a0056863"></a><!-- doxytag: member="vtkCollapseGraph::SetSelectionConnection" ref="454c154599fd6668cea0adb6a0056863" args="(vtkAlgorithmOutput *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkCollapseGraph::SetSelectionConnection           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00102.html">vtkAlgorithmOutput</a> *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience function provided for setting the selection input. 
<p>

</div>
</div><p>
<a class="anchor" name="633280735a2af6ab88a57c1fd05e76df"></a><!-- doxytag: member="vtkCollapseGraph::FillInputPortInformation" ref="633280735a2af6ab88a57c1fd05e76df" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int vtkCollapseGraph::FillInputPortInformation           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname"> <em>info</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle. 
<p>Reimplemented from <a class="el" href="a00656.html#2119e6b6b3b5be8c1389da0e84b2c235">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="4416c9d08a04bbe963271d8ff1e3e762"></a><!-- doxytag: member="vtkCollapseGraph::RequestData" ref="4416c9d08a04bbe963271d8ff1e3e762" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int vtkCollapseGraph::RequestData           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname"> <em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> **&nbsp;</td>
          <td class="paramname"> <em>inputVector</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> *&nbsp;</td>
          <td class="paramname"> <em>outputVector</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This is called by the superclass. This is the method you should override. 
<p>Reimplemented from <a class="el" href="a00656.html#adc44af7541c6076e3953a94e9477abf">vtkGraphAlgorithm</a>.</p>

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