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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
<!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: vtkHyperOctreeSampleFunction</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('vtkgraphics_vtkhyperoctreesamplefunction.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkHyperOctreeSampleFunction </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkgraphics.html">Visualization Toolkit Graphics Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkHyperOctreeSampleFunction is a source object that evaluates an implicit function to drive the subdivision process. The user can specify the threshold over which a subdivision occurs, the maximum and minimum level of subdivisions and the dimension of the hyperoctree.</p>
<p>To create an instance of class vtkHyperOctreeSampleFunction, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkHyperOctreeSampleFunction
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkHyperOctreeSampleFunction 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 vtkHyperOctreeSampleFunction class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkHyperOctreeSampleFunction = obj.NewInstance ()</code> </li>
<li>
<code>vtkHyperOctreeSampleFunction = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.GetLevels ()</code> - Return the maximum number of levels of the hyperoctree. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>=1 </dd></dl>
</li>
<li>
<code>obj.SetLevels (int levels)</code> - Set the maximum number of levels of the hyperoctree. If GetMinLevels()>=levels, GetMinLevels() is changed to levels-1. <dl class="section pre"><dt>Precondition:</dt><dd>positive_levels: levels>=1 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_set: this->GetLevels()==levels </dd>
<dd>
min_is_valid: this->GetMinLevels()<this->GetLevels() </dd></dl>
</li>
<li>
<code>int = obj.GetMinLevels ()</code> - Return the minimal number of levels of systematic subdivision. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>=0 </dd></dl>
</li>
<li>
<code>obj.SetMinLevels (int minLevels)</code> - Set the minimal number of levels of systematic subdivision. <dl class="section pre"><dt>Precondition:</dt><dd>positive_minLevels: minLevels>=0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_set: this->GetMinLevels()==minLevels </dd></dl>
</li>
<li>
<code>double = obj.GetThreshold ()</code> - Return the threshold over which a subdivision is required. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>0 </dd></dl>
</li>
<li>
<code>obj.SetThreshold (double threshold)</code> - Set the threshold over which a subdivision is required. <dl class="section pre"><dt>Precondition:</dt><dd>positive_threshold: threshold>=0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_set: this->GetThreshold()==threshold </dd></dl>
</li>
<li>
<code>int = obj.GetDimension ()</code> - Return the dimension of the tree (1D:binary tree(2 children), 2D:quadtree(4 children), 3D:octree (8 children)) <dl class="section post"><dt>Postcondition:</dt><dd>valid_result: result>=1 && result<=3 </dd></dl>
</li>
<li>
<code>obj.SetDimension (int dim)</code> </li>
<li>
<code>obj.SetSize (double , double , double )</code> - Set the size on each axis. </li>
<li>
<code>obj.SetSize (double a[3])</code> - Set the size on each axis. </li>
<li>
<code>double = obj. GetSize ()</code> - Return the size on each axis. </li>
<li>
<code>obj.SetOrigin (double , double , double )</code> - Set the origin (position of corner (0,0,0) of the root. </li>
<li>
<code>obj.SetOrigin (double a[3])</code> - Set the origin (position of corner (0,0,0) of the root. </li>
<li>
<code>double = obj. GetOrigin ()</code> - Set the origin (position of corner (0,0,0) of the root. Return the origin (position of corner (0,0,0) ) of the root. </li>
<li>
<code>double = obj.GetWidth ()</code> - Return the length along the x-axis. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>0 </dd></dl>
</li>
<li>
<code>obj.SetWidth (double width)</code> - Set the length along the x-axis. <dl class="section pre"><dt>Precondition:</dt><dd>positive_width: width>0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>width_is_set: GetWidth()==width </dd></dl>
</li>
<li>
<code>double = obj.GetHeight ()</code> - Return the length along the y-axis. Relevant only if GetDimension()>=2 <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>0 </dd></dl>
</li>
<li>
<code>obj.SetHeight (double height)</code> - Set the length along the y-axis. Relevant only if GetDimension()>=2 <dl class="section pre"><dt>Precondition:</dt><dd>positive_height: height>0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>height_is_set: GetHeight()==height </dd></dl>
</li>
<li>
<code>double = obj.GetDepth ()</code> - Return the length along the z-axis. Relevant only if GetDimension()>=3 <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>0 </dd></dl>
</li>
<li>
<code>obj.SetDepth (double depth)</code> - Return the length along the z-axis. Relevant only if GetDimension()>=3 <dl class="section pre"><dt>Precondition:</dt><dd>positive_depth: depth>0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>depth_is_set: GetDepth()==depth </dd></dl>
</li>
<li>
<code>obj.SetImplicitFunction (vtkImplicitFunction )</code> - Specify the implicit function to use to generate data. </li>
<li>
<code>vtkImplicitFunction = obj.GetImplicitFunction ()</code> - Specify the implicit function to use to generate data. </li>
<li>
<code>obj.SetOutputScalarType (int )</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>int = obj.GetOutputScalarType ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToDouble ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToFloat ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToLong ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToUnsignedLong ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToInt ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToUnsignedInt ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToShort ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToUnsignedShort ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToChar ()</code> - Set what type of scalar data this source should generate. </li>
<li>
<code>obj.SetOutputScalarTypeToUnsignedChar ()</code> - Return the MTime also considering the implicit function. </li>
<li>
<code>long = obj.GetMTime ()</code> - Return the MTime also considering the implicit function. </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_vtkgraphics.html">Visualization Toolkit Graphics Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:32 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>
|
