| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190 |
- <!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/SpringSettings.h Source File</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('_spring_settings_8h_source.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="headertitle"><div class="title">SpringSettings.h</div></div>
- </div><!--header-->
- <div class="contents">
- <a href="_spring_settings_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)</span></div>
- <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: 2023 Jorrit Rouwe</span></div>
- <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
- <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
- <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
- <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
- <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <<a class="code" href="_serializable_object_8h.html">Jolt/ObjectStream/SerializableObject.h</a>></span></div>
- <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
- <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
- <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
- <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">class </span><a class="code hl_class" href="class_stream_in.html">StreamIn</a>;</div>
- <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">class </span><a class="code hl_class" href="class_stream_out.html">StreamOut</a>;</div>
- <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
- <div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
- <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d"> 15</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a> : <a class="code hl_typedef" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a></div>
- <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
- <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_enumvalue" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">FrequencyAndDamping</a>, </div>
- <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_enumvalue" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da80c2dd5c28197f2baebff76bf0299d47">StiffnessAndDamping</a>, </div>
- <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>};</div>
- </div>
- <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
- <div class="foldopen" id="foldopen00022" data-start="{" data-end="};">
- <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="class_spring_settings.html"> 22</a></span><span class="keyword">class </span><a class="code hl_define" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="code hl_class" href="class_spring_settings.html">SpringSettings</a></div>
- <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>{</div>
- <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_define" href="_serializable_object_8h.html#accc27ff8b37777018bc2d93207412b71">JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL</a>(<a class="code hl_define" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a>, <a class="code hl_class" href="class_spring_settings.html">SpringSettings</a>)</div>
- <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
- <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">public</span>:</div>
- <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_spring_settings.html#aefa8b0caa0840d58f74b297ad275c1cf"> 28</a></span> <a class="code hl_function" href="class_spring_settings.html#aefa8b0caa0840d58f74b297ad275c1cf">SpringSettings</a>() = <span class="keywordflow">default</span>;</div>
- <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="class_spring_settings.html#ad21b30d2d06ed66e8660ccfc14403827"> 29</a></span> <a class="code hl_function" href="class_spring_settings.html#ad21b30d2d06ed66e8660ccfc14403827">SpringSettings</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_spring_settings.html">SpringSettings</a> &) = <span class="keywordflow">default</span>;</div>
- <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_spring_settings.html#a035ab930afc30365053d1814f838f335"> 30</a></span> <a class="code hl_class" href="class_spring_settings.html">SpringSettings</a> & operator = (<span class="keyword">const</span> <a class="code hl_class" href="class_spring_settings.html">SpringSettings</a> &) = <span class="keywordflow">default</span>;</div>
- <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="class_spring_settings.html#a3cf17470851be12c258e0c2f200f27e4"> 31</a></span> <a class="code hl_function" href="class_spring_settings.html#a3cf17470851be12c258e0c2f200f27e4">SpringSettings</a>(<a class="code hl_enumeration" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a> inMode, <span class="keywordtype">float</span> inFrequencyOrStiffness, <span class="keywordtype">float</span> inDamping) : mMode(inMode), mFrequency(inFrequencyOrStiffness), mDamping(inDamping) { }</div>
- <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
- <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> SaveBinaryState(<a class="code hl_class" href="class_stream_out.html">StreamOut</a> &inStream) <span class="keyword">const</span>;</div>
- <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
- <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> RestoreBinaryState(<a class="code hl_class" href="class_stream_in.html">StreamIn</a> &inStream);</div>
- <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
- <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="class_spring_settings.html#afb683eddb2db25f62403a6af6410eebb"> 40</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_spring_settings.html#afb683eddb2db25f62403a6af6410eebb">HasStiffness</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFrequency > 0.0f; }</div>
- <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
- <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_spring_settings.html#a7d27c541e7d25d9da0c263ec99ea528a"> 44</a></span> <a class="code hl_enumeration" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a> mMode = <a class="code hl_enumvalue" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a>;</div>
- <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
- <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">union</span></div>
- <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {</div>
- <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="class_spring_settings.html#acea8e3f5767edbfaffa01417733b5dc0"> 51</a></span> <span class="keywordtype">float</span> mFrequency = 0.0f;</div>
- <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
- <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="class_spring_settings.html#a688815c0e85518f1ac42f1d077415472"> 60</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_spring_settings.html#a688815c0e85518f1ac42f1d077415472">mStiffness</a>;</div>
- <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> };</div>
- <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
- <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="class_spring_settings.html#a72165bbe14974afb17df18e88f6d205e"> 67</a></span> <span class="keywordtype">float</span> mDamping = 0.0f;</div>
- <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>};</div>
- </div>
- <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
- <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
- <div class="ttc" id="a_core_8h_html_a115946cb5fc5879545e9ccea096a6031"><div class="ttname"><a href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a></div><div class="ttdeci">std::uint8_t uint8</div><div class="ttdef"><b>Definition</b> Core.h:501</div></div>
- <div class="ttc" id="a_core_8h_html_a2712a9b0f778ab9d1aa5118b4e8e6bd8"><div class="ttname"><a href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a></div><div class="ttdeci">#define JPH_EXPORT</div><div class="ttdef"><b>Definition</b> Core.h:275</div></div>
- <div class="ttc" id="a_core_8h_html_a73da8725998b00321a9db341202d650d"><div class="ttname"><a href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div><div class="ttdeci">#define JPH_NAMESPACE_END</div><div class="ttdef"><b>Definition</b> Core.h:425</div></div>
- <div class="ttc" id="a_core_8h_html_ad14098b68b8c44ea6112601031268405"><div class="ttname"><a href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define JPH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:419</div></div>
- <div class="ttc" id="a_serializable_object_8h_html"><div class="ttname"><a href="_serializable_object_8h.html">SerializableObject.h</a></div></div>
- <div class="ttc" id="a_serializable_object_8h_html_accc27ff8b37777018bc2d93207412b71"><div class="ttname"><a href="_serializable_object_8h.html#accc27ff8b37777018bc2d93207412b71">JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL</a></div><div class="ttdeci">#define JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(linkage, class_name)</div><div class="ttdef"><b>Definition</b> SerializableObject.h:80</div></div>
- <div class="ttc" id="a_spring_settings_8h_html_ac805e5e93f24003512d2ca7e0d71512d"><div class="ttname"><a href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a></div><div class="ttdeci">ESpringMode</div><div class="ttdoc">Enum used by constraints to specify how the spring is defined.</div><div class="ttdef"><b>Definition</b> SpringSettings.h:16</div></div>
- <div class="ttc" id="a_spring_settings_8h_html_ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018"><div class="ttname"><a href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a></div><div class="ttdeci">@ FrequencyAndDamping</div><div class="ttdoc">Frequency and damping are specified.</div></div>
- <div class="ttc" id="a_spring_settings_8h_html_ac805e5e93f24003512d2ca7e0d71512da80c2dd5c28197f2baebff76bf0299d47"><div class="ttname"><a href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da80c2dd5c28197f2baebff76bf0299d47">ESpringMode::StiffnessAndDamping</a></div><div class="ttdeci">@ StiffnessAndDamping</div><div class="ttdoc">Stiffness and damping are specified.</div></div>
- <div class="ttc" id="aclass_spring_settings_html"><div class="ttname"><a href="class_spring_settings.html">SpringSettings</a></div><div class="ttdoc">Settings for a linear or angular spring.</div><div class="ttdef"><b>Definition</b> SpringSettings.h:23</div></div>
- <div class="ttc" id="aclass_spring_settings_html_a3cf17470851be12c258e0c2f200f27e4"><div class="ttname"><a href="class_spring_settings.html#a3cf17470851be12c258e0c2f200f27e4">SpringSettings::SpringSettings</a></div><div class="ttdeci">SpringSettings(ESpringMode inMode, float inFrequencyOrStiffness, float inDamping)</div><div class="ttdef"><b>Definition</b> SpringSettings.h:31</div></div>
- <div class="ttc" id="aclass_spring_settings_html_a688815c0e85518f1ac42f1d077415472"><div class="ttname"><a href="class_spring_settings.html#a688815c0e85518f1ac42f1d077415472">SpringSettings::mStiffness</a></div><div class="ttdeci">float mStiffness</div><div class="ttdef"><b>Definition</b> SpringSettings.h:60</div></div>
- <div class="ttc" id="aclass_spring_settings_html_ad21b30d2d06ed66e8660ccfc14403827"><div class="ttname"><a href="class_spring_settings.html#ad21b30d2d06ed66e8660ccfc14403827">SpringSettings::SpringSettings</a></div><div class="ttdeci">SpringSettings(const SpringSettings &)=default</div></div>
- <div class="ttc" id="aclass_spring_settings_html_aefa8b0caa0840d58f74b297ad275c1cf"><div class="ttname"><a href="class_spring_settings.html#aefa8b0caa0840d58f74b297ad275c1cf">SpringSettings::SpringSettings</a></div><div class="ttdeci">SpringSettings()=default</div><div class="ttdoc">Constructor.</div></div>
- <div class="ttc" id="aclass_spring_settings_html_afb683eddb2db25f62403a6af6410eebb"><div class="ttname"><a href="class_spring_settings.html#afb683eddb2db25f62403a6af6410eebb">SpringSettings::HasStiffness</a></div><div class="ttdeci">bool HasStiffness() const</div><div class="ttdoc">Check if the spring has a valid frequency / stiffness, if not the spring will be hard.</div><div class="ttdef"><b>Definition</b> SpringSettings.h:40</div></div>
- <div class="ttc" id="aclass_stream_in_html"><div class="ttname"><a href="class_stream_in.html">StreamIn</a></div><div class="ttdoc">Simple binary input stream.</div><div class="ttdef"><b>Definition</b> StreamIn.h:13</div></div>
- <div class="ttc" id="aclass_stream_out_html"><div class="ttname"><a href="class_stream_out.html">StreamOut</a></div><div class="ttdoc">Simple binary output stream.</div><div class="ttdef"><b>Definition</b> StreamOut.h:13</div></div>
- </div><!-- fragment --></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="_spring_settings_8h.html">SpringSettings.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>
|