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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<!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: vtkLineRepresentation</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('vtkwidgets_vtklinerepresentation.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkLineRepresentation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkwidgets.html">Visualization Toolkit Widget Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>This class is a concrete representation for the vtkLineWidget2. It represents a straight line with three handles: one at the beginning and ending of the line, and one used to translate the line. Through interaction with the widget, the line representation can be arbitrarily placed in the 3D space.</p>
<p>To use this representation, you normally specify the position of the two end points (either in world or display coordinates). The PlaceWidget() method is also used to intially position the representation.</p>
<p>To create an instance of class vtkLineRepresentation, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkLineRepresentation
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkLineRepresentation 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 vtkLineRepresentation class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> - Standard methods for the class. </li>
<li>
<code>int = obj.IsA (string name)</code> - Standard methods for the class. </li>
<li>
<code>vtkLineRepresentation = obj.NewInstance ()</code> - Standard methods for the class. </li>
<li>
<code>vtkLineRepresentation = obj.SafeDownCast (vtkObject o)</code> - Standard methods for the class. </li>
<li>
<code>obj.GetPoint1WorldPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>double = obj.GetPoint1WorldPosition ()</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.GetPoint1DisplayPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>double = obj.GetPoint1DisplayPosition ()</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.SetPoint1WorldPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.SetPoint1DisplayPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.GetPoint2DisplayPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>double = obj.GetPoint2DisplayPosition ()</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.GetPoint2WorldPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>double = obj.GetPoint2WorldPosition ()</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.SetPoint2WorldPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.SetPoint2DisplayPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates. </li>
<li>
<code>obj.SetHandleRepresentation (vtkPointHandleRepresentation3D handle)</code> - This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkLineWidget2. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkLineRepresentation uses this dummy to clone three vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkLineWidget2.) </li>
<li>
<code>obj.InstantiateHandleRepresentation ()</code> - This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkLineWidget2. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkLineRepresentation uses this dummy to clone three vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkLineWidget2.) </li>
<li>
<code>vtkPointHandleRepresentation3D = obj.GetPoint1Representation ()</code> - Get the three handle representations used for the vtkLineWidget2. </li>
<li>
<code>vtkPointHandleRepresentation3D = obj.GetPoint2Representation ()</code> - Get the three handle representations used for the vtkLineWidget2. </li>
<li>
<code>vtkPointHandleRepresentation3D = obj.GetLineHandleRepresentation ()</code> - Get the three handle representations used for the vtkLineWidget2. </li>
<li>
<code>vtkProperty = obj.GetEndPointProperty ()</code> - Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated. </li>
<li>
<code>vtkProperty = obj.GetSelectedEndPointProperty ()</code> - Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated. </li>
<li>
<code>vtkProperty = obj.GetEndPoint2Property ()</code> - Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated. </li>
<li>
<code>vtkProperty = obj.GetSelectedEndPoint2Property ()</code> - Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated. </li>
<li>
<code>vtkProperty = obj.GetLineProperty ()</code> - Get the line properties. The properties of the line when selected and unselected can be manipulated. </li>
<li>
<code>vtkProperty = obj.GetSelectedLineProperty ()</code> - Get the line properties. The properties of the line when selected and unselected can be manipulated. </li>
<li>
<code>obj.SetTolerance (int )</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active. </li>
<li>
<code>int = obj.GetToleranceMinValue ()</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active. </li>
<li>
<code>int = obj.GetToleranceMaxValue ()</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active. </li>
<li>
<code>int = obj.GetTolerance ()</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active. </li>
<li>
<code>obj.SetResolution (int res)</code> - Set/Get the resolution (number of subdivisions) of the line. A line with resolution greater than one is useful when points along the line are desired; e.g., generating a rake of streamlines. </li>
<li>
<code>int = obj.GetResolution ()</code> - Set/Get the resolution (number of subdivisions) of the line. A line with resolution greater than one is useful when points along the line are desired; e.g., generating a rake of streamlines. </li>
<li>
<code>obj.GetPolyData (vtkPolyData pd)</code> - Retrieve the polydata (including points) that defines the line. The polydata consists of n+1 points, where n is the resolution of the line. These point values are guaranteed to be up-to-date whenever any one of the three handles are moved. To use this method, the user provides the vtkPolyData as an input argument, and the points and polyline are copied into it. </li>
<li>
<code>obj.PlaceWidget (double bounds[6])</code> - These are methods that satisfy vtkWidgetRepresentation's API. </li>
<li>
<code>obj.BuildRepresentation ()</code> - These are methods that satisfy vtkWidgetRepresentation's API. </li>
<li>
<code>int = obj.ComputeInteractionState (int X, int Y, int modify)</code> - These are methods that satisfy vtkWidgetRepresentation's API. </li>
<li>
<code>obj.StartWidgetInteraction (double e[2])</code> - These are methods that satisfy vtkWidgetRepresentation's API. </li>
<li>
<code>obj.WidgetInteraction (double e[2])</code> - These are methods that satisfy vtkWidgetRepresentation's API. </li>
<li>
<code>double = obj.GetBounds ()</code> - These are methods that satisfy vtkWidgetRepresentation's API. </li>
<li>
<code>obj.GetActors (vtkPropCollection pc)</code> - Methods supporting the rendering process. </li>
<li>
<code>obj.ReleaseGraphicsResources (vtkWindow )</code> - Methods supporting the rendering process. </li>
<li>
<code>int = obj.RenderOpaqueGeometry (vtkViewport )</code> - Methods supporting the rendering process. </li>
<li>
<code>int = obj.RenderTranslucentPolygonalGeometry (vtkViewport )</code> - Methods supporting the rendering process. </li>
<li>
<code>int = obj.HasTranslucentPolygonalGeometry ()</code> - Methods supporting the rendering process. </li>
<li>
<code>obj.SetInteractionState (int )</code> - The interaction state may be set from a widget (e.g., vtkLineWidget2) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further. </li>
<li>
<code>int = obj.GetInteractionStateMinValue ()</code> - The interaction state may be set from a widget (e.g., vtkLineWidget2) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further. </li>
<li>
<code>int = obj.GetInteractionStateMaxValue ()</code> - The interaction state may be set from a widget (e.g., vtkLineWidget2) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further. </li>
<li>
<code>obj.SetRepresentationState (int )</code> - Sets the visual appearance of the representation based on the state it is in. This state is usually the same as InteractionState. </li>
<li>
<code>int = obj.GetRepresentationState ()</code> - Sets the visual appearance of the representation based on the state it is in. This state is usually the same as InteractionState. </li>
<li>
<code>long = obj.GetMTime ()</code> - Overload the superclasses' GetMTime() because internal classes are used to keep the state of the representation. </li>
<li>
<code>obj.SetRenderer (vtkRenderer ren)</code> - Overridden to set the rendererer on the internal representations. </li>
<li>
<code>obj.SetDistanceAnnotationVisibility (int )</code> - Show the distance between the points </li>
<li>
<code>int = obj.GetDistanceAnnotationVisibility ()</code> - Show the distance between the points </li>
<li>
<code>obj.DistanceAnnotationVisibilityOn ()</code> - Show the distance between the points </li>
<li>
<code>obj.DistanceAnnotationVisibilityOff ()</code> - Show the distance between the points </li>
<li>
<code>obj.SetDistanceAnnotationFormat (string )</code> - Specify the format to use for labelling the angle. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value. </li>
<li>
<code>string = obj.GetDistanceAnnotationFormat ()</code> - Specify the format to use for labelling the angle. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value. </li>
<li>
<code>obj.SetDistanceAnnotationScale (double scale[3])</code> - Scale text (font size along each dimension). </li>
<li>
<code>double = obj.GetDistance ()</code> - Get the distance between the points. </li>
<li>
<code>obj.SetLineColor (double r, double g, double b)</code> - Convenience method to set the line color. Ideally one should use GetLineProperty()->SetColor(). </li>
<li>
<code>vtkProperty = obj.GetDistanceAnnotationProperty ()</code> - Get the distance annotation property </li>
<li>
<code>vtkFollower = obj.GetTextActor ()</code> - Get the text actor </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_vtkwidgets.html">Visualization Toolkit Widget Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:36 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>
|
