<!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: vtkArrayCoordinateIterator 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>vtkArrayCoordinateIterator Class Reference</h1><!-- doxytag: class="vtkArrayCoordinateIterator" --><!-- doxytag: inherits="vtkObject" --><code>#include <<a class="el" href="a03770.html">vtkArrayCoordinateIterator.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkArrayCoordinateIterator:</div> <div class="dynsection"> <p><center><img src="a07960.png" border="0" usemap="#a07961" alt="Inheritance graph"></center> <map name="a07961"> <area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="58,80,138,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="43,6,152,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkArrayCoordinateIterator:</div> <div class="dynsection"> <p><center><img src="a07962.png" border="0" usemap="#a07963" alt="Collaboration graph"></center> <map name="a07963"> <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"><area shape="rect" href="a00127.html" title="Stores coordinate into an N-way array." alt="" coords="191,96,337,123"><area shape="rect" href="a00130.html" title="Stores the number of dimensions and size of an N-way array." alt="" coords="361,96,479,123"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="a07964.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Iterates over array coordinates. <p> <a class="el" href="a00126.html" title="Iterates over array coordinates.">vtkArrayCoordinateIterator</a> iterates over every unique set of coordinates that are defined by a set of <a class="el" href="a00130.html" title="Stores the number of dimensions and size of an N-way array.">vtkArrayExtents</a>. The order in which coordinates are visited is undefined.<p> Note that <a class="el" href="a00126.html" title="Iterates over array coordinates.">vtkArrayCoordinateIterator</a> visits every permutation of coordinates defined by a set of array extents, *not* the array itself - if you are working with a sparse array, any of the coordinates that are visited by the iterator could be NULL within the array.<p> <a class="el" href="a00126.html" title="Iterates over array coordinates.">vtkArrayCoordinateIterator</a> is mainly useful if you are writing a source that generates arbitrary-dimension arrays from scratch. Algorithms that process existing arrays can almost always be written more efficiently using <a class="el" href="a00124.html#04e0788bdf155863c9e2c3e7bef8277b">vtkArray::GetCoordinatesN()</a> and <a class="el" href="a01771.html#6aa80097eff83159898849ea08a0aaa6">vtkTypedArray::GetValueN()</a>, which only visit non-NULL values within an array.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00124.html" title="Abstract interface for N-dimensional arrays.">vtkArray</a>, <a class="el" href="a00130.html" title="Stores the number of dimensions and size of an N-way array.">vtkArrayExtents</a>, <a class="el" href="a00127.html" title="Stores coordinate into an N-way array.">vtkArrayCoordinates</a></dd></dl> <dl class="user" compact><dt><b>Thanks:</b></dt><dd>Developed by Timothy M. Shead (<a href="mailto:tshead@sandia.gov">tshead@sandia.gov</a>) at Sandia National Laboratories. </dd></dl> <p>Definition at line <a class="el" href="a03770.html#l00055">55</a> of file <a class="el" href="a03770.html">vtkArrayCoordinateIterator.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="a01084.html">vtkObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#d653513d013aa9f004109ab981844250">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="a00126.html#abc0183daf44fb2b5e6b73aab16e383a">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="a00126.html#1ca7fc64a0baf4791c8a286be62a6e87">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="a00126.html#0ea4936a0c85459c49bab29c75492230">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#23452a864058c77e4d215fe95dd3c60f">SetExtents</a> (const <a class="el" href="a00130.html">vtkArrayExtents</a> &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#eccd40665f9b1b6ef977547fe4673dc5">HasNext</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00127.html">vtkArrayCoordinates</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#117752d13c4b2a8592f4264417ee6161">Next</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="a00126.html">vtkArrayCoordinateIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#cdd7f5b0feaf9eca34ce1b3c229ace63">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="a00126.html#4b0aa20b3778ac033669a9fc68dc9184">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00126.html">vtkArrayCoordinateIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#bd8c7a98f1a8e3650bb0892c98310205">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="a00126.html#3fb05197547e2c98142e4123358b2da0">vtkArrayCoordinateIterator</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00126.html#208e8600ce0468ba9247a8e755ee1426">~vtkArrayCoordinateIterator</a> ()</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="d653513d013aa9f004109ab981844250"></a><!-- doxytag: member="vtkArrayCoordinateIterator::Superclass" ref="d653513d013aa9f004109ab981844250" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a01084.html">vtkObject</a> <a class="el" href="a01084.html">vtkArrayCoordinateIterator::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p> <p>Definition at line <a class="el" href="a03770.html#l00059">59</a> of file <a class="el" href="a03770.html">vtkArrayCoordinateIterator.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="3fb05197547e2c98142e4123358b2da0"></a><!-- doxytag: member="vtkArrayCoordinateIterator::vtkArrayCoordinateIterator" ref="3fb05197547e2c98142e4123358b2da0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkArrayCoordinateIterator::vtkArrayCoordinateIterator </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="208e8600ce0468ba9247a8e755ee1426"></a><!-- doxytag: member="vtkArrayCoordinateIterator::~vtkArrayCoordinateIterator" ref="208e8600ce0468ba9247a8e755ee1426" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkArrayCoordinateIterator::~vtkArrayCoordinateIterator </td> <td>(</td> <td class="paramname"> </td> <td> ) </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="cdd7f5b0feaf9eca34ce1b3c229ace63"></a><!-- doxytag: member="vtkArrayCoordinateIterator::New" ref="cdd7f5b0feaf9eca34ce1b3c229ace63" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00126.html">vtkArrayCoordinateIterator</a>* vtkArrayCoordinateIterator::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="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="abc0183daf44fb2b5e6b73aab16e383a"></a><!-- doxytag: member="vtkArrayCoordinateIterator::GetClassName" ref="abc0183daf44fb2b5e6b73aab16e383a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkArrayCoordinateIterator::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="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="4b0aa20b3778ac033669a9fc68dc9184"></a><!-- doxytag: member="vtkArrayCoordinateIterator::IsTypeOf" ref="4b0aa20b3778ac033669a9fc68dc9184" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkArrayCoordinateIterator::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="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="1ca7fc64a0baf4791c8a286be62a6e87"></a><!-- doxytag: member="vtkArrayCoordinateIterator::IsA" ref="1ca7fc64a0baf4791c8a286be62a6e87" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkArrayCoordinateIterator::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="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="bd8c7a98f1a8e3650bb0892c98310205"></a><!-- doxytag: member="vtkArrayCoordinateIterator::SafeDownCast" ref="bd8c7a98f1a8e3650bb0892c98310205" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00126.html">vtkArrayCoordinateIterator</a>* vtkArrayCoordinateIterator::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="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="0ea4936a0c85459c49bab29c75492230"></a><!-- doxytag: member="vtkArrayCoordinateIterator::PrintSelf" ref="0ea4936a0c85459c49bab29c75492230" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkArrayCoordinateIterator::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="a01084.html#bf3dbb4154289b56a12483eee3866263">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="23452a864058c77e4d215fe95dd3c60f"></a><!-- doxytag: member="vtkArrayCoordinateIterator::SetExtents" ref="23452a864058c77e4d215fe95dd3c60f" args="(const vtkArrayExtents &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkArrayCoordinateIterator::SetExtents </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00130.html">vtkArrayExtents</a> & </td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Sets the array extents to iterate over, and resets the iterator to the beginning of the range of unique coordinates. </div> </div><p> <a class="anchor" name="eccd40665f9b1b6ef977547fe4673dc5"></a><!-- doxytag: member="vtkArrayCoordinateIterator::HasNext" ref="eccd40665f9b1b6ef977547fe4673dc5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool vtkArrayCoordinateIterator::HasNext </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Returns true iff the iterator has not reached the end of the range of unique coordinates. </div> </div><p> <a class="anchor" name="117752d13c4b2a8592f4264417ee6161"></a><!-- doxytag: member="vtkArrayCoordinateIterator::Next" ref="117752d13c4b2a8592f4264417ee6161" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00127.html">vtkArrayCoordinates</a> vtkArrayCoordinateIterator::Next </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the next set of coordinates and advances the iterator. </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/Common/<a class="el" href="a03770.html">vtkArrayCoordinateIterator.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:53: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>