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
|
<!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: vtkTextProperty</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_vtktextproperty.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkTextProperty </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>vtkTextProperty is an object that represents text properties. The primary properties that can be set are color, opacity, font size, font family horizontal and vertical justification, bold/italic/shadow styles.</p>
<p>To create an instance of class vtkTextProperty, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkTextProperty
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkTextProperty 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 vtkTextProperty class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkTextProperty = obj.NewInstance ()</code> </li>
<li>
<code>vtkTextProperty = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetColor (double , double , double )</code> - Set the color of the text. </li>
<li>
<code>obj.SetColor (double a[3])</code> - Set the color of the text. </li>
<li>
<code>double = obj. GetColor ()</code> - Set the color of the text. </li>
<li>
<code>obj.SetOpacity (double )</code> - Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent. </li>
<li>
<code>double = obj.GetOpacity ()</code> - Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent. </li>
<li>
<code>string = obj.GetFontFamilyAsString ()</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>obj.SetFontFamilyAsString (string )</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>obj.SetFontFamily (int t)</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>int = obj.GetFontFamily ()</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>int = obj.GetFontFamilyMinValue ()</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>obj.SetFontFamilyToArial ()</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>obj.SetFontFamilyToCourier ()</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>obj.SetFontFamilyToTimes ()</code> - Set/Get the font family. Supports legacy three font family system. </li>
<li>
<code>obj.SetFontSize (int )</code> - Set/Get the font size (in points). </li>
<li>
<code>int = obj.GetFontSizeMinValue ()</code> - Set/Get the font size (in points). </li>
<li>
<code>int = obj.GetFontSizeMaxValue ()</code> - Set/Get the font size (in points). </li>
<li>
<code>int = obj.GetFontSize ()</code> - Set/Get the font size (in points). </li>
<li>
<code>obj.SetBold (int )</code> - Enable/disable text bolding. </li>
<li>
<code>int = obj.GetBold ()</code> - Enable/disable text bolding. </li>
<li>
<code>obj.BoldOn ()</code> - Enable/disable text bolding. </li>
<li>
<code>obj.BoldOff ()</code> - Enable/disable text bolding. </li>
<li>
<code>obj.SetItalic (int )</code> - Enable/disable text italic. </li>
<li>
<code>int = obj.GetItalic ()</code> - Enable/disable text italic. </li>
<li>
<code>obj.ItalicOn ()</code> - Enable/disable text italic. </li>
<li>
<code>obj.ItalicOff ()</code> - Enable/disable text italic. </li>
<li>
<code>obj.SetShadow (int )</code> - Enable/disable text shadow. </li>
<li>
<code>int = obj.GetShadow ()</code> - Enable/disable text shadow. </li>
<li>
<code>obj.ShadowOn ()</code> - Enable/disable text shadow. </li>
<li>
<code>obj.ShadowOff ()</code> - Enable/disable text shadow. </li>
<li>
<code>obj.SetShadowOffset (int , int )</code> - Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize. </li>
<li>
<code>obj.SetShadowOffset (int a[2])</code> - Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize. </li>
<li>
<code>int = obj. GetShadowOffset ()</code> - Set/Get the shadow offset, i.e. the distance from the text to its shadow, in the same unit as FontSize. </li>
<li>
<code>obj.GetShadowColor (double color[3])</code> - Get the shadow color. It is computed from the Color ivar </li>
<li>
<code>obj.SetJustification (int )</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>int = obj.GetJustificationMinValue ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>int = obj.GetJustificationMaxValue ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>int = obj.GetJustification ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>obj.SetJustificationToLeft ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>obj.SetJustificationToCentered ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>obj.SetJustificationToRight ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>string = obj.GetJustificationAsString ()</code> - Set/Get the horizontal justification to left (default), centered, or right. </li>
<li>
<code>obj.SetVerticalJustification (int )</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>int = obj.GetVerticalJustificationMinValue ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>int = obj.GetVerticalJustificationMaxValue ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>int = obj.GetVerticalJustification ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>obj.SetVerticalJustificationToBottom ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>obj.SetVerticalJustificationToCentered ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>obj.SetVerticalJustificationToTop ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>string = obj.GetVerticalJustificationAsString ()</code> - Set/Get the vertical justification to bottom (default), middle, or top. </li>
<li>
<code>obj.SetOrientation (double )</code> - Set/Get the text's orientation (in degrees). </li>
<li>
<code>double = obj.GetOrientation ()</code> - Set/Get the text's orientation (in degrees). </li>
<li>
<code>obj.SetLineSpacing (double )</code> - Set/Get the (extra) spacing between lines, expressed as a text height multiplication factor. </li>
<li>
<code>double = obj.GetLineSpacing ()</code> - Set/Get the (extra) spacing between lines, expressed as a text height multiplication factor. </li>
<li>
<code>obj.SetLineOffset (double )</code> - Set/Get the vertical offset (measured in pixels). </li>
<li>
<code>double = obj.GetLineOffset ()</code> - Set/Get the vertical offset (measured in pixels). </li>
<li>
<code>obj.ShallowCopy (vtkTextProperty tprop)</code> - Shallow copy of a text property. </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>
|
