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
|
<!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: vtkXOpenGLRenderWindow</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_vtkxopenglrenderwindow.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkXOpenGLRenderWindow </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>vtkXOpenGLRenderWindow is a concrete implementation of the abstract class vtkRenderWindow. vtkOpenGLRenderer interfaces to the OpenGL graphics library. Application programmers should normally use vtkRenderWindow instead of the OpenGL specific version.</p>
<p>To create an instance of class vtkXOpenGLRenderWindow, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkXOpenGLRenderWindow
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkXOpenGLRenderWindow 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 vtkXOpenGLRenderWindow class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkXOpenGLRenderWindow = obj.NewInstance ()</code> </li>
<li>
<code>vtkXOpenGLRenderWindow = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.Start (void )</code> - Begin the rendering process. </li>
<li>
<code>obj.Frame (void )</code> - End the rendering process and display the image. </li>
<li>
<code>obj.WindowInitialize (void )</code> - Initialize the window for rendering. </li>
<li>
<code>obj.Initialize (void )</code> - Initialize the rendering window. This will setup all system-specific resources. This method and Finalize() must be symmetric and it should be possible to call them multiple times, even changing WindowId in-between. This is what WindowRemap does. </li>
<li>
<code>obj.Finalize (void )</code> - "Deinitialize" the rendering window. This will shutdown all system-specific resources. After having called this, it should be possible to destroy a window that was used for a SetWindowId() call without any ill effects. </li>
<li>
<code>obj.SetFullScreen (int )</code> - Change the window to fill the entire screen. </li>
<li>
<code>obj.WindowRemap (void )</code> - Resize the window. </li>
<li>
<code>obj.PrefFullScreen (void )</code> - Set the preferred window size to full screen. </li>
<li>
<code>obj.SetSize (int , int )</code> - Specify the size of the rendering window in pixels. </li>
<li>
<code>obj.SetSize (int a[2])</code> - Specify the size of the rendering window in pixels. </li>
<li>
<code>int = obj.GetDesiredDepth ()</code> - Get the X properties of an ideal rendering window. </li>
<li>
<code>obj.SetStereoCapableWindow (int capable)</code> - Prescribe that the window be created in a stereo-capable mode. This method must be called before the window is realized. This method overrides the superclass method since this class can actually check whether the window has been realized yet. </li>
<li>
<code>obj.MakeCurrent ()</code> - Make this window the current OpenGL context. </li>
<li>
<code>bool = obj.IsCurrent ()</code> - Tells if this window is the current OpenGL context for the calling thread. </li>
<li>
<code>obj.SetForceMakeCurrent ()</code> - If called, allow MakeCurrent() to skip cache-check when called. MakeCurrent() reverts to original behavior of cache-checking on the next render. </li>
<li>
<code>string = obj.ReportCapabilities ()</code> - Get report of capabilities for the render window </li>
<li>
<code>int = obj.SupportsOpenGL ()</code> - Does this render window support OpenGL? 0-false, 1-true </li>
<li>
<code>int = obj.IsDirect ()</code> - Is this render window using hardware acceleration? 0-false, 1-true </li>
<li>
<code>obj.SetWindowName (string )</code> </li>
<li>
<code>obj.SetPosition (int , int )</code> - Move the window to a new position on the display. </li>
<li>
<code>obj.SetPosition (int a[2])</code> - Move the window to a new position on the display. </li>
<li>
<code>obj.HideCursor ()</code> - Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead. </li>
<li>
<code>obj.ShowCursor ()</code> - Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead. </li>
<li>
<code>obj.SetCurrentCursor (int )</code> - Change the shape of the cursor </li>
<li>
<code>int = obj.GetEventPending ()</code> - Check to see if a mouse button has been pressed. All other events are ignored by this method. This is a useful check to abort a long render. </li>
<li>
<code>obj.SetWindowInfo (string info)</code> - Set this RenderWindow's X window id to a pre-existing window. </li>
<li>
<code>obj.SetNextWindowInfo (string info)</code> - Set the window info that will be used after WindowRemap() </li>
<li>
<code>obj.SetParentInfo (string info)</code> - Sets the X window id of the window that WILL BE created. </li>
<li>
<code>obj.Render ()</code> - This computes the size of the render window before calling the supper classes render </li>
<li>
<code>obj.SetOffScreenRendering (int i)</code> - Render without displaying the window. </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:36 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>
|
