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
|
<!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: vtkProperty2D</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('vtkcommon_vtkproperty2d.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkProperty2D </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkcommon.html">Visualization Toolkit Common Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkProperty2D contains properties used to render two dimensional images and annotations.</p>
<p>To create an instance of class vtkProperty2D, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkProperty2D
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkProperty2D 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 vtkProperty2D class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkProperty2D = obj.NewInstance ()</code> </li>
<li>
<code>vtkProperty2D = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.DeepCopy (vtkProperty2D p)</code> - Assign one property to another. </li>
<li>
<code>obj.SetColor (double , double , double )</code> - Set/Get the RGB color of this property. </li>
<li>
<code>obj.SetColor (double a[3])</code> - Set/Get the RGB color of this property. </li>
<li>
<code>double = obj. GetColor ()</code> - Set/Get the RGB color of this property. </li>
<li>
<code>double = obj.GetOpacity ()</code> - Set/Get the Opacity of this property. </li>
<li>
<code>obj.SetOpacity (double )</code> - Set/Get the Opacity of this property. </li>
<li>
<code>obj.SetPointSize (float )</code> - Set/Get the diameter of a Point. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>float = obj.GetPointSizeMinValue ()</code> - Set/Get the diameter of a Point. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>float = obj.GetPointSizeMaxValue ()</code> - Set/Get the diameter of a Point. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>float = obj.GetPointSize ()</code> - Set/Get the diameter of a Point. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>obj.SetLineWidth (float )</code> - Set/Get the width of a Line. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>float = obj.GetLineWidthMinValue ()</code> - Set/Get the width of a Line. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>float = obj.GetLineWidthMaxValue ()</code> - Set/Get the width of a Line. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>float = obj.GetLineWidth ()</code> - Set/Get the width of a Line. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. </li>
<li>
<code>obj.SetLineStipplePattern (int )</code> - Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). This is only implemented for OpenGL. The default is 0xFFFF. </li>
<li>
<code>int = obj.GetLineStipplePattern ()</code> - Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). This is only implemented for OpenGL. The default is 0xFFFF. </li>
<li>
<code>obj.SetLineStippleRepeatFactor (int )</code> - Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1. </li>
<li>
<code>int = obj.GetLineStippleRepeatFactorMinValue ()</code> - Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1. </li>
<li>
<code>int = obj.GetLineStippleRepeatFactorMaxValue ()</code> - Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1. </li>
<li>
<code>int = obj.GetLineStippleRepeatFactor ()</code> - Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1. </li>
<li>
<code>obj.SetDisplayLocation (int )</code> - The DisplayLocation is either background or foreground. If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is background, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport. </li>
<li>
<code>int = obj.GetDisplayLocationMinValue ()</code> - The DisplayLocation is either background or foreground. If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is background, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport. </li>
<li>
<code>int = obj.GetDisplayLocationMaxValue ()</code> - The DisplayLocation is either background or foreground. If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is background, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport. </li>
<li>
<code>int = obj.GetDisplayLocation ()</code> - The DisplayLocation is either background or foreground. If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is background, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport. </li>
<li>
<code>obj.SetDisplayLocationToBackground ()</code> - The DisplayLocation is either background or foreground. If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is background, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport. </li>
<li>
<code>obj.SetDisplayLocationToForeground ()</code> - The DisplayLocation is either background or foreground. If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is background, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport. </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_vtkcommon.html">Visualization Toolkit Common Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:30 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>
|
