Sophie

Sophie

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

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: vtkTreeMapLayoutStrategy 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>vtkTreeMapLayoutStrategy Class Reference</h1><!-- doxytag: class="vtkTreeMapLayoutStrategy" --><!-- doxytag: inherits="vtkAreaLayoutStrategy" --><code>#include &lt;<a class="el" href="a04872.html">vtkTreeMapLayoutStrategy.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkTreeMapLayoutStrategy:</div>
<div class="dynsection">
<p><center><img src="a15391.png" border="0" usemap="#a15392" alt="Inheritance graph"></center>
<map name="a15392">
<area shape="rect" href="a00197.html" title="a tree map layout that puts vertices in square&#45;ish boxes" alt="" coords="5,304,160,331"><area shape="rect" href="a01556.html" title="a horizontal and vertical slicing tree map layout" alt="" coords="184,304,397,331"><area shape="rect" href="a01601.html" title="uses the squarify tree map layout algorithm" alt="" coords="421,304,603,331"><area shape="rect" href="a00122.html" title="abstract superclass for all area layout strategies" alt="" coords="211,155,371,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="251,80,331,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="236,5,345,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkTreeMapLayoutStrategy:</div>
<div class="dynsection">
<p><center><img src="a15393.png" border="0" usemap="#a15394" alt="Collaboration graph"></center>
<map name="a15394">
<area shape="rect" href="a00122.html" title="abstract superclass for all area layout strategies" alt="" coords="47,174,207,200"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><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="a15395.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
abstract superclass for all tree map layout strategies 
<p>
All subclasses of this class perform a tree map layout on a tree. This involves assigning a rectangular region to each vertex in the tree, and placing that information in a data array with four components per tuple representing (Xmin, Xmax, Ymin, Ymax).<p>
Instances of subclasses of this class may be assigned as the layout strategy to <a class="el" href="a01750.html" title="layout a vtkTree into a tree map">vtkTreeMapLayout</a><p>
<dl class="user" compact><dt><b>Thanks:</b></dt><dd>Thanks to Brian Wylie and Ken Moreland from Sandia National Laboratories for help developing this class.</dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_16.html#c2_vtk_t_vtkTreeMapLayoutStrategy">vtkTreeMapLayoutStrategy (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04872.html#l00049">49</a> of file <a class="el" href="a04872.html">vtkTreeMapLayoutStrategy.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="a00122.html">vtkAreaLayoutStrategy</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01751.html#9e5c67a913241fcadbc82daa7ebc9625">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="a01751.html#0f37487aba4b29442cf54e7b33cdbf3e">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="a01751.html#8608e3063f5afd56418a61490e385245">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="a01751.html#96a47d61d3a9935a80c8ba65002da996">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01751.html#5f6bb1d20d2cbc47fbac624b7536ad78">FindVertex</a> (<a class="el" href="a01741.html">vtkTree</a> *tree, <a class="el" href="a00356.html">vtkDataArray</a> *areaArray, float pnt[2])</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 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01751.html#978b4faa51d6043c33d65f9a4459d22f">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01751.html">vtkTreeMapLayoutStrategy</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01751.html#3ab02fbb14dd014811333e9e1b8e7293">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="a01751.html#1359107b7c96eb0d0943b3bd985a1f3d">vtkTreeMapLayoutStrategy</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01751.html#33db242ba83ee19980e53d60427c4d6d">~vtkTreeMapLayoutStrategy</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01751.html#5155c4a7971ce8dc984a7dfe0eb3f401">AddBorder</a> (float *boxInfo)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="9e5c67a913241fcadbc82daa7ebc9625"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::Superclass" ref="9e5c67a913241fcadbc82daa7ebc9625" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00122.html">vtkAreaLayoutStrategy</a> <a class="el" href="a00122.html">vtkTreeMapLayoutStrategy::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00122.html#0c86a89c5a2a57122750df4d7b2c8eb2">vtkAreaLayoutStrategy</a>.</p>

<p>Reimplemented in <a class="el" href="a00197.html#3aac341aa7bbfb161f05078560706772">vtkBoxLayoutStrategy</a>, <a class="el" href="a01556.html#5d72d16ea59a3ab5fb86ae2193507bfd">vtkSliceAndDiceLayoutStrategy</a>, and <a class="el" href="a01601.html#a14f5d27e96bb111600936c383117d7f">vtkSquarifyLayoutStrategy</a>.</p>

<p>Definition at line <a class="el" href="a04872.html#l00052">52</a> of file <a class="el" href="a04872.html">vtkTreeMapLayoutStrategy.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="1359107b7c96eb0d0943b3bd985a1f3d"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::vtkTreeMapLayoutStrategy" ref="1359107b7c96eb0d0943b3bd985a1f3d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkTreeMapLayoutStrategy::vtkTreeMapLayoutStrategy           </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="33db242ba83ee19980e53d60427c4d6d"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::~vtkTreeMapLayoutStrategy" ref="33db242ba83ee19980e53d60427c4d6d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkTreeMapLayoutStrategy::~vtkTreeMapLayoutStrategy           </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="0f37487aba4b29442cf54e7b33cdbf3e"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::GetClassName" ref="0f37487aba4b29442cf54e7b33cdbf3e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkTreeMapLayoutStrategy::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="a00122.html#0d85b8b473b3883369b101da39032faf">vtkAreaLayoutStrategy</a>.</p>

<p>Reimplemented in <a class="el" href="a00197.html#e50807ac0bbfe52cda43a94b4deda9da">vtkBoxLayoutStrategy</a>, <a class="el" href="a01556.html#e1cb119318c2e0faad6c2d23b90400a2">vtkSliceAndDiceLayoutStrategy</a>, and <a class="el" href="a01601.html#6394f316d984548c9c9760e4204d4a07">vtkSquarifyLayoutStrategy</a>.</p>

</div>
</div><p>
<a class="anchor" name="978b4faa51d6043c33d65f9a4459d22f"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::IsTypeOf" ref="978b4faa51d6043c33d65f9a4459d22f" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkTreeMapLayoutStrategy::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="a00122.html#6b58cc9a26eefa19713e01000a84b1be">vtkAreaLayoutStrategy</a>.</p>

<p>Reimplemented in <a class="el" href="a00197.html#7a24065eaaef043cb317a2c73f33a49e">vtkBoxLayoutStrategy</a>, <a class="el" href="a01556.html#91e2fb56ae6368f761725aabfa54ac7d">vtkSliceAndDiceLayoutStrategy</a>, and <a class="el" href="a01601.html#86b6878e4b59a94cb0131cbd4cc00f96">vtkSquarifyLayoutStrategy</a>.</p>

</div>
</div><p>
<a class="anchor" name="8608e3063f5afd56418a61490e385245"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::IsA" ref="8608e3063f5afd56418a61490e385245" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkTreeMapLayoutStrategy::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="a00122.html#e847c72ddf78c4fb00b130b3c080c1d7">vtkAreaLayoutStrategy</a>.</p>

<p>Reimplemented in <a class="el" href="a00197.html#a307cb6fb6b3723a063b140e79e47357">vtkBoxLayoutStrategy</a>, <a class="el" href="a01556.html#aa5a1689ed542857974cee69f04ce25f">vtkSliceAndDiceLayoutStrategy</a>, and <a class="el" href="a01601.html#603cc7875f32fae71c5951377f95c684">vtkSquarifyLayoutStrategy</a>.</p>

</div>
</div><p>
<a class="anchor" name="3ab02fbb14dd014811333e9e1b8e7293"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::SafeDownCast" ref="3ab02fbb14dd014811333e9e1b8e7293" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01751.html">vtkTreeMapLayoutStrategy</a>* vtkTreeMapLayoutStrategy::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="a00122.html#79dc09031b2d18287e77808a3928ed85">vtkAreaLayoutStrategy</a>.</p>

<p>Reimplemented in <a class="el" href="a00197.html#396a3877dcf51120c03a30038818ab46">vtkBoxLayoutStrategy</a>, <a class="el" href="a01556.html#fc963898428bdec649224065027745c2">vtkSliceAndDiceLayoutStrategy</a>, and <a class="el" href="a01601.html#a2af67daeb057c4c039e476a5156c628">vtkSquarifyLayoutStrategy</a>.</p>

</div>
</div><p>
<a class="anchor" name="96a47d61d3a9935a80c8ba65002da996"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::PrintSelf" ref="96a47d61d3a9935a80c8ba65002da996" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkTreeMapLayoutStrategy::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="a00122.html#4b8339c361146ce4b8e691c1b968d0c8">vtkAreaLayoutStrategy</a>.</p>

<p>Reimplemented in <a class="el" href="a00197.html#f669fd35b461f7bb4ac556d8dac9e526">vtkBoxLayoutStrategy</a>, <a class="el" href="a01556.html#4a2df7c02451fa63eee33d8a386e2933">vtkSliceAndDiceLayoutStrategy</a>, and <a class="el" href="a01601.html#0d324a30274ff1335eed80cfcde79e3b">vtkSquarifyLayoutStrategy</a>.</p>

</div>
</div><p>
<a class="anchor" name="5f6bb1d20d2cbc47fbac624b7536ad78"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::FindVertex" ref="5f6bb1d20d2cbc47fbac624b7536ad78" args="(vtkTree *tree, vtkDataArray *areaArray, float pnt[2])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> vtkTreeMapLayoutStrategy::FindVertex           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01741.html">vtkTree</a> *&nbsp;</td>
          <td class="paramname"> <em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00356.html">vtkDataArray</a> *&nbsp;</td>
          <td class="paramname"> <em>areaArray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>pnt</em>[2]</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>
Find the vertex at a certain location, or -1 if none found. 
<p>Implements <a class="el" href="a00122.html#4d3e3938c688b74055acf61622c09b74">vtkAreaLayoutStrategy</a>.</p>

</div>
</div><p>
<a class="anchor" name="5155c4a7971ce8dc984a7dfe0eb3f401"></a><!-- doxytag: member="vtkTreeMapLayoutStrategy::AddBorder" ref="5155c4a7971ce8dc984a7dfe0eb3f401" args="(float *boxInfo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkTreeMapLayoutStrategy::AddBorder           </td>
          <td>(</td>
          <td class="paramtype">float *&nbsp;</td>
          <td class="paramname"> <em>boxInfo</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

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