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
|
<!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: vtkActor2D</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('vtkfiltering_vtkactor2d.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkActor2D </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkfiltering.html">Visualization Toolkit Filtering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkActor2D is similar to vtkActor, but it is made to be used with two dimensional images and annotation. vtkActor2D has a position but does not use a transformation matrix like vtkActor (see the superclass vtkProp for information on positioning vtkActor2D). vtkActor2D has a reference to a vtkMapper2D object which does the rendering.</p>
<p>To create an instance of class vtkActor2D, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkActor2D
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkActor2D 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 vtkActor2D class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkActor2D = obj.NewInstance ()</code> </li>
<li>
<code>vtkActor2D = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.RenderOverlay (vtkViewport viewport)</code> - Support the standard render methods. </li>
<li>
<code>int = obj.RenderOpaqueGeometry (vtkViewport viewport)</code> - Support the standard render methods. </li>
<li>
<code>int = obj.RenderTranslucentPolygonalGeometry (vtkViewport viewport)</code> - Support the standard render methods. </li>
<li>
<code>int = obj.HasTranslucentPolygonalGeometry ()</code> - Does this prop have some translucent polygonal geometry? </li>
<li>
<code>obj.SetMapper (vtkMapper2D mapper)</code> - Set/Get the vtkMapper2D which defines the data to be drawn. </li>
<li>
<code>vtkMapper2D = obj.GetMapper ()</code> - Set/Get the vtkMapper2D which defines the data to be drawn. </li>
<li>
<code>obj.SetLayerNumber (int )</code> - Set/Get the layer number in the overlay planes into which to render. </li>
<li>
<code>int = obj.GetLayerNumber ()</code> - Set/Get the layer number in the overlay planes into which to render. </li>
<li>
<code>vtkProperty2D = obj.GetProperty ()</code> - Returns this actor's vtkProperty2D. Creates a property if one doesn't already exist. </li>
<li>
<code>obj.SetProperty (vtkProperty2D )</code> - Set this vtkProp's vtkProperty2D. </li>
<li>
<code>vtkCoordinate = obj.GetPositionCoordinate ()</code> - Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D </li>
<li>
<code>obj.SetPosition (double, double)</code> - Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D </li>
<li>
<code>obj.SetPosition (double a[2])</code> - Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D </li>
<li>
<code>double = obj.GetPosition ()</code> - Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D </li>
<li>
<code>obj.SetDisplayPosition (int , int )</code> - Set the Prop2D's position in display coordinates. </li>
<li>
<code>vtkCoordinate = obj.GetPosition2Coordinate ()</code> - Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable </li>
<li>
<code>obj.SetPosition2 (double, double)</code> - Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable </li>
<li>
<code>obj.SetPosition2 (double a[2])</code> - Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable </li>
<li>
<code>double = obj.GetPosition2 ()</code> - Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable </li>
<li>
<code>obj.SetWidth (double w)</code> - Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable. </li>
<li>
<code>double = obj.GetWidth ()</code> - Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable. </li>
<li>
<code>obj.SetHeight (double h)</code> - Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable. </li>
<li>
<code>double = obj.GetHeight ()</code> - Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable. </li>
<li>
<code>long = obj.GetMTime ()</code> - Return this objects MTime. </li>
<li>
<code>obj.GetActors2D (vtkPropCollection pc)</code> - For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process. </li>
<li>
<code>obj.ShallowCopy (vtkProp prop)</code> - Shallow copy of this vtkActor2D. Overloads the virtual vtkProp method. </li>
<li>
<code>obj.ReleaseGraphicsResources (vtkWindow )</code> - Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release. </li>
<li>
<code>vtkCoordinate = obj.GetActualPositionCoordinate (void )</code> - Return the actual vtkCoordinate reference that the mapper should use to position the actor. This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored. </li>
<li>
<code>vtkCoordinate = obj.GetActualPosition2Coordinate (void )</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_vtkfiltering.html">Visualization Toolkit Filtering 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>
|
