| <!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"> |
| <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"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>32blit API: math/geometry.cpp File 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">32blit API |
| </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> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('geometry_8cpp.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">geometry.cpp File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Geometry helper functions. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <cstring></code><br /> |
| <code>#include <cfloat></code><br /> |
| <code>#include "../types/vec3.hpp"</code><br /> |
| <code>#include "../types/vec2.hpp"</code><br /> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for geometry.cpp:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="geometry_8cpp__incl.png" border="0" usemap="#amath_2geometry_8cpp" alt=""/></div> |
| <map name="amath_2geometry_8cpp" id="amath_2geometry_8cpp"> |
| <area shape="rect" title="Geometry helper functions." alt="" coords="111,5,259,32"/> |
| <area shape="rect" title=" " alt="" coords="5,80,72,107"/> |
| <area shape="rect" title=" " alt="" coords="96,80,155,107"/> |
| <area shape="rect" href="vec3_8hpp_source.html" title=" " alt="" coords="179,80,312,107"/> |
| <area shape="rect" href="vec2_8hpp_source.html" title=" " alt="" coords="336,80,469,107"/> |
| <area shape="rect" title=" " alt="" coords="371,155,434,181"/> |
| </map> |
| </div> |
| </div><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ab2ac077c41b7179cc5e32937a734200a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="geometry_8cpp.html#ab2ac077c41b7179cc5e32937a734200a">ray_sphere_intersect</a> (<a class="el" href="structblit_1_1Vec3.html">Vec3</a> ray_origin, <a class="el" href="structblit_1_1Vec3.html">Vec3</a> ray_vector, <a class="el" href="structblit_1_1Vec3.html">Vec3</a> sphere_origin, float sphere_radius, <a class="el" href="structblit_1_1Vec3.html">Vec3</a> *point=nullptr, float *distance=nullptr, <a class="el" href="structblit_1_1Vec3.html">Vec3</a> *normal=nullptr)</td></tr> |
| <tr class="separator:ab2ac077c41b7179cc5e32937a734200a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16918933674ba8b82e9d1a80cbe22787"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="geometry_8cpp.html#a16918933674ba8b82e9d1a80cbe22787">ray_circle_intersect</a> (<a class="el" href="structblit_1_1Vec2.html">Vec2</a> ray_origin, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> ray_vector, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> circle_origin, float circle_radius, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> *point=nullptr, float *distance=nullptr, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> *normal=nullptr)</td></tr> |
| <tr class="separator:a16918933674ba8b82e9d1a80cbe22787"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23984b05be35d5dbfc4bb66b33027b38"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="geometry_8cpp.html#a23984b05be35d5dbfc4bb66b33027b38">ray_line_intersect</a> (<a class="el" href="structblit_1_1Vec2.html">Vec2</a> ray_origin, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> ray_vector, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> start, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> end, <a class="el" href="structblit_1_1Vec2.html">Vec2</a> *point=nullptr, float *distance=nullptr)</td></tr> |
| <tr class="separator:a23984b05be35d5dbfc4bb66b33027b38"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Geometry helper functions. </p> |
| <p>These are some neat functions for geometry stuff! </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a id="a16918933674ba8b82e9d1a80cbe22787"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16918933674ba8b82e9d1a80cbe22787">◆ </a></span>ray_circle_intersect()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ray_circle_intersect </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>ray_origin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>ray_vector</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>circle_origin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>circle_radius</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> * </td> |
| <td class="paramname"><em>point</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float * </td> |
| <td class="paramname"><em>distance</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> * </td> |
| <td class="paramname"><em>normal</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Return the first point of intersection (if any) between a ray and a circle.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">ray_origin</td><td>Origin of the ray </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">ray_vector</td><td>Vector of the ray </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">circle_origin</td><td>Origin of the circle </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">circle_radius</td><td>Radius of the circle </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">point</td><td>Point of intersection </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">distance</td><td>Distance to intersection </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">normal</td><td>Normal of point on circle circumference where intersection occurred</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if intersection occurs </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a23984b05be35d5dbfc4bb66b33027b38"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a23984b05be35d5dbfc4bb66b33027b38">◆ </a></span>ray_line_intersect()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ray_line_intersect </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>ray_origin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>ray_vector</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>start</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> </td> |
| <td class="paramname"><em>end</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec2.html">Vec2</a> * </td> |
| <td class="paramname"><em>point</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float * </td> |
| <td class="paramname"><em>distance</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Return the first point of intersection (if any) between a line and a circle.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">ray_origin</td><td>Origin of the ray </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">ray_vector</td><td>Vector of the ray </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Start of the line </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>End of the line </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">point</td><td>Point of intersection </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">distance</td><td>Distance to intersection</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if intersection occurs </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab2ac077c41b7179cc5e32937a734200a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab2ac077c41b7179cc5e32937a734200a">◆ </a></span>ray_sphere_intersect()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ray_sphere_intersect </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec3.html">Vec3</a> </td> |
| <td class="paramname"><em>ray_origin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec3.html">Vec3</a> </td> |
| <td class="paramname"><em>ray_vector</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec3.html">Vec3</a> </td> |
| <td class="paramname"><em>sphere_origin</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>sphere_radius</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec3.html">Vec3</a> * </td> |
| <td class="paramname"><em>point</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float * </td> |
| <td class="paramname"><em>distance</em> = <code>nullptr</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structblit_1_1Vec3.html">Vec3</a> * </td> |
| <td class="paramname"><em>normal</em> = <code>nullptr</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Return the first point of intersection (if any) between a ray and a sphere.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">ray_origin</td><td>Origin of the ray </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">ray_vector</td><td>Vector of the ray </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">sphere_origin</td><td>Origin of the sphere </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">sphere_radius</td><td>Radius of the sphere </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">point</td><td>Point of intersection </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">distance</td><td>Distance to intersection </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">normal</td><td>Normal of point on sphere surface where intersection occurred</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if intersection occurs </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_296d53ceaeaa7e099814a6def439fe8a.html">math</a></li><li class="navelem"><a class="el" href="geometry_8cpp.html">geometry.cpp</a></li> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
