<!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: vtkMaskPolyData 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>vtkMaskPolyData Class Reference</h1><!-- doxytag: class="vtkMaskPolyData" --><!-- doxytag: inherits="vtkPolyDataAlgorithm" --><code>#include <<a class="el" href="a04384.html">vtkMaskPolyData.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkMaskPolyData:</div> <div class="dynsection"> <p><center><img src="a11956.png" border="0" usemap="#a11957" alt="Inheritance graph"></center> <map name="a11957"> <area shape="rect" href="a01261.html" title="Superclass for algorithms that produce only polydata as output." alt="" coords="5,229,160,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="33,155,132,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="43,80,123,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="28,5,137,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkMaskPolyData:</div> <div class="dynsection"> <p><center><img src="a11958.png" border="0" usemap="#a11959" alt="Collaboration graph"></center> <map name="a11959"> <area shape="rect" href="a01261.html" title="Superclass for algorithms that produce only polydata as output." alt="" coords="173,499,328,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="a11960.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> sample subset of input polygonal data cells <p> <a class="el" href="a00993.html" title="sample subset of input polygonal data cells">vtkMaskPolyData</a> is a filter that sub-samples the cells of input polygonal data. The user specifies every nth item, with an initial offset to begin sampling.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00992.html" title="selectively filter points">vtkMaskPoints</a></dd></dl> <dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_10.html#c2_vtk_t_vtkMaskPolyData">vtkMaskPolyData (Tests)</a> </dd></dl> <p>Definition at line <a class="el" href="a04384.html#l00034">34</a> of file <a class="el" href="a04384.html">vtkMaskPolyData.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="a01261.html">vtkPolyDataAlgorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#8cb509e23a7979c494d8f32b9c892dcc">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="a00993.html#d5e6410ebbe96e2ea0474a8571d194b7">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="a00993.html#a098b0f3350c942dfd59d351c26c1e47">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="a00993.html#59217dbec0d56d856c94a353aa904f81">PrintSelf</a> (ostream &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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#add6b204272f3e3558db4c1aefaeae70">SetOnRatio</a> (int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#6e71388cc2284c5b627035777fe7d2fa">GetOnRatio</a> ()</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#ad3e4b9098b220f74637ead8954357a6">SetOffset</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#58e268ef83eb8e60ced76f5952373681">GetOffset</a> ()</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="a00993.html">vtkMaskPolyData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#2ddb4d7c5537b13aca11839a47b65628">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="a00993.html#0d4c637cb2f690bef38ff3711a8a432e">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00993.html">vtkMaskPolyData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#9eb5e7dca7d8113ad9a5c3e92b209722">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="a00993.html#663a5a98e31305d3a4cd734c8ac088df">vtkMaskPolyData</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#2535431d88c6df62c751e8446450addf">~vtkMaskPolyData</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#d245df9b9e4f47fe5c25db65601ac92e">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> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#766f23b2a311b5ab898b9cb9873e2b4d">OnRatio</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00993.html#0f98e23e97f91447000ff27ecd5cdde0">Offset</a></td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="8cb509e23a7979c494d8f32b9c892dcc"></a><!-- doxytag: member="vtkMaskPolyData::Superclass" ref="8cb509e23a7979c494d8f32b9c892dcc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a01261.html">vtkPolyDataAlgorithm</a> <a class="el" href="a01261.html">vtkMaskPolyData::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a01261.html#0ef1960e1f3d6980b058ab47b5475b91">vtkPolyDataAlgorithm</a>.</p> <p>Definition at line <a class="el" href="a04384.html#l00038">38</a> of file <a class="el" href="a04384.html">vtkMaskPolyData.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="663a5a98e31305d3a4cd734c8ac088df"></a><!-- doxytag: member="vtkMaskPolyData::vtkMaskPolyData" ref="663a5a98e31305d3a4cd734c8ac088df" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkMaskPolyData::vtkMaskPolyData </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="2535431d88c6df62c751e8446450addf"></a><!-- doxytag: member="vtkMaskPolyData::~vtkMaskPolyData" ref="2535431d88c6df62c751e8446450addf" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkMaskPolyData::~vtkMaskPolyData </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="a04384.html#l00055">55</a> of file <a class="el" href="a04384.html">vtkMaskPolyData.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="2ddb4d7c5537b13aca11839a47b65628"></a><!-- doxytag: member="vtkMaskPolyData::New" ref="2ddb4d7c5537b13aca11839a47b65628" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00993.html">vtkMaskPolyData</a>* vtkMaskPolyData::New </td> <td>(</td> <td class="paramname"> </td> <td> ) </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="a01261.html#cf785ac526132296ff652c636f713b5e">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="d5e6410ebbe96e2ea0474a8571d194b7"></a><!-- doxytag: member="vtkMaskPolyData::GetClassName" ref="d5e6410ebbe96e2ea0474a8571d194b7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkMaskPolyData::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="a01261.html#117691a3be177e85a0eb7e54b011c9de">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="0d4c637cb2f690bef38ff3711a8a432e"></a><!-- doxytag: member="vtkMaskPolyData::IsTypeOf" ref="0d4c637cb2f690bef38ff3711a8a432e" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkMaskPolyData::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="a01261.html#6e4df93069945e2df17a891c6f4cd557">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="a098b0f3350c942dfd59d351c26c1e47"></a><!-- doxytag: member="vtkMaskPolyData::IsA" ref="a098b0f3350c942dfd59d351c26c1e47" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkMaskPolyData::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="a01261.html#b0133191c934f596dac2a21fd5a8da20">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="9eb5e7dca7d8113ad9a5c3e92b209722"></a><!-- doxytag: member="vtkMaskPolyData::SafeDownCast" ref="9eb5e7dca7d8113ad9a5c3e92b209722" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00993.html">vtkMaskPolyData</a>* vtkMaskPolyData::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="a01261.html#3a09aba4f394c174457d17e9bc08af04">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="59217dbec0d56d856c94a353aa904f81"></a><!-- doxytag: member="vtkMaskPolyData::PrintSelf" ref="59217dbec0d56d856c94a353aa904f81" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkMaskPolyData::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="a01261.html#e6d59a63261b0c56f8f473984ae0e1b6">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <a class="anchor" name="add6b204272f3e3558db4c1aefaeae70"></a><!-- doxytag: member="vtkMaskPolyData::SetOnRatio" ref="add6b204272f3e3558db4c1aefaeae70" args="(int)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMaskPolyData::SetOnRatio </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Turn on every nth entity (cell). </div> </div><p> <a class="anchor" name="6e71388cc2284c5b627035777fe7d2fa"></a><!-- doxytag: member="vtkMaskPolyData::GetOnRatio" ref="6e71388cc2284c5b627035777fe7d2fa" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkMaskPolyData::GetOnRatio </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Turn on every nth entity (cell). </div> </div><p> <a class="anchor" name="ad3e4b9098b220f74637ead8954357a6"></a><!-- doxytag: member="vtkMaskPolyData::SetOffset" ref="ad3e4b9098b220f74637ead8954357a6" args="(vtkIdType)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void vtkMaskPolyData::SetOffset </td> <td>(</td> <td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Start with this entity (cell). </div> </div><p> <a class="anchor" name="58e268ef83eb8e60ced76f5952373681"></a><!-- doxytag: member="vtkMaskPolyData::GetOffset" ref="58e268ef83eb8e60ced76f5952373681" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> vtkMaskPolyData::GetOffset </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Start with this entity (cell). </div> </div><p> <a class="anchor" name="d245df9b9e4f47fe5c25db65601ac92e"></a><!-- doxytag: member="vtkMaskPolyData::RequestData" ref="d245df9b9e4f47fe5c25db65601ac92e" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int vtkMaskPolyData::RequestData </td> <td>(</td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </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> ** </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> * </td> <td class="paramname"> <em>outputVector</em></td><td> </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="a01261.html#6b5a43ab1f9bbcb368c7dc83e4afe068">vtkPolyDataAlgorithm</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="766f23b2a311b5ab898b9cb9873e2b4d"></a><!-- doxytag: member="vtkMaskPolyData::OnRatio" ref="766f23b2a311b5ab898b9cb9873e2b4d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="a00993.html#766f23b2a311b5ab898b9cb9873e2b4d">vtkMaskPolyData::OnRatio</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="a04384.html#l00058">58</a> of file <a class="el" href="a04384.html">vtkMaskPolyData.h</a>.</p> </div> </div><p> <a class="anchor" name="0f98e23e97f91447000ff27ecd5cdde0"></a><!-- doxytag: member="vtkMaskPolyData::Offset" ref="0f98e23e97f91447000ff27ecd5cdde0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> <a class="el" href="a00993.html#0f98e23e97f91447000ff27ecd5cdde0">vtkMaskPolyData::Offset</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="a04384.html#l00059">59</a> of file <a class="el" href="a04384.html">vtkMaskPolyData.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/Graphics/<a class="el" href="a04384.html">vtkMaskPolyData.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:16:41 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>