class_path_constraint_path.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: PathConstraintPath Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_path_constraint_path.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#pub-types">Public Types</a> &#124;
  108. <a href="#pub-methods">Public Member Functions</a> &#124;
  109. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  110. <a href="#pro-methods">Protected Member Functions</a> &#124;
  111. <a href="class_path_constraint_path-members.html">List of all members</a> </div>
  112. <div class="headertitle"><div class="title">PathConstraintPath Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
  113. </div><!--header-->
  114. <div class="contents">
  115. <p>The path for a path constraint. It allows attaching two bodies to each other while giving the second body the freedom to move along a path relative to the first.
  116. <a href="#details">More...</a></p>
  117. <p><code>#include &lt;<a class="el" href="_path_constraint_path_8h_source.html">PathConstraintPath.h</a>&gt;</code></p>
  118. <div class="dynheader">
  119. Inheritance diagram for PathConstraintPath:</div>
  120. <div class="dyncontent">
  121. <div class="center">
  122. <img src="class_path_constraint_path.png" usemap="#PathConstraintPath_map" alt=""/>
  123. <map id="PathConstraintPath_map" name="PathConstraintPath_map">
  124. <area href="class_serializable_object.html" alt="SerializableObject" shape="rect" coords="0,0,198,24"/>
  125. <area href="class_ref_target.html" alt="RefTarget&lt; PathConstraintPath &gt;" shape="rect" coords="208,0,406,24"/>
  126. <area href="class_path_constraint_path_hermite.html" title="A path that follows a Hermite spline." alt="PathConstraintPathHermite" shape="rect" coords="104,112,302,136"/>
  127. </map>
  128. </div></div>
  129. <table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  131. Public Types</h2></td></tr>
  132. <tr class="memitem:aa7e9426bcfe13eb9f5944fb4f542db48" id="r_aa7e9426bcfe13eb9f5944fb4f542db48"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7e9426bcfe13eb9f5944fb4f542db48">PathResult</a> = <a class="el" href="class_result.html">Result</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;<a class="el" href="class_path_constraint_path.html">PathConstraintPath</a>&gt;&gt;</td></tr>
  133. <tr class="separator:aa7e9426bcfe13eb9f5944fb4f542db48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  136. Public Member Functions</h2></td></tr>
  137. <tr class="memitem:aff085b5af851482956c8696d0e87f73d" id="r_aff085b5af851482956c8696d0e87f73d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff085b5af851482956c8696d0e87f73d">~PathConstraintPath</a> () override=default</td></tr>
  138. <tr class="memdesc:aff085b5af851482956c8696d0e87f73d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor to ensure that derived types get their destructors called. <br /></td></tr>
  139. <tr class="separator:aff085b5af851482956c8696d0e87f73d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aae9ea1aede3ece72c5620bf88776757d" id="r_aae9ea1aede3ece72c5620bf88776757d"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae9ea1aede3ece72c5620bf88776757d">GetPathMaxFraction</a> () const =0</td></tr>
  141. <tr class="memdesc:aae9ea1aede3ece72c5620bf88776757d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the max fraction along the path. I.e. sort of the length of the path. <br /></td></tr>
  142. <tr class="separator:aae9ea1aede3ece72c5620bf88776757d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:aa84329614fd89561c555e2af0d4381a2" id="r_aa84329614fd89561c555e2af0d4381a2"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa84329614fd89561c555e2af0d4381a2">GetClosestPoint</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPosition, float inFractionHint) const =0</td></tr>
  144. <tr class="separator:aa84329614fd89561c555e2af0d4381a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:aa0dc6d3e2b57196ca90da9c10d37f9ea" id="r_aa0dc6d3e2b57196ca90da9c10d37f9ea"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0dc6d3e2b57196ca90da9c10d37f9ea">GetPointOnPath</a> (float inFraction, <a class="el" href="class_vec3.html">Vec3</a> &amp;outPathPosition, <a class="el" href="class_vec3.html">Vec3</a> &amp;outPathTangent, <a class="el" href="class_vec3.html">Vec3</a> &amp;outPathNormal, <a class="el" href="class_vec3.html">Vec3</a> &amp;outPathBinormal) const =0</td></tr>
  146. <tr class="separator:aa0dc6d3e2b57196ca90da9c10d37f9ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:aae13b9ca0a67ed16657f15c1d9b28d4b" id="r_aae13b9ca0a67ed16657f15c1d9b28d4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae13b9ca0a67ed16657f15c1d9b28d4b">SetIsLooping</a> (bool inIsLooping)</td></tr>
  148. <tr class="memdesc:aae13b9ca0a67ed16657f15c1d9b28d4b"><td class="mdescLeft">&#160;</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>
  149. <tr class="separator:aae13b9ca0a67ed16657f15c1d9b28d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a8ec3b671b2e5abaa571a24baa0fae9fa" id="r_a8ec3b671b2e5abaa571a24baa0fae9fa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ec3b671b2e5abaa571a24baa0fae9fa">IsLooping</a> () const</td></tr>
  151. <tr class="separator:a8ec3b671b2e5abaa571a24baa0fae9fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a666c1696bf4a1f468efb89a87ca7461b" id="r_a666c1696bf4a1f468efb89a87ca7461b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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>
  153. <tr class="memdesc:a666c1696bf4a1f468efb89a87ca7461b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the path relative to inBaseTransform. Used for debug purposes. <br /></td></tr>
  154. <tr class="separator:a666c1696bf4a1f468efb89a87ca7461b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a5e969d5cd0b3bede01788cb898445d36" id="r_a5e969d5cd0b3bede01788cb898445d36"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e969d5cd0b3bede01788cb898445d36">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  156. <tr class="memdesc:a5e969d5cd0b3bede01788cb898445d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents of the path in binary form to inStream. <br /></td></tr>
  157. <tr class="separator:a5e969d5cd0b3bede01788cb898445d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
  159. <tr class="memitem:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object" id="r_afad98c73b77e9cef11cf5083a5866d49"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#afad98c73b77e9cef11cf5083a5866d49">~SerializableObject</a> ()=default</td></tr>
  160. <tr class="memdesc:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  161. <tr class="separator:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; PathConstraintPath &gt;</a></td></tr>
  163. <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
  164. <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  165. <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;)</td></tr>
  167. <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
  169. <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
  170. <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
  172. <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <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> &amp;&#160;</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> &amp;)</td></tr>
  174. <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
  175. <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
  177. <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
  178. <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
  180. <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
  181. <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
  183. <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. </table><table class="memberdecls">
  185. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  186. Static Public Member Functions</h2></td></tr>
  187. <tr class="memitem:ac6fa79b918e711e6cd800463d9506663" id="r_ac6fa79b918e711e6cd800463d9506663"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#aa7e9426bcfe13eb9f5944fb4f542db48">PathResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac6fa79b918e711e6cd800463d9506663">sRestoreFromBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  188. <tr class="memdesc:ac6fa79b918e711e6cd800463d9506663"><td class="mdescLeft">&#160;</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>
  189. <tr class="separator:ac6fa79b918e711e6cd800463d9506663"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <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="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; PathConstraintPath &gt;</a></td></tr>
  191. <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
  192. <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
  193. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. </table><table class="memberdecls">
  195. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
  196. Protected Member Functions</h2></td></tr>
  197. <tr class="memitem:a8b79982f785171d16cdd1ba600e3390d" id="r_a8b79982f785171d16cdd1ba600e3390d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b79982f785171d16cdd1ba600e3390d">PathConstraintPath</a> ()=default</td></tr>
  198. <tr class="memdesc:a8b79982f785171d16cdd1ba600e3390d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
  199. <tr class="separator:a8b79982f785171d16cdd1ba600e3390d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:a498feecabacdcee5d1d2ec32f9a12f54" id="r_a498feecabacdcee5d1d2ec32f9a12f54"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a498feecabacdcee5d1d2ec32f9a12f54">PathConstraintPath</a> (const <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &amp;)=default</td></tr>
  201. <tr class="separator:a498feecabacdcee5d1d2ec32f9a12f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a1505ef855e267661550158aa7c665ed0" id="r_a1505ef855e267661550158aa7c665ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1505ef855e267661550158aa7c665ed0">operator=</a> (const <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &amp;)=default</td></tr>
  203. <tr class="separator:a1505ef855e267661550158aa7c665ed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:a98e97ad6b58e3467c014a524c1062ad7" id="r_a98e97ad6b58e3467c014a524c1062ad7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a98e97ad6b58e3467c014a524c1062ad7">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  205. <tr class="memdesc:a98e97ad6b58e3467c014a524c1062ad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function should not be called directly, it is used by sRestoreFromBinaryState. <br /></td></tr>
  206. <tr class="separator:a98e97ad6b58e3467c014a524c1062ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <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="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
  208. <tr class="memitem:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object" id="r_a17ef2cfabac970a7b97b3dc75fa06eee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a17ef2cfabac970a7b97b3dc75fa06eee">SerializableObject</a> ()=default</td></tr>
  209. <tr class="memdesc:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
  210. <tr class="separator:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object" id="r_aaf09b99b1dcfe726a392cfa2f9e2b3eb"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;)=default</td></tr>
  212. <tr class="separator:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <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> &amp;&#160;</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> &amp;)=default</td></tr>
  214. <tr class="separator:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. </table><table class="memberdecls">
  216. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  217. Additional Inherited Members</h2></td></tr>
  218. <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="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; PathConstraintPath &gt;</a></td></tr>
  219. <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic&lt; <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
  220. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  221. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <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="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; PathConstraintPath &gt;</a></td></tr>
  223. <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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
  224. <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
  225. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. </table>
  227. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  228. <div class="textblock"><p>The path for a path constraint. It allows attaching two bodies to each other while giving the second body the freedom to move along a path relative to the first. </p>
  229. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  230. <a id="aa7e9426bcfe13eb9f5944fb4f542db48" name="aa7e9426bcfe13eb9f5944fb4f542db48"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#aa7e9426bcfe13eb9f5944fb4f542db48">&#9670;&#160;</a></span>PathResult</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">using <a class="el" href="#aa7e9426bcfe13eb9f5944fb4f542db48">PathConstraintPath::PathResult</a> = <a class="el" href="class_result.html">Result</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;<a class="el" href="class_path_constraint_path.html">PathConstraintPath</a>&gt;&gt;</td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. </div>
  241. </div>
  242. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  243. <a id="aff085b5af851482956c8696d0e87f73d" name="aff085b5af851482956c8696d0e87f73d"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#aff085b5af851482956c8696d0e87f73d">&#9670;&#160;</a></span>~PathConstraintPath()</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="mlabels">
  248. <tr>
  249. <td class="mlabels-left">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">virtual PathConstraintPath::~PathConstraintPath </td>
  253. <td>(</td>
  254. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  255. <td></td>
  256. </tr>
  257. </table>
  258. </td>
  259. <td class="mlabels-right">
  260. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Virtual destructor to ensure that derived types get their destructors called. </p>
  265. </div>
  266. </div>
  267. <a id="a8b79982f785171d16cdd1ba600e3390d" name="a8b79982f785171d16cdd1ba600e3390d"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#a8b79982f785171d16cdd1ba600e3390d">&#9670;&#160;</a></span>PathConstraintPath() <span class="overload">[1/2]</span></h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">PathConstraintPath::PathConstraintPath </td>
  277. <td>(</td>
  278. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </td>
  283. <td class="mlabels-right">
  284. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. </p>
  289. </div>
  290. </div>
  291. <a id="a498feecabacdcee5d1d2ec32f9a12f54" name="a498feecabacdcee5d1d2ec32f9a12f54"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#a498feecabacdcee5d1d2ec32f9a12f54">&#9670;&#160;</a></span>PathConstraintPath() <span class="overload">[2/2]</span></h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="mlabels">
  296. <tr>
  297. <td class="mlabels-left">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">PathConstraintPath::PathConstraintPath </td>
  301. <td>(</td>
  302. <td class="paramtype">const <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </td>
  307. <td class="mlabels-right">
  308. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. </div>
  313. </div>
  314. <h2 class="groupheader">Member Function Documentation</h2>
  315. <a id="a666c1696bf4a1f468efb89a87ca7461b" name="a666c1696bf4a1f468efb89a87ca7461b"></a>
  316. <h2 class="memtitle"><span class="permalink"><a href="#a666c1696bf4a1f468efb89a87ca7461b">&#9670;&#160;</a></span>DrawPath()</h2>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">void PathConstraintPath::DrawPath </td>
  322. <td>(</td>
  323. <td class="paramtype"><a class="el" href="class_debug_renderer.html">DebugRenderer</a> *</td> <td class="paramname"><span class="paramname"><em>inRenderer</em></span>, </td>
  324. </tr>
  325. <tr>
  326. <td class="paramkey"></td>
  327. <td></td>
  328. <td class="paramtype"><a class="el" href="_real_8h.html#a61b9fb9774ecfc9a33318eead7118ee9">RMat44Arg</a></td> <td class="paramname"><span class="paramname"><em>inBaseTransform</em></span>&#160;) const</td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Draw the path relative to inBaseTransform. Used for debug purposes. </p>
  333. </div>
  334. </div>
  335. <a id="aa84329614fd89561c555e2af0d4381a2" name="aa84329614fd89561c555e2af0d4381a2"></a>
  336. <h2 class="memtitle"><span class="permalink"><a href="#aa84329614fd89561c555e2af0d4381a2">&#9670;&#160;</a></span>GetClosestPoint()</h2>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="mlabels">
  340. <tr>
  341. <td class="mlabels-left">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">virtual float PathConstraintPath::GetClosestPoint </td>
  345. <td>(</td>
  346. <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>
  347. </tr>
  348. <tr>
  349. <td class="paramkey"></td>
  350. <td></td>
  351. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFractionHint</em></span>&#160;) const</td>
  352. </tr>
  353. </table>
  354. </td>
  355. <td class="mlabels-right">
  356. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Get the globally closest point on the curve (Could be slow!) </p><dl class="params"><dt>Parameters</dt><dd>
  361. <table class="params">
  362. <tr><td class="paramname">inPosition</td><td>Position to find closest point for </td></tr>
  363. <tr><td class="paramname">inFractionHint</td><td>Last known fraction along the path (can be used to speed up the search) </td></tr>
  364. </table>
  365. </dd>
  366. </dl>
  367. <dl class="section return"><dt>Returns</dt><dd>Fraction of closest point along the path </dd></dl>
  368. <p>Implemented in <a class="el" href="class_path_constraint_path_hermite.html#a9675ad7e14e9cc9f7b07b9df0d6cfffc">PathConstraintPathHermite</a>.</p>
  369. </div>
  370. </div>
  371. <a id="aae9ea1aede3ece72c5620bf88776757d" name="aae9ea1aede3ece72c5620bf88776757d"></a>
  372. <h2 class="memtitle"><span class="permalink"><a href="#aae9ea1aede3ece72c5620bf88776757d">&#9670;&#160;</a></span>GetPathMaxFraction()</h2>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="mlabels">
  376. <tr>
  377. <td class="mlabels-left">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname">virtual float PathConstraintPath::GetPathMaxFraction </td>
  381. <td>(</td>
  382. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  383. <td> const</td>
  384. </tr>
  385. </table>
  386. </td>
  387. <td class="mlabels-right">
  388. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>Gets the max fraction along the path. I.e. sort of the length of the path. </p>
  393. <p>Implemented in <a class="el" href="class_path_constraint_path_hermite.html#aafea15f5e08786a10baea9f92e01426c">PathConstraintPathHermite</a>.</p>
  394. </div>
  395. </div>
  396. <a id="aa0dc6d3e2b57196ca90da9c10d37f9ea" name="aa0dc6d3e2b57196ca90da9c10d37f9ea"></a>
  397. <h2 class="memtitle"><span class="permalink"><a href="#aa0dc6d3e2b57196ca90da9c10d37f9ea">&#9670;&#160;</a></span>GetPointOnPath()</h2>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <table class="mlabels">
  401. <tr>
  402. <td class="mlabels-left">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">virtual void PathConstraintPath::GetPointOnPath </td>
  406. <td>(</td>
  407. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFraction</em></span>, </td>
  408. </tr>
  409. <tr>
  410. <td class="paramkey"></td>
  411. <td></td>
  412. <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outPathPosition</em></span>, </td>
  413. </tr>
  414. <tr>
  415. <td class="paramkey"></td>
  416. <td></td>
  417. <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outPathTangent</em></span>, </td>
  418. </tr>
  419. <tr>
  420. <td class="paramkey"></td>
  421. <td></td>
  422. <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outPathNormal</em></span>, </td>
  423. </tr>
  424. <tr>
  425. <td class="paramkey"></td>
  426. <td></td>
  427. <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outPathBinormal</em></span>&#160;) const</td>
  428. </tr>
  429. </table>
  430. </td>
  431. <td class="mlabels-right">
  432. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <p>Given the fraction along the path, get the point, tangent and normal. </p><dl class="params"><dt>Parameters</dt><dd>
  437. <table class="params">
  438. <tr><td class="paramname">inFraction</td><td>Fraction along the path [0, <a class="el" href="#aae9ea1aede3ece72c5620bf88776757d" title="Gets the max fraction along the path. I.e. sort of the length of the path.">GetPathMaxFraction()</a>]. </td></tr>
  439. <tr><td class="paramname">outPathPosition</td><td>Returns the closest position to inSearchPosition on the path. </td></tr>
  440. <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>
  441. <tr><td class="paramname">outPathNormal</td><td>Return the normal to the path at outPathPosition (a vector that's perpendicular to outPathTangent) </td></tr>
  442. <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>
  443. </table>
  444. </dd>
  445. </dl>
  446. <p>Implemented in <a class="el" href="class_path_constraint_path_hermite.html#a5645f67f35fd20fe9a966a40a19d0eb8">PathConstraintPathHermite</a>.</p>
  447. </div>
  448. </div>
  449. <a id="a8ec3b671b2e5abaa571a24baa0fae9fa" name="a8ec3b671b2e5abaa571a24baa0fae9fa"></a>
  450. <h2 class="memtitle"><span class="permalink"><a href="#a8ec3b671b2e5abaa571a24baa0fae9fa">&#9670;&#160;</a></span>IsLooping()</h2>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="mlabels">
  454. <tr>
  455. <td class="mlabels-left">
  456. <table class="memname">
  457. <tr>
  458. <td class="memname">bool PathConstraintPath::IsLooping </td>
  459. <td>(</td>
  460. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  461. <td> const</td>
  462. </tr>
  463. </table>
  464. </td>
  465. <td class="mlabels-right">
  466. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. </div>
  471. </div>
  472. <a id="a1505ef855e267661550158aa7c665ed0" name="a1505ef855e267661550158aa7c665ed0"></a>
  473. <h2 class="memtitle"><span class="permalink"><a href="#a1505ef855e267661550158aa7c665ed0">&#9670;&#160;</a></span>operator=()</h2>
  474. <div class="memitem">
  475. <div class="memproto">
  476. <table class="mlabels">
  477. <tr>
  478. <td class="mlabels-left">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname"><a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &amp; PathConstraintPath::operator= </td>
  482. <td>(</td>
  483. <td class="paramtype">const <a class="el" href="class_path_constraint_path.html">PathConstraintPath</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  484. <td></td>
  485. </tr>
  486. </table>
  487. </td>
  488. <td class="mlabels-right">
  489. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  490. </tr>
  491. </table>
  492. </div><div class="memdoc">
  493. </div>
  494. </div>
  495. <a id="a98e97ad6b58e3467c014a524c1062ad7" name="a98e97ad6b58e3467c014a524c1062ad7"></a>
  496. <h2 class="memtitle"><span class="permalink"><a href="#a98e97ad6b58e3467c014a524c1062ad7">&#9670;&#160;</a></span>RestoreBinaryState()</h2>
  497. <div class="memitem">
  498. <div class="memproto">
  499. <table class="mlabels">
  500. <tr>
  501. <td class="mlabels-left">
  502. <table class="memname">
  503. <tr>
  504. <td class="memname">void PathConstraintPath::RestoreBinaryState </td>
  505. <td>(</td>
  506. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  507. <td></td>
  508. </tr>
  509. </table>
  510. </td>
  511. <td class="mlabels-right">
  512. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  513. </tr>
  514. </table>
  515. </div><div class="memdoc">
  516. <p>This function should not be called directly, it is used by sRestoreFromBinaryState. </p>
  517. <p>Reimplemented in <a class="el" href="class_path_constraint_path_hermite.html#a4d0c669b370d78bccdd0fa40f6861fca">PathConstraintPathHermite</a>.</p>
  518. </div>
  519. </div>
  520. <a id="a5e969d5cd0b3bede01788cb898445d36" name="a5e969d5cd0b3bede01788cb898445d36"></a>
  521. <h2 class="memtitle"><span class="permalink"><a href="#a5e969d5cd0b3bede01788cb898445d36">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  522. <div class="memitem">
  523. <div class="memproto">
  524. <table class="mlabels">
  525. <tr>
  526. <td class="mlabels-left">
  527. <table class="memname">
  528. <tr>
  529. <td class="memname">void PathConstraintPath::SaveBinaryState </td>
  530. <td>(</td>
  531. <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  532. <td> const</td>
  533. </tr>
  534. </table>
  535. </td>
  536. <td class="mlabels-right">
  537. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>Saves the contents of the path in binary form to inStream. </p>
  542. <p>Reimplemented in <a class="el" href="class_path_constraint_path_hermite.html#a5ebfbd249290a134915daf8f451ad050">PathConstraintPathHermite</a>.</p>
  543. </div>
  544. </div>
  545. <a id="aae13b9ca0a67ed16657f15c1d9b28d4b" name="aae13b9ca0a67ed16657f15c1d9b28d4b"></a>
  546. <h2 class="memtitle"><span class="permalink"><a href="#aae13b9ca0a67ed16657f15c1d9b28d4b">&#9670;&#160;</a></span>SetIsLooping()</h2>
  547. <div class="memitem">
  548. <div class="memproto">
  549. <table class="mlabels">
  550. <tr>
  551. <td class="mlabels-left">
  552. <table class="memname">
  553. <tr>
  554. <td class="memname">void PathConstraintPath::SetIsLooping </td>
  555. <td>(</td>
  556. <td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>inIsLooping</em></span></td><td>)</td>
  557. <td></td>
  558. </tr>
  559. </table>
  560. </td>
  561. <td class="mlabels-right">
  562. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  563. </tr>
  564. </table>
  565. </div><div class="memdoc">
  566. <p>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. </p>
  567. </div>
  568. </div>
  569. <a id="ac6fa79b918e711e6cd800463d9506663" name="ac6fa79b918e711e6cd800463d9506663"></a>
  570. <h2 class="memtitle"><span class="permalink"><a href="#ac6fa79b918e711e6cd800463d9506663">&#9670;&#160;</a></span>sRestoreFromBinaryState()</h2>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="mlabels">
  574. <tr>
  575. <td class="mlabels-left">
  576. <table class="memname">
  577. <tr>
  578. <td class="memname"><a class="el" href="#aa7e9426bcfe13eb9f5944fb4f542db48">PathConstraintPath::PathResult</a> PathConstraintPath::sRestoreFromBinaryState </td>
  579. <td>(</td>
  580. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  581. <td></td>
  582. </tr>
  583. </table>
  584. </td>
  585. <td class="mlabels-right">
  586. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <p>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. </p>
  591. </div>
  592. </div>
  593. <hr/>The documentation for this class was generated from the following files:<ul>
  594. <li>Jolt/Physics/Constraints/<a class="el" href="_path_constraint_path_8h_source.html">PathConstraintPath.h</a></li>
  595. <li>Jolt/Physics/Constraints/<a class="el" href="_path_constraint_path_8cpp.html">PathConstraintPath.cpp</a></li>
  596. </ul>
  597. </div><!-- contents -->
  598. </div><!-- doc-content -->
  599. <!-- start footer part -->
  600. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  601. <ul>
  602. <li class="navelem"><a class="el" href="class_path_constraint_path.html">PathConstraintPath</a></li>
  603. <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>
  604. </ul>
  605. </div>
  606. </body>
  607. </html>