| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.12.0"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Jolt Physics: PointConstraintSettings Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- extensions: ["tex2jax.js"],
- jax: ["input/TeX","output/HTML-CSS"],
- });
- </script>
- <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() { codefold.init(0); });
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search',true);
- $(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function(){initNavTree('class_point_constraint_settings.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="class_point_constraint_settings-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">PointConstraintSettings Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
- </div><!--header-->
- <div class="contents">
- <p>Point constraint settings, used to create a point constraint.
- <a href="#details">More...</a></p>
- <p><code>#include <<a class="el" href="_point_constraint_8h_source.html">PointConstraint.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for PointConstraintSettings:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_point_constraint_settings.png" usemap="#PointConstraintSettings_map" alt=""/>
- <map id="PointConstraintSettings_map" name="PointConstraintSettings_map">
- <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="101,112,293,136"/>
- <area href="class_constraint_settings.html" title="Class used to store the configuration of a constraint. Allows run-time creation of constraints." alt="ConstraintSettings" shape="rect" coords="101,56,293,80"/>
- <area href="class_serializable_object.html" alt="SerializableObject" shape="rect" coords="0,0,192,24"/>
- <area href="class_ref_target.html" alt="RefTarget< ConstraintSettings >" shape="rect" coords="202,0,394,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a40d21e7ac18cc0d8a922a2d7398cd7a1" id="r_a40d21e7ac18cc0d8a922a2d7398cd7a1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a40d21e7ac18cc0d8a922a2d7398cd7a1">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &inStream) const override</td></tr>
- <tr class="memdesc:a40d21e7ac18cc0d8a922a2d7398cd7a1"><td class="mdescLeft"> </td><td class="mdescRight">Saves the contents of the constraint settings in binary form to inStream. <br /></td></tr>
- <tr class="separator:a40d21e7ac18cc0d8a922a2d7398cd7a1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae907012c2cecdd8df49afe781b66c1a3" id="r_ae907012c2cecdd8df49afe781b66c1a3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_two_body_constraint.html">TwoBodyConstraint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae907012c2cecdd8df49afe781b66c1a3">Create</a> (<a class="el" href="class_body.html">Body</a> &inBody1, <a class="el" href="class_body.html">Body</a> &inBody2) const override</td></tr>
- <tr class="memdesc:ae907012c2cecdd8df49afe781b66c1a3"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of this constraint. <br /></td></tr>
- <tr class="separator:ae907012c2cecdd8df49afe781b66c1a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_two_body_constraint_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_two_body_constraint_settings')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_two_body_constraint_settings.html">TwoBodyConstraintSettings</a></td></tr>
- <tr class="inherit_header pub_methods_class_constraint_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_constraint_settings')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_constraint_settings.html">ConstraintSettings</a></td></tr>
- <tr class="inherit_header pub_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_serializable_object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
- <tr class="memitem:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object" id="r_afad98c73b77e9cef11cf5083a5866d49"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#afad98c73b77e9cef11cf5083a5866d49">~SerializableObject</a> ()=default</td></tr>
- <tr class="memdesc:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_ref_target')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget< ConstraintSettings ></a></td></tr>
- <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
- <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
- <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a50444e3b659c6f93c64aee224a93f6ab">RefTarget</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &)</td></tr>
- <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
- <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
- <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
- <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target" id="r_a1fc15bfe979bc43a7fa71c7c34f87ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_target.html">RefTarget</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a1fc15bfe979bc43a7fa71c7c34f87ed0">operator=</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &)</td></tr>
- <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
- <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target" id="r_acaf07366183c51cd8460c7d3dcd07c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
- <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
- <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
- <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
- <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
- <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:abebac3d7da7808a7430f01398a1d817a" id="r_abebac3d7da7808a7430f01398a1d817a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_constraint_8h.html#a5951578637c20f8aad819c13ad09b1be">EConstraintSpace</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abebac3d7da7808a7430f01398a1d817a">mSpace</a> = <a class="el" href="_constraint_8h.html#a5951578637c20f8aad819c13ad09b1bea43c5bd4a88c440bd0862f954e4faa177">EConstraintSpace::WorldSpace</a></td></tr>
- <tr class="memdesc:abebac3d7da7808a7430f01398a1d817a"><td class="mdescLeft"> </td><td class="mdescRight">This determines in which space the constraint is setup, all properties below should be in the specified space. <br /></td></tr>
- <tr class="separator:abebac3d7da7808a7430f01398a1d817a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a75e5165cface9c64e3edb866b0de9b11" id="r_a75e5165cface9c64e3edb866b0de9b11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a75e5165cface9c64e3edb866b0de9b11">mPoint1</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">RVec3::sZero</a>()</td></tr>
- <tr class="memdesc:a75e5165cface9c64e3edb866b0de9b11"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_body.html">Body</a> 1 constraint position (space determined by mSpace). <br /></td></tr>
- <tr class="separator:a75e5165cface9c64e3edb866b0de9b11"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa7b0100193fa0754bcfa7011e2900195" id="r_aa7b0100193fa0754bcfa7011e2900195"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7b0100193fa0754bcfa7011e2900195">mPoint2</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">RVec3::sZero</a>()</td></tr>
- <tr class="separator:aa7b0100193fa0754bcfa7011e2900195"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_class_constraint_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_constraint_settings')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_constraint_settings.html">ConstraintSettings</a></td></tr>
- <tr class="memitem:a190607bdccb3df5a2fef3d6cc60c4eae inherit pub_attribs_class_constraint_settings" id="r_a190607bdccb3df5a2fef3d6cc60c4eae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#a190607bdccb3df5a2fef3d6cc60c4eae">mEnabled</a> = true</td></tr>
- <tr class="memdesc:a190607bdccb3df5a2fef3d6cc60c4eae inherit pub_attribs_class_constraint_settings"><td class="mdescLeft"> </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>
- <tr class="separator:a190607bdccb3df5a2fef3d6cc60c4eae inherit pub_attribs_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab01ba90506d17f415054bfa6208a4939 inherit pub_attribs_class_constraint_settings" id="r_ab01ba90506d17f415054bfa6208a4939"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#ab01ba90506d17f415054bfa6208a4939">mConstraintPriority</a> = 0</td></tr>
- <tr class="separator:ab01ba90506d17f415054bfa6208a4939 inherit pub_attribs_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ade4ba912369caad8d5acb9ce87c27e4f inherit pub_attribs_class_constraint_settings" id="r_ade4ba912369caad8d5acb9ce87c27e4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#ade4ba912369caad8d5acb9ce87c27e4f">mNumVelocityStepsOverride</a> = 0</td></tr>
- <tr class="memdesc:ade4ba912369caad8d5acb9ce87c27e4f inherit pub_attribs_class_constraint_settings"><td class="mdescLeft"> </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>
- <tr class="separator:ade4ba912369caad8d5acb9ce87c27e4f inherit pub_attribs_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7022c1a032590883f2002aeef24adf69 inherit pub_attribs_class_constraint_settings" id="r_a7022c1a032590883f2002aeef24adf69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#a7022c1a032590883f2002aeef24adf69">mNumPositionStepsOverride</a> = 0</td></tr>
- <tr class="memdesc:a7022c1a032590883f2002aeef24adf69 inherit pub_attribs_class_constraint_settings"><td class="mdescLeft"> </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>
- <tr class="separator:a7022c1a032590883f2002aeef24adf69 inherit pub_attribs_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2e3913b76c52d885bf88b9e9dc2bfd3 inherit pub_attribs_class_constraint_settings" id="r_ad2e3913b76c52d885bf88b9e9dc2bfd3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#ad2e3913b76c52d885bf88b9e9dc2bfd3">mDrawConstraintSize</a> = 1.0f</td></tr>
- <tr class="memdesc:ad2e3913b76c52d885bf88b9e9dc2bfd3 inherit pub_attribs_class_constraint_settings"><td class="mdescLeft"> </td><td class="mdescRight">Size of constraint when drawing it through the debug renderer. <br /></td></tr>
- <tr class="separator:ad2e3913b76c52d885bf88b9e9dc2bfd3 inherit pub_attribs_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5f1b930fc3798cce17979e631a2a8a05 inherit pub_attribs_class_constraint_settings" id="r_a5f1b930fc3798cce17979e631a2a8a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#a5f1b930fc3798cce17979e631a2a8a05">mUserData</a> = 0</td></tr>
- <tr class="memdesc:a5f1b930fc3798cce17979e631a2a8a05 inherit pub_attribs_class_constraint_settings"><td class="mdescLeft"> </td><td class="mdescRight">User data value (can be used by application) <br /></td></tr>
- <tr class="separator:a5f1b930fc3798cce17979e631a2a8a05 inherit pub_attribs_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a280c2307c3b0dc13ee399c5a5100c020" id="r_a280c2307c3b0dc13ee399c5a5100c020"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a280c2307c3b0dc13ee399c5a5100c020">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &inStream) override</td></tr>
- <tr class="memdesc:a280c2307c3b0dc13ee399c5a5100c020"><td class="mdescLeft"> </td><td class="mdescRight">This function should not be called directly, it is used by sRestoreFromBinaryState. <br /></td></tr>
- <tr class="separator:a280c2307c3b0dc13ee399c5a5100c020"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_constraint_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_constraint_settings')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_constraint_settings.html">ConstraintSettings</a></td></tr>
- <tr class="memitem:aaf7d5a749cc34bd07646c702ea814fab inherit pro_methods_class_constraint_settings" id="r_aaf7d5a749cc34bd07646c702ea814fab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#aaf7d5a749cc34bd07646c702ea814fab">ConstraintSettings</a> ()=default</td></tr>
- <tr class="memdesc:aaf7d5a749cc34bd07646c702ea814fab inherit pro_methods_class_constraint_settings"><td class="mdescLeft"> </td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
- <tr class="separator:aaf7d5a749cc34bd07646c702ea814fab inherit pro_methods_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3c05743cca4630984c1f4ffd28e861d1 inherit pro_methods_class_constraint_settings" id="r_a3c05743cca4630984c1f4ffd28e861d1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#a3c05743cca4630984c1f4ffd28e861d1">ConstraintSettings</a> (const <a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &)=default</td></tr>
- <tr class="separator:a3c05743cca4630984c1f4ffd28e861d1 inherit pro_methods_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a17aa114170d5ecf5e5ffbbb3c25c8537 inherit pro_methods_class_constraint_settings" id="r_a17aa114170d5ecf5e5ffbbb3c25c8537"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_constraint_settings.html">ConstraintSettings</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#a17aa114170d5ecf5e5ffbbb3c25c8537">operator=</a> (const <a class="el" href="class_constraint_settings.html">ConstraintSettings</a> &)=default</td></tr>
- <tr class="separator:a17aa114170d5ecf5e5ffbbb3c25c8537 inherit pro_methods_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_serializable_object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
- <tr class="memitem:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object" id="r_a17ef2cfabac970a7b97b3dc75fa06eee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a17ef2cfabac970a7b97b3dc75fa06eee">SerializableObject</a> ()=default</td></tr>
- <tr class="memdesc:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="mdescLeft"> </td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
- <tr class="separator:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object" id="r_aaf09b99b1dcfe726a392cfa2f9e2b3eb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#aaf09b99b1dcfe726a392cfa2f9e2b3eb">SerializableObject</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &)=default</td></tr>
- <tr class="separator:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object" id="r_a2e1b9e7dda273bacf82f2708c9f8537a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_serializable_object.html">SerializableObject</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a2e1b9e7dda273bacf82f2708c9f8537a">operator=</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &)=default</td></tr>
- <tr class="separator:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_types_class_constraint_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_constraint_settings')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_constraint_settings.html">ConstraintSettings</a></td></tr>
- <tr class="memitem:ad2bae1f8bc31e93f462e0ed3872c0603 inherit pub_types_class_constraint_settings" id="r_ad2bae1f8bc31e93f462e0ed3872c0603"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#ad2bae1f8bc31e93f462e0ed3872c0603">ConstraintResult</a> = <a class="el" href="class_result.html">Result</a><<a class="el" href="class_ref.html">Ref</a><<a class="el" href="class_constraint_settings.html">ConstraintSettings</a>>></td></tr>
- <tr class="separator:ad2bae1f8bc31e93f462e0ed3872c0603 inherit pub_types_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_static_methods_class_constraint_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_constraint_settings')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_constraint_settings.html">ConstraintSettings</a></td></tr>
- <tr class="memitem:a0e806046f09625624a7ecdec52aafa8b inherit pub_static_methods_class_constraint_settings" id="r_a0e806046f09625624a7ecdec52aafa8b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_constraint_settings.html#ad2bae1f8bc31e93f462e0ed3872c0603">ConstraintResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html#a0e806046f09625624a7ecdec52aafa8b">sRestoreFromBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &inStream)</td></tr>
- <tr class="memdesc:a0e806046f09625624a7ecdec52aafa8b inherit pub_static_methods_class_constraint_settings"><td class="mdescLeft"> </td><td class="mdescRight">Creates a constraint of the correct type and restores its contents from the binary stream inStream. <br /></td></tr>
- <tr class="separator:a0e806046f09625624a7ecdec52aafa8b inherit pub_static_methods_class_constraint_settings"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_static_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_ref_target')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget< ConstraintSettings ></a></td></tr>
- <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
- <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
- <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_ref_target')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget< ConstraintSettings ></a></td></tr>
- <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic< <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
- <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">Current reference count. <br /></td></tr>
- <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_static_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_ref_target')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget< ConstraintSettings ></a></td></tr>
- <tr class="memitem:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target" id="r_ad37db773efa3c8756f6d95df3862b875"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
- <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft"> </td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
- <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Point constraint settings, used to create a point constraint. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="ae907012c2cecdd8df49afe781b66c1a3" name="ae907012c2cecdd8df49afe781b66c1a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae907012c2cecdd8df49afe781b66c1a3">◆ </a></span>Create()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_two_body_constraint.html">TwoBodyConstraint</a> * PointConstraintSettings::Create </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_body.html">Body</a> &</td> <td class="paramname"><span class="paramname"><em>inBody1</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_body.html">Body</a> &</td> <td class="paramname"><span class="paramname"><em>inBody2</em></span> ) const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create an instance of this constraint. </p>
- <p>Implements <a class="el" href="class_two_body_constraint_settings.html#a42e353e736b0254b02008b050a28f55b">TwoBodyConstraintSettings</a>.</p>
- </div>
- </div>
- <a id="a280c2307c3b0dc13ee399c5a5100c020" name="a280c2307c3b0dc13ee399c5a5100c020"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a280c2307c3b0dc13ee399c5a5100c020">◆ </a></span>RestoreBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void PointConstraintSettings::RestoreBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>This function should not be called directly, it is used by sRestoreFromBinaryState. </p>
- <p>Reimplemented from <a class="el" href="class_constraint_settings.html#a71f815e6f2e1bd3e0c8be210936b0e79">ConstraintSettings</a>.</p>
- </div>
- </div>
- <a id="a40d21e7ac18cc0d8a922a2d7398cd7a1" name="a40d21e7ac18cc0d8a922a2d7398cd7a1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a40d21e7ac18cc0d8a922a2d7398cd7a1">◆ </a></span>SaveBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void PointConstraintSettings::SaveBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Saves the contents of the constraint settings in binary form to inStream. </p>
- <p>Reimplemented from <a class="el" href="class_constraint_settings.html#a3123d8d5dc6b127c2d19c95f6fe23a74">ConstraintSettings</a>.</p>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a75e5165cface9c64e3edb866b0de9b11" name="a75e5165cface9c64e3edb866b0de9b11"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a75e5165cface9c64e3edb866b0de9b11">◆ </a></span>mPoint1</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> PointConstraintSettings::mPoint1 = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">RVec3::sZero</a>()</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="class_body.html">Body</a> 1 constraint position (space determined by mSpace). </p>
- </div>
- </div>
- <a id="aa7b0100193fa0754bcfa7011e2900195" name="aa7b0100193fa0754bcfa7011e2900195"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa7b0100193fa0754bcfa7011e2900195">◆ </a></span>mPoint2</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> PointConstraintSettings::mPoint2 = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">RVec3::sZero</a>()</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="class_body.html">Body</a> 2 constraint position (space determined by mSpace). Note: Normally you would set mPoint1 = mPoint2 if the bodies are already placed how you want to constrain them (if mSpace = world space). </p>
- </div>
- </div>
- <a id="abebac3d7da7808a7430f01398a1d817a" name="abebac3d7da7808a7430f01398a1d817a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abebac3d7da7808a7430f01398a1d817a">◆ </a></span>mSpace</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_constraint_8h.html#a5951578637c20f8aad819c13ad09b1be">EConstraintSpace</a> PointConstraintSettings::mSpace = <a class="el" href="_constraint_8h.html#a5951578637c20f8aad819c13ad09b1bea43c5bd4a88c440bd0862f954e4faa177">EConstraintSpace::WorldSpace</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>This determines in which space the constraint is setup, all properties below should be in the specified space. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>Jolt/Physics/Constraints/<a class="el" href="_point_constraint_8h_source.html">PointConstraint.h</a></li>
- <li>Jolt/Physics/Constraints/<a class="el" href="_point_constraint_8cpp.html">PointConstraint.cpp</a></li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="class_point_constraint_settings.html">PointConstraintSettings</a></li>
- <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
- </ul>
- </div>
- </body>
- </html>
|