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
|
<!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: vtkPoints</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('vtkcommon_vtkpoints.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkPoints </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkcommon.html">Visualization Toolkit Common Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkPoints represents 3D points. The data model for vtkPoints is an array of vx-vy-vz triplets accessible by (point or cell) id.</p>
<p>To create an instance of class vtkPoints, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkPoints
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkPoints 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 vtkPoints class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkPoints = obj.NewInstance ()</code> </li>
<li>
<code>vtkPoints = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.Allocate (vtkIdType sz, vtkIdType ext)</code> - Allocate initial memory size. </li>
<li>
<code>obj.Initialize ()</code> - Return object to instantiated state. </li>
<li>
<code>obj.SetData (vtkDataArray )</code> - Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object, which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending on the type of scalar.) </li>
<li>
<code>vtkDataArray = obj.GetData ()</code> - Set/Get the underlying data array. This function must be implemented in a concrete subclass to check for consistency. (The tuple size must match the type of data. For example, 3-tuple data array can be assigned to a vector, normal, or points object, but not a tensor object, which has a tuple dimension of 9. Scalars, on the other hand, can have tuple dimension from 1-4, depending on the type of scalar.) </li>
<li>
<code>int = obj.GetDataType ()</code> - Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h. </li>
<li>
<code>obj.SetDataType (int dataType)</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToBit ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToChar ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToUnsignedChar ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToShort ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToUnsignedShort ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToInt ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToUnsignedInt ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToLong ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToUnsignedLong ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToFloat ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.SetDataTypeToDouble ()</code> - Specify the underlying data type of the object. </li>
<li>
<code>obj.Squeeze ()</code> - Reclaim any extra memory. </li>
<li>
<code>obj.Reset ()</code> - Make object look empty but do not delete memory. </li>
<li>
<code>obj.DeepCopy (vtkPoints ad)</code> - Different ways to copy data. Shallow copy does reference count (i.e., assigns pointers and updates reference count); deep copy runs through entire data array assigning values. </li>
<li>
<code>obj.ShallowCopy (vtkPoints ad)</code> - Different ways to copy data. Shallow copy does reference count (i.e., assigns pointers and updates reference count); deep copy runs through entire data array assigning values. </li>
<li>
<code>long = obj.GetActualMemorySize ()</code> - Return the memory in kilobytes consumed by this attribute data. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated. </li>
<li>
<code>vtkIdType = obj.GetNumberOfPoints ()</code> - Return number of points in array. </li>
<li>
<code>double = obj.GetPoint (vtkIdType id)</code> - Return a pointer to a double point x[3] for a specific id. WARNING: Just don't use this error-prone method, the returned pointer and its values are only valid as long as another method invocation is not performed. Prefer GetPoint() with the return value in argument. </li>
<li>
<code>obj.GetPoint (vtkIdType id, double x[3])</code> - Copy point components into user provided array v[3] for specified id. </li>
<li>
<code>obj.SetPoint (vtkIdType id, float x[3])</code> - Insert point into object. No range checking performed (fast!). Make sure you use SetNumberOfPoints() to allocate memory prior to using SetPoint(). </li>
<li>
<code>obj.SetPoint (vtkIdType id, double x[3])</code> - Insert point into object. No range checking performed (fast!). Make sure you use SetNumberOfPoints() to allocate memory prior to using SetPoint(). </li>
<li>
<code>obj.SetPoint (vtkIdType id, double x, double y, double z)</code> - Insert point into object. No range checking performed (fast!). Make sure you use SetNumberOfPoints() to allocate memory prior to using SetPoint(). </li>
<li>
<code>obj.InsertPoint (vtkIdType id, float x[3])</code> - Insert point into object. Range checking performed and memory allocated as necessary. </li>
<li>
<code>obj.InsertPoint (vtkIdType id, double x[3])</code> - Insert point into object. Range checking performed and memory allocated as necessary. </li>
<li>
<code>obj.InsertPoint (vtkIdType id, double x, double y, double z)</code> - Insert point into object. Range checking performed and memory allocated as necessary. </li>
<li>
<code>vtkIdType = obj.InsertNextPoint (float x[3])</code> - Insert point into next available slot. Returns id of slot. </li>
<li>
<code>vtkIdType = obj.InsertNextPoint (double x[3])</code> - Insert point into next available slot. Returns id of slot. </li>
<li>
<code>vtkIdType = obj.InsertNextPoint (double x, double y, double z)</code> - Insert point into next available slot. Returns id of slot. </li>
<li>
<code>obj.SetNumberOfPoints (vtkIdType number)</code> - Specify the number of points for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetPoint() method for fast insertion. </li>
<li>
<code>obj.GetPoints (vtkIdList ptId, vtkPoints fp)</code> - Given a list of pt ids, return an array of points. </li>
<li>
<code>obj.ComputeBounds ()</code> - Determine (xmin,xmax, ymin,ymax, zmin,zmax) bounds of points. </li>
<li>
<code>double = obj.GetBounds ()</code> - Return the bounds of the points. </li>
<li>
<code>obj.GetBounds (double bounds[6])</code> - Return the bounds of the points. </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_vtkcommon.html">Visualization Toolkit Common 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>
|
