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
|
<!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: vtkArcPlotter</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('vtkhybrid_vtkarcplotter.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkArcPlotter </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkhybrid.html">Visualization Toolkit Hybrid Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkArcPlotter performs plotting of attribute data along polylines defined with an input vtkPolyData data object. Any type of attribute data can be plotted including scalars, vectors, tensors, normals, texture coordinates, and field data. Either one or multiple data components can be plotted.</p>
<p>To use this class you must specify an input data set that contains one or more polylines, and some attribute data including which component of the attribute data. (By default, this class processes the first component of scalar data.) You will also need to set an offset radius (the distance of the polyline to the median line of the plot), a width for the plot (the distance that the minimum and maximum plot values are mapped into), an possibly an offset (used to offset attribute data with multiple components).</p>
<p>Normally the filter automatically computes normals for generating the offset arc plot. However, you can specify a default normal and use that instead.</p>
<p>To create an instance of class vtkArcPlotter, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkArcPlotter
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkArcPlotter 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 vtkArcPlotter class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkArcPlotter = obj.NewInstance ()</code> </li>
<li>
<code>vtkArcPlotter = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetCamera (vtkCamera )</code> - Specify a camera used to orient the plot along the arc. If no camera is specified, then the orientation of the plot is arbitrary. </li>
<li>
<code>vtkCamera = obj.GetCamera ()</code> - Specify a camera used to orient the plot along the arc. If no camera is specified, then the orientation of the plot is arbitrary. </li>
<li>
<code>obj.SetPlotMode (int )</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>int = obj.GetPlotMode ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotModeToPlotScalars ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotModeToPlotVectors ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotModeToPlotNormals ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotModeToPlotTCoords ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotModeToPlotTensors ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotModeToPlotFieldData ()</code> - Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot. </li>
<li>
<code>obj.SetPlotComponent (int )</code> - Set/Get the component number to plot if the data has more than one component. If the value of the plot component is == (-1), then all the components will be plotted. </li>
<li>
<code>int = obj.GetPlotComponent ()</code> - Set/Get the component number to plot if the data has more than one component. If the value of the plot component is == (-1), then all the components will be plotted. </li>
<li>
<code>obj.SetRadius (double )</code> - Set the radius of the "median" value of the first plotted component. </li>
<li>
<code>double = obj.GetRadiusMinValue ()</code> - Set the radius of the "median" value of the first plotted component. </li>
<li>
<code>double = obj.GetRadiusMaxValue ()</code> - Set the radius of the "median" value of the first plotted component. </li>
<li>
<code>double = obj.GetRadius ()</code> - Set the radius of the "median" value of the first plotted component. </li>
<li>
<code>obj.SetHeight (double )</code> - Set the height of the plot. (The radius combined with the height define the location of the plot relative to the generating polyline.) </li>
<li>
<code>double = obj.GetHeightMinValue ()</code> - Set the height of the plot. (The radius combined with the height define the location of the plot relative to the generating polyline.) </li>
<li>
<code>double = obj.GetHeightMaxValue ()</code> - Set the height of the plot. (The radius combined with the height define the location of the plot relative to the generating polyline.) </li>
<li>
<code>double = obj.GetHeight ()</code> - Set the height of the plot. (The radius combined with the height define the location of the plot relative to the generating polyline.) </li>
<li>
<code>obj.SetOffset (double )</code> - Specify an offset that translates each subsequent plot (if there is more than one component plotted) from the defining arc (i.e., polyline). </li>
<li>
<code>double = obj.GetOffsetMinValue ()</code> - Specify an offset that translates each subsequent plot (if there is more than one component plotted) from the defining arc (i.e., polyline). </li>
<li>
<code>double = obj.GetOffsetMaxValue ()</code> - Specify an offset that translates each subsequent plot (if there is more than one component plotted) from the defining arc (i.e., polyline). </li>
<li>
<code>double = obj.GetOffset ()</code> - Specify an offset that translates each subsequent plot (if there is more than one component plotted) from the defining arc (i.e., polyline). </li>
<li>
<code>obj.SetUseDefaultNormal (int )</code> - Set a boolean to control whether to use default normals. By default, normals are automatically computed from the generating polyline and camera. </li>
<li>
<code>int = obj.GetUseDefaultNormal ()</code> - Set a boolean to control whether to use default normals. By default, normals are automatically computed from the generating polyline and camera. </li>
<li>
<code>obj.UseDefaultNormalOn ()</code> - Set a boolean to control whether to use default normals. By default, normals are automatically computed from the generating polyline and camera. </li>
<li>
<code>obj.UseDefaultNormalOff ()</code> - Set a boolean to control whether to use default normals. By default, normals are automatically computed from the generating polyline and camera. </li>
<li>
<code>obj.SetDefaultNormal (float , float , float )</code> - Set the default normal to use if you do not wish automatic normal calculation. The arc plot will be generated using this normal. </li>
<li>
<code>obj.SetDefaultNormal (float a[3])</code> - Set the default normal to use if you do not wish automatic normal calculation. The arc plot will be generated using this normal. </li>
<li>
<code>float = obj. GetDefaultNormal ()</code> - Set the default normal to use if you do not wish automatic normal calculation. The arc plot will be generated using this normal. </li>
<li>
<code>obj.SetFieldDataArray (int )</code> - Set/Get the field data array to plot. This instance variable is only applicable if field data is plotted. </li>
<li>
<code>int = obj.GetFieldDataArrayMinValue ()</code> - Set/Get the field data array to plot. This instance variable is only applicable if field data is plotted. </li>
<li>
<code>int = obj.GetFieldDataArrayMaxValue ()</code> - Set/Get the field data array to plot. This instance variable is only applicable if field data is plotted. </li>
<li>
<code>int = obj.GetFieldDataArray ()</code> - Set/Get the field data array to plot. This instance variable is only applicable if field data is plotted. </li>
<li>
<code>long = obj.GetMTime ()</code> - New GetMTime because of camera dependency. </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_vtkhybrid.html">Visualization Toolkit Hybrid 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>
|
