Files
PhysX4.1/physx/documentation/PhysXAPI/files/classPxJointLinearLimitPair.html
2025-11-28 23:13:44 +05:30

365 lines
26 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxJointLinearLimitPair 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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>
<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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxJointLinearLimitPair.html','');});
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classPxJointLinearLimitPair-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxJointLinearLimitPair Class Reference<div class="ingroups"><a class="el" href="group__extensions.html">Extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Describes a two-sided limit.
<a href="classPxJointLinearLimitPair.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxJointLimit_8h_source.html">PxJointLimit.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxJointLinearLimitPair:</div>
<div class="dyncontent">
<div class="center"><img src="classPxJointLinearLimitPair__inherit__graph.png" border="0" usemap="#PxJointLinearLimitPair_inherit__map" alt="Inheritance graph"/></div>
<map name="PxJointLinearLimitPair_inherit__map" id="PxJointLinearLimitPair_inherit__map">
<area shape="rect" id="node2" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit. " alt="" coords="5,5,165,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxJointLinearLimitPair:</div>
<div class="dyncontent">
<div class="center"><img src="classPxJointLinearLimitPair__coll__graph.png" border="0" usemap="#PxJointLinearLimitPair_coll__map" alt="Collaboration graph"/></div>
<map name="PxJointLinearLimitPair_coll__map" id="PxJointLinearLimitPair_coll__map">
<area shape="rect" id="node2" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit. " alt="" coords="5,5,165,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa0bd4b39e190c58bb7db3d09db37fbe2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#aa0bd4b39e190c58bb7db3d09db37fbe2">PxJointLinearLimitPair</a> (const <a class="el" href="classPxTolerancesScale.html">PxTolerancesScale</a> &amp;scale, PxReal lowerLimit=-<a class="el" href="group__foundation.html#ga7539e08056ea09ff1c341b866b7103f4">PX_MAX_F32</a>/3.0f, PxReal upperLimit=PX_MAX_F32/3.0f, PxReal contactDist=-1.0f)</td></tr>
<tr class="memdesc:aa0bd4b39e190c58bb7db3d09db37fbe2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a linear hard limit pair. The lower distance value must be less than the upper distance value. <a href="#aa0bd4b39e190c58bb7db3d09db37fbe2">More...</a><br /></td></tr>
<tr class="separator:aa0bd4b39e190c58bb7db3d09db37fbe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a95bf4d353436b030e652ef3cb1343b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#a8a95bf4d353436b030e652ef3cb1343b">PxJointLinearLimitPair</a> (PxReal lowerLimit, PxReal upperLimit, const <a class="el" href="classPxSpring.html">PxSpring</a> &amp;<a class="el" href="PxConstraintDesc_8h.html#ab545718d2685b45ef4df86c181ca0baa">spring</a>)</td></tr>
<tr class="memdesc:a8a95bf4d353436b030e652ef3cb1343b"><td class="mdescLeft">&#160;</td><td class="mdescRight">construct a linear soft limit pair <a href="#a8a95bf4d353436b030e652ef3cb1343b">More...</a><br /></td></tr>
<tr class="separator:a8a95bf4d353436b030e652ef3cb1343b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a665b7dfdfae70094a37dac14cc895fbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#a665b7dfdfae70094a37dac14cc895fbe">isValid</a> () const</td></tr>
<tr class="memdesc:a665b7dfdfae70094a37dac14cc895fbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the limit is valid. <a href="#a665b7dfdfae70094a37dac14cc895fbe">More...</a><br /></td></tr>
<tr class="separator:a665b7dfdfae70094a37dac14cc895fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxJointLimitParameters"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxJointLimitParameters')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxJointLimitParameters.html">PxJointLimitParameters</a></td></tr>
<tr class="memitem:ab706ebb59cf473d1537741edfab2c387 inherit pub_methods_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#ab706ebb59cf473d1537741edfab2c387">PxJointLimitParameters</a> ()</td></tr>
<tr class="separator:ab706ebb59cf473d1537741edfab2c387 inherit pub_methods_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a055ad82eede514226e33be0e1a72f87c inherit pub_methods_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#a055ad82eede514226e33be0e1a72f87c">PxJointLimitParameters</a> (const <a class="el" href="classPxJointLimitParameters.html">PxJointLimitParameters</a> &amp;p)</td></tr>
<tr class="separator:a055ad82eede514226e33be0e1a72f87c inherit pub_methods_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8186c20e07fa7f1e06529dce77e06123 inherit pub_methods_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#a8186c20e07fa7f1e06529dce77e06123">isValid</a> () const</td></tr>
<tr class="memdesc:a8186c20e07fa7f1e06529dce77e06123 inherit pub_methods_classPxJointLimitParameters"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the current settings are valid. <a href="classPxJointLimitParameters.html#a8186c20e07fa7f1e06529dce77e06123">More...</a><br /></td></tr>
<tr class="separator:a8186c20e07fa7f1e06529dce77e06123 inherit pub_methods_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af340f6b7f344746a21834fca6ba6eb46 inherit pub_methods_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#af340f6b7f344746a21834fca6ba6eb46">isSoft</a> () const</td></tr>
<tr class="separator:af340f6b7f344746a21834fca6ba6eb46 inherit pub_methods_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a247c6737628a515ca5fc8fd139678d25"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#a247c6737628a515ca5fc8fd139678d25">upper</a></td></tr>
<tr class="memdesc:a247c6737628a515ca5fc8fd139678d25"><td class="mdescLeft">&#160;</td><td class="mdescRight">the range of the limit. The upper limit must be no lower than the lower limit, and if they are equal the limited degree of freedom will be treated as locked. <a href="#a247c6737628a515ca5fc8fd139678d25">More...</a><br /></td></tr>
<tr class="separator:a247c6737628a515ca5fc8fd139678d25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09443a891435349fdafaeae3a6377a2b"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLinearLimitPair.html#a09443a891435349fdafaeae3a6377a2b">lower</a></td></tr>
<tr class="separator:a09443a891435349fdafaeae3a6377a2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classPxJointLimitParameters"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classPxJointLimitParameters')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classPxJointLimitParameters.html">PxJointLimitParameters</a></td></tr>
<tr class="memitem:acf208a0f1e54fb8e9219af1e0357d4a9 inherit pub_attribs_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#acf208a0f1e54fb8e9219af1e0357d4a9">restitution</a></td></tr>
<tr class="memdesc:acf208a0f1e54fb8e9219af1e0357d4a9 inherit pub_attribs_classPxJointLimitParameters"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls the amount of bounce when the joint hits a limit. <a href="classPxJointLimitParameters.html#acf208a0f1e54fb8e9219af1e0357d4a9">More...</a><br /></td></tr>
<tr class="separator:acf208a0f1e54fb8e9219af1e0357d4a9 inherit pub_attribs_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82e6ed96bd05d01b7459d8200f16df9f inherit pub_attribs_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#a82e6ed96bd05d01b7459d8200f16df9f">bounceThreshold</a></td></tr>
<tr class="separator:a82e6ed96bd05d01b7459d8200f16df9f inherit pub_attribs_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7431e7b65a92dd7fafc386c6a159a22c inherit pub_attribs_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#a7431e7b65a92dd7fafc386c6a159a22c">stiffness</a></td></tr>
<tr class="memdesc:a7431e7b65a92dd7fafc386c6a159a22c inherit pub_attribs_classPxJointLimitParameters"><td class="mdescLeft">&#160;</td><td class="mdescRight">if greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit <a href="classPxJointLimitParameters.html#a7431e7b65a92dd7fafc386c6a159a22c">More...</a><br /></td></tr>
<tr class="separator:a7431e7b65a92dd7fafc386c6a159a22c inherit pub_attribs_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac6d185cfc3adea24cdb943cf893beac inherit pub_attribs_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#aac6d185cfc3adea24cdb943cf893beac">damping</a></td></tr>
<tr class="memdesc:aac6d185cfc3adea24cdb943cf893beac inherit pub_attribs_classPxJointLimitParameters"><td class="mdescLeft">&#160;</td><td class="mdescRight">if spring is greater than zero, this is the damping of the limit spring <a href="classPxJointLimitParameters.html#aac6d185cfc3adea24cdb943cf893beac">More...</a><br /></td></tr>
<tr class="separator:aac6d185cfc3adea24cdb943cf893beac inherit pub_attribs_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc405245761d0b153f490ec1dd65af78 inherit pub_attribs_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#adc405245761d0b153f490ec1dd65af78">contactDistance</a></td></tr>
<tr class="memdesc:adc405245761d0b153f490ec1dd65af78 inherit pub_attribs_classPxJointLimitParameters"><td class="mdescLeft">&#160;</td><td class="mdescRight">the distance inside the limit value at which the limit will be considered to be active by the solver. As this value is made larger, the limit becomes active more quickly. It thus becomes less likely to violate the extents of the limit, but more expensive. <a href="classPxJointLimitParameters.html#adc405245761d0b153f490ec1dd65af78">More...</a><br /></td></tr>
<tr class="separator:adc405245761d0b153f490ec1dd65af78 inherit pub_attribs_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classPxJointLimitParameters"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPxJointLimitParameters')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classPxJointLimitParameters.html">PxJointLimitParameters</a></td></tr>
<tr class="memitem:af68daaa7495377cabc01d27d3c2e864e inherit pro_methods_classPxJointLimitParameters"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitParameters.html#af68daaa7495377cabc01d27d3c2e864e">~PxJointLimitParameters</a> ()</td></tr>
<tr class="separator:af68daaa7495377cabc01d27d3c2e864e inherit pro_methods_classPxJointLimitParameters"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes a two-sided limit. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa0bd4b39e190c58bb7db3d09db37fbe2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0bd4b39e190c58bb7db3d09db37fbe2">&#9670;&nbsp;</a></span>PxJointLinearLimitPair() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PxJointLinearLimitPair::PxJointLinearLimitPair </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPxTolerancesScale.html">PxTolerancesScale</a> &amp;&#160;</td>
<td class="paramname"><em>scale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>lowerLimit</em> = <code>-<a class="el" href="group__foundation.html#ga7539e08056ea09ff1c341b866b7103f4">PX_MAX_F32</a>/3.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>upperLimit</em> = <code><a class="el" href="group__foundation.html#ga7539e08056ea09ff1c341b866b7103f4">PX_MAX_F32</a>/3.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>contactDist</em> = <code>-1.0f</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a linear hard limit pair. The lower distance value must be less than the upper distance value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>A <a class="el" href="classPxTolerancesScale.html" title="Class to define the scale at which simulation runs. Most simulation tolerances are calculated in term...">PxTolerancesScale</a> struct. Should be the same as used when creating the <a class="el" href="classPxPhysics.html" title="Abstract singleton factory class used for instancing objects in the Physics SDK. ">PxPhysics</a> object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lowerLimit</td><td>The lower distance of the limit </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">upperLimit</td><td>The upper distance of the limit </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">contactDist</td><td>The distance from the limit at which it becomes active. Default is the lesser of 0.01f scaled by the tolerance length scale, and 0.49 * (upperLimit - lowerLimit)</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit. ">PxJointLimitParameters</a> <a class="el" href="classPxTolerancesScale.html" title="Class to define the scale at which simulation runs. Most simulation tolerances are calculated in term...">PxTolerancesScale</a> </dd></dl>
<p class="reference">References <a class="el" href="classPxJointLimitParameters.html#adc405245761d0b153f490ec1dd65af78">PxJointLimitParameters::contactDistance</a>, <a class="el" href="classPxTolerancesScale.html#a7d93bf20de0e5b54783eda5bb64effeb">PxTolerancesScale::length</a>, and <a class="el" href="group__foundation.html#ga19ecbe58dd6039373c15c8452550bd07">PxMin()</a>.</p>
</div>
</div>
<a id="a8a95bf4d353436b030e652ef3cb1343b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a95bf4d353436b030e652ef3cb1343b">&#9670;&nbsp;</a></span>PxJointLinearLimitPair() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PxJointLinearLimitPair::PxJointLinearLimitPair </td>
<td>(</td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>lowerLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>upperLimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxSpring.html">PxSpring</a> &amp;&#160;</td>
<td class="paramname"><em>spring</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>construct a linear soft limit pair </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">lowerLimit</td><td>The lower distance of the limit </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">upperLimit</td><td>The upper distance of the limit </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">spring</td><td>The stiffness and damping parameters of the limit spring</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxJointLimitParameters.html" title="Describes the parameters for a joint limit. ">PxJointLimitParameters</a> <a class="el" href="classPxTolerancesScale.html" title="Class to define the scale at which simulation runs. Most simulation tolerances are calculated in term...">PxTolerancesScale</a> </dd></dl>
<p class="reference">References <a class="el" href="PxConstraintDesc_8h.html#adc081240b94af5fc9f010e0583263581">damping</a>, <a class="el" href="PxConstraintDesc_8h.html#ab545718d2685b45ef4df86c181ca0baa">spring</a>, and <a class="el" href="PxConstraintDesc_8h.html#a9cf8670b7dde57314a7d3cfc5799c277">stiffness</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a665b7dfdfae70094a37dac14cc895fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a665b7dfdfae70094a37dac14cc895fbe">&#9670;&nbsp;</a></span>isValid()</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="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool PxJointLinearLimitPair::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the limit is valid. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the current settings are valid </dd></dl>
<p class="reference">References <a class="el" href="classPxJointLimitParameters.html#a8186c20e07fa7f1e06529dce77e06123">PxJointLimitParameters::isValid()</a>, and <a class="el" href="group__foundation.html#gad6de0f4af98c5c5280b8fe695dc87318">PxIsFinite()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a09443a891435349fdafaeae3a6377a2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09443a891435349fdafaeae3a6377a2b">&#9670;&nbsp;</a></span>lower</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal PxJointLinearLimitPair::lower</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a247c6737628a515ca5fc8fd139678d25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a247c6737628a515ca5fc8fd139678d25">&#9670;&nbsp;</a></span>upper</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal PxJointLinearLimitPair::upper</td>
</tr>
</table>
</div><div class="memdoc">
<p>the range of the limit. The upper limit must be no lower than the lower limit, and if they are equal the limited degree of freedom will be treated as locked. </p>
<p><b>Range:</b> See the joint on which the limit is used for details<br />
<b>Default:</b> lower = -PX_MAX_F32/3, upper = PX_MAX_F32/3 </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxJointLimit_8h_source.html">PxJointLimit.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classPxJointLinearLimitPair.html">PxJointLinearLimitPair</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>