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

364 lines
25 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>PxJointLimitCone 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('classPxJointLimitCone.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="classPxJointLimitCone-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxJointLimitCone Class Reference<div class="ingroups"><a class="el" href="group__extensions.html">Extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Describes an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter.
<a href="classPxJointLimitCone.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 PxJointLimitCone:</div>
<div class="dyncontent">
<div class="center"><img src="classPxJointLimitCone__inherit__graph.png" border="0" usemap="#PxJointLimitCone_inherit__map" alt="Inheritance graph"/></div>
<map name="PxJointLimitCone_inherit__map" id="PxJointLimitCone_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 PxJointLimitCone:</div>
<div class="dyncontent">
<div class="center"><img src="classPxJointLimitCone__coll__graph.png" border="0" usemap="#PxJointLimitCone_coll__map" alt="Collaboration graph"/></div>
<map name="PxJointLimitCone_coll__map" id="PxJointLimitCone_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:ac942cefe6d9cb042a4e323266d2b29b9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitCone.html#ac942cefe6d9cb042a4e323266d2b29b9">PxJointLimitCone</a> (PxReal yLimitAngle, PxReal zLimitAngle, PxReal contactDist=-1.0f)</td></tr>
<tr class="memdesc:ac942cefe6d9cb042a4e323266d2b29b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a cone hard limit. <a href="#ac942cefe6d9cb042a4e323266d2b29b9">More...</a><br /></td></tr>
<tr class="separator:ac942cefe6d9cb042a4e323266d2b29b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bb99b52fb177d263b926938b239aa9c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitCone.html#a0bb99b52fb177d263b926938b239aa9c">PxJointLimitCone</a> (PxReal yLimitAngle, PxReal zLimitAngle, 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:a0bb99b52fb177d263b926938b239aa9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a cone soft limit. <a href="#a0bb99b52fb177d263b926938b239aa9c">More...</a><br /></td></tr>
<tr class="separator:a0bb99b52fb177d263b926938b239aa9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a122b0e940c3ec2227e856ffe51ca7c2e"><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="classPxJointLimitCone.html#a122b0e940c3ec2227e856ffe51ca7c2e">isValid</a> () const</td></tr>
<tr class="memdesc:a122b0e940c3ec2227e856ffe51ca7c2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the limit is valid. <a href="#a122b0e940c3ec2227e856ffe51ca7c2e">More...</a><br /></td></tr>
<tr class="separator:a122b0e940c3ec2227e856ffe51ca7c2e"><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:aeac6d3168fe1a6ccca4642a9f19e50a7"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitCone.html#aeac6d3168fe1a6ccca4642a9f19e50a7">yAngle</a></td></tr>
<tr class="memdesc:aeac6d3168fe1a6ccca4642a9f19e50a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">the maximum angle from the Y axis of the constraint frame. <a href="#aeac6d3168fe1a6ccca4642a9f19e50a7">More...</a><br /></td></tr>
<tr class="separator:aeac6d3168fe1a6ccca4642a9f19e50a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af14e3c875ee7f9cf772bafc535af7631"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxJointLimitCone.html#af14e3c875ee7f9cf772bafc535af7631">zAngle</a></td></tr>
<tr class="memdesc:af14e3c875ee7f9cf772bafc535af7631"><td class="mdescLeft">&#160;</td><td class="mdescRight">the maximum angle from the Z-axis of the constraint frame. <a href="#af14e3c875ee7f9cf772bafc535af7631">More...</a><br /></td></tr>
<tr class="separator:af14e3c875ee7f9cf772bafc535af7631"><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 an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxD6Joint.html" title="A D6 joint is a general constraint between two actors. ">PxD6Joint</a> <a class="el" href="classPxSphericalJoint.html" title="A joint which behaves in a similar way to a ball and socket. ">PxSphericalJoint</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac942cefe6d9cb042a4e323266d2b29b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac942cefe6d9cb042a4e323266d2b29b9">&#9670;&nbsp;</a></span>PxJointLimitCone() <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">PxJointLimitCone::PxJointLimitCone </td>
<td>(</td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>yLimitAngle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>zLimitAngle</em>, </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 cone hard limit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">yLimitAngle</td><td>The limit angle from the Y-axis of the constraint frame </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">zLimitAngle</td><td>The limit angle from the Z-axis of the constraint frame </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.1 radians, and 0.49 * the lower of the limit angles</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> </dd></dl>
<p class="reference">References <a class="el" href="classPxJointLimitParameters.html#adc405245761d0b153f490ec1dd65af78">PxJointLimitParameters::contactDistance</a>, and <a class="el" href="group__foundation.html#ga19ecbe58dd6039373c15c8452550bd07">PxMin()</a>.</p>
</div>
</div>
<a id="a0bb99b52fb177d263b926938b239aa9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bb99b52fb177d263b926938b239aa9c">&#9670;&nbsp;</a></span>PxJointLimitCone() <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">PxJointLimitCone::PxJointLimitCone </td>
<td>(</td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>yLimitAngle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal&#160;</td>
<td class="paramname"><em>zLimitAngle</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 cone soft limit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">yLimitAngle</td><td>The limit angle from the Y-axis of the constraint frame </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">zLimitAngle</td><td>The limit angle from the Z-axis of the constraint frame </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">spring</td><td>The stiffness and damping 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> </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="a122b0e940c3ec2227e856ffe51ca7c2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a122b0e940c3ec2227e856ffe51ca7c2e">&#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 PxJointLimitCone::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>, <a class="el" href="group__foundation.html#gad6de0f4af98c5c5280b8fe695dc87318">PxIsFinite()</a>, and <a class="el" href="group__foundation.html#gabcd49a429b8119de54375b3538ae8a8d">PxPi</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aeac6d3168fe1a6ccca4642a9f19e50a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeac6d3168fe1a6ccca4642a9f19e50a7">&#9670;&nbsp;</a></span>yAngle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal PxJointLimitCone::yAngle</td>
</tr>
</table>
</div><div class="memdoc">
<p>the maximum angle from the Y axis of the constraint frame. </p>
<p><b>Unit:</b> Angular: Radians <b>Range:</b> Angular: (0,PI)<br />
<b>Default:</b> PI/2 </p>
</div>
</div>
<a id="af14e3c875ee7f9cf772bafc535af7631"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af14e3c875ee7f9cf772bafc535af7631">&#9670;&nbsp;</a></span>zAngle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal PxJointLimitCone::zAngle</td>
</tr>
</table>
</div><div class="memdoc">
<p>the maximum angle from the Z-axis of the constraint frame. </p>
<p><b>Unit:</b> Angular: Radians <b>Range:</b> Angular: (0,PI)<br />
<b>Default:</b> PI/2 </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="classPxJointLimitCone.html">PxJointLimitCone</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>