File: vtkwidgets_vtkanglerepresentation.html

package info (click to toggle)
freemat 4.2%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 141,800 kB
  • ctags: 14,082
  • sloc: ansic: 126,788; cpp: 62,046; python: 2,080; perl: 1,255; sh: 1,146; yacc: 1,019; lex: 239; makefile: 100
file content (166 lines) | stat: -rw-r--r-- 11,785 bytes parent folder | download | duplicates (2)
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
<!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: vtkAngleRepresentation</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&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;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_vtkanglerepresentation.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vtkAngleRepresentation </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>The vtkAngleRepresentation is a superclass for classes representing the vtkAngleWidget. This representation consists of two rays and three vtkHandleRepresentations to place and manipulate the three points defining the angle representation. (Note: the three points are referred to as Point1, Center, and Point2, at the two end points (Point1 and Point2) and Center (around which the angle is measured).</p>
<p>To create an instance of class vtkAngleRepresentation, simply invoke its constructor as follows </p>
<pre class="fragment">  obj = vtkAngleRepresentation
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkAngleRepresentation 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 vtkAngleRepresentation class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> - Standard VTK methods.  </li>
<li>
<code>int = obj.IsA (string name)</code> - Standard VTK methods.  </li>
<li>
<code>vtkAngleRepresentation = obj.NewInstance ()</code> - Standard VTK methods.  </li>
<li>
<code>vtkAngleRepresentation = obj.SafeDownCast (vtkObject o)</code> - Standard VTK methods.  </li>
<li>
<code>double = obj.GetAngle ()</code> - This representation and all subclasses must keep an angle (in degrees) consistent with the state of the widget.  </li>
<li>
<code>obj.GetPoint1WorldPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.  </li>
<li>
<code>obj.GetCenterWorldPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the three 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 three 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 three points defining this representation. Note that methods are available for both display and world coordinates.  </li>
<li>
<code>obj.SetCenterDisplayPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the three 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 three 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 three points defining this representation. Note that methods are available for both display and world coordinates.  </li>
<li>
<code>obj.GetCenterDisplayPosition (double pos[3])</code> - Methods to Set/Get the coordinates of the three 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 three points defining this representation. Note that methods are available for both display and world coordinates.  </li>
<li>
<code>obj.SetHandleRepresentation (vtkHandleRepresentation handle)</code> - This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkAngleRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkAngleRepresentation uses this dummy to clone three vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkAngle widget.)  </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 vtkAngleRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkAngleRepresentation uses this dummy to clone three vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkAngle widget.)  </li>
<li>
<code>vtkHandleRepresentation = obj.GetPoint1Representation ()</code> - Set/Get the handle representations used for the vtkAngleRepresentation.  </li>
<li>
<code>vtkHandleRepresentation = obj.GetCenterRepresentation ()</code> - Set/Get the handle representations used for the vtkAngleRepresentation.  </li>
<li>
<code>vtkHandleRepresentation = obj.GetPoint2Representation ()</code> - Set/Get the handle representations used for the vtkAngleRepresentation.  </li>
<li>
<code>obj.SetTolerance (int )</code> - The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the end points of the representation to be active.  </li>
<li>
<code>int = obj.GetToleranceMinValue ()</code> - The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the end points of the representation to be active.  </li>
<li>
<code>int = obj.GetToleranceMaxValue ()</code> - The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the end points of the representation to be active.  </li>
<li>
<code>int = obj.GetTolerance ()</code> - The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the end points of the representation to be active.  </li>
<li>
<code>obj.SetLabelFormat (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.GetLabelFormat ()</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.SetRay1Visibility (int )</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>int = obj.GetRay1Visibility ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.Ray1VisibilityOn ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.Ray1VisibilityOff ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.SetRay2Visibility (int )</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>int = obj.GetRay2Visibility ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.Ray2VisibilityOn ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.Ray2VisibilityOff ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.SetArcVisibility (int )</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>int = obj.GetArcVisibility ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.ArcVisibilityOn ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </li>
<li>
<code>obj.ArcVisibilityOff ()</code> - Special methods for turning off the rays and arc that define the cone and arc of the angle.  </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.CenterWidgetInteraction (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>
</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>