Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
class_c_s_d462_1_1_viewer.html 12.3 KB
Newer Older
Nick Sharp's avatar
Initial commit  
Nick Sharp committed
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260 
<!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"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>CSD462 Library Documentation: CSD462::Viewer Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</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">CSD462 Library Documentation
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">15-462/15-662: Computer Graphics (Fall 2015)</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>CSD462</b></li><li class="navelem"><a class="el" href="class_c_s_d462_1_1_viewer.html">Viewer</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_c_s_d462_1_1_viewer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CSD462::Viewer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Provides OpenGL context, window display, and event handling routines.  
 <a href="class_c_s_d462_1_1_viewer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="viewer_8h_source.html">viewer.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19d29efdf881d9ac2a257e592a5d2f3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a19d29efdf881d9ac2a257e592a5d2f3e">Viewer</a> (void)</td></tr>
<tr class="memdesc:a19d29efdf881d9ac2a257e592a5d2f3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a19d29efdf881d9ac2a257e592a5d2f3e">More...</a><br /></td></tr>
<tr class="separator:a19d29efdf881d9ac2a257e592a5d2f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9cc961cc9a3966f9191a1ddad256642"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#ad9cc961cc9a3966f9191a1ddad256642">Viewer</a> (const char *title)</td></tr>
<tr class="memdesc:ad9cc961cc9a3966f9191a1ddad256642"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad9cc961cc9a3966f9191a1ddad256642">More...</a><br /></td></tr>
<tr class="separator:ad9cc961cc9a3966f9191a1ddad256642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a934c617c4669a38c6b097b96acbd3dde"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a934c617c4669a38c6b097b96acbd3dde">~Viewer</a> (void)</td></tr>
<tr class="memdesc:a934c617c4669a38c6b097b96acbd3dde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a934c617c4669a38c6b097b96acbd3dde">More...</a><br /></td></tr>
<tr class="separator:a934c617c4669a38c6b097b96acbd3dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a020f41a5af51fd3d797f22d414da43f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a020f41a5af51fd3d797f22d414da43f1">init</a> (void)</td></tr>
<tr class="memdesc:a020f41a5af51fd3d797f22d414da43f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the viewer.  <a href="#a020f41a5af51fd3d797f22d414da43f1">More...</a><br /></td></tr>
<tr class="separator:a020f41a5af51fd3d797f22d414da43f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4b8928c167634cb882081dd63294735"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#ab4b8928c167634cb882081dd63294735">start</a> (void)</td></tr>
<tr class="memdesc:ab4b8928c167634cb882081dd63294735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the drawing loop of the viewer.  <a href="#ab4b8928c167634cb882081dd63294735">More...</a><br /></td></tr>
<tr class="separator:ab4b8928c167634cb882081dd63294735"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a024db44ae25cd5e4d9110c0530f71520"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_d462_1_1_viewer.html#a024db44ae25cd5e4d9110c0530f71520">set_renderer</a> (<a class="el" href="class_c_s_d462_1_1_renderer.html">Renderer</a> *renderer)</td></tr>
<tr class="memdesc:a024db44ae25cd5e4d9110c0530f71520"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a user space renderer.  <a href="#a024db44ae25cd5e4d9110c0530f71520">More...</a><br /></td></tr>
<tr class="separator:a024db44ae25cd5e4d9110c0530f71520"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides OpenGL context, window display, and event handling routines. </p>
<p>A user application may draw to the window's context by providing a user renderer. The viewer manages other display components such as the zoom views, text OSD, etc. It also takes care of window event handling and event passing, through which the renderer may interact with user inputs. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a19d29efdf881d9ac2a257e592a5d2f3e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Viewer::Viewer </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Creates a new viewer with the default title (CSD462). </p>

</div>
</div>
<a class="anchor" id="ad9cc961cc9a3966f9191a1ddad256642"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Viewer::Viewer </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>title</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>Creates a new viweer with the given title. </p>

</div>
</div>
<a class="anchor" id="a934c617c4669a38c6b097b96acbd3dde"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSD462::Viewer::~Viewer </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>
<p>Destroys the viewer instance and frees memory. Note that this does not change the user space renderer. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a020f41a5af51fd3d797f22d414da43f1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSD462::Viewer::init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the viewer. </p>
<p>This will open up a window and install all the event handlers and make the viewer ready for drawing. </p>

</div>
</div>
<a class="anchor" id="ab4b8928c167634cb882081dd63294735"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSD462::Viewer::start </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start the drawing loop of the viewer. </p>
<p>Once called this will block until the viewer is close. </p>

</div>
</div>
<a class="anchor" id="a024db44ae25cd5e4d9110c0530f71520"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSD462::Viewer::set_renderer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_c_s_d462_1_1_renderer.html">Renderer</a> *&#160;</td>
          <td class="paramname"><em>renderer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set a user space renderer. </p>
<p>The viewer will use the given user space renderer in drawing. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">renderer</td><td>The user space renderer to use in the viewer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lib/<a class="el" href="viewer_8h_source.html">viewer.h</a></li>
<li>lib/viewer.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 1 2015 14:30:00 for CSD462 Library Documentation by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>