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
|
<!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: vtkBorderRepresentation</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_vtkborderrepresentation.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkBorderRepresentation </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 used to represent and render a vtBorderWidget. To use this class, you need to specify the two corners of a rectangular region.</p>
<p>The class is typically subclassed so that specialized representations can be created. The class defines an API and a default implementation that the vtkBorderRepresentation interacts with to render itself in the scene.</p>
<p>To create an instance of class vtkBorderRepresentation, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkBorderRepresentation
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkBorderRepresentation 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 vtkBorderRepresentation class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> - Define standard methods. </li>
<li>
<code>int = obj.IsA (string name)</code> - Define standard methods. </li>
<li>
<code>vtkBorderRepresentation = obj.NewInstance ()</code> - Define standard methods. </li>
<li>
<code>vtkBorderRepresentation = obj.SafeDownCast (vtkObject o)</code> - Define standard methods. </li>
<li>
<code>vtkCoordinate = obj.GetPositionCoordinate ()</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>obj.SetPosition (double, double)</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>obj.SetPosition (double a[2])</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>double = obj.GetPosition ()</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>vtkCoordinate = obj.GetPosition2Coordinate ()</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>obj.SetPosition2 (double, double)</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>obj.SetPosition2 (double a[2])</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>double = obj.GetPosition2 ()</code> - Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also, </li>
<li>
<code>obj.SetShowBorder (int )</code> - Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. </li>
<li>
<code>int = obj.GetShowBorderMinValue ()</code> - Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. </li>
<li>
<code>int = obj.GetShowBorderMaxValue ()</code> - Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. </li>
<li>
<code>int = obj.GetShowBorder ()</code> - Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. </li>
<li>
<code>obj.SetShowBorderToOff ()</code> - Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. </li>
<li>
<code>obj.SetShowBorderToOn ()</code> - Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. </li>
<li>
<code>obj.SetShowBorderToActive ()</code> - Specify the properties of the border. </li>
<li>
<code>vtkProperty2D = obj.GetBorderProperty ()</code> - Specify the properties of the border. </li>
<li>
<code>obj.SetProportionalResize (int )</code> - Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation. </li>
<li>
<code>int = obj.GetProportionalResize ()</code> - Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation. </li>
<li>
<code>obj.ProportionalResizeOn ()</code> - Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation. </li>
<li>
<code>obj.ProportionalResizeOff ()</code> - Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation. </li>
<li>
<code>obj.SetMinimumSize (int , int )</code> - Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively. </li>
<li>
<code>obj.SetMinimumSize (int a[2])</code> - Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively. </li>
<li>
<code>int = obj. GetMinimumSize ()</code> - Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively. </li>
<li>
<code>obj.SetMaximumSize (int , int )</code> - Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively. </li>
<li>
<code>obj.SetMaximumSize (int a[2])</code> - Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively. </li>
<li>
<code>int = obj. GetMaximumSize ()</code> - Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively. </li>
<li>
<code>obj.SetTolerance (int )</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). </li>
<li>
<code>int = obj.GetToleranceMinValue ()</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). </li>
<li>
<code>int = obj.GetToleranceMaxValue ()</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). </li>
<li>
<code>int = obj.GetTolerance ()</code> - The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). </li>
<li>
<code>double = obj. GetSelectionPoint ()</code> - After a selection event within the region interior to the border; the normalized selection coordinates may be obtained. </li>
<li>
<code>obj.SetMoving (int )</code> - This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion. </li>
<li>
<code>int = obj.GetMoving ()</code> - This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion. </li>
<li>
<code>obj.MovingOn ()</code> - This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion. </li>
<li>
<code>obj.MovingOff ()</code> - This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion. </li>
<li>
<code>obj.BuildRepresentation ()</code> - Subclasses should implement these methods. See the superclasses' documentation for more information. </li>
<li>
<code>obj.StartWidgetInteraction (double eventPos[2])</code> - Subclasses should implement these methods. See the superclasses' documentation for more information. </li>
<li>
<code>obj.WidgetInteraction (double eventPos[2])</code> - Subclasses should implement these methods. See the superclasses' documentation for more information. </li>
<li>
<code>obj.GetSize (double size[2])</code> - Subclasses should implement these methods. See the superclasses' documentation for more information. </li>
<li>
<code>int = obj.ComputeInteractionState (int X, int Y, int modify)</code> - Subclasses should implement these methods. See the superclasses' documentation for more information. </li>
<li>
<code>obj.GetActors2D (vtkPropCollection )</code> - These methods are necessary to make this representation behave as a vtkProp. </li>
<li>
<code>obj.ReleaseGraphicsResources (vtkWindow )</code> - These methods are necessary to make this representation behave as a vtkProp. </li>
<li>
<code>int = obj.RenderOverlay (vtkViewport )</code> - These methods are necessary to make this representation behave as a vtkProp. </li>
<li>
<code>int = obj.RenderOpaqueGeometry (vtkViewport )</code> - These methods are necessary to make this representation behave as a vtkProp. </li>
<li>
<code>int = obj.RenderTranslucentPolygonalGeometry (vtkViewport )</code> - These methods are necessary to make this representation behave as a vtkProp. </li>
<li>
<code>int = obj.HasTranslucentPolygonalGeometry ()</code> - These methods are necessary to make this representation behave as a vtkProp. </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>
|
