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
|
<!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: vtkGenericAttribute</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_vtkgenericattribute.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkGenericAttribute </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>vtkGenericAttribute is an abstract class that defines an API for attribute data. Attribute data is data associated with the topology or geometry of a dataset (i.e., points, cells, etc.). vtkGenericAttribute is part of the adaptor framework (see GenericFiltering/README.html).</p>
<p>vtkGenericAttribute provides a more general interface to attribute data than its counterpart vtkDataArray (which assumes a linear, contiguous array). It adopts an iterator interface, and allows attributes to be associated with points, edges, faces, or edges.</p>
<p>To create an instance of class vtkGenericAttribute, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkGenericAttribute
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkGenericAttribute 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 vtkGenericAttribute class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkGenericAttribute = obj.NewInstance ()</code> </li>
<li>
<code>vtkGenericAttribute = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>string = obj.GetName ()</code> - Name of the attribute. (e.g. "velocity") <dl class="section post"><dt>Postcondition:</dt><dd>result_may_not_exist: result!=0 || result==0 </dd></dl>
</li>
<li>
<code>int = obj.GetNumberOfComponents ()</code> - Dimension of the attribute. (1 for scalar, 3 for velocity) <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>=0 </dd>
<dd>
GetType()==VTK_SCALARS implies result==1 </dd>
<dd>
(GetType()==VTK_VECTORS||(GetType()==VTK_NORMALS)||(GetType()==VTK_TCOORDS) implies result==3 </dd>
<dd>
GetType()==VTK_TENSORS implies result==6 </dd></dl>
</li>
<li>
<code>int = obj.GetCentering ()</code> - Is the attribute centered either on points, cells or boundaries? <dl class="section post"><dt>Postcondition:</dt><dd>valid_result: (result==vtkPointCentered)||(result==vtkCellCentered) </dd></dl>
</li>
<li>
<code>int = obj.GetType ()</code> - Type of the attribute: scalar, vector, normal, texture coordinate, tensor <dl class="section post"><dt>Postcondition:</dt><dd>valid_result: (result==vtkDataSetAttributes::SCALARS) ||(result==vtkDataSetAttributes::VECTORS) ||(result==vtkDataSetAttributes::NORMALS) ||(result==vtkDataSetAttributes::TCOORDS) ||(result==vtkDataSetAttributes::TENSORS) </dd></dl>
</li>
<li>
<code>int = obj.GetComponentType ()</code> - Type of the components of the attribute: int, float, double <dl class="section post"><dt>Postcondition:</dt><dd>valid_result: (result==VTK_BIT) ||(result==VTK_CHAR) ||(result==VTK_UNSIGNED_CHAR) ||(result==VTK_SHORT) ||(result==VTK_UNSIGNED_SHORT)||(result==VTK_INT) ||(result==VTK_UNSIGNED_INT) ||(result==VTK_LONG) ||(result==VTK_UNSIGNED_LONG) ||(result==VTK_FLOAT) ||(result==VTK_DOUBLE) ||(result==VTK_ID_TYPE) </dd></dl>
</li>
<li>
<code>vtkIdType = obj.GetSize ()</code> - Number of tuples. <dl class="section post"><dt>Postcondition:</dt><dd>valid_result: result>=0 </dd></dl>
</li>
<li>
<code>long = obj.GetActualMemorySize ()</code> - Size in kilobytes taken by the attribute. </li>
<li>
<code>obj.GetRange (int component, double range[2])</code> - Range of the attribute component `component'. If `component'==-1, it returns the range of the magnitude (euclidean norm). THREAD SAFE <dl class="section pre"><dt>Precondition:</dt><dd>valid_component: (component>=-1)&&(component<GetNumberOfComponents()) </dd></dl>
</li>
<li>
<code>double = obj.GetMaxNorm ()</code> - Return the maximum euclidean norm for the tuples. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result>=0 </dd></dl>
</li>
<li>
<code>obj.GetTuple (vtkGenericAdaptorCell c, double tuple)</code> - Put attribute at all points of cell `c' in `tuple'. <dl class="section pre"><dt>Precondition:</dt><dd>c_exists: c!=0 </dd>
<dd>
c_valid: !c->IsAtEnd() </dd>
<dd>
tuple_exists: tuple!=0 </dd>
<dd>
valid_tuple: sizeof(tuple)>=GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints() </dd></dl>
</li>
<li>
<code>obj.GetTuple (vtkGenericCellIterator c, double tuple)</code> - Put attribute at all points of cell `c' in `tuple'. <dl class="section pre"><dt>Precondition:</dt><dd>c_exists: c!=0 </dd>
<dd>
c_valid: !c->IsAtEnd() </dd>
<dd>
tuple_exists: tuple!=0 </dd>
<dd>
valid_tuple: sizeof(tuple)>=GetNumberOfComponents()*c->GetCell()->GetNumberOfPoints() </dd></dl>
</li>
<li>
<code>obj.GetTuple (vtkGenericPointIterator p, double tuple)</code> - Put the value of the attribute at position `p' into `tuple'. <dl class="section pre"><dt>Precondition:</dt><dd>p_exists: p!=0 </dd>
<dd>
p_valid: !p->IsAtEnd() </dd>
<dd>
tuple_exists: tuple!=0 </dd>
<dd>
valid_tuple_size: sizeof(tuple)>=GetNumberOfComponents() </dd></dl>
</li>
<li>
<code>obj.GetComponent (int i, vtkGenericCellIterator c, double values)</code> - Put component `i' of the attribute at all points of cell `c' in `values'. <dl class="section pre"><dt>Precondition:</dt><dd>valid_component: (i>=0) && (i<GetNumberOfComponents()) </dd>
<dd>
c_exists: c!=0 </dd>
<dd>
c_valid: !c->IsAtEnd() </dd>
<dd>
values_exist: values!=0 </dd>
<dd>
valid_values: sizeof(values)>=c->GetCell()->GetNumberOfPoints() </dd></dl>
</li>
<li>
<code>double = obj.GetComponent (int i, vtkGenericPointIterator p)</code> - Value of the component `i' of the attribute at position `p'. <dl class="section pre"><dt>Precondition:</dt><dd>valid_component: (i>=0) && (i<GetNumberOfComponents()) </dd>
<dd>
p_exists: p!=0 </dd>
<dd>
p_valid: !p->IsAtEnd() </dd></dl>
</li>
<li>
<code>obj.DeepCopy (vtkGenericAttribute other)</code> - Recursive duplication of `other' in `this'. <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd>
<dd>
not_self: other!=this </dd></dl>
</li>
<li>
<code>obj.ShallowCopy (vtkGenericAttribute other)</code> - Update `this' using fields of `other'. <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd>
<dd>
not_self: other!=this </dd></dl>
</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>
|
