namespace_scale_helpers.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485
  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: ScaleHelpers Namespace 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('namespace_scale_helpers.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="#func-members">Functions</a> </div>
  108. <div class="headertitle"><div class="title">ScaleHelpers Namespace Reference</div></div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <p>Helper functions to get properties of a scaling vector.
  112. <a href="#details">More...</a></p>
  113. <table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  115. Functions</h2></td></tr>
  116. <tr class="memitem:abf3b185a98bea874b96fa82a0db2d7e2" id="r_abf3b185a98bea874b96fa82a0db2d7e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abf3b185a98bea874b96fa82a0db2d7e2">IsNotScaled</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  117. <tr class="memdesc:abf3b185a98bea874b96fa82a0db2d7e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a scale is identity. <br /></td></tr>
  118. <tr class="separator:abf3b185a98bea874b96fa82a0db2d7e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a8ff2f9310527acbb4b02a00150fe02fe" id="r_a8ff2f9310527acbb4b02a00150fe02fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ff2f9310527acbb4b02a00150fe02fe">IsUniformScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  120. <tr class="memdesc:a8ff2f9310527acbb4b02a00150fe02fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a scale is uniform. <br /></td></tr>
  121. <tr class="separator:a8ff2f9310527acbb4b02a00150fe02fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ab4d95f2ecd59a1a77263a3be465fd34e" id="r_ab4d95f2ecd59a1a77263a3be465fd34e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4d95f2ecd59a1a77263a3be465fd34e">IsUniformScaleXZ</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  123. <tr class="memdesc:ab4d95f2ecd59a1a77263a3be465fd34e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a scale is uniform in XZ. <br /></td></tr>
  124. <tr class="separator:ab4d95f2ecd59a1a77263a3be465fd34e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a3c182e760f2d4a5b0985b20d50b0c870" id="r_a3c182e760f2d4a5b0985b20d50b0c870"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c182e760f2d4a5b0985b20d50b0c870">ScaleConvexRadius</a> (float inConvexRadius, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  126. <tr class="memdesc:a3c182e760f2d4a5b0985b20d50b0c870"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale the convex radius of an object. <br /></td></tr>
  127. <tr class="separator:a3c182e760f2d4a5b0985b20d50b0c870"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a968d814e04071d431f79a2ba4e9d4da1" id="r_a968d814e04071d431f79a2ba4e9d4da1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a968d814e04071d431f79a2ba4e9d4da1">IsInsideOut</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  129. <tr class="memdesc:a968d814e04071d431f79a2ba4e9d4da1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a scale flips an object inside out (which requires flipping all normals and polygon windings) <br /></td></tr>
  130. <tr class="separator:a968d814e04071d431f79a2ba4e9d4da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a3f452edeafb5aeb1ea965c1a2b1d9912" id="r_a3f452edeafb5aeb1ea965c1a2b1d9912"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f452edeafb5aeb1ea965c1a2b1d9912">IsZeroScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  132. <tr class="memdesc:a3f452edeafb5aeb1ea965c1a2b1d9912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if any of the components of the scale have a value below cMinScale. <br /></td></tr>
  133. <tr class="separator:a3f452edeafb5aeb1ea965c1a2b1d9912"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a7445e71cd125deb818c71e867ea9275e" id="r_a7445e71cd125deb818c71e867ea9275e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7445e71cd125deb818c71e867ea9275e">MakeNonZeroScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  135. <tr class="memdesc:a7445e71cd125deb818c71e867ea9275e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ensure that the scale for each component is at least cMinScale. <br /></td></tr>
  136. <tr class="separator:a7445e71cd125deb818c71e867ea9275e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a1eeb857fb92f13a5ddd9dac662146b96" id="r_a1eeb857fb92f13a5ddd9dac662146b96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1eeb857fb92f13a5ddd9dac662146b96">MakeUniformScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  138. <tr class="memdesc:a1eeb857fb92f13a5ddd9dac662146b96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the average scale if inScale, used to make the scale uniform when a shape doesn't support non-uniform scale. <br /></td></tr>
  139. <tr class="separator:a1eeb857fb92f13a5ddd9dac662146b96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a18833eca6231a55b302eaa70c81b5162" id="r_a18833eca6231a55b302eaa70c81b5162"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18833eca6231a55b302eaa70c81b5162">MakeUniformScaleXZ</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  141. <tr class="memdesc:a18833eca6231a55b302eaa70c81b5162"><td class="mdescLeft">&#160;</td><td class="mdescRight">Average the scale in XZ, used to make the scale uniform when a shape doesn't support non-uniform scale in the XZ plane. <br /></td></tr>
  142. <tr class="separator:a18833eca6231a55b302eaa70c81b5162"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a024fa9a3c672218ce6b7aaa97d953ae1" id="r_a024fa9a3c672218ce6b7aaa97d953ae1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a024fa9a3c672218ce6b7aaa97d953ae1">CanScaleBeRotated</a> (<a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inRotation, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  144. <tr class="separator:a024fa9a3c672218ce6b7aaa97d953ae1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a317905196055a0a720d6468cbb4840b9" id="r_a317905196055a0a720d6468cbb4840b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a317905196055a0a720d6468cbb4840b9">RotateScale</a> (<a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inRotation, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale)</td></tr>
  146. <tr class="separator:a317905196055a0a720d6468cbb4840b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table>
  148. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  149. <div class="textblock"><p>Helper functions to get properties of a scaling vector. </p>
  150. </div><h2 class="groupheader">Function Documentation</h2>
  151. <a id="a024fa9a3c672218ce6b7aaa97d953ae1" name="a024fa9a3c672218ce6b7aaa97d953ae1"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a024fa9a3c672218ce6b7aaa97d953ae1">&#9670;&#160;</a></span>CanScaleBeRotated()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">bool ScaleHelpers::CanScaleBeRotated </td>
  161. <td>(</td>
  162. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inRotation</em></span>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span>&#160;)</td>
  168. </tr>
  169. </table>
  170. </td>
  171. <td class="mlabels-right">
  172. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Checks in scale can be rotated to child shape </p><dl class="params"><dt>Parameters</dt><dd>
  177. <table class="params">
  178. <tr><td class="paramname">inRotation</td><td>Rotation of child shape </td></tr>
  179. <tr><td class="paramname">inScale</td><td>Scale in local space of parent shape </td></tr>
  180. </table>
  181. </dd>
  182. </dl>
  183. <dl class="section return"><dt>Returns</dt><dd>True if the scale is valid (no shearing introduced) </dd></dl>
  184. </div>
  185. </div>
  186. <a id="a968d814e04071d431f79a2ba4e9d4da1" name="a968d814e04071d431f79a2ba4e9d4da1"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#a968d814e04071d431f79a2ba4e9d4da1">&#9670;&#160;</a></span>IsInsideOut()</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="mlabels">
  191. <tr>
  192. <td class="mlabels-left">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">bool ScaleHelpers::IsInsideOut </td>
  196. <td>(</td>
  197. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </td>
  202. <td class="mlabels-right">
  203. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>Test if a scale flips an object inside out (which requires flipping all normals and polygon windings) </p>
  208. </div>
  209. </div>
  210. <a id="abf3b185a98bea874b96fa82a0db2d7e2" name="abf3b185a98bea874b96fa82a0db2d7e2"></a>
  211. <h2 class="memtitle"><span class="permalink"><a href="#abf3b185a98bea874b96fa82a0db2d7e2">&#9670;&#160;</a></span>IsNotScaled()</h2>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="mlabels">
  215. <tr>
  216. <td class="mlabels-left">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">bool ScaleHelpers::IsNotScaled </td>
  220. <td>(</td>
  221. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Test if a scale is identity. </p>
  232. </div>
  233. </div>
  234. <a id="a8ff2f9310527acbb4b02a00150fe02fe" name="a8ff2f9310527acbb4b02a00150fe02fe"></a>
  235. <h2 class="memtitle"><span class="permalink"><a href="#a8ff2f9310527acbb4b02a00150fe02fe">&#9670;&#160;</a></span>IsUniformScale()</h2>
  236. <div class="memitem">
  237. <div class="memproto">
  238. <table class="mlabels">
  239. <tr>
  240. <td class="mlabels-left">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname">bool ScaleHelpers::IsUniformScale </td>
  244. <td>(</td>
  245. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </td>
  250. <td class="mlabels-right">
  251. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Test if a scale is uniform. </p>
  256. </div>
  257. </div>
  258. <a id="ab4d95f2ecd59a1a77263a3be465fd34e" name="ab4d95f2ecd59a1a77263a3be465fd34e"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#ab4d95f2ecd59a1a77263a3be465fd34e">&#9670;&#160;</a></span>IsUniformScaleXZ()</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="mlabels">
  263. <tr>
  264. <td class="mlabels-left">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">bool ScaleHelpers::IsUniformScaleXZ </td>
  268. <td>(</td>
  269. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  270. <td></td>
  271. </tr>
  272. </table>
  273. </td>
  274. <td class="mlabels-right">
  275. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Test if a scale is uniform in XZ. </p>
  280. </div>
  281. </div>
  282. <a id="a3f452edeafb5aeb1ea965c1a2b1d9912" name="a3f452edeafb5aeb1ea965c1a2b1d9912"></a>
  283. <h2 class="memtitle"><span class="permalink"><a href="#a3f452edeafb5aeb1ea965c1a2b1d9912">&#9670;&#160;</a></span>IsZeroScale()</h2>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="mlabels">
  287. <tr>
  288. <td class="mlabels-left">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname">bool ScaleHelpers::IsZeroScale </td>
  292. <td>(</td>
  293. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  294. <td></td>
  295. </tr>
  296. </table>
  297. </td>
  298. <td class="mlabels-right">
  299. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Test if any of the components of the scale have a value below cMinScale. </p>
  304. </div>
  305. </div>
  306. <a id="a7445e71cd125deb818c71e867ea9275e" name="a7445e71cd125deb818c71e867ea9275e"></a>
  307. <h2 class="memtitle"><span class="permalink"><a href="#a7445e71cd125deb818c71e867ea9275e">&#9670;&#160;</a></span>MakeNonZeroScale()</h2>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="mlabels">
  311. <tr>
  312. <td class="mlabels-left">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> ScaleHelpers::MakeNonZeroScale </td>
  316. <td>(</td>
  317. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  318. <td></td>
  319. </tr>
  320. </table>
  321. </td>
  322. <td class="mlabels-right">
  323. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Ensure that the scale for each component is at least cMinScale. </p>
  328. </div>
  329. </div>
  330. <a id="a1eeb857fb92f13a5ddd9dac662146b96" name="a1eeb857fb92f13a5ddd9dac662146b96"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a1eeb857fb92f13a5ddd9dac662146b96">&#9670;&#160;</a></span>MakeUniformScale()</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"><a class="el" href="class_vec3.html">Vec3</a> ScaleHelpers::MakeUniformScale </td>
  340. <td>(</td>
  341. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</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">inline</span></span> </td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>Get the average scale if inScale, used to make the scale uniform when a shape doesn't support non-uniform scale. </p>
  352. </div>
  353. </div>
  354. <a id="a18833eca6231a55b302eaa70c81b5162" name="a18833eca6231a55b302eaa70c81b5162"></a>
  355. <h2 class="memtitle"><span class="permalink"><a href="#a18833eca6231a55b302eaa70c81b5162">&#9670;&#160;</a></span>MakeUniformScaleXZ()</h2>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="mlabels">
  359. <tr>
  360. <td class="mlabels-left">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> ScaleHelpers::MakeUniformScaleXZ </td>
  364. <td>(</td>
  365. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  366. <td></td>
  367. </tr>
  368. </table>
  369. </td>
  370. <td class="mlabels-right">
  371. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  372. </tr>
  373. </table>
  374. </div><div class="memdoc">
  375. <p>Average the scale in XZ, used to make the scale uniform when a shape doesn't support non-uniform scale in the XZ plane. </p>
  376. </div>
  377. </div>
  378. <a id="a317905196055a0a720d6468cbb4840b9" name="a317905196055a0a720d6468cbb4840b9"></a>
  379. <h2 class="memtitle"><span class="permalink"><a href="#a317905196055a0a720d6468cbb4840b9">&#9670;&#160;</a></span>RotateScale()</h2>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="mlabels">
  383. <tr>
  384. <td class="mlabels-left">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> ScaleHelpers::RotateScale </td>
  388. <td>(</td>
  389. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inRotation</em></span>, </td>
  390. </tr>
  391. <tr>
  392. <td class="paramkey"></td>
  393. <td></td>
  394. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span>&#160;)</td>
  395. </tr>
  396. </table>
  397. </td>
  398. <td class="mlabels-right">
  399. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  400. </tr>
  401. </table>
  402. </div><div class="memdoc">
  403. <p>Adjust scale for rotated child shape </p><dl class="params"><dt>Parameters</dt><dd>
  404. <table class="params">
  405. <tr><td class="paramname">inRotation</td><td>Rotation of child shape </td></tr>
  406. <tr><td class="paramname">inScale</td><td>Scale in local space of parent shape </td></tr>
  407. </table>
  408. </dd>
  409. </dl>
  410. <dl class="section return"><dt>Returns</dt><dd>Rotated scale </dd></dl>
  411. </div>
  412. </div>
  413. <a id="a3c182e760f2d4a5b0985b20d50b0c870" name="a3c182e760f2d4a5b0985b20d50b0c870"></a>
  414. <h2 class="memtitle"><span class="permalink"><a href="#a3c182e760f2d4a5b0985b20d50b0c870">&#9670;&#160;</a></span>ScaleConvexRadius()</h2>
  415. <div class="memitem">
  416. <div class="memproto">
  417. <table class="mlabels">
  418. <tr>
  419. <td class="mlabels-left">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname">float ScaleHelpers::ScaleConvexRadius </td>
  423. <td>(</td>
  424. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inConvexRadius</em></span>, </td>
  425. </tr>
  426. <tr>
  427. <td class="paramkey"></td>
  428. <td></td>
  429. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span>&#160;)</td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Scale the convex radius of an object. </p>
  439. </div>
  440. </div>
  441. </div><!-- contents -->
  442. </div><!-- doc-content -->
  443. <!-- start footer part -->
  444. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  445. <ul>
  446. <li class="navelem"><a class="el" href="namespace_scale_helpers.html">ScaleHelpers</a></li>
  447. <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>
  448. </ul>
  449. </div>
  450. </body>
  451. </html>