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
|
<!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: vtkCursor2D</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_vtkcursor2d.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkCursor2D </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>vtkCursor2D is a class that generates a 2D cursor representation. The cursor consists of two intersection axes lines that meet at the cursor focus. Several optional features are available as well. An optional 2D bounding box may be enabled. An inner radius, centered at the focal point, can be set that erases the intersecting lines (e.g., it leaves a clear area under the focal point so you can see what you are selecting). And finally, an optional point can be enabled located at the focal point. All of these features can be turned on and off independently.</p>
<p>To create an instance of class vtkCursor2D, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkCursor2D
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkCursor2D 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 vtkCursor2D class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkCursor2D = obj.NewInstance ()</code> </li>
<li>
<code>vtkCursor2D = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetModelBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)</code> - Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie. </li>
<li>
<code>obj.SetModelBounds (double bounds[6])</code> - Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie. </li>
<li>
<code>double = obj. GetModelBounds ()</code> - Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie. </li>
<li>
<code>obj.SetFocalPoint (double x[3])</code> - Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value. </li>
<li>
<code>obj.SetFocalPoint (double x, double y, double z)</code> - Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value. </li>
<li>
<code>double = obj. GetFocalPoint ()</code> - Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.) Note that the method takes a 3D point but ignores the z-coordinate value. </li>
<li>
<code>obj.SetOutline (int )</code> - Turn on/off the wireframe bounding box. </li>
<li>
<code>int = obj.GetOutline ()</code> - Turn on/off the wireframe bounding box. </li>
<li>
<code>obj.OutlineOn ()</code> - Turn on/off the wireframe bounding box. </li>
<li>
<code>obj.OutlineOff ()</code> - Turn on/off the wireframe bounding box. </li>
<li>
<code>obj.SetAxes (int )</code> - Turn on/off the wireframe axes. </li>
<li>
<code>int = obj.GetAxes ()</code> - Turn on/off the wireframe axes. </li>
<li>
<code>obj.AxesOn ()</code> - Turn on/off the wireframe axes. </li>
<li>
<code>obj.AxesOff ()</code> - Turn on/off the wireframe axes. </li>
<li>
<code>obj.SetRadius (double )</code> - Specify a radius for a circle. This erases the cursor lines around the focal point. </li>
<li>
<code>double = obj.GetRadiusMinValue ()</code> - Specify a radius for a circle. This erases the cursor lines around the focal point. </li>
<li>
<code>double = obj.GetRadiusMaxValue ()</code> - Specify a radius for a circle. This erases the cursor lines around the focal point. </li>
<li>
<code>double = obj.GetRadius ()</code> - Specify a radius for a circle. This erases the cursor lines around the focal point. </li>
<li>
<code>obj.SetPoint (int )</code> - Turn on/off the point located at the cursor focus. </li>
<li>
<code>int = obj.GetPoint ()</code> - Turn on/off the point located at the cursor focus. </li>
<li>
<code>obj.PointOn ()</code> - Turn on/off the point located at the cursor focus. </li>
<li>
<code>obj.PointOff ()</code> - Turn on/off the point located at the cursor focus. </li>
<li>
<code>obj.SetTranslationMode (int )</code> - Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off. </li>
<li>
<code>int = obj.GetTranslationMode ()</code> - Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off. </li>
<li>
<code>obj.TranslationModeOn ()</code> - Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off. </li>
<li>
<code>obj.TranslationModeOff ()</code> - Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off. </li>
<li>
<code>obj.SetWrap (int )</code> - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on). </li>
<li>
<code>int = obj.GetWrap ()</code> - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on). </li>
<li>
<code>obj.WrapOn ()</code> - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on). </li>
<li>
<code>obj.WrapOff ()</code> - Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on). </li>
<li>
<code>obj.AllOn ()</code> - Turn every part of the cursor on or off. </li>
<li>
<code>obj.AllOff ()</code> - Turn every part of the cursor on or off. </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:31 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>
|
