| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471 |
- <!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.12.0"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Jolt Physics: PathConstraintPathHermite 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>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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 id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() { codefold.init(0); });
- /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search',true);
- $(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function(){initNavTree('class_path_constraint_path_hermite.html',''); initResizable(true); });
- /* @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">
- <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 class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="class_path_constraint_path_hermite-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">PathConstraintPathHermite Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
- </div><!--header-->
- <div class="contents">
- <p>A path that follows a Hermite spline.
- <a href="#details">More...</a></p>
- <p><code>#include <<a class="el" href="_path_constraint_path_hermite_8h_source.html">PathConstraintPathHermite.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for PathConstraintPathHermite:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_path_constraint_path_hermite.png" usemap="#PathConstraintPathHermite_map" alt=""/>
- <map id="PathConstraintPathHermite_map" name="PathConstraintPathHermite_map">
- <area href="class_path_constraint_path.html" title="The path for a path constraint. It allows attaching two bodies to each other while giving the second ..." alt="PathConstraintPath" shape="rect" coords="104,56,302,80"/>
- <area href="class_serializable_object.html" alt="SerializableObject" shape="rect" coords="0,0,198,24"/>
- <area href="class_ref_target.html" alt="RefTarget< PathConstraintPath >" shape="rect" coords="208,0,406,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_path_constraint_path_hermite_1_1_point.html">Point</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aafea15f5e08786a10baea9f92e01426c" id="r_aafea15f5e08786a10baea9f92e01426c"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="#aafea15f5e08786a10baea9f92e01426c">GetPathMaxFraction</a> () const override</td></tr>
- <tr class="memdesc:aafea15f5e08786a10baea9f92e01426c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the max fraction along the path. I.e. sort of the length of the path. <br /></td></tr>
- <tr class="separator:aafea15f5e08786a10baea9f92e01426c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9675ad7e14e9cc9f7b07b9df0d6cfffc" id="r_a9675ad7e14e9cc9f7b07b9df0d6cfffc"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9675ad7e14e9cc9f7b07b9df0d6cfffc">GetClosestPoint</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPosition, float inFractionHint) const override</td></tr>
- <tr class="separator:a9675ad7e14e9cc9f7b07b9df0d6cfffc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5645f67f35fd20fe9a966a40a19d0eb8" id="r_a5645f67f35fd20fe9a966a40a19d0eb8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5645f67f35fd20fe9a966a40a19d0eb8">GetPointOnPath</a> (float inFraction, <a class="el" href="class_vec3.html">Vec3</a> &outPathPosition, <a class="el" href="class_vec3.html">Vec3</a> &outPathTangent, <a class="el" href="class_vec3.html">Vec3</a> &outPathNormal, <a class="el" href="class_vec3.html">Vec3</a> &outPathBinormal) const override</td></tr>
- <tr class="separator:a5645f67f35fd20fe9a966a40a19d0eb8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a66a08dc34277969fc1f4dc3cbbca9682" id="r_a66a08dc34277969fc1f4dc3cbbca9682"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a66a08dc34277969fc1f4dc3cbbca9682">AddPoint</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPosition, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inTangent, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inNormal)</td></tr>
- <tr class="memdesc:a66a08dc34277969fc1f4dc3cbbca9682"><td class="mdescLeft"> </td><td class="mdescRight">Adds a point to the path. <br /></td></tr>
- <tr class="separator:a66a08dc34277969fc1f4dc3cbbca9682"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ebfbd249290a134915daf8f451ad050" id="r_a5ebfbd249290a134915daf8f451ad050"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ebfbd249290a134915daf8f451ad050">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &inStream) const override</td></tr>
- <tr class="memdesc:a5ebfbd249290a134915daf8f451ad050"><td class="mdescLeft"> </td><td class="mdescRight">Saves the contents of the path in binary form to inStream. <br /></td></tr>
- <tr class="separator:a5ebfbd249290a134915daf8f451ad050"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_path_constraint_path"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_path_constraint_path')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a></td></tr>
- <tr class="memitem:aff085b5af851482956c8696d0e87f73d inherit pub_methods_class_path_constraint_path" id="r_aff085b5af851482956c8696d0e87f73d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#aff085b5af851482956c8696d0e87f73d">~PathConstraintPath</a> () override=default</td></tr>
- <tr class="memdesc:aff085b5af851482956c8696d0e87f73d inherit pub_methods_class_path_constraint_path"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor to ensure that derived types get their destructors called. <br /></td></tr>
- <tr class="separator:aff085b5af851482956c8696d0e87f73d inherit pub_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aae13b9ca0a67ed16657f15c1d9b28d4b inherit pub_methods_class_path_constraint_path" id="r_aae13b9ca0a67ed16657f15c1d9b28d4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#aae13b9ca0a67ed16657f15c1d9b28d4b">SetIsLooping</a> (bool inIsLooping)</td></tr>
- <tr class="memdesc:aae13b9ca0a67ed16657f15c1d9b28d4b inherit pub_methods_class_path_constraint_path"><td class="mdescLeft"> </td><td class="mdescRight">If the path is looping or not. If a path is looping, the first and last point are automatically connected to each other. They should not be the same points. <br /></td></tr>
- <tr class="separator:aae13b9ca0a67ed16657f15c1d9b28d4b inherit pub_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8ec3b671b2e5abaa571a24baa0fae9fa inherit pub_methods_class_path_constraint_path" id="r_a8ec3b671b2e5abaa571a24baa0fae9fa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#a8ec3b671b2e5abaa571a24baa0fae9fa">IsLooping</a> () const</td></tr>
- <tr class="separator:a8ec3b671b2e5abaa571a24baa0fae9fa inherit pub_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a666c1696bf4a1f468efb89a87ca7461b inherit pub_methods_class_path_constraint_path" id="r_a666c1696bf4a1f468efb89a87ca7461b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#a666c1696bf4a1f468efb89a87ca7461b">DrawPath</a> (<a class="el" href="class_debug_renderer.html">DebugRenderer</a> *inRenderer, <a class="el" href="_real_8h.html#a61b9fb9774ecfc9a33318eead7118ee9">RMat44Arg</a> inBaseTransform) const</td></tr>
- <tr class="memdesc:a666c1696bf4a1f468efb89a87ca7461b inherit pub_methods_class_path_constraint_path"><td class="mdescLeft"> </td><td class="mdescRight">Draw the path relative to inBaseTransform. Used for debug purposes. <br /></td></tr>
- <tr class="separator:a666c1696bf4a1f468efb89a87ca7461b inherit pub_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_serializable_object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
- <tr class="memitem:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object" id="r_afad98c73b77e9cef11cf5083a5866d49"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#afad98c73b77e9cef11cf5083a5866d49">~SerializableObject</a> ()=default</td></tr>
- <tr class="memdesc:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_ref_target')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget< PathConstraintPath ></a></td></tr>
- <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
- <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
- <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a50444e3b659c6f93c64aee224a93f6ab">RefTarget</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &)</td></tr>
- <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
- <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
- <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
- <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target" id="r_a1fc15bfe979bc43a7fa71c7c34f87ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_target.html">RefTarget</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a1fc15bfe979bc43a7fa71c7c34f87ed0">operator=</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &)</td></tr>
- <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
- <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target" id="r_acaf07366183c51cd8460c7d3dcd07c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
- <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
- <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
- <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
- <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
- <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a4d0c669b370d78bccdd0fa40f6861fca" id="r_a4d0c669b370d78bccdd0fa40f6861fca"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d0c669b370d78bccdd0fa40f6861fca">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &inStream) override</td></tr>
- <tr class="memdesc:a4d0c669b370d78bccdd0fa40f6861fca"><td class="mdescLeft"> </td><td class="mdescRight">This function should not be called directly, it is used by sRestoreFromBinaryState. <br /></td></tr>
- <tr class="separator:a4d0c669b370d78bccdd0fa40f6861fca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_path_constraint_path"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_path_constraint_path')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a></td></tr>
- <tr class="memitem:a8b79982f785171d16cdd1ba600e3390d inherit pro_methods_class_path_constraint_path" id="r_a8b79982f785171d16cdd1ba600e3390d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#a8b79982f785171d16cdd1ba600e3390d">PathConstraintPath</a> ()=default</td></tr>
- <tr class="memdesc:a8b79982f785171d16cdd1ba600e3390d inherit pro_methods_class_path_constraint_path"><td class="mdescLeft"> </td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
- <tr class="separator:a8b79982f785171d16cdd1ba600e3390d inherit pro_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a498feecabacdcee5d1d2ec32f9a12f54 inherit pro_methods_class_path_constraint_path" id="r_a498feecabacdcee5d1d2ec32f9a12f54"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#a498feecabacdcee5d1d2ec32f9a12f54">PathConstraintPath</a> (const <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &)=default</td></tr>
- <tr class="separator:a498feecabacdcee5d1d2ec32f9a12f54 inherit pro_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1505ef855e267661550158aa7c665ed0 inherit pro_methods_class_path_constraint_path" id="r_a1505ef855e267661550158aa7c665ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#a1505ef855e267661550158aa7c665ed0">operator=</a> (const <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &)=default</td></tr>
- <tr class="separator:a1505ef855e267661550158aa7c665ed0 inherit pro_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_serializable_object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
- <tr class="memitem:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object" id="r_a17ef2cfabac970a7b97b3dc75fa06eee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a17ef2cfabac970a7b97b3dc75fa06eee">SerializableObject</a> ()=default</td></tr>
- <tr class="memdesc:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="mdescLeft"> </td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
- <tr class="separator:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object" id="r_aaf09b99b1dcfe726a392cfa2f9e2b3eb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#aaf09b99b1dcfe726a392cfa2f9e2b3eb">SerializableObject</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &)=default</td></tr>
- <tr class="separator:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object" id="r_a2e1b9e7dda273bacf82f2708c9f8537a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_serializable_object.html">SerializableObject</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a2e1b9e7dda273bacf82f2708c9f8537a">operator=</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &)=default</td></tr>
- <tr class="separator:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_types_class_path_constraint_path"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_path_constraint_path')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a></td></tr>
- <tr class="memitem:aa7e9426bcfe13eb9f5944fb4f542db48 inherit pub_types_class_path_constraint_path" id="r_aa7e9426bcfe13eb9f5944fb4f542db48"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#aa7e9426bcfe13eb9f5944fb4f542db48">PathResult</a> = <a class="el" href="class_result.html">Result</a><<a class="el" href="class_ref.html">Ref</a><<a class="el" href="class_path_constraint_path.html">PathConstraintPath</a>>></td></tr>
- <tr class="separator:aa7e9426bcfe13eb9f5944fb4f542db48 inherit pub_types_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_static_methods_class_path_constraint_path"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_path_constraint_path')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a></td></tr>
- <tr class="memitem:ac6fa79b918e711e6cd800463d9506663 inherit pub_static_methods_class_path_constraint_path" id="r_ac6fa79b918e711e6cd800463d9506663"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_path_constraint_path.html#aa7e9426bcfe13eb9f5944fb4f542db48">PathResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_path.html#ac6fa79b918e711e6cd800463d9506663">sRestoreFromBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &inStream)</td></tr>
- <tr class="memdesc:ac6fa79b918e711e6cd800463d9506663 inherit pub_static_methods_class_path_constraint_path"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_shape.html" title="Base class for all shapes (collision volume of a body). Defines a virtual interface for collision det...">Shape</a> of the correct type and restores its contents from the binary stream inStream. <br /></td></tr>
- <tr class="separator:ac6fa79b918e711e6cd800463d9506663 inherit pub_static_methods_class_path_constraint_path"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_static_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_ref_target')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget< PathConstraintPath ></a></td></tr>
- <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
- <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
- <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_ref_target')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget< PathConstraintPath ></a></td></tr>
- <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic< <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
- <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Current reference count. <br /></td></tr>
- <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_static_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_ref_target')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget< PathConstraintPath ></a></td></tr>
- <tr class="memitem:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target" id="r_ad37db773efa3c8756f6d95df3862b875"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
- <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
- <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><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 path that follows a Hermite spline. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="a66a08dc34277969fc1f4dc3cbbca9682" name="a66a08dc34277969fc1f4dc3cbbca9682"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a66a08dc34277969fc1f4dc3cbbca9682">◆ </a></span>AddPoint()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void PathConstraintPathHermite::AddPoint </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inPosition</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inTangent</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inNormal</em></span> )</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>Adds a point to the path. </p>
- </div>
- </div>
- <a id="a9675ad7e14e9cc9f7b07b9df0d6cfffc" name="a9675ad7e14e9cc9f7b07b9df0d6cfffc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9675ad7e14e9cc9f7b07b9df0d6cfffc">◆ </a></span>GetClosestPoint()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float PathConstraintPathHermite::GetClosestPoint </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inPosition</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFractionHint</em></span> ) const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the globally closest point on the curve (Could be slow!) </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inPosition</td><td>Position to find closest point for </td></tr>
- <tr><td class="paramname">inFractionHint</td><td>Last known fraction along the path (can be used to speed up the search) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Fraction of closest point along the path </dd></dl>
- <p>Implements <a class="el" href="class_path_constraint_path.html#aa84329614fd89561c555e2af0d4381a2">PathConstraintPath</a>.</p>
- </div>
- </div>
- <a id="aafea15f5e08786a10baea9f92e01426c" name="aafea15f5e08786a10baea9f92e01426c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aafea15f5e08786a10baea9f92e01426c">◆ </a></span>GetPathMaxFraction()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual float PathConstraintPathHermite::GetPathMaxFraction </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the max fraction along the path. I.e. sort of the length of the path. </p>
- <p>Implements <a class="el" href="class_path_constraint_path.html#aae9ea1aede3ece72c5620bf88776757d">PathConstraintPath</a>.</p>
- </div>
- </div>
- <a id="a5645f67f35fd20fe9a966a40a19d0eb8" name="a5645f67f35fd20fe9a966a40a19d0eb8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5645f67f35fd20fe9a966a40a19d0eb8">◆ </a></span>GetPointOnPath()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void PathConstraintPathHermite::GetPointOnPath </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFraction</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &</td> <td class="paramname"><span class="paramname"><em>outPathPosition</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &</td> <td class="paramname"><span class="paramname"><em>outPathTangent</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &</td> <td class="paramname"><span class="paramname"><em>outPathNormal</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &</td> <td class="paramname"><span class="paramname"><em>outPathBinormal</em></span> ) const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Given the fraction along the path, get the point, tangent and normal. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inFraction</td><td>Fraction along the path [0, <a class="el" href="#aafea15f5e08786a10baea9f92e01426c" title="Gets the max fraction along the path. I.e. sort of the length of the path.">GetPathMaxFraction()</a>]. </td></tr>
- <tr><td class="paramname">outPathPosition</td><td>Returns the closest position to inSearchPosition on the path. </td></tr>
- <tr><td class="paramname">outPathTangent</td><td>Returns the tangent to the path at outPathPosition (the vector that follows the direction of the path) </td></tr>
- <tr><td class="paramname">outPathNormal</td><td>Return the normal to the path at outPathPosition (a vector that's perpendicular to outPathTangent) </td></tr>
- <tr><td class="paramname">outPathBinormal</td><td>Returns the binormal to the path at outPathPosition (a vector so that normal cross tangent = binormal) </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implements <a class="el" href="class_path_constraint_path.html#aa0dc6d3e2b57196ca90da9c10d37f9ea">PathConstraintPath</a>.</p>
- </div>
- </div>
- <a id="a4d0c669b370d78bccdd0fa40f6861fca" name="a4d0c669b370d78bccdd0fa40f6861fca"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4d0c669b370d78bccdd0fa40f6861fca">◆ </a></span>RestoreBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void PathConstraintPathHermite::RestoreBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>This function should not be called directly, it is used by sRestoreFromBinaryState. </p>
- <p>Reimplemented from <a class="el" href="class_path_constraint_path.html#a98e97ad6b58e3467c014a524c1062ad7">PathConstraintPath</a>.</p>
- </div>
- </div>
- <a id="a5ebfbd249290a134915daf8f451ad050" name="a5ebfbd249290a134915daf8f451ad050"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5ebfbd249290a134915daf8f451ad050">◆ </a></span>SaveBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void PathConstraintPathHermite::SaveBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Saves the contents of the path in binary form to inStream. </p>
- <p>Reimplemented from <a class="el" href="class_path_constraint_path.html#a5e969d5cd0b3bede01788cb898445d36">PathConstraintPath</a>.</p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>Jolt/Physics/Constraints/<a class="el" href="_path_constraint_path_hermite_8h_source.html">PathConstraintPathHermite.h</a></li>
- <li>Jolt/Physics/Constraints/<a class="el" href="_path_constraint_path_hermite_8cpp.html">PathConstraintPathHermite.cpp</a></li>
- </ul>
- </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="class_path_constraint_path_hermite.html">PathConstraintPathHermite</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.12.0 </li>
- </ul>
- </div>
- </body>
- </html>
|