-
Notifications
You must be signed in to change notification settings - Fork 0
/
class_open_g_p_1_1_depth_render_component.html
243 lines (234 loc) · 18.4 KB
/
class_open_g_p_1_1_depth_render_component.html
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
<!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.11"/>
<title>OpenGP: OpenGP::DepthRenderComponent 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" />
<link href="style.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenGP
 <span id="projectnumber">1.1</span>
</div>
<div id="projectbrief">Open Geometry Processing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 Page</span></a></li>
<li><a href="tutorial.html"><span>Tutorial</span></a></li>
<li><a href="devel.html"><span>Development</span></a></li>
<li><a href="annotated.html"><span>Reference Manual</span></a></li>
<li><a href="https://github.com/OpenGP/OpenGP/issues"><span>Report Bug</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>
<!-- 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>OpenGP</b></li><li class="navelem"><a class="el" href="class_open_g_p_1_1_depth_render_component.html">DepthRenderComponent</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="class_open_g_p_1_1_depth_render_component-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OpenGP::DepthRenderComponent Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A component representing some geometry that may be rendered to a depthmap.
<a href="class_open_g_p_1_1_depth_render_component.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_depth_render_component_8h_source.html">DepthRenderComponent.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for OpenGP::DepthRenderComponent:</div>
<div class="dyncontent">
<div class="center">
<img src="class_open_g_p_1_1_depth_render_component.png" usemap="#OpenGP::DepthRenderComponent_map" alt=""/>
<map id="OpenGP::DepthRenderComponent_map" name="OpenGP::DepthRenderComponent_map">
<area href="class_open_g_p_1_1_component.html" title="The base class for all components. " alt="OpenGP::Component" shape="rect" coords="0,0,203,24"/>
</map>
</div></div>
<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:a5476a499638b6a4f92f420c4e2e9450a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_depth_render_component.html#a5476a499638b6a4f92f420c4e2e9450a">init</a> ()</td></tr>
<tr class="memdesc:a5476a499638b6a4f92f420c4e2e9450a"><td class="mdescLeft"> </td><td class="mdescRight">Overridable method that handles object initialization. <a href="#a5476a499638b6a4f92f420c4e2e9450a">More...</a><br /></td></tr>
<tr class="separator:a5476a499638b6a4f92f420c4e2e9450a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c3051117329a5fba64c200a4ad0f137"><td class="memTemplParams" colspan="2"><a class="anchor" id="a5c3051117329a5fba64c200a4ad0f137"></a>
template<typename T , typename... Args> </td></tr>
<tr class="memitem:a5c3051117329a5fba64c200a4ad0f137"><td class="memTemplItemLeft" align="right" valign="top">T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_depth_render_component.html#a5c3051117329a5fba64c200a4ad0f137">set_renderer</a> (Args &...args)</td></tr>
<tr class="memdesc:a5c3051117329a5fba64c200a4ad0f137"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new renderer of type <code>T</code> with the given arguments. <br /></td></tr>
<tr class="separator:a5c3051117329a5fba64c200a4ad0f137"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc3cd90e29515681c686e1a070b428bd"><td class="memTemplParams" colspan="2">template<typename T = DepthmapRenderer> </td></tr>
<tr class="memitem:abc3cd90e29515681c686e1a070b428bd"><td class="memTemplItemLeft" align="right" valign="top">T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_depth_render_component.html#abc3cd90e29515681c686e1a070b428bd">get_renderer</a> ()</td></tr>
<tr class="memdesc:abc3cd90e29515681c686e1a070b428bd"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the renderer. <a href="#abc3cd90e29515681c686e1a070b428bd">More...</a><br /></td></tr>
<tr class="separator:abc3cd90e29515681c686e1a070b428bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_open_g_p_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_open_g_p_1_1_component')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_open_g_p_1_1_component.html">OpenGP::Component</a></td></tr>
<tr class="memitem:ad547b8d6d1d379ade1c877f8f2eb93a2 inherit pub_methods_class_open_g_p_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad547b8d6d1d379ade1c877f8f2eb93a2"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#ad547b8d6d1d379ade1c877f8f2eb93a2">update</a> ()</td></tr>
<tr class="memdesc:ad547b8d6d1d379ade1c877f8f2eb93a2 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Overridable method that handles per-frame updates. <br /></td></tr>
<tr class="separator:ad547b8d6d1d379ade1c877f8f2eb93a2 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0585c66874d2c2c4c75973f512e8f9c2 inherit pub_methods_class_open_g_p_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0585c66874d2c2c4c75973f512e8f9c2"></a>
<a class="el" href="class_open_g_p_1_1_entity.html">Entity</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#a0585c66874d2c2c4c75973f512e8f9c2">get_entity</a> ()</td></tr>
<tr class="memdesc:a0585c66874d2c2c4c75973f512e8f9c2 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the entity that holds this component. <br /></td></tr>
<tr class="separator:a0585c66874d2c2c4c75973f512e8f9c2 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03aec52728d4ee789fb3177b5e9fe177 inherit pub_methods_class_open_g_p_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03aec52728d4ee789fb3177b5e9fe177"></a>
const <a class="el" href="class_open_g_p_1_1_entity.html">Entity</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#a03aec52728d4ee789fb3177b5e9fe177">get_entity</a> () const </td></tr>
<tr class="memdesc:a03aec52728d4ee789fb3177b5e9fe177 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the entity that holds this component. <br /></td></tr>
<tr class="separator:a03aec52728d4ee789fb3177b5e9fe177 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad73f971d5d134c44267bbfb107cd5338 inherit pub_methods_class_open_g_p_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad73f971d5d134c44267bbfb107cd5338"></a>
<a class="el" href="class_open_g_p_1_1_scene.html">Scene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#ad73f971d5d134c44267bbfb107cd5338">get_scene</a> ()</td></tr>
<tr class="memdesc:ad73f971d5d134c44267bbfb107cd5338 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the scene that contains the parent entity. <br /></td></tr>
<tr class="separator:ad73f971d5d134c44267bbfb107cd5338 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56455f0b87a4e9967cf848a8c5a28ca3 inherit pub_methods_class_open_g_p_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56455f0b87a4e9967cf848a8c5a28ca3"></a>
const <a class="el" href="class_open_g_p_1_1_scene.html">Scene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#a56455f0b87a4e9967cf848a8c5a28ca3">get_scene</a> () const </td></tr>
<tr class="memdesc:a56455f0b87a4e9967cf848a8c5a28ca3 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the scene that contains the parent entity. <br /></td></tr>
<tr class="separator:a56455f0b87a4e9967cf848a8c5a28ca3 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af019a7d403976e4432630e11e3c38f19 inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplParams" colspan="2"><a class="anchor" id="af019a7d403976e4432630e11e3c38f19"></a>
template<typename T > </td></tr>
<tr class="memitem:af019a7d403976e4432630e11e3c38f19 inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplItemLeft" align="right" valign="top">T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#af019a7d403976e4432630e11e3c38f19">require</a> ()</td></tr>
<tr class="memdesc:af019a7d403976e4432630e11e3c38f19 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Add the specified component to the parent entity if it does not already exist. <br /></td></tr>
<tr class="separator:af019a7d403976e4432630e11e3c38f19 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8fe58136c84677cdc49422a6723e9f7 inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplParams" colspan="2"><a class="anchor" id="af8fe58136c84677cdc49422a6723e9f7"></a>
template<typename T > </td></tr>
<tr class="memitem:af8fe58136c84677cdc49422a6723e9f7 inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#af8fe58136c84677cdc49422a6723e9f7">has</a> ()</td></tr>
<tr class="memdesc:af8fe58136c84677cdc49422a6723e9f7 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Check if the parent entity has the specified component. <br /></td></tr>
<tr class="separator:af8fe58136c84677cdc49422a6723e9f7 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a830c1ad8fcbb94f78effea9a8889ba9c inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplParams" colspan="2"><a class="anchor" id="a830c1ad8fcbb94f78effea9a8889ba9c"></a>
template<typename T > </td></tr>
<tr class="memitem:a830c1ad8fcbb94f78effea9a8889ba9c inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplItemLeft" align="right" valign="top">T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#a830c1ad8fcbb94f78effea9a8889ba9c">get</a> ()</td></tr>
<tr class="memdesc:a830c1ad8fcbb94f78effea9a8889ba9c inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the specified component in the parent entity. <br /></td></tr>
<tr class="separator:a830c1ad8fcbb94f78effea9a8889ba9c inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c5263675ca3895c66c06a61b40f3c71 inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4c5263675ca3895c66c06a61b40f3c71"></a>
template<typename T > </td></tr>
<tr class="memitem:a4c5263675ca3895c66c06a61b40f3c71 inherit pub_methods_class_open_g_p_1_1_component"><td class="memTemplItemLeft" align="right" valign="top">const T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_component.html#a4c5263675ca3895c66c06a61b40f3c71">get</a> () const </td></tr>
<tr class="memdesc:a4c5263675ca3895c66c06a61b40f3c71 inherit pub_methods_class_open_g_p_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to the specified component in the parent entity. <br /></td></tr>
<tr class="separator:a4c5263675ca3895c66c06a61b40f3c71 inherit pub_methods_class_open_g_p_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a34a165e6fdadd687ef241ec1ed275646"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34a165e6fdadd687ef241ec1ed275646"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_g_p_1_1_depth_render_component.html#a34a165e6fdadd687ef241ec1ed275646">visible</a> = true</td></tr>
<tr class="memdesc:a34a165e6fdadd687ef241ec1ed275646"><td class="mdescLeft"> </td><td class="mdescRight">Should the object be rendered. <br /></td></tr>
<tr class="separator:a34a165e6fdadd687ef241ec1ed275646"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A component representing some geometry that may be rendered to a depthmap. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abc3cd90e29515681c686e1a070b428bd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T = DepthmapRenderer> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T& OpenGP::DepthRenderComponent::get_renderer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a reference to the renderer. </p>
<p>The contained renderer must exist and be convertible to type <code>T&</code> </p>
</div>
</div>
<a class="anchor" id="a5476a499638b6a4f92f420c4e2e9450a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGP::DepthRenderComponent::init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overridable method that handles object initialization. </p>
<dl class="section warning"><dt>Warning</dt><dd>any initialization code that depends on the state of the entity, scene, or other components should go here, <b>not</b> in the constructor </dd></dl>
<p>Reimplemented from <a class="el" href="class_open_g_p_1_1_component.html#ae74cab2b81e83fa892e439b4e6941718">OpenGP::Component</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/drebain/Workspace/research/OpenGPFork/src/OpenGP/GL/Components/<a class="el" href="_depth_render_component_8h_source.html">DepthRenderComponent.h</a></li>
</ul>
</div><!-- contents -->
<div id="footer">
<!-- <address>
<small>
Copyright © 2013
</small>
</address> -->
</div>
</body>
</html>