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
|
<!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: vtkTextMapper</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_vtktextmapper.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkTextMapper </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>vtkTextMapper provides 2D text annotation support for VTK. It is a vtkMapper2D that can be associated with a vtkActor2D and placed into a vtkRenderer.</p>
<p>To use vtkTextMapper, specify an input text string.</p>
<p>To create an instance of class vtkTextMapper, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkTextMapper
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkTextMapper 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 vtkTextMapper class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkTextMapper = obj.NewInstance ()</code> </li>
<li>
<code>vtkTextMapper = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.GetSize (vtkViewport , int size[2])</code> - Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels). </li>
<li>
<code>int = obj.GetWidth (vtkViewport v)</code> - Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels). </li>
<li>
<code>int = obj.GetHeight (vtkViewport v)</code> - Return the size[2]/width/height of the rectangle required to draw this mapper (in pixels). </li>
<li>
<code>obj.SetInput (string inputString)</code> - Set the input text string to the mapper. The mapper recognizes "\n" as a carriage return/linefeed (line separator). </li>
<li>
<code>string = obj.GetInput ()</code> - Set the input text string to the mapper. The mapper recognizes "\n" as a carriage return/linefeed (line separator). </li>
<li>
<code>obj.SetTextProperty (vtkTextProperty p)</code> - Set/Get the text property. </li>
<li>
<code>vtkTextProperty = obj.GetTextProperty ()</code> - Set/Get the text property. </li>
<li>
<code>obj.ShallowCopy (vtkTextMapper tm)</code> - Shallow copy of an actor. </li>
<li>
<code>int = obj.GetNumberOfLines (string input)</code> - Determine the number of lines in the input string (delimited by "\n"). </li>
<li>
<code>int = obj.GetNumberOfLines ()</code> - Get the number of lines in the input string (the method GetNumberOfLines(char*) must have been previously called for the return value to be valid). </li>
<li>
<code>int = obj.SetConstrainedFontSize (vtkViewport , int targetWidth, int targetHeight)</code> - Set and return the font size required to make this mapper fit in a given target rectangle (width x height, in pixels). A static version of the method is also available for convenience to other classes (e.g., widgets). </li>
<li>
<code>int = obj.GetSystemFontSize (int size)</code> </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>
|
