<!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: vtkArrayCoordinates 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>vtkArrayCoordinates Class Reference</h1><!-- doxytag: class="vtkArrayCoordinates" --><code>#include <<a class="el" href="a03771.html">vtkArrayCoordinates.h</a>></code>
<p>
<p>
<a href="a07965.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Stores coordinate into an N-way array.
<p>
<a class="el" href="a00127.html" title="Stores coordinate into an N-way array.">vtkArrayCoordinates</a> stores a collection of coordinates that can be used to access values in a <a class="el" href="a00124.html" title="Abstract interface for N-dimensional arrays.">vtkArray</a> containing an arbitrary number of dimensions.<p>
Convenience constructors are provided for working with one, two, and three dimensions. For higher dimensions, use the default constructor, <a class="el" href="a00127.html#38117261fb6ac782fb32b10299e6918a">SetDimensions()</a> and operator[] to assign a coordinate value along each dimension.<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></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>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_1.html#c2_vtk_t_vtkArrayCoordinates">vtkArrayCoordinates (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a03771.html#l00050">50</a> of file <a class="el" href="a03771.html">vtkArrayCoordinates.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#5ead2b950f9a989ae4f16d874f2536e6">operator!=</a> (const <a class="el" href="a00127.html">vtkArrayCoordinates</a> &rhs) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">VTK_COMMON_EXPORT friend ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#55fa2e6d6fafd7569b5072c202f2184d">operator<<</a> (ostream &stream, const <a class="el" href="a00127.html">vtkArrayCoordinates</a> &rhs)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#5a10cfe54c92b8c8d04f9b60b1a2e5eb">vtkArrayCoordinates</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#59ef1708d7a082943b81c3492e9ec624">vtkArrayCoordinates</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#b17550312f21f9f7873579254756e85a">vtkArrayCoordinates</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i, <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> j)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#764ed6e4cbc96b5d813101850e839cd0">vtkArrayCoordinates</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i, <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> j, <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> k)</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="a00127.html#962a72969516f559fb1ef08d8ed98e08">GetDimensions</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#38117261fb6ac782fb32b10299e6918a">SetDimensions</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> dimensions)</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="a00127.html#2b7c13e268fae57ebea7755b03d5da2f">operator[]</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#1312a407aebdd0c44f4a77e857ce4634">operator[]</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> i) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#e7556d46b33f79493aca4dcc323a8e2c">operator==</a> (const <a class="el" href="a00127.html">vtkArrayCoordinates</a> &rhs) const </td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5a10cfe54c92b8c8d04f9b60b1a2e5eb"></a><!-- doxytag: member="vtkArrayCoordinates::vtkArrayCoordinates" ref="5a10cfe54c92b8c8d04f9b60b1a2e5eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArrayCoordinates::vtkArrayCoordinates </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an empty set of coordinates. Use <a class="el" href="a00127.html#38117261fb6ac782fb32b10299e6918a">SetDimensions()</a> and operator[] to populate the coordinates.
</div>
</div><p>
<a class="anchor" name="59ef1708d7a082943b81c3492e9ec624"></a><!-- doxytag: member="vtkArrayCoordinates::vtkArrayCoordinates" ref="59ef1708d7a082943b81c3492e9ec624" args="(vtkIdType i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArrayCoordinates::vtkArrayCoordinates </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create coordinates for a one-dimensional array.
</div>
</div><p>
<a class="anchor" name="b17550312f21f9f7873579254756e85a"></a><!-- doxytag: member="vtkArrayCoordinates::vtkArrayCoordinates" ref="b17550312f21f9f7873579254756e85a" args="(vtkIdType i, vtkIdType j)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArrayCoordinates::vtkArrayCoordinates </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>j</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create coordinates for a two-dimensional array.
</div>
</div><p>
<a class="anchor" name="764ed6e4cbc96b5d813101850e839cd0"></a><!-- doxytag: member="vtkArrayCoordinates::vtkArrayCoordinates" ref="764ed6e4cbc96b5d813101850e839cd0" args="(vtkIdType i, vtkIdType j, vtkIdType k)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkArrayCoordinates::vtkArrayCoordinates </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>j</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>k</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create coordinates for a three-dimensional array.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="962a72969516f559fb1ef08d8ed98e08"></a><!-- doxytag: member="vtkArrayCoordinates::GetDimensions" ref="962a72969516f559fb1ef08d8ed98e08" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> vtkArrayCoordinates::GetDimensions </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of dimensions contained in the coordinates.
</div>
</div><p>
<a class="anchor" name="38117261fb6ac782fb32b10299e6918a"></a><!-- doxytag: member="vtkArrayCoordinates::SetDimensions" ref="38117261fb6ac782fb32b10299e6918a" args="(vtkIdType dimensions)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkArrayCoordinates::SetDimensions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>dimensions</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the number of dimensions. Note that this method resets the coordinate along each dimension to zero, so you must set every coordinate explicitly using operator[] after calling <a class="el" href="a00127.html#38117261fb6ac782fb32b10299e6918a">SetDimensions()</a>.
</div>
</div><p>
<a class="anchor" name="2b7c13e268fae57ebea7755b03d5da2f"></a><!-- doxytag: member="vtkArrayCoordinates::operator[]" ref="2b7c13e268fae57ebea7755b03d5da2f" args="(vtkIdType i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>& vtkArrayCoordinates::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the index of the i-th dimension.
</div>
</div><p>
<a class="anchor" name="1312a407aebdd0c44f4a77e857ce4634"></a><!-- doxytag: member="vtkArrayCoordinates::operator[]" ref="1312a407aebdd0c44f4a77e857ce4634" args="(vtkIdType i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>& vtkArrayCoordinates::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the index of the i-th dimension.
</div>
</div><p>
<a class="anchor" name="e7556d46b33f79493aca4dcc323a8e2c"></a><!-- doxytag: member="vtkArrayCoordinates::operator==" ref="e7556d46b33f79493aca4dcc323a8e2c" args="(const vtkArrayCoordinates &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkArrayCoordinates::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00127.html">vtkArrayCoordinates</a> & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Equality comparison
</div>
</div><p>
<a class="anchor" name="5ead2b950f9a989ae4f16d874f2536e6"></a><!-- doxytag: member="vtkArrayCoordinates::operator!=" ref="5ead2b950f9a989ae4f16d874f2536e6" args="(const vtkArrayCoordinates &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool vtkArrayCoordinates::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00127.html">vtkArrayCoordinates</a> & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Inequality comparison
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="55fa2e6d6fafd7569b5072c202f2184d"></a><!-- doxytag: member="vtkArrayCoordinates::operator<<" ref="55fa2e6d6fafd7569b5072c202f2184d" args="(ostream &stream, const vtkArrayCoordinates &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VTK_COMMON_EXPORT friend ostream& operator<< </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00127.html">vtkArrayCoordinates</a> & </td>
<td class="paramname"> <em>rhs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Inequality comparison
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03771.html">vtkArrayCoordinates.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
130
