glm/doc/api/a00194_source.html
Christophe Riccio 0c2e470baf Updated API doc
2018-09-02 23:34:18 +02:00

91 lines
16 KiB
HTML

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>0.9.9 API documenation: matrix_projection.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>
<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 id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.9 API documenation
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_02cc19cee4c4780485bfe81520450212.html">christophericcio</a></li><li class="navelem"><a class="el" href="dir_54de7df3bc9880881b14ec07f256fd2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_6399a054f5929b58eaa476233e406ce8.html">Repository</a></li><li class="navelem"><a class="el" href="dir_627f4a52155b61a75c7c4851d7df9027.html">Github</a></li><li class="navelem"><a class="el" href="dir_ffdfd01cf51cdb2fe8bd5e55c6e0c4e8.html">glm</a></li><li class="navelem"><a class="el" href="dir_4ca6aa55b50e6be994025af27820140e.html">glm</a></li><li class="navelem"><a class="el" href="dir_b115b02f1dab989141fcd87ab0462f01.html">ext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_projection.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00194.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// Dependencies</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;../gtc/constants.hpp&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;../geometric.hpp&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;../trigonometric.hpp&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;../matrix.hpp&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_ENABLE &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_EXT_matrix_projection extension included&quot;)</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00792.html">glm</a></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, qualifier Q&gt;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00666.html#ga77d157525063dec83a557186873ee080">projectZO</a>(</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; obj, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; model, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">proj</a>, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, qualifier Q&gt;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00666.html#ga05249751f48d14cb282e4979802b8111">projectNO</a>(</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; obj, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; model, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">proj</a>, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, qualifier Q&gt;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00666.html#gaf36e96033f456659e6705472a06b6e11">project</a>(</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; obj, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; model, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">proj</a>, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, qualifier Q&gt;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00666.html#gade5136413ce530f8e606124d570fba32">unProjectZO</a>(</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; win, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; model, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">proj</a>, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, qualifier Q&gt;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00666.html#gae089ba9fc150ff69c252a20e508857b5">unProjectNO</a>(</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; win, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; model, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">proj</a>, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, qualifier Q&gt;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00666.html#ga36641e5d60f994e01c3d8f56b10263d2">unProject</a>(</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; win, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; model, mat&lt;4, 4, T, Q&gt; <span class="keyword">const</span>&amp; <a class="code" href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">proj</a>, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q, <span class="keyword">typename</span> U&gt;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, Q&gt; <a class="code" href="a00666.html#gaf6b21eadb7ac2ecbbe258a9a233b4c82">pickMatrix</a>(</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; vec&lt;2, T, Q&gt; <span class="keyword">const</span>&amp; center, vec&lt;2, T, Q&gt; <span class="keyword">const</span>&amp; delta, vec&lt;4, U, Q&gt; <span class="keyword">const</span>&amp; viewport);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;}<span class="comment">//namespace glm</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="preprocessor">#include &quot;matrix_projection.inl&quot;</span></div><div class="ttc" id="a00666_html_gaf6b21eadb7ac2ecbbe258a9a233b4c82"><div class="ttname"><a href="a00666.html#gaf6b21eadb7ac2ecbbe258a9a233b4c82">glm::pickMatrix</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt; pickMatrix(vec&lt; 2, T, Q &gt; const &amp;center, vec&lt; 2, T, Q &gt; const &amp;delta, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Define a picking region. </div></div>
<div class="ttc" id="a00666_html_ga05249751f48d14cb282e4979802b8111"><div class="ttname"><a href="a00666.html#ga05249751f48d14cb282e4979802b8111">glm::projectNO</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; projectNO(vec&lt; 3, T, Q &gt; const &amp;obj, mat&lt; 4, 4, T, Q &gt; const &amp;model, mat&lt; 4, 4, T, Q &gt; const &amp;proj, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Map the specified object coordinates (obj.x, obj.y, obj.z) into window coordinates. </div></div>
<div class="ttc" id="a00768_html_ga58384b7170801dd513de46f87c7fb00e"><div class="ttname"><a href="a00768.html#ga58384b7170801dd513de46f87c7fb00e">glm::proj</a></div><div class="ttdeci">GLM_FUNC_DECL genType proj(genType const &amp;x, genType const &amp;Normal)</div><div class="ttdoc">Projects x on Normal. </div></div>
<div class="ttc" id="a00666_html_ga77d157525063dec83a557186873ee080"><div class="ttname"><a href="a00666.html#ga77d157525063dec83a557186873ee080">glm::projectZO</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; projectZO(vec&lt; 3, T, Q &gt; const &amp;obj, mat&lt; 4, 4, T, Q &gt; const &amp;model, mat&lt; 4, 4, T, Q &gt; const &amp;proj, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Map the specified object coordinates (obj.x, obj.y, obj.z) into window coordinates. </div></div>
<div class="ttc" id="a00666_html_gae089ba9fc150ff69c252a20e508857b5"><div class="ttname"><a href="a00666.html#gae089ba9fc150ff69c252a20e508857b5">glm::unProjectNO</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; unProjectNO(vec&lt; 3, T, Q &gt; const &amp;win, mat&lt; 4, 4, T, Q &gt; const &amp;model, mat&lt; 4, 4, T, Q &gt; const &amp;proj, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Map the specified window coordinates (win.x, win.y, win.z) into object coordinates. </div></div>
<div class="ttc" id="a00666_html_gade5136413ce530f8e606124d570fba32"><div class="ttname"><a href="a00666.html#gade5136413ce530f8e606124d570fba32">glm::unProjectZO</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; unProjectZO(vec&lt; 3, T, Q &gt; const &amp;win, mat&lt; 4, 4, T, Q &gt; const &amp;model, mat&lt; 4, 4, T, Q &gt; const &amp;proj, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Map the specified window coordinates (win.x, win.y, win.z) into object coordinates. </div></div>
<div class="ttc" id="a00666_html_gaf36e96033f456659e6705472a06b6e11"><div class="ttname"><a href="a00666.html#gaf36e96033f456659e6705472a06b6e11">glm::project</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; project(vec&lt; 3, T, Q &gt; const &amp;obj, mat&lt; 4, 4, T, Q &gt; const &amp;model, mat&lt; 4, 4, T, Q &gt; const &amp;proj, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Map the specified object coordinates (obj.x, obj.y, obj.z) into window coordinates using default near...</div></div>
<div class="ttc" id="a00666_html_ga36641e5d60f994e01c3d8f56b10263d2"><div class="ttname"><a href="a00666.html#ga36641e5d60f994e01c3d8f56b10263d2">glm::unProject</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; unProject(vec&lt; 3, T, Q &gt; const &amp;win, mat&lt; 4, 4, T, Q &gt; const &amp;model, mat&lt; 4, 4, T, Q &gt; const &amp;proj, vec&lt; 4, U, Q &gt; const &amp;viewport)</div><div class="ttdoc">Map the specified window coordinates (win.x, win.y, win.z) into object coordinates using default near...</div></div>
<div class="ttc" id="a00792_html"><div class="ttname"><a href="a00792.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00002_source.html#l00020">common.hpp:20</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>