1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkHyperOctreeCursor</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkfiltering_vtkhyperoctreecursor.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkHyperOctreeCursor </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkfiltering.html">Visualization Toolkit Filtering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>Objects that can traverse hyperoctree nodes. It is an abstract class. Cursors are created by the hyperoctree.</p>
<p>To create an instance of class vtkHyperOctreeCursor, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkHyperOctreeCursor
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkHyperOctreeCursor has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkHyperOctreeCursor class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkHyperOctreeCursor = obj.NewInstance ()</code> </li>
<li>
<code>vtkHyperOctreeCursor = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.GetLeafId ()</code> - Return the index of the current leaf in the data arrays. <dl class="section pre"><dt>Precondition:</dt><dd>is_leaf: CurrentIsLeaf() </dd></dl>
</li>
<li>
<code>int = obj.CurrentIsLeaf ()</code> - Is the node pointed by the cursor a leaf? </li>
<li>
<code>int = obj.CurrentIsRoot ()</code> - Is the node pointed by the cursor the root? </li>
<li>
<code>int = obj.GetCurrentLevel ()</code> - Return the level of the node pointed by the cursor. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>=0 </dd></dl>
</li>
<li>
<code>int = obj.GetChildIndex ()</code> - Return the child number of the current node relative to its parent. <dl class="section pre"><dt>Precondition:</dt><dd>not_root: !CurrentIsRoot(). </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>valid_range: result>=0 && result<GetNumberOfChildren() </dd></dl>
</li>
<li>
<code>int = obj.CurrentIsTerminalNode ()</code> </li>
<li>
<code>obj.ToRoot ()</code> - Move the cursor the root node. <dl class="section pre"><dt>Precondition:</dt><dd>can be root </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_root: CurrentIsRoot() </dd></dl>
</li>
<li>
<code>obj.ToParent ()</code> - Move the cursor to the parent of the current node. <dl class="section pre"><dt>Precondition:</dt><dd>not_root: !CurrentIsRoot() </dd></dl>
</li>
<li>
<code>obj.ToChild (int child)</code> - Move the cursor to child `child' of the current node. <dl class="section pre"><dt>Precondition:</dt><dd>not_leaf: !CurrentIsLeaf() </dd>
<dd>
valid_child: child>=0 && child<this->GetNumberOfChildren() </dd></dl>
</li>
<li>
<code>obj.ToSameNode (vtkHyperOctreeCursor other)</code> - Move the cursor to the same node pointed by `other'. <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd>
<dd>
same_hyperoctree: this->SameTree(other); </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>equal: this->IsEqual(other) </dd></dl>
</li>
<li>
<code>int = obj.IsEqual (vtkHyperOctreeCursor other)</code> - Is `this' equal to `other'? <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd>
<dd>
same_hyperoctree: this->SameTree(other); </dd></dl>
</li>
<li>
<code>vtkHyperOctreeCursor = obj.Clone ()</code> - Create a copy of `this'. <dl class="section post"><dt>Postcondition:</dt><dd>results_exists:result!=0 </dd>
<dd>
same_tree: result->SameTree(this) </dd></dl>
</li>
<li>
<code>int = obj.SameTree (vtkHyperOctreeCursor other)</code> - Are `this' and `other' pointing on the same hyperoctree? <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd></dl>
</li>
<li>
<code>int = obj.GetIndex (int d)</code> - Return the index in dimension `d', as if the node was a cell of a uniform grid of 1<<GetCurrentLevel() cells in each dimension. <dl class="section pre"><dt>Precondition:</dt><dd>valid_range: d>=0 && d<GetDimension() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>valid_result: result>=0 && result<(1<<GetCurrentLevel()) </dd></dl>
</li>
<li>
<code>int = obj.GetNumberOfChildren ()</code> - Return the number of children for each node of the tree. <dl class="section post"><dt>Postcondition:</dt><dd>positive_number: result>0 </dd></dl>
</li>
<li>
<code>int = obj.GetDimension ()</code> - Return the dimension of the tree. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>0 </dd></dl>
</li>
<li>
<code>obj.MoveToNode (int indices, int level)</code> - Move to the node described by its indices in each dimension and at a given level. If there is actually a node or a leaf at this location, Found() returns true. Otherwise, Found() returns false and the cursor moves to the closest parent of the query. It can be the root in the worst case. <dl class="section pre"><dt>Precondition:</dt><dd>indices_exists: indices!=0 </dd>
<dd>
valid_size: sizeof(indices)==GetDimension() </dd>
<dd>
valid_level: level>=0 </dd></dl>
</li>
<li>
<code>int = obj.Found ()</code> </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkfiltering.html">Visualization Toolkit Filtering Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:30 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
