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
|
<!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: vtkLabelPlacementMapper</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('vtkrendering_vtklabelplacementmapper.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkLabelPlacementMapper </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkrendering.html">Visualization Toolkit Rendering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>To use this mapper, first send your data through vtkPointSetToLabelHierarchy, which takes a set of points, associates special arrays to the points (label, priority, etc.), and produces a prioritized spatial tree of labels.</p>
<p>This mapper then takes that hierarchy (or hierarchies) as input, and every frame will decide which labels and/or icons to place in order of priority, and will render only those labels/icons. A label render strategy is used to render the labels, and can use e.g. FreeType or Qt for rendering.</p>
<p>To create an instance of class vtkLabelPlacementMapper, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkLabelPlacementMapper
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkLabelPlacementMapper 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 vtkLabelPlacementMapper class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkLabelPlacementMapper = obj.NewInstance ()</code> </li>
<li>
<code>vtkLabelPlacementMapper = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.RenderOverlay (vtkViewport viewport, vtkActor2D actor)</code> - Draw non-overlapping labels to the screen. </li>
<li>
<code>obj.SetRenderStrategy (vtkLabelRenderStrategy s)</code> - Set the label rendering strategy. </li>
<li>
<code>vtkLabelRenderStrategy = obj.GetRenderStrategy ()</code> - Set the label rendering strategy. </li>
<li>
<code>obj.SetMaximumLabelFraction (double )</code> - The maximum fraction of the screen that the labels may cover. Label placement stops when this fraction is reached. </li>
<li>
<code>double = obj.GetMaximumLabelFractionMinValue ()</code> - The maximum fraction of the screen that the labels may cover. Label placement stops when this fraction is reached. </li>
<li>
<code>double = obj.GetMaximumLabelFractionMaxValue ()</code> - The maximum fraction of the screen that the labels may cover. Label placement stops when this fraction is reached. </li>
<li>
<code>double = obj.GetMaximumLabelFraction ()</code> - The maximum fraction of the screen that the labels may cover. Label placement stops when this fraction is reached. </li>
<li>
<code>obj.SetIteratorType (int )</code> - The type of iterator used when traversing the labels. May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT </li>
<li>
<code>int = obj.GetIteratorType ()</code> - The type of iterator used when traversing the labels. May be vtkLabelHierarchy::FRUSTUM or vtkLabelHierarchy::FULL_SORT </li>
<li>
<code>obj.SetUseUnicodeStrings (bool )</code> - Set whether, or not, to use unicode strings. </li>
<li>
<code>bool = obj.GetUseUnicodeStrings ()</code> - Set whether, or not, to use unicode strings. </li>
<li>
<code>obj.UseUnicodeStringsOn ()</code> - Set whether, or not, to use unicode strings. </li>
<li>
<code>obj.UseUnicodeStringsOff ()</code> - Set whether, or not, to use unicode strings. </li>
<li>
<code>bool = obj.GetPositionsAsNormals ()</code> - Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default. </li>
<li>
<code>obj.SetPositionsAsNormals (bool )</code> - Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default. </li>
<li>
<code>obj.PositionsAsNormalsOn ()</code> - Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default. </li>
<li>
<code>obj.PositionsAsNormalsOff ()</code> - Use label anchor point coordinates as normal vectors and eliminate those pointing away from the camera. Valid only when points are on a sphere centered at the origin (such as a 3D geographic view). Off by default. </li>
<li>
<code>bool = obj.GetGeneratePerturbedLabelSpokes ()</code> - Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates. </li>
<li>
<code>obj.SetGeneratePerturbedLabelSpokes (bool )</code> - Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates. </li>
<li>
<code>obj.GeneratePerturbedLabelSpokesOn ()</code> - Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates. </li>
<li>
<code>obj.GeneratePerturbedLabelSpokesOff ()</code> - Enable drawing spokes (lines) to anchor point coordinates that were perturbed for being coincident with other anchor point coordinates. </li>
<li>
<code>bool = obj.GetUseDepthBuffer ()</code> - Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default. </li>
<li>
<code>obj.SetUseDepthBuffer (bool )</code> - Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default. </li>
<li>
<code>obj.UseDepthBufferOn ()</code> - Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default. </li>
<li>
<code>obj.UseDepthBufferOff ()</code> - Use the depth buffer to test each label to see if it should not be displayed if it would be occluded by other objects in the scene. Off by default. </li>
<li>
<code>obj.SetPlaceAllLabels (bool )</code> - Tells the placer to place every label regardless of overlap. Off by default. </li>
<li>
<code>bool = obj.GetPlaceAllLabels ()</code> - Tells the placer to place every label regardless of overlap. Off by default. </li>
<li>
<code>obj.PlaceAllLabelsOn ()</code> - Tells the placer to place every label regardless of overlap. Off by default. </li>
<li>
<code>obj.PlaceAllLabelsOff ()</code> - Tells the placer to place every label regardless of overlap. Off by default. </li>
<li>
<code>obj.SetOutputTraversedBounds (bool )</code> - Whether to render traversed bounds. Off by default. </li>
<li>
<code>bool = obj.GetOutputTraversedBounds ()</code> - Whether to render traversed bounds. Off by default. </li>
<li>
<code>obj.OutputTraversedBoundsOn ()</code> - Whether to render traversed bounds. Off by default. </li>
<li>
<code>obj.OutputTraversedBoundsOff ()</code> - Whether to render traversed bounds. Off by default. </li>
<li>
<code>obj.SetShape (int )</code> - The shape of the label background, should be one of the values in the LabelShape enumeration. </li>
<li>
<code>int = obj.GetShapeMinValue ()</code> - The shape of the label background, should be one of the values in the LabelShape enumeration. </li>
<li>
<code>int = obj.GetShapeMaxValue ()</code> - The shape of the label background, should be one of the values in the LabelShape enumeration. </li>
<li>
<code>int = obj.GetShape ()</code> - The shape of the label background, should be one of the values in the LabelShape enumeration. </li>
<li>
<code>obj.SetShapeToNone ()</code> - The shape of the label background, should be one of the values in the LabelShape enumeration. </li>
<li>
<code>obj.SetShapeToRect ()</code> - The shape of the label background, should be one of the values in the LabelShape enumeration. </li>
<li>
<code>obj.SetShapeToRoundedRect ()</code> - The style of the label background shape, should be one of the values in the LabelStyle enumeration. </li>
<li>
<code>obj.SetStyle (int )</code> - The style of the label background shape, should be one of the values in the LabelStyle enumeration. </li>
<li>
<code>int = obj.GetStyleMinValue ()</code> - The style of the label background shape, should be one of the values in the LabelStyle enumeration. </li>
<li>
<code>int = obj.GetStyleMaxValue ()</code> - The style of the label background shape, should be one of the values in the LabelStyle enumeration. </li>
<li>
<code>int = obj.GetStyle ()</code> - The style of the label background shape, should be one of the values in the LabelStyle enumeration. </li>
<li>
<code>obj.SetStyleToFilled ()</code> - The style of the label background shape, should be one of the values in the LabelStyle enumeration. </li>
<li>
<code>obj.SetStyleToOutline ()</code> - The size of the margin on the label background shape. Default is 5. </li>
<li>
<code>obj.SetMargin (double )</code> - The size of the margin on the label background shape. Default is 5. </li>
<li>
<code>double = obj.GetMargin ()</code> - The size of the margin on the label background shape. Default is 5. </li>
<li>
<code>obj.SetBackgroundColor (double , double , double )</code> - The color of the background shape. </li>
<li>
<code>obj.SetBackgroundColor (double a[3])</code> - The color of the background shape. </li>
<li>
<code>double = obj. GetBackgroundColor ()</code> - The color of the background shape. </li>
<li>
<code>obj.SetBackgroundOpacity (double )</code> - The opacity of the background shape. </li>
<li>
<code>double = obj.GetBackgroundOpacityMinValue ()</code> - The opacity of the background shape. </li>
<li>
<code>double = obj.GetBackgroundOpacityMaxValue ()</code> - The opacity of the background shape. </li>
<li>
<code>double = obj.GetBackgroundOpacity ()</code> - The opacity of the background shape. </li>
<li>
<code>vtkCoordinate = obj.GetAnchorTransform ()</code> - Get the transform for the anchor points. </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_vtkrendering.html">Visualization Toolkit Rendering Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:35 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>
|
