-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_point_light_8hpp_source.html
174 lines (172 loc) · 20.9 KB
/
_point_light_8hpp_source.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Rendu: src/engine/scene/lights/PointLight.hpp Source File</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Rendu
</div>
<div id="projectbrief">A lightweight rendering engine for experimentations</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2052808828190f934b76e979ee65af8a.html">engine</a></li><li class="navelem"><a class="el" href="dir_e7396cefb42403d530f4b4cb25fac8dc.html">scene</a></li><li class="navelem"><a class="el" href="dir_040e9f8fbffe21c184490dc7c9eb2371.html">lights</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">PointLight.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include "scene/lights/Light.hpp"</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "scene/Animated.hpp"</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "scene/Object.hpp"</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <array></span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_point_light.html"> 15</a></span><span class="keyword">class </span><a class="code hl_class" href="class_point_light.html">PointLight</a> final : <span class="keyword">public</span> <a class="code hl_class" href="class_light.html">Light</a> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_point_light.html#aead30d605c09f7ee16b01407693ad06a"> 19</a></span> <a class="code hl_function" href="class_point_light.html#aead30d605c09f7ee16b01407693ad06a">PointLight</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="class_point_light.html#aead30d605c09f7ee16b01407693ad06a">PointLight</a>(<span class="keyword">const</span> glm::vec3 & worldPosition, <span class="keyword">const</span> glm::vec3 & color, <span class="keywordtype">float</span> <a class="code hl_function" href="class_point_light.html#ab6f33ac38107e2bf60a1d4300ca40acc">radius</a>);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_point_light.html#a25e0b38ceb6fd459e90e72dc6b370636">draw</a>(<a class="code hl_class" href="class_light_renderer.html">LightRenderer</a> & renderer) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_point_light.html#ad6ec64c7e3a994fd8411cae4d3798dfa">update</a>(<span class="keywordtype">double</span> fullTime, <span class="keywordtype">double</span> frameTime) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_point_light.html#ac0627d1590a6d752598b34df84c52681">setScene</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_bounding_box.html">BoundingBox</a> & sceneBox) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> glm::vec3 <a class="code hl_function" href="class_point_light.html#af6d41041671d1a108626f913df9c291d">sample</a>(<span class="keyword">const</span> glm::vec3 & <a class="code hl_function" href="class_point_light.html#a799d62b0e3985973aab89321a97c4c01">position</a>, <span class="keywordtype">float</span> & dist, <span class="keywordtype">float</span> & attenuation) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_point_light.html#aa6e915095886501e27e4af8d9eddb41c">decode</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_key_values.html">KeyValues</a> & params);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_struct" href="struct_key_values.html">KeyValues</a> <a class="code hl_function" href="class_point_light.html#abf8e3d8b158df092926942a825340133">encode</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="class_point_light.html#a799d62b0e3985973aab89321a97c4c01"> 71</a></span> <span class="keyword">const</span> glm::vec3 & <a class="code hl_function" href="class_point_light.html#a799d62b0e3985973aab89321a97c4c01">position</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="class_point_light.html#a7053004a6a5f93c831d5bb5b28e1d27d">_lightPosition</a>; }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="class_point_light.html#ab6f33ac38107e2bf60a1d4300ca40acc"> 76</a></span> <span class="keywordtype">float</span> <a class="code hl_function" href="class_point_light.html#ab6f33ac38107e2bf60a1d4300ca40acc">radius</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="class_point_light.html#a60b435b6c141281436e8b2cfb621b139">_radius</a>; }</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="class_point_light.html#aac43879220b93e574b0d0cb9a4b56ea5"> 81</a></span> <span class="keywordtype">float</span> <a class="code hl_function" href="class_point_light.html#aac43879220b93e574b0d0cb9a4b56ea5">farPlane</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="class_point_light.html#afddde3565e7d7d484cbfbaef54d9fcfe">_farPlane</a>; }</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="class_point_light.html#a7fd2b3852f91e5eb30df3c0acb614375"> 86</a></span> <span class="keyword">const</span> std::array<glm::mat4, 6> & <a class="code hl_function" href="class_point_light.html#a7fd2b3852f91e5eb30df3c0acb614375">vpFaces</a>(){ <span class="keywordflow">return</span> <a class="code hl_variable" href="class_point_light.html#a0bb8aea096acbd57117644a09572ce55">_vps</a>; }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="class_point_light.html#a0bb8aea096acbd57117644a09572ce55"> 90</a></span> std::array<glm::mat4, 6> <a class="code hl_variable" href="class_point_light.html#a0bb8aea096acbd57117644a09572ce55">_vps</a>; </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="class_point_light.html#a7053004a6a5f93c831d5bb5b28e1d27d"> 91</a></span> <a class="code hl_class" href="class_animated.html">Animated<glm::vec3></a> <a class="code hl_variable" href="class_point_light.html#a7053004a6a5f93c831d5bb5b28e1d27d">_lightPosition</a> { glm::vec3(0.0f) }; </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="class_point_light.html#a60b435b6c141281436e8b2cfb621b139"> 92</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_point_light.html#a60b435b6c141281436e8b2cfb621b139">_radius</a> = 1.0f; </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="class_point_light.html#afddde3565e7d7d484cbfbaef54d9fcfe"> 93</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_point_light.html#afddde3565e7d7d484cbfbaef54d9fcfe">_farPlane</a> = 1.0f; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>};</div>
<div class="ttc" id="aclass_animated_html"><div class="ttname"><a href="class_animated.html">Animated</a></div><div class="ttdoc">Wraps an animated property so that the initial value is preserved.</div><div class="ttdef"><b>Definition:</b> Animated.hpp:11</div></div>
<div class="ttc" id="aclass_bounding_box_html"><div class="ttname"><a href="class_bounding_box.html">BoundingBox</a></div><div class="ttdoc">Represent the smallest axis-aligne box containing a given object or region of space.</div><div class="ttdef"><b>Definition:</b> Bounds.hpp:28</div></div>
<div class="ttc" id="aclass_light_html"><div class="ttname"><a href="class_light.html">Light</a></div><div class="ttdoc">A general light with adjustable color intensity, that can cast shadows.</div><div class="ttdef"><b>Definition:</b> Light.hpp:20</div></div>
<div class="ttc" id="aclass_light_renderer_html"><div class="ttname"><a href="class_light_renderer.html">LightRenderer</a></div><div class="ttdoc">Base structure of a per-light specialized renderer.</div><div class="ttdef"><b>Definition:</b> LightRenderer.hpp:13</div></div>
<div class="ttc" id="aclass_point_light_html"><div class="ttname"><a href="class_point_light.html">PointLight</a></div><div class="ttdoc">An omnidirectional punctual light, where light is radiating in all directions from a single point in ...</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:15</div></div>
<div class="ttc" id="aclass_point_light_html_a0bb8aea096acbd57117644a09572ce55"><div class="ttname"><a href="class_point_light.html#a0bb8aea096acbd57117644a09572ce55">PointLight::_vps</a></div><div class="ttdeci">std::array< glm::mat4, 6 > _vps</div><div class="ttdoc">Light VP matrices for each face.</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:90</div></div>
<div class="ttc" id="aclass_point_light_html_a25e0b38ceb6fd459e90e72dc6b370636"><div class="ttname"><a href="class_point_light.html#a25e0b38ceb6fd459e90e72dc6b370636">PointLight::draw</a></div><div class="ttdeci">void draw(LightRenderer &renderer) override</div><div class="ttdef"><b>Definition:</b> PointLight.cpp:12</div></div>
<div class="ttc" id="aclass_point_light_html_a60b435b6c141281436e8b2cfb621b139"><div class="ttname"><a href="class_point_light.html#a60b435b6c141281436e8b2cfb621b139">PointLight::_radius</a></div><div class="ttdeci">float _radius</div><div class="ttdoc">The attenuation radius.</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:92</div></div>
<div class="ttc" id="aclass_point_light_html_a7053004a6a5f93c831d5bb5b28e1d27d"><div class="ttname"><a href="class_point_light.html#a7053004a6a5f93c831d5bb5b28e1d27d">PointLight::_lightPosition</a></div><div class="ttdeci">Animated< glm::vec3 > _lightPosition</div><div class="ttdoc">Light position.</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:91</div></div>
<div class="ttc" id="aclass_point_light_html_a799d62b0e3985973aab89321a97c4c01"><div class="ttname"><a href="class_point_light.html#a799d62b0e3985973aab89321a97c4c01">PointLight::position</a></div><div class="ttdeci">const glm::vec3 & position() const</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:71</div></div>
<div class="ttc" id="aclass_point_light_html_a7fd2b3852f91e5eb30df3c0acb614375"><div class="ttname"><a href="class_point_light.html#a7fd2b3852f91e5eb30df3c0acb614375">PointLight::vpFaces</a></div><div class="ttdeci">const std::array< glm::mat4, 6 > & vpFaces()</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:86</div></div>
<div class="ttc" id="aclass_point_light_html_aa6e915095886501e27e4af8d9eddb41c"><div class="ttname"><a href="class_point_light.html#aa6e915095886501e27e4af8d9eddb41c">PointLight::decode</a></div><div class="ttdeci">bool decode(const KeyValues &params)</div><div class="ttdef"><b>Definition:</b> PointLight.cpp:89</div></div>
<div class="ttc" id="aclass_point_light_html_aac43879220b93e574b0d0cb9a4b56ea5"><div class="ttname"><a href="class_point_light.html#aac43879220b93e574b0d0cb9a4b56ea5">PointLight::farPlane</a></div><div class="ttdeci">float farPlane() const</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:81</div></div>
<div class="ttc" id="aclass_point_light_html_ab6f33ac38107e2bf60a1d4300ca40acc"><div class="ttname"><a href="class_point_light.html#ab6f33ac38107e2bf60a1d4300ca40acc">PointLight::radius</a></div><div class="ttdeci">float radius() const</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:76</div></div>
<div class="ttc" id="aclass_point_light_html_abf8e3d8b158df092926942a825340133"><div class="ttname"><a href="class_point_light.html#abf8e3d8b158df092926942a825340133">PointLight::encode</a></div><div class="ttdeci">KeyValues encode() const override</div><div class="ttdef"><b>Definition:</b> PointLight.cpp:101</div></div>
<div class="ttc" id="aclass_point_light_html_ac0627d1590a6d752598b34df84c52681"><div class="ttname"><a href="class_point_light.html#ac0627d1590a6d752598b34df84c52681">PointLight::setScene</a></div><div class="ttdeci">void setScene(const BoundingBox &sceneBox) override</div><div class="ttdef"><b>Definition:</b> PointLight.cpp:25</div></div>
<div class="ttc" id="aclass_point_light_html_ad6ec64c7e3a994fd8411cae4d3798dfa"><div class="ttname"><a href="class_point_light.html#ad6ec64c7e3a994fd8411cae4d3798dfa">PointLight::update</a></div><div class="ttdeci">void update(double fullTime, double frameTime) override</div><div class="ttdef"><b>Definition:</b> PointLight.cpp:16</div></div>
<div class="ttc" id="aclass_point_light_html_aead30d605c09f7ee16b01407693ad06a"><div class="ttname"><a href="class_point_light.html#aead30d605c09f7ee16b01407693ad06a">PointLight::PointLight</a></div><div class="ttdeci">PointLight()=default</div></div>
<div class="ttc" id="aclass_point_light_html_af6d41041671d1a108626f913df9c291d"><div class="ttname"><a href="class_point_light.html#af6d41041671d1a108626f913df9c291d">PointLight::sample</a></div><div class="ttdeci">glm::vec3 sample(const glm::vec3 &position, float &dist, float &attenuation) const override</div><div class="ttdef"><b>Definition:</b> PointLight.cpp:68</div></div>
<div class="ttc" id="aclass_point_light_html_afddde3565e7d7d484cbfbaef54d9fcfe"><div class="ttname"><a href="class_point_light.html#afddde3565e7d7d484cbfbaef54d9fcfe">PointLight::_farPlane</a></div><div class="ttdeci">float _farPlane</div><div class="ttdoc">The projection matrices far plane.</div><div class="ttdef"><b>Definition:</b> PointLight.hpp:93</div></div>
<div class="ttc" id="astruct_key_values_html"><div class="ttname"><a href="struct_key_values.html">KeyValues</a></div><div class="ttdoc">Represent a key-values tuple.</div><div class="ttdef"><b>Definition:</b> Config.hpp:9</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a> 1.9.5
- Theme by <a href="http://simonrodriguez.fr">Simon Rodriguez</a></small></address><br>
</body>
</html>