class_constraint_settings.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538
  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: ConstraintSettings 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_constraint_settings.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="#pub-attribs">Public Attributes</a> &#124;
  111. <a href="#pro-methods">Protected Member Functions</a> &#124;
  112. <a href="class_constraint_settings-members.html">List of all members</a> </div>
  113. <div class="headertitle"><div class="title">ConstraintSettings Class Reference</div></div>
  114. </div><!--header-->
  115. <div class="contents">
  116. <p>Class used to store the configuration of a constraint. Allows run-time creation of constraints.
  117. <a href="#details">More...</a></p>
  118. <p><code>#include &lt;<a class="el" href="_constraint_8h_source.html">Constraint.h</a>&gt;</code></p>
  119. <div class="dynheader">
  120. Inheritance diagram for ConstraintSettings:</div>
  121. <div class="dyncontent">
  122. <div class="center">
  123. <img src="class_constraint_settings.png" usemap="#ConstraintSettings_map" alt=""/>
  124. <map id="ConstraintSettings_map" name="ConstraintSettings_map">
  125. <area href="class_serializable_object.html" alt="SerializableObject" shape="rect" coords="0,0,199,24"/>
  126. <area href="class_ref_target.html" alt="RefTarget&lt; ConstraintSettings &gt;" shape="rect" coords="209,0,408,24"/>
  127. <area href="class_two_body_constraint_settings.html" title="Base class for settings for all constraints that involve 2 bodies." alt="TwoBodyConstraintSettings" shape="rect" coords="0,112,199,136"/>
  128. <area href="class_vehicle_constraint_settings.html" alt="VehicleConstraintSettings" shape="rect" coords="209,112,408,136"/>
  129. <area href="class_cone_constraint_settings.html" title="Cone constraint settings, used to create a cone constraint." alt="ConeConstraintSettings" shape="rect" coords="209,168,408,192"/>
  130. <area href="class_distance_constraint_settings.html" title="Distance constraint settings, used to create a distance constraint." alt="DistanceConstraintSettings" shape="rect" coords="209,224,408,248"/>
  131. <area href="class_fixed_constraint_settings.html" title="Fixed constraint settings, used to create a fixed constraint." alt="FixedConstraintSettings" shape="rect" coords="209,280,408,304"/>
  132. <area href="class_gear_constraint_settings.html" title="Gear constraint settings." alt="GearConstraintSettings" shape="rect" coords="209,336,408,360"/>
  133. <area href="class_hinge_constraint_settings.html" title="Hinge constraint settings, used to create a hinge constraint." alt="HingeConstraintSettings" shape="rect" coords="209,392,408,416"/>
  134. <area href="class_path_constraint_settings.html" alt="PathConstraintSettings" shape="rect" coords="209,448,408,472"/>
  135. <area href="class_point_constraint_settings.html" title="Point constraint settings, used to create a point constraint." alt="PointConstraintSettings" shape="rect" coords="209,504,408,528"/>
  136. <area href="class_pulley_constraint_settings.html" alt="PulleyConstraintSettings" shape="rect" coords="209,560,408,584"/>
  137. <area href="class_rack_and_pinion_constraint_settings.html" title="Rack and pinion constraint (slider &amp; gear) settings." alt="RackAndPinionConstraintSettings" shape="rect" coords="209,616,408,640"/>
  138. <area href="class_six_d_o_f_constraint_settings.html" title="6 Degree Of Freedom Constraint setup structure. Allows control over each of the 6 degrees of freedom." alt="SixDOFConstraintSettings" shape="rect" coords="209,672,408,696"/>
  139. <area href="class_slider_constraint_settings.html" title="Slider constraint settings, used to create a slider constraint." alt="SliderConstraintSettings" shape="rect" coords="209,728,408,752"/>
  140. <area href="class_swing_twist_constraint_settings.html" alt="SwingTwistConstraintSettings" shape="rect" coords="209,784,408,808"/>
  141. </map>
  142. </div></div>
  143. <table class="memberdecls">
  144. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  145. Public Types</h2></td></tr>
  146. <tr class="memitem:ad2bae1f8bc31e93f462e0ed3872c0603" id="r_ad2bae1f8bc31e93f462e0ed3872c0603"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2bae1f8bc31e93f462e0ed3872c0603">ConstraintResult</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_constraint_settings.html">ConstraintSettings</a>&gt;&gt;</td></tr>
  147. <tr class="separator:ad2bae1f8bc31e93f462e0ed3872c0603"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table><table class="memberdecls">
  149. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  150. Public Member Functions</h2></td></tr>
  151. <tr class="memitem:a3123d8d5dc6b127c2d19c95f6fe23a74" id="r_a3123d8d5dc6b127c2d19c95f6fe23a74"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3123d8d5dc6b127c2d19c95f6fe23a74">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  152. <tr class="memdesc:a3123d8d5dc6b127c2d19c95f6fe23a74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents of the constraint settings in binary form to inStream. <br /></td></tr>
  153. <tr class="separator:a3123d8d5dc6b127c2d19c95f6fe23a74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <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>
  156. <tr class="memdesc:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  157. <tr class="separator:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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; ConstraintSettings &gt;</a></td></tr>
  159. <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>
  160. <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  161. <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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>
  163. <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <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>
  165. <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>
  166. <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <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>
  168. <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <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>
  170. <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
  171. <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <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>
  173. <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>
  174. <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <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>
  176. <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>
  177. <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <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>
  179. <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. </table><table class="memberdecls">
  181. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  182. Static Public Member Functions</h2></td></tr>
  183. <tr class="memitem:a0e806046f09625624a7ecdec52aafa8b" id="r_a0e806046f09625624a7ecdec52aafa8b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#ad2bae1f8bc31e93f462e0ed3872c0603">ConstraintResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e806046f09625624a7ecdec52aafa8b">sRestoreFromBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  184. <tr class="memdesc:a0e806046f09625624a7ecdec52aafa8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a constraint of the correct type and restores its contents from the binary stream inStream. <br /></td></tr>
  185. <tr class="separator:a0e806046f09625624a7ecdec52aafa8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <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; ConstraintSettings &gt;</a></td></tr>
  187. <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>
  188. <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>
  189. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. </table><table class="memberdecls">
  191. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  192. Public Attributes</h2></td></tr>
  193. <tr class="memitem:a190607bdccb3df5a2fef3d6cc60c4eae" id="r_a190607bdccb3df5a2fef3d6cc60c4eae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a190607bdccb3df5a2fef3d6cc60c4eae">mEnabled</a> = true</td></tr>
  194. <tr class="memdesc:a190607bdccb3df5a2fef3d6cc60c4eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this constraint is enabled initially. Use <a class="el" href="class_constraint.html#aa6621fbefd246003aece1e9be8a169cb">Constraint::SetEnabled</a> to toggle after creation. <br /></td></tr>
  195. <tr class="separator:a190607bdccb3df5a2fef3d6cc60c4eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:ab01ba90506d17f415054bfa6208a4939" id="r_ab01ba90506d17f415054bfa6208a4939"><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="#ab01ba90506d17f415054bfa6208a4939">mConstraintPriority</a> = 0</td></tr>
  197. <tr class="separator:ab01ba90506d17f415054bfa6208a4939"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:ade4ba912369caad8d5acb9ce87c27e4f" id="r_ade4ba912369caad8d5acb9ce87c27e4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade4ba912369caad8d5acb9ce87c27e4f">mNumVelocityStepsOverride</a> = 0</td></tr>
  199. <tr class="memdesc:ade4ba912369caad8d5acb9ce87c27e4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used only when the constraint is active. Override for the number of solver velocity iterations to run, 0 means use the default in <a class="el" href="struct_physics_settings.html#a66af679ba7f202b402bb23d0a0e117ad">PhysicsSettings::mNumVelocitySteps</a>. The number of iterations to use is the max of all contacts and constraints in the island. <br /></td></tr>
  200. <tr class="separator:ade4ba912369caad8d5acb9ce87c27e4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:a7022c1a032590883f2002aeef24adf69" id="r_a7022c1a032590883f2002aeef24adf69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7022c1a032590883f2002aeef24adf69">mNumPositionStepsOverride</a> = 0</td></tr>
  202. <tr class="memdesc:a7022c1a032590883f2002aeef24adf69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used only when the constraint is active. Override for the number of solver position iterations to run, 0 means use the default in <a class="el" href="struct_physics_settings.html#a3724f8c1ef9269076dac93c4d7b7cfdb" title="Number of solver position iterations to run.">PhysicsSettings::mNumPositionSteps</a>. The number of iterations to use is the max of all contacts and constraints in the island. <br /></td></tr>
  203. <tr class="separator:a7022c1a032590883f2002aeef24adf69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:ad2e3913b76c52d885bf88b9e9dc2bfd3" id="r_ad2e3913b76c52d885bf88b9e9dc2bfd3"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2e3913b76c52d885bf88b9e9dc2bfd3">mDrawConstraintSize</a> = 1.0f</td></tr>
  205. <tr class="memdesc:ad2e3913b76c52d885bf88b9e9dc2bfd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of constraint when drawing it through the debug renderer. <br /></td></tr>
  206. <tr class="separator:ad2e3913b76c52d885bf88b9e9dc2bfd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:a5f1b930fc3798cce17979e631a2a8a05" id="r_a5f1b930fc3798cce17979e631a2a8a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f1b930fc3798cce17979e631a2a8a05">mUserData</a> = 0</td></tr>
  208. <tr class="memdesc:a5f1b930fc3798cce17979e631a2a8a05"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data value (can be used by application) <br /></td></tr>
  209. <tr class="separator:a5f1b930fc3798cce17979e631a2a8a05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. </table><table class="memberdecls">
  211. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
  212. Protected Member Functions</h2></td></tr>
  213. <tr class="memitem:aaf7d5a749cc34bd07646c702ea814fab" id="r_aaf7d5a749cc34bd07646c702ea814fab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf7d5a749cc34bd07646c702ea814fab">ConstraintSettings</a> ()=default</td></tr>
  214. <tr class="memdesc:aaf7d5a749cc34bd07646c702ea814fab"><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>
  215. <tr class="separator:aaf7d5a749cc34bd07646c702ea814fab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:a3c05743cca4630984c1f4ffd28e861d1" id="r_a3c05743cca4630984c1f4ffd28e861d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c05743cca4630984c1f4ffd28e861d1">ConstraintSettings</a> (const <a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &amp;)=default</td></tr>
  217. <tr class="separator:a3c05743cca4630984c1f4ffd28e861d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <tr class="memitem:a17aa114170d5ecf5e5ffbbb3c25c8537" id="r_a17aa114170d5ecf5e5ffbbb3c25c8537"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17aa114170d5ecf5e5ffbbb3c25c8537">operator=</a> (const <a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &amp;)=default</td></tr>
  219. <tr class="separator:a17aa114170d5ecf5e5ffbbb3c25c8537"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <tr class="memitem:a71f815e6f2e1bd3e0c8be210936b0e79" id="r_a71f815e6f2e1bd3e0c8be210936b0e79"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a71f815e6f2e1bd3e0c8be210936b0e79">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  221. <tr class="memdesc:a71f815e6f2e1bd3e0c8be210936b0e79"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function should not be called directly, it is used by sRestoreFromBinaryState. <br /></td></tr>
  222. <tr class="separator:a71f815e6f2e1bd3e0c8be210936b0e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <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>
  224. <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>
  225. <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>
  226. <tr class="separator:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  227. <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>
  228. <tr class="separator:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <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>
  230. <tr class="separator:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. </table><table class="memberdecls">
  232. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  233. Additional Inherited Members</h2></td></tr>
  234. <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; ConstraintSettings &gt;</a></td></tr>
  235. <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>
  236. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  237. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  238. <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; ConstraintSettings &gt;</a></td></tr>
  239. <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>
  240. <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>
  241. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  242. </table>
  243. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  244. <div class="textblock"><p>Class used to store the configuration of a constraint. Allows run-time creation of constraints. </p>
  245. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  246. <a id="ad2bae1f8bc31e93f462e0ed3872c0603" name="ad2bae1f8bc31e93f462e0ed3872c0603"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#ad2bae1f8bc31e93f462e0ed3872c0603">&#9670;&#160;</a></span>ConstraintResult</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">using <a class="el" href="#ad2bae1f8bc31e93f462e0ed3872c0603">ConstraintSettings::ConstraintResult</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_constraint_settings.html">ConstraintSettings</a>&gt;&gt;</td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. </div>
  257. </div>
  258. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  259. <a id="aaf7d5a749cc34bd07646c702ea814fab" name="aaf7d5a749cc34bd07646c702ea814fab"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#aaf7d5a749cc34bd07646c702ea814fab">&#9670;&#160;</a></span>ConstraintSettings() <span class="overload">[1/2]</span></h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="mlabels">
  264. <tr>
  265. <td class="mlabels-left">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">ConstraintSettings::ConstraintSettings </td>
  269. <td>(</td>
  270. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  271. <td></td>
  272. </tr>
  273. </table>
  274. </td>
  275. <td class="mlabels-right">
  276. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. </p>
  281. </div>
  282. </div>
  283. <a id="a3c05743cca4630984c1f4ffd28e861d1" name="a3c05743cca4630984c1f4ffd28e861d1"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#a3c05743cca4630984c1f4ffd28e861d1">&#9670;&#160;</a></span>ConstraintSettings() <span class="overload">[2/2]</span></h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="mlabels">
  288. <tr>
  289. <td class="mlabels-left">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">ConstraintSettings::ConstraintSettings </td>
  293. <td>(</td>
  294. <td class="paramtype">const <a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  295. <td></td>
  296. </tr>
  297. </table>
  298. </td>
  299. <td class="mlabels-right">
  300. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. </div>
  305. </div>
  306. <h2 class="groupheader">Member Function Documentation</h2>
  307. <a id="a17aa114170d5ecf5e5ffbbb3c25c8537" name="a17aa114170d5ecf5e5ffbbb3c25c8537"></a>
  308. <h2 class="memtitle"><span class="permalink"><a href="#a17aa114170d5ecf5e5ffbbb3c25c8537">&#9670;&#160;</a></span>operator=()</h2>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &amp; ConstraintSettings::operator= </td>
  317. <td>(</td>
  318. <td class="paramtype">const <a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </td>
  323. <td class="mlabels-right">
  324. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. </div>
  329. </div>
  330. <a id="a71f815e6f2e1bd3e0c8be210936b0e79" name="a71f815e6f2e1bd3e0c8be210936b0e79"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a71f815e6f2e1bd3e0c8be210936b0e79">&#9670;&#160;</a></span>RestoreBinaryState()</h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="mlabels">
  335. <tr>
  336. <td class="mlabels-left">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">void ConstraintSettings::RestoreBinaryState </td>
  340. <td>(</td>
  341. <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>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </td>
  346. <td class="mlabels-right">
  347. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>This function should not be called directly, it is used by sRestoreFromBinaryState. </p>
  352. <p>Reimplemented in <a class="el" href="class_cone_constraint_settings.html#a18a734d20a0d8d9fbaf697523d43a53d">ConeConstraintSettings</a>, <a class="el" href="class_distance_constraint_settings.html#ad20296ac7f200e6f5515d5026f243028">DistanceConstraintSettings</a>, <a class="el" href="class_fixed_constraint_settings.html#a68029fead89e2efc72ddec38977086cf">FixedConstraintSettings</a>, <a class="el" href="class_gear_constraint_settings.html#a19e829338afbd3f7b7bd50614f1dadd7">GearConstraintSettings</a>, <a class="el" href="class_hinge_constraint_settings.html#ab9e2ce19ee6cde2921df8d3fba49d02e">HingeConstraintSettings</a>, <a class="el" href="class_path_constraint_settings.html#a5a69dc6588941a9699e3a80755716444">PathConstraintSettings</a>, <a class="el" href="class_point_constraint_settings.html#a280c2307c3b0dc13ee399c5a5100c020">PointConstraintSettings</a>, <a class="el" href="class_pulley_constraint_settings.html#a386c539940f18601f78f5bebd85550ac">PulleyConstraintSettings</a>, <a class="el" href="class_rack_and_pinion_constraint_settings.html#a84da5f10be9658a7652391b0d699911f">RackAndPinionConstraintSettings</a>, <a class="el" href="class_six_d_o_f_constraint_settings.html#ac7edaa973ecaf000923b3d1d795ce9cc">SixDOFConstraintSettings</a>, <a class="el" href="class_slider_constraint_settings.html#ac0986c9c1bad64fbb5a4f77476e6d1ed">SliderConstraintSettings</a>, <a class="el" href="class_swing_twist_constraint_settings.html#aea7e8886dad7c91dd6b35eb66d040905">SwingTwistConstraintSettings</a>, and <a class="el" href="class_vehicle_constraint_settings.html#a710a5387a975c46e52fb4a860cec6c75">VehicleConstraintSettings</a>.</p>
  353. </div>
  354. </div>
  355. <a id="a3123d8d5dc6b127c2d19c95f6fe23a74" name="a3123d8d5dc6b127c2d19c95f6fe23a74"></a>
  356. <h2 class="memtitle"><span class="permalink"><a href="#a3123d8d5dc6b127c2d19c95f6fe23a74">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="mlabels">
  360. <tr>
  361. <td class="mlabels-left">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname">void ConstraintSettings::SaveBinaryState </td>
  365. <td>(</td>
  366. <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>
  367. <td> const</td>
  368. </tr>
  369. </table>
  370. </td>
  371. <td class="mlabels-right">
  372. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Saves the contents of the constraint settings in binary form to inStream. </p>
  377. <p>Reimplemented in <a class="el" href="class_cone_constraint_settings.html#a39ca1254ca2bb8c686eec1c92cbe48a3">ConeConstraintSettings</a>, <a class="el" href="class_distance_constraint_settings.html#a6ccc7f6a9630c0c6f818a82c37640943">DistanceConstraintSettings</a>, <a class="el" href="class_fixed_constraint_settings.html#a88c2bdb8ffe59b43f61165ab2b6b5909">FixedConstraintSettings</a>, <a class="el" href="class_gear_constraint_settings.html#acfd729d2e49300f557a029ad14598b60">GearConstraintSettings</a>, <a class="el" href="class_hinge_constraint_settings.html#ad1949141d8e31c72cd3eb6dcd8e82d28">HingeConstraintSettings</a>, <a class="el" href="class_path_constraint_settings.html#a9c56f9bc1b35f6df6b7aa520a4128fdf">PathConstraintSettings</a>, <a class="el" href="class_point_constraint_settings.html#a40d21e7ac18cc0d8a922a2d7398cd7a1">PointConstraintSettings</a>, <a class="el" href="class_pulley_constraint_settings.html#ab8b9eea11b3adb23d825581a821c4a8f">PulleyConstraintSettings</a>, <a class="el" href="class_rack_and_pinion_constraint_settings.html#a92be9cdd89c5a465323f2a770c13fef6">RackAndPinionConstraintSettings</a>, <a class="el" href="class_six_d_o_f_constraint_settings.html#a765a3475ed53ef68701c6113ba7dd46b">SixDOFConstraintSettings</a>, <a class="el" href="class_slider_constraint_settings.html#acfae9c6e70eef7f2fdb2d12fd718f187">SliderConstraintSettings</a>, <a class="el" href="class_swing_twist_constraint_settings.html#a4fe33d4d02bc21c602c0396e3e2fa981">SwingTwistConstraintSettings</a>, and <a class="el" href="class_vehicle_constraint_settings.html#ad880e9519583ffb70b93bec474176fd6">VehicleConstraintSettings</a>.</p>
  378. </div>
  379. </div>
  380. <a id="a0e806046f09625624a7ecdec52aafa8b" name="a0e806046f09625624a7ecdec52aafa8b"></a>
  381. <h2 class="memtitle"><span class="permalink"><a href="#a0e806046f09625624a7ecdec52aafa8b">&#9670;&#160;</a></span>sRestoreFromBinaryState()</h2>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="mlabels">
  385. <tr>
  386. <td class="mlabels-left">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname"><a class="el" href="#ad2bae1f8bc31e93f462e0ed3872c0603">ConstraintSettings::ConstraintResult</a> ConstraintSettings::sRestoreFromBinaryState </td>
  390. <td>(</td>
  391. <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>
  392. <td></td>
  393. </tr>
  394. </table>
  395. </td>
  396. <td class="mlabels-right">
  397. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <p>Creates a constraint of the correct type and restores its contents from the binary stream inStream. </p>
  402. </div>
  403. </div>
  404. <h2 class="groupheader">Member Data Documentation</h2>
  405. <a id="ab01ba90506d17f415054bfa6208a4939" name="ab01ba90506d17f415054bfa6208a4939"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#ab01ba90506d17f415054bfa6208a4939">&#9670;&#160;</a></span>mConstraintPriority</h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> ConstraintSettings::mConstraintPriority = 0</td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>Priority of the constraint when solving. Higher numbers are more likely to be solved correctly. Note that if you want a deterministic simulation and you cannot guarantee the order in which constraints are added/removed, you can make the priority for all constraints unique to get a deterministic ordering. </p>
  416. </div>
  417. </div>
  418. <a id="ad2e3913b76c52d885bf88b9e9dc2bfd3" name="ad2e3913b76c52d885bf88b9e9dc2bfd3"></a>
  419. <h2 class="memtitle"><span class="permalink"><a href="#ad2e3913b76c52d885bf88b9e9dc2bfd3">&#9670;&#160;</a></span>mDrawConstraintSize</h2>
  420. <div class="memitem">
  421. <div class="memproto">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">float ConstraintSettings::mDrawConstraintSize = 1.0f</td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>Size of constraint when drawing it through the debug renderer. </p>
  429. </div>
  430. </div>
  431. <a id="a190607bdccb3df5a2fef3d6cc60c4eae" name="a190607bdccb3df5a2fef3d6cc60c4eae"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#a190607bdccb3df5a2fef3d6cc60c4eae">&#9670;&#160;</a></span>mEnabled</h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="memname">
  436. <tr>
  437. <td class="memname">bool ConstraintSettings::mEnabled = true</td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>If this constraint is enabled initially. Use <a class="el" href="class_constraint.html#aa6621fbefd246003aece1e9be8a169cb">Constraint::SetEnabled</a> to toggle after creation. </p>
  442. </div>
  443. </div>
  444. <a id="a7022c1a032590883f2002aeef24adf69" name="a7022c1a032590883f2002aeef24adf69"></a>
  445. <h2 class="memtitle"><span class="permalink"><a href="#a7022c1a032590883f2002aeef24adf69">&#9670;&#160;</a></span>mNumPositionStepsOverride</h2>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <table class="memname">
  449. <tr>
  450. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> ConstraintSettings::mNumPositionStepsOverride = 0</td>
  451. </tr>
  452. </table>
  453. </div><div class="memdoc">
  454. <p>Used only when the constraint is active. Override for the number of solver position iterations to run, 0 means use the default in <a class="el" href="struct_physics_settings.html#a3724f8c1ef9269076dac93c4d7b7cfdb" title="Number of solver position iterations to run.">PhysicsSettings::mNumPositionSteps</a>. The number of iterations to use is the max of all contacts and constraints in the island. </p>
  455. </div>
  456. </div>
  457. <a id="ade4ba912369caad8d5acb9ce87c27e4f" name="ade4ba912369caad8d5acb9ce87c27e4f"></a>
  458. <h2 class="memtitle"><span class="permalink"><a href="#ade4ba912369caad8d5acb9ce87c27e4f">&#9670;&#160;</a></span>mNumVelocityStepsOverride</h2>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> ConstraintSettings::mNumVelocityStepsOverride = 0</td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. <p>Used only when the constraint is active. Override for the number of solver velocity iterations to run, 0 means use the default in <a class="el" href="struct_physics_settings.html#a66af679ba7f202b402bb23d0a0e117ad">PhysicsSettings::mNumVelocitySteps</a>. The number of iterations to use is the max of all contacts and constraints in the island. </p>
  468. </div>
  469. </div>
  470. <a id="a5f1b930fc3798cce17979e631a2a8a05" name="a5f1b930fc3798cce17979e631a2a8a05"></a>
  471. <h2 class="memtitle"><span class="permalink"><a href="#a5f1b930fc3798cce17979e631a2a8a05">&#9670;&#160;</a></span>mUserData</h2>
  472. <div class="memitem">
  473. <div class="memproto">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> ConstraintSettings::mUserData = 0</td>
  477. </tr>
  478. </table>
  479. </div><div class="memdoc">
  480. <p>User data value (can be used by application) </p>
  481. </div>
  482. </div>
  483. <hr/>The documentation for this class was generated from the following files:<ul>
  484. <li>Jolt/Physics/Constraints/<a class="el" href="_constraint_8h_source.html">Constraint.h</a></li>
  485. <li>Jolt/Physics/Constraints/<a class="el" href="_constraint_8cpp.html">Constraint.cpp</a></li>
  486. </ul>
  487. </div><!-- contents -->
  488. </div><!-- doc-content -->
  489. <!-- start footer part -->
  490. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  491. <ul>
  492. <li class="navelem"><a class="el" href="class_constraint_settings.html">ConstraintSettings</a></li>
  493. <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>
  494. </ul>
  495. </div>
  496. </body>
  497. </html>