| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282 |
- <!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: Jolt/Physics/Constraints/Constraint.h File Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <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('_constraint_8h.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#enum-members">Enumerations</a> </div>
- <div class="headertitle"><div class="title">Constraint.h File Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <div class="textblock"><code>#include <<a class="el" href="_reference_8h_source.html">Jolt/Core/Reference.h</a>></code><br />
- <code>#include <<a class="el" href="_non_copyable_8h_source.html">Jolt/Core/NonCopyable.h</a>></code><br />
- <code>#include <<a class="el" href="_result_8h_source.html">Jolt/Core/Result.h</a>></code><br />
- <code>#include <<a class="el" href="_serializable_object_8h_source.html">Jolt/ObjectStream/SerializableObject.h</a>></code><br />
- </div>
- <p><a href="_constraint_8h_source.html">Go to the source code of this file.</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint_settings.html">ConstraintSettings</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class used to store the configuration of a constraint. Allows run-time creation of constraints. <a href="class_constraint_settings.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_constraint.html">Constraint</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for all physics constraints. A constraint removes one or more degrees of freedom for a rigid body. <a href="class_constraint.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:a2a4cc5b25efd5f8862f80eb2f5fcdc47" id="r_a2a4cc5b25efd5f8862f80eb2f5fcdc47"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a4cc5b25efd5f8862f80eb2f5fcdc47">EConstraintType</a> { <a class="el" href="#a2a4cc5b25efd5f8862f80eb2f5fcdc47a5573c74299e0af37fd558445022c4b15">Constraint</a>
- , <a class="el" href="#a2a4cc5b25efd5f8862f80eb2f5fcdc47a279848af426fbf128cc3620da5bd99bd">TwoBodyConstraint</a>
- }</td></tr>
- <tr class="memdesc:a2a4cc5b25efd5f8862f80eb2f5fcdc47"><td class="mdescLeft"> </td><td class="mdescRight">Enum to identify constraint type. <a href="#a2a4cc5b25efd5f8862f80eb2f5fcdc47">More...</a><br /></td></tr>
- <tr class="separator:a2a4cc5b25efd5f8862f80eb2f5fcdc47"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adfc8350888df0c3a51714b7f372baf2d" id="r_adfc8350888df0c3a51714b7f372baf2d"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#adfc8350888df0c3a51714b7f372baf2d">EConstraintSubType</a> { <br />
-   <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da4457d440870ad6d42bab9082d9bf9b61">Fixed</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da2a3cd5946cfd317eb99c3d32e35e2d4c">Point</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da18205404fe6507d42b3b2d25aaf62f21">Hinge</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da2d9b9a764fb0be4be10e1b2fce63f561">Slider</a>
- , <br />
-   <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da0aa6f4210bf373c95eda00232e93cd98">Distance</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2dacd2c8bc6e5f1ea17c918ccaf89660104">Cone</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da45c50d709bcdfc9e1733315ce452aeb2">SwingTwist</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2dac3d163397733dea0f5563f2b7b3fa4a2">SixDOF</a>
- , <br />
-   <a class="el" href="#adfc8350888df0c3a51714b7f372baf2daac70412e939d72a9234cdebb1af5867b">Path</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2dad6af9c1eaff2a89ebd3f8d0c542be12b">Vehicle</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da8ee4f481186dec454e1fac31c622045e">RackAndPinion</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2dafb845762a66c26782f477febab5344dc">Gear</a>
- , <br />
-   <a class="el" href="#adfc8350888df0c3a51714b7f372baf2daba41903d01ed39b1b98768512c8e65f5">Pulley</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da6b908b785fdba05a6446347dae08d8c5">User1</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2daa09bccf2b2963982b34dc0e08d8b582a">User2</a>
- , <a class="el" href="#adfc8350888df0c3a51714b7f372baf2dae5d2ad241ec44cf155bc78ae8d11f715">User3</a>
- , <br />
-   <a class="el" href="#adfc8350888df0c3a51714b7f372baf2da5ad55d96abf0e50647d6de116530d6df">User4</a>
- <br />
- }</td></tr>
- <tr class="memdesc:adfc8350888df0c3a51714b7f372baf2d"><td class="mdescLeft"> </td><td class="mdescRight">Enum to identify constraint sub type. <a href="#adfc8350888df0c3a51714b7f372baf2d">More...</a><br /></td></tr>
- <tr class="separator:adfc8350888df0c3a51714b7f372baf2d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5951578637c20f8aad819c13ad09b1be" id="r_a5951578637c20f8aad819c13ad09b1be"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5951578637c20f8aad819c13ad09b1be">EConstraintSpace</a> { <a class="el" href="#a5951578637c20f8aad819c13ad09b1bea337c8a797ceff07104efbfcdea102759">LocalToBodyCOM</a>
- , <a class="el" href="#a5951578637c20f8aad819c13ad09b1bea43c5bd4a88c440bd0862f954e4faa177">WorldSpace</a>
- }</td></tr>
- <tr class="memdesc:a5951578637c20f8aad819c13ad09b1be"><td class="mdescLeft"> </td><td class="mdescRight">Certain constraints support setting them up in local or world space. This governs what is used. <a href="#a5951578637c20f8aad819c13ad09b1be">More...</a><br /></td></tr>
- <tr class="separator:a5951578637c20f8aad819c13ad09b1be"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Enumeration Type Documentation</h2>
- <a id="a5951578637c20f8aad819c13ad09b1be" name="a5951578637c20f8aad819c13ad09b1be"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5951578637c20f8aad819c13ad09b1be">◆ </a></span>EConstraintSpace</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">enum class <a class="el" href="#a5951578637c20f8aad819c13ad09b1be">EConstraintSpace</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">strong</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Certain constraints support setting them up in local or world space. This governs what is used. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5951578637c20f8aad819c13ad09b1bea337c8a797ceff07104efbfcdea102759" name="a5951578637c20f8aad819c13ad09b1bea337c8a797ceff07104efbfcdea102759"></a>LocalToBodyCOM </td><td class="fielddoc"><p>All constraint properties are specified in local space to center of mass of the bodies that are being constrained (so e.g. 'constraint position 1' will be local to body 1 COM, 'constraint position 2' will be local to body 2 COM). Note that this means you need to subtract <a class="el" href="class_shape.html#a7e34b0626a40c31db0b2a761922adb1a" title="All shapes are centered around their center of mass. This function returns the center of mass positio...">Shape::GetCenterOfMass()</a> from positions! </p>
- </td></tr>
- <tr><td class="fieldname"><a id="a5951578637c20f8aad819c13ad09b1bea43c5bd4a88c440bd0862f954e4faa177" name="a5951578637c20f8aad819c13ad09b1bea43c5bd4a88c440bd0862f954e4faa177"></a>WorldSpace </td><td class="fielddoc"><p>All constraint properties are specified in world space. </p>
- </td></tr>
- </table>
- </div>
- </div>
- <a id="adfc8350888df0c3a51714b7f372baf2d" name="adfc8350888df0c3a51714b7f372baf2d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adfc8350888df0c3a51714b7f372baf2d">◆ </a></span>EConstraintSubType</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">enum class <a class="el" href="#adfc8350888df0c3a51714b7f372baf2d">EConstraintSubType</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">strong</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enum to identify constraint sub type. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da4457d440870ad6d42bab9082d9bf9b61" name="adfc8350888df0c3a51714b7f372baf2da4457d440870ad6d42bab9082d9bf9b61"></a>Fixed </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da2a3cd5946cfd317eb99c3d32e35e2d4c" name="adfc8350888df0c3a51714b7f372baf2da2a3cd5946cfd317eb99c3d32e35e2d4c"></a>Point </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da18205404fe6507d42b3b2d25aaf62f21" name="adfc8350888df0c3a51714b7f372baf2da18205404fe6507d42b3b2d25aaf62f21"></a>Hinge </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da2d9b9a764fb0be4be10e1b2fce63f561" name="adfc8350888df0c3a51714b7f372baf2da2d9b9a764fb0be4be10e1b2fce63f561"></a>Slider </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da0aa6f4210bf373c95eda00232e93cd98" name="adfc8350888df0c3a51714b7f372baf2da0aa6f4210bf373c95eda00232e93cd98"></a>Distance </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2dacd2c8bc6e5f1ea17c918ccaf89660104" name="adfc8350888df0c3a51714b7f372baf2dacd2c8bc6e5f1ea17c918ccaf89660104"></a>Cone </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da45c50d709bcdfc9e1733315ce452aeb2" name="adfc8350888df0c3a51714b7f372baf2da45c50d709bcdfc9e1733315ce452aeb2"></a>SwingTwist </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2dac3d163397733dea0f5563f2b7b3fa4a2" name="adfc8350888df0c3a51714b7f372baf2dac3d163397733dea0f5563f2b7b3fa4a2"></a>SixDOF </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2daac70412e939d72a9234cdebb1af5867b" name="adfc8350888df0c3a51714b7f372baf2daac70412e939d72a9234cdebb1af5867b"></a>Path </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2dad6af9c1eaff2a89ebd3f8d0c542be12b" name="adfc8350888df0c3a51714b7f372baf2dad6af9c1eaff2a89ebd3f8d0c542be12b"></a>Vehicle </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da8ee4f481186dec454e1fac31c622045e" name="adfc8350888df0c3a51714b7f372baf2da8ee4f481186dec454e1fac31c622045e"></a>RackAndPinion </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2dafb845762a66c26782f477febab5344dc" name="adfc8350888df0c3a51714b7f372baf2dafb845762a66c26782f477febab5344dc"></a>Gear </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2daba41903d01ed39b1b98768512c8e65f5" name="adfc8350888df0c3a51714b7f372baf2daba41903d01ed39b1b98768512c8e65f5"></a>Pulley </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da6b908b785fdba05a6446347dae08d8c5" name="adfc8350888df0c3a51714b7f372baf2da6b908b785fdba05a6446347dae08d8c5"></a>User1 </td><td class="fielddoc"><p>User defined constraint types start here. </p>
- </td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2daa09bccf2b2963982b34dc0e08d8b582a" name="adfc8350888df0c3a51714b7f372baf2daa09bccf2b2963982b34dc0e08d8b582a"></a>User2 </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2dae5d2ad241ec44cf155bc78ae8d11f715" name="adfc8350888df0c3a51714b7f372baf2dae5d2ad241ec44cf155bc78ae8d11f715"></a>User3 </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="adfc8350888df0c3a51714b7f372baf2da5ad55d96abf0e50647d6de116530d6df" name="adfc8350888df0c3a51714b7f372baf2da5ad55d96abf0e50647d6de116530d6df"></a>User4 </td><td class="fielddoc"></td></tr>
- </table>
- </div>
- </div>
- <a id="a2a4cc5b25efd5f8862f80eb2f5fcdc47" name="a2a4cc5b25efd5f8862f80eb2f5fcdc47"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2a4cc5b25efd5f8862f80eb2f5fcdc47">◆ </a></span>EConstraintType</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">enum class <a class="el" href="#a2a4cc5b25efd5f8862f80eb2f5fcdc47">EConstraintType</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">strong</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enum to identify constraint type. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a2a4cc5b25efd5f8862f80eb2f5fcdc47a5573c74299e0af37fd558445022c4b15" name="a2a4cc5b25efd5f8862f80eb2f5fcdc47a5573c74299e0af37fd558445022c4b15"></a>Constraint </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="a2a4cc5b25efd5f8862f80eb2f5fcdc47a279848af426fbf128cc3620da5bd99bd" name="a2a4cc5b25efd5f8862f80eb2f5fcdc47a279848af426fbf128cc3620da5bd99bd"></a>TwoBodyConstraint </td><td class="fielddoc"></td></tr>
- </table>
- </div>
- </div>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_a0f33af92addde396fc27b064c5eb8a9.html">Physics</a></li><li class="navelem"><a class="el" href="dir_166975991df1b4ecc6dd5a6639d45e50.html">Constraints</a></li><li class="navelem"><a class="el" href="_constraint_8h.html">Constraint.h</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>
|