diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDifferentialNWData.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDifferentialNWData.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDifferentialNWData.html | 318 |
1 files changed, 318 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDifferentialNWData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDifferentialNWData.html new file mode 100644 index 00000000..376324dc --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDifferentialNWData.html @@ -0,0 +1,318 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleDifferentialNWData Class Reference</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css"> + </head> + + <body bgcolor="#FFFFFF"> + <div id="header"> + <hr class="first"> + <img alt="" src="images/PhysXlogo.png" align="middle"> <br> + <center> + <a class="qindex" href="main.html">Main Page</a> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxVehicleDifferentialNWData Class Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxVehicleDifferentialNWData" --><code>#include <<a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.h</a>></code> +<p> + +<p> +<a href="classPxVehicleDifferentialNWData-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#a363bb07cd4533cfee8a59bc14d03c10">PxVehicleDifferentialNWData</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#c8976b0853cae0c7baf95603aa1909f9">setDrivenWheel</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> wheelId, const bool drivenState)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a specific wheel to be driven or non-driven by the differential. <a href="#c8976b0853cae0c7baf95603aa1909f9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#d6ce03b73ade4456d46790901e2ba011">getIsDrivenWheel</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> wheelId) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a specific wheel has been configured as a driven or non-driven wheel. <a href="#d6ce03b73ade4456d46790901e2ba011"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#df2433f5f82e770290a30dfe1eda3a81">PxVehicleDifferentialNWData</a> (const <a class="el" href="group__foundation.html#g0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#fdbdba4ebebfa67f63a0fe2244125ebf">getDrivenWheelStatus</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#9041277bd53d21ad9992365185f9a06e">setDrivenWheelStatus</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> status)</td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#381805ed5c4501a6b84c312742e6f579">isValid</a> () const </td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#7cbdd47808542cbabbd7486b8ab73151">mBitmapBuffer</a> [((PX_MAX_NB_WHEELS+31)&~31) >> 5]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#d568184c553c242cd8dac918d3a39eb9">mNbDrivenWheels</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#7dad368357aa927245c645706cc0e280">mInvNbDrivenWheels</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#ef3d841f346427763b04148b07ad76bd">mPad</a></td></tr> + +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#966a53de4d7949668cafafe064045841">PxVehicleDriveSimDataNW</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDifferentialNWData.html#a960a335429c764ff7e258a0ec3ab5f0">PxVehicleUpdate</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="a363bb07cd4533cfee8a59bc14d03c10"></a><!-- doxytag: member="PxVehicleDifferentialNWData::PxVehicleDifferentialNWData" ref="a363bb07cd4533cfee8a59bc14d03c10" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDifferentialNWData::PxVehicleDifferentialNWData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxVehicleSDK_8h-source.html#l00081">PX_MAX_NB_WHEELS</a>, and <a class="el" href="PxMemory_8h-source.html#l00068">PxMemSet()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="df2433f5f82e770290a30dfe1eda3a81"></a><!-- doxytag: member="PxVehicleDifferentialNWData::PxVehicleDifferentialNWData" ref="df2433f5f82e770290a30dfe1eda3a81" args="(const PxEMPTY)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDifferentialNWData::PxVehicleDifferentialNWData </td> + <td>(</td> + <td class="paramtype">const </td> + <td class="paramname"> <em>PxEMPTY</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="fdbdba4ebebfa67f63a0fe2244125ebf"></a><!-- doxytag: member="PxVehicleDifferentialNWData::getDrivenWheelStatus" ref="fdbdba4ebebfa67f63a0fe2244125ebf" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDifferentialNWData::getDrivenWheelStatus </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="d6ce03b73ade4456d46790901e2ba011"></a><!-- doxytag: member="PxVehicleDifferentialNWData::getIsDrivenWheel" ref="d6ce03b73ade4456d46790901e2ba011" args="(const PxU32 wheelId) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDifferentialNWData::getIsDrivenWheel </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>wheelId</em> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Test if a specific wheel has been configured as a driven or non-driven wheel. +<p> + +</div> +</div><p> +<a class="anchor" name="381805ed5c4501a6b84c312742e6f579"></a><!-- doxytag: member="PxVehicleDifferentialNWData::isValid" ref="381805ed5c4501a6b84c312742e6f579" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDifferentialNWData::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="c8976b0853cae0c7baf95603aa1909f9"></a><!-- doxytag: member="PxVehicleDifferentialNWData::setDrivenWheel" ref="c8976b0853cae0c7baf95603aa1909f9" args="(const PxU32 wheelId, const bool drivenState)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDifferentialNWData::setDrivenWheel </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>wheelId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const bool </td> + <td class="paramname"> <em>drivenState</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a specific wheel to be driven or non-driven by the differential. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The available drive torque will be split equally between all driven wheels. Zero torque will be applied to non-driven wheels. The default state of each wheel is to be uncoupled to the differential. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9041277bd53d21ad9992365185f9a06e"></a><!-- doxytag: member="PxVehicleDifferentialNWData::setDrivenWheelStatus" ref="9041277bd53d21ad9992365185f9a06e" args="(PxU32 status)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDifferentialNWData::setDrivenWheelStatus </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>status</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="966a53de4d7949668cafafe064045841"></a><!-- doxytag: member="PxVehicleDifferentialNWData::PxVehicleDriveSimDataNW" ref="966a53de4d7949668cafafe064045841" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="a960a335429c764ff7e258a0ec3ab5f0"></a><!-- doxytag: member="PxVehicleDifferentialNWData::PxVehicleUpdate" ref="a960a335429c764ff7e258a0ec3ab5f0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class PxVehicleUpdate<code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="7cbdd47808542cbabbd7486b8ab73151"></a><!-- doxytag: member="PxVehicleDifferentialNWData::mBitmapBuffer" ref="7cbdd47808542cbabbd7486b8ab73151" args="[((PX_MAX_NB_WHEELS+31)&~31) >> 5]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxVehicleDifferentialNWData.html#7cbdd47808542cbabbd7486b8ab73151">PxVehicleDifferentialNWData::mBitmapBuffer</a>[((PX_MAX_NB_WHEELS+31)&~31) >> 5]<code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="7dad368357aa927245c645706cc0e280"></a><!-- doxytag: member="PxVehicleDifferentialNWData::mInvNbDrivenWheels" ref="7dad368357aa927245c645706cc0e280" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleDifferentialNWData.html#7dad368357aa927245c645706cc0e280">PxVehicleDifferentialNWData::mInvNbDrivenWheels</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="d568184c553c242cd8dac918d3a39eb9"></a><!-- doxytag: member="PxVehicleDifferentialNWData::mNbDrivenWheels" ref="d568184c553c242cd8dac918d3a39eb9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxVehicleDifferentialNWData.html#d568184c553c242cd8dac918d3a39eb9">PxVehicleDifferentialNWData::mNbDrivenWheels</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="ef3d841f346427763b04148b07ad76bd"></a><!-- doxytag: member="PxVehicleDifferentialNWData::mPad" ref="ef3d841f346427763b04148b07ad76bd" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxVehicleDifferentialNWData.html#ef3d841f346427763b04148b07ad76bd">PxVehicleDifferentialNWData::mPad</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a> +</body> +</html> |