diff options
Diffstat (limited to 'dev/MinGfx/docs/html/classmingfx_1_1_gfx_math.html')
| -rw-r--r-- | dev/MinGfx/docs/html/classmingfx_1_1_gfx_math.html | 591 |
1 files changed, 591 insertions, 0 deletions
diff --git a/dev/MinGfx/docs/html/classmingfx_1_1_gfx_math.html b/dev/MinGfx/docs/html/classmingfx_1_1_gfx_math.html new file mode 100644 index 0000000..938c08c --- /dev/null +++ b/dev/MinGfx/docs/html/classmingfx_1_1_gfx_math.html @@ -0,0 +1,591 @@ +<!-- HTML header for doxygen 1.8.9.1--> +<!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.9.1"/> +<title>MinGfx Toolkit: mingfx::GfxMath 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/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script> +<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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 style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">MinGfx Toolkit +  <span id="projectnumber">1.0</span> + </div> + <div id="projectbrief">A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @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&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="namespacemingfx.html">mingfx</a></li><li class="navelem"><a class="el" href="classmingfx_1_1_gfx_math.html">GfxMath</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pub-static-attribs">Static Public Attributes</a> | +<a href="classmingfx_1_1_gfx_math-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">mingfx::GfxMath Class Reference</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This class holds a variety of static math functions that are useful to have defined with creating graphics programs. </p> + +<p class="definition">Definition at line <a class="el" href="gfxmath_8h_source.html#l00028">28</a> of file <a class="el" href="gfxmath_8h_source.html">gfxmath.h</a>.</p> +</div> +<p><code>#include <<a class="el" href="gfxmath_8h_source.html">gfxmath.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:af227209ec043b375497556ee2dcdf850"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#af227209ec043b375497556ee2dcdf850">Clamp</a> (float x, float a, float b)</td></tr> +<tr class="memdesc:af227209ec043b375497556ee2dcdf850"><td class="mdescLeft"> </td><td class="mdescRight">Returns a if x is less than a and b if x is greater than b. <a href="classmingfx_1_1_gfx_math.html#af227209ec043b375497556ee2dcdf850">More...</a><br /></td></tr> +<tr class="separator:af227209ec043b375497556ee2dcdf850"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1336de2695bc3bb750b23fb0ea211637"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#a1336de2695bc3bb750b23fb0ea211637">ToRadians</a> (float degrees)</td></tr> +<tr class="separator:a1336de2695bc3bb750b23fb0ea211637"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a39a2b5973249fb3aefc210b18b0fdff3"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#a39a2b5973249fb3aefc210b18b0fdff3">ToDegrees</a> (float radians)</td></tr> +<tr class="separator:a39a2b5973249fb3aefc210b18b0fdff3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a38927f1f8ea4625d909e64efa93c5190"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#a38927f1f8ea4625d909e64efa93c5190">ToRadians</a> (<a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> degrees)</td></tr> +<tr class="separator:a38927f1f8ea4625d909e64efa93c5190"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa5411a7d8bfc8e47d596362a328dbde8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#aa5411a7d8bfc8e47d596362a328dbde8">ToDegrees</a> (<a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> radians)</td></tr> +<tr class="separator:aa5411a7d8bfc8e47d596362a328dbde8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ace452fb6b86eb638897b474e9dd51647"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#ace452fb6b86eb638897b474e9dd51647">Lerp</a> (float a, float b, float alpha)</td></tr> +<tr class="separator:ace452fb6b86eb638897b474e9dd51647"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af255bde64498e9b55be466abeea97f4d"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#af255bde64498e9b55be466abeea97f4d">iLerp</a> (int a, int b, float alpha)</td></tr> +<tr class="separator:af255bde64498e9b55be466abeea97f4d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2086a2f885f887fb53da8a5adb5860f0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_point3.html">Point3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#a2086a2f885f887fb53da8a5adb5860f0">ScreenToNearPlane</a> (const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> &viewMatrix, const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> &projMatrix, const <a class="el" href="classmingfx_1_1_point2.html">Point2</a> &normalizedScreenPt)</td></tr> +<tr class="memdesc:a2086a2f885f887fb53da8a5adb5860f0"><td class="mdescLeft"> </td><td class="mdescRight">Converts a 2D point on the filmplane represented in Normalized Device Coorindates, which means (-1,1) for the top left corner of the screen and (1,-1) for the bottom right corner, to a 3D point that lies on the camera's near plane. Useful for converting mouse coordinates into a 3D point. Remember that this uses NORMALIZED device coordinates for the screenPt, not pixels. <a class="el" href="classmingfx_1_1_graphics_app.html" title="This is the main application base class for the MinGfx Toolkit.">GraphicsApp</a> and most other graphics engines report mouse move events in pixels, so you need to convert these to normalized device coordinates first. If you are using <a class="el" href="classmingfx_1_1_graphics_app.html" title="This is the main application base class for the MinGfx Toolkit.">GraphicsApp</a>, you can do this with: <a class="el" href="classmingfx_1_1_point2.html" title="A 2D Point with floating point coordinates, used for storing 2D texture coordinates,...">Point2</a> normPos = graphicsApp->pixels_to_normalized_coordinates(mousePos);. <a href="classmingfx_1_1_gfx_math.html#a2086a2f885f887fb53da8a5adb5860f0">More...</a><br /></td></tr> +<tr class="separator:a2086a2f885f887fb53da8a5adb5860f0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaa6af7c0de01fdad46d48d43efb6aa67"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_point3.html">Point3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#aaa6af7c0de01fdad46d48d43efb6aa67">ScreenToDepthPlane</a> (const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> &viewMatrix, const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> &projMatrix, const <a class="el" href="classmingfx_1_1_point2.html">Point2</a> &normalizedScreenPt, float planeDepth)</td></tr> +<tr class="memdesc:aaa6af7c0de01fdad46d48d43efb6aa67"><td class="mdescLeft"> </td><td class="mdescRight">Similar to filmplane2D_to_nearplane3D() but here rather than using the nearplane, you specify the depth of the plane to use as a distance away from the camera's focal point. <a href="classmingfx_1_1_gfx_math.html#aaa6af7c0de01fdad46d48d43efb6aa67">More...</a><br /></td></tr> +<tr class="separator:aaa6af7c0de01fdad46d48d43efb6aa67"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24048d7b688ae46317c3e8de8a701273"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmingfx_1_1_point3.html">Point3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#a24048d7b688ae46317c3e8de8a701273">ScreenToWorld</a> (const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> &viewMatrix, const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> &projMatrix, const <a class="el" href="classmingfx_1_1_point2.html">Point2</a> &normalizedScreenPt, float normalizedZ)</td></tr> +<tr class="memdesc:a24048d7b688ae46317c3e8de8a701273"><td class="mdescLeft"> </td><td class="mdescRight">Converts a 2D point on the filmplane represented in Normalized Device Coorindates, which means (-1,1) for the top left corner of the screen and (1,-1) for the bottom right corner, to a 3D point in the world. The depth buffer value under the pixel must be supplied. If you are using <a class="el" href="classmingfx_1_1_graphics_app.html" title="This is the main application base class for the MinGfx Toolkit.">GraphicsApp</a>, you can use the mouse pos in pixels to get the required arguments like this: <a class="el" href="classmingfx_1_1_point2.html" title="A 2D Point with floating point coordinates, used for storing 2D texture coordinates,...">Point2</a> normPos = graphicsApp->pixels_to_normalized_coordinates(mousePos); float normZ = graphicsApp->z_value_at_pixel(mousePos);. <a href="classmingfx_1_1_gfx_math.html#a24048d7b688ae46317c3e8de8a701273">More...</a><br /></td></tr> +<tr class="separator:a24048d7b688ae46317c3e8de8a701273"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr class="memitem:aaa14e60a5f7c158db443f8b6d87958b4"><td class="memItemLeft" align="right" valign="top">static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#aaa14e60a5f7c158db443f8b6d87958b4">PI</a></td></tr> +<tr class="separator:aaa14e60a5f7c158db443f8b6d87958b4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e5c7562116babf11c61f4c7f20f8b69"><td class="memItemLeft" align="right" valign="top">static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#a0e5c7562116babf11c61f4c7f20f8b69">TWO_PI</a></td></tr> +<tr class="separator:a0e5c7562116babf11c61f4c7f20f8b69"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab5ba8ba54257d86dcf95bd2bbeb534c0"><td class="memItemLeft" align="right" valign="top">static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_gfx_math.html#ab5ba8ba54257d86dcf95bd2bbeb534c0">HALF_PI</a></td></tr> +<tr class="separator:ab5ba8ba54257d86dcf95bd2bbeb534c0"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="af227209ec043b375497556ee2dcdf850"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af227209ec043b375497556ee2dcdf850">◆ </a></span>Clamp()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static float mingfx::GfxMath::Clamp </td> + <td>(</td> + <td class="paramtype">float </td> + <td class="paramname"><em>x</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>b</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Returns a if x is less than a and b if x is greater than b. </p> + +</div> +</div> +<a id="af255bde64498e9b55be466abeea97f4d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af255bde64498e9b55be466abeea97f4d">◆ </a></span>iLerp()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int mingfx::GfxMath::iLerp </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>b</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>alpha</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ace452fb6b86eb638897b474e9dd51647"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ace452fb6b86eb638897b474e9dd51647">◆ </a></span>Lerp()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static float mingfx::GfxMath::Lerp </td> + <td>(</td> + <td class="paramtype">float </td> + <td class="paramname"><em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>b</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>alpha</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="aaa6af7c0de01fdad46d48d43efb6aa67"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaa6af7c0de01fdad46d48d43efb6aa67">◆ </a></span>ScreenToDepthPlane()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classmingfx_1_1_point3.html">Point3</a> mingfx::GfxMath::ScreenToDepthPlane </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> & </td> + <td class="paramname"><em>viewMatrix</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> & </td> + <td class="paramname"><em>projMatrix</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_point2.html">Point2</a> & </td> + <td class="paramname"><em>normalizedScreenPt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>planeDepth</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Similar to filmplane2D_to_nearplane3D() but here rather than using the nearplane, you specify the depth of the plane to use as a distance away from the camera's focal point. </p> + +</div> +</div> +<a id="a2086a2f885f887fb53da8a5adb5860f0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2086a2f885f887fb53da8a5adb5860f0">◆ </a></span>ScreenToNearPlane()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classmingfx_1_1_point3.html">Point3</a> mingfx::GfxMath::ScreenToNearPlane </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> & </td> + <td class="paramname"><em>viewMatrix</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> & </td> + <td class="paramname"><em>projMatrix</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_point2.html">Point2</a> & </td> + <td class="paramname"><em>normalizedScreenPt</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Converts a 2D point on the filmplane represented in Normalized Device Coorindates, which means (-1,1) for the top left corner of the screen and (1,-1) for the bottom right corner, to a 3D point that lies on the camera's near plane. Useful for converting mouse coordinates into a 3D point. Remember that this uses NORMALIZED device coordinates for the screenPt, not pixels. <a class="el" href="classmingfx_1_1_graphics_app.html" title="This is the main application base class for the MinGfx Toolkit.">GraphicsApp</a> and most other graphics engines report mouse move events in pixels, so you need to convert these to normalized device coordinates first. If you are using <a class="el" href="classmingfx_1_1_graphics_app.html" title="This is the main application base class for the MinGfx Toolkit.">GraphicsApp</a>, you can do this with: <a class="el" href="classmingfx_1_1_point2.html" title="A 2D Point with floating point coordinates, used for storing 2D texture coordinates,...">Point2</a> normPos = graphicsApp->pixels_to_normalized_coordinates(mousePos);. </p> + +</div> +</div> +<a id="a24048d7b688ae46317c3e8de8a701273"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a24048d7b688ae46317c3e8de8a701273">◆ </a></span>ScreenToWorld()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classmingfx_1_1_point3.html">Point3</a> mingfx::GfxMath::ScreenToWorld </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> & </td> + <td class="paramname"><em>viewMatrix</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> & </td> + <td class="paramname"><em>projMatrix</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classmingfx_1_1_point2.html">Point2</a> & </td> + <td class="paramname"><em>normalizedScreenPt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>normalizedZ</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Converts a 2D point on the filmplane represented in Normalized Device Coorindates, which means (-1,1) for the top left corner of the screen and (1,-1) for the bottom right corner, to a 3D point in the world. The depth buffer value under the pixel must be supplied. If you are using <a class="el" href="classmingfx_1_1_graphics_app.html" title="This is the main application base class for the MinGfx Toolkit.">GraphicsApp</a>, you can use the mouse pos in pixels to get the required arguments like this: <a class="el" href="classmingfx_1_1_point2.html" title="A 2D Point with floating point coordinates, used for storing 2D texture coordinates,...">Point2</a> normPos = graphicsApp->pixels_to_normalized_coordinates(mousePos); float normZ = graphicsApp->z_value_at_pixel(mousePos);. </p> + +</div> +</div> +<a id="a39a2b5973249fb3aefc210b18b0fdff3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a39a2b5973249fb3aefc210b18b0fdff3">◆ </a></span>ToDegrees() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static float mingfx::GfxMath::ToDegrees </td> + <td>(</td> + <td class="paramtype">float </td> + <td class="paramname"><em>radians</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="aa5411a7d8bfc8e47d596362a328dbde8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa5411a7d8bfc8e47d596362a328dbde8">◆ </a></span>ToDegrees() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> mingfx::GfxMath::ToDegrees </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> </td> + <td class="paramname"><em>radians</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a1336de2695bc3bb750b23fb0ea211637"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1336de2695bc3bb750b23fb0ea211637">◆ </a></span>ToRadians() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static float mingfx::GfxMath::ToRadians </td> + <td>(</td> + <td class="paramtype">float </td> + <td class="paramname"><em>degrees</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a38927f1f8ea4625d909e64efa93c5190"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a38927f1f8ea4625d909e64efa93c5190">◆ </a></span>ToRadians() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> mingfx::GfxMath::ToRadians </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> </td> + <td class="paramname"><em>degrees</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="ab5ba8ba54257d86dcf95bd2bbeb534c0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab5ba8ba54257d86dcf95bd2bbeb534c0">◆ </a></span>HALF_PI</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const float mingfx::GfxMath::HALF_PI</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="gfxmath_8h_source.html#l00074">74</a> of file <a class="el" href="gfxmath_8h_source.html">gfxmath.h</a>.</p> + +</div> +</div> +<a id="aaa14e60a5f7c158db443f8b6d87958b4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaa14e60a5f7c158db443f8b6d87958b4">◆ </a></span>PI</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const float mingfx::GfxMath::PI</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="gfxmath_8h_source.html#l00072">72</a> of file <a class="el" href="gfxmath_8h_source.html">gfxmath.h</a>.</p> + +</div> +</div> +<a id="a0e5c7562116babf11c61f4c7f20f8b69"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0e5c7562116babf11c61f4c7f20f8b69">◆ </a></span>TWO_PI</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const float mingfx::GfxMath::TWO_PI</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="gfxmath_8h_source.html#l00073">73</a> of file <a class="el" href="gfxmath_8h_source.html">gfxmath.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/<a class="el" href="gfxmath_8h_source.html">gfxmath.h</a></li> +</ul> +</div><!-- contents --> +<!-- HTML footer for doxygen 1.8.9.1--> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.9.1 +</small></address> +</body> +</html> |