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/classPxVehicleDriveSimData4W.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/classPxVehicleDriveSimData4W.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveSimData4W.html | 327 |
1 files changed, 327 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveSimData4W.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveSimData4W.html new file mode 100644 index 00000000..1f8fcf2f --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveSimData4W.html @@ -0,0 +1,327 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleDriveSimData4W 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>PxVehicleDriveSimData4W Class Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxVehicleDriveSimData4W" --><!-- doxytag: inherits="PxVehicleDriveSimData" -->Data structure describing the drive model components of a vehicle with up to 4 driven wheels and up to 16 un-driven wheels. The drive model incorporates engine, clutch, gears, autobox, differential, and Ackermann steer correction. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxVehicleDrive4W_8h-source.html">PxVehicleDrive4W.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxVehicleDriveSimData4W:</div> +<div class="dynsection"> +<p><center><img src="classPxVehicleDriveSimData4W__inherit__graph.png" border="0" usemap="#PxVehicleDriveSimData4W__inherit__map" alt="Inheritance graph"></center> +<map name="PxVehicleDriveSimData4W__inherit__map"> +<area shape="rect" href="classPxVehicleDriveSimData.html" title="Data structure describing non-wheel configuration data of a vehicle that has engine..." alt="PxVehicleDriveSimData" coords="16,16,163,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxVehicleDriveSimData4W:</div> +<div class="dynsection"> +<p><center><img src="classPxVehicleDriveSimData4W__coll__graph.png" border="0" usemap="#PxVehicleDriveSimData4W__coll__map" alt="Collaboration graph"></center> +<map name="PxVehicleDriveSimData4W__coll__map"> +<area shape="rect" href="classPxVehicleDriveSimData.html" title="Data structure describing non-wheel configuration data of a vehicle that has engine..." alt="PxVehicleDriveSimData" coords="217,198,364,219"><area shape="rect" href="classPxVehicleGearsData.html" title="PxVehicleGearsData" alt="PxVehicleGearsData" coords="7,107,137,128"><area shape="rect" href="classPxVehicleClutchData.html" title="PxVehicleClutchData" alt="PxVehicleClutchData" coords="161,107,289,128"><area shape="rect" href="classPxVehicleEngineData.html" title="PxVehicleEngineData" alt="PxVehicleEngineData" coords="313,107,449,128"><area shape="rect" href="classPxFixedSizeLookupTable.html" title="PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \>" alt="PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \>" coords="141,16,621,38"><area shape="rect" href="classPxVehicleAutoBoxData.html" title="PxVehicleAutoBoxData" alt="PxVehicleAutoBoxData" coords="473,107,615,128"><area shape="rect" href="classPxVehicleDifferential4WData.html" title="PxVehicleDifferential4WData" alt="PxVehicleDifferential4WData" coords="388,198,561,219"><area shape="rect" href="classPxVehicleAckermannGeometryData.html" title="PxVehicleAckermannGeometryData" alt="PxVehicleAckermannGeometryData" coords="585,198,801,219"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxVehicleDriveSimData4W-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="classPxVehicleDriveSimData4W.html#b79ed54dbd9ead2aeef21ee3c4e270a9">PxVehicleDriveSimData4W</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE const <br class="typebreak"> +<a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#5fed6583be837a24605373d155b8170a">getDiffData</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the data describing the differential. <a href="#5fed6583be837a24605373d155b8170a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE const <br class="typebreak"> +<a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#848a87fab754dd9acaafd857b7dbf1e6">getAckermannGeometryData</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the data describing the Ackermann steer-correction. <a href="#848a87fab754dd9acaafd857b7dbf1e6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#6a0bd7a643cdba6571de4470ddb8533b">setDiffData</a> (const <a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> &diff)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data describing the differential. <a href="#6a0bd7a643cdba6571de4470ddb8533b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#5a0a4baf4721c3b213258978ed7003fb">setAckermannGeometryData</a> (const <a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> &ackermannData)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data describing the Ackermann steer-correction. <a href="#5a0a4baf4721c3b213258978ed7003fb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#db99a930a7426f4835c48574ee77e947">PxVehicleDriveSimData4W</a> (const <a class="el" href="group__foundation.html#g0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr> + +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#fdfd16778fc3f905ecef5552697af8e1">getBinaryMetaData</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &stream)</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="classPxVehicleDriveSimData4W.html#fa8f53655e4b0298fa1a9ad0645ab437">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the 4W-drive simulation data has been setup with legal data. <a href="#fa8f53655e4b0298fa1a9ad0645ab437"></a><br></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="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#2833f597f39e2ec08492130a795e353e">mDiff</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Differential simulation data. <a href="#2833f597f39e2ec08492130a795e353e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveSimData4W.html#8665e6e42fb679b35be211b1306a0ff3">mAckermannGeometry</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Data for ackermann steer angle computation. <a href="#8665e6e42fb679b35be211b1306a0ff3"></a><br></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="classPxVehicleDriveSimData4W.html#24d8342a0d0166c21ae69a1497d54cee">PxVehicleDrive4W</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Data structure describing the drive model components of a vehicle with up to 4 driven wheels and up to 16 un-driven wheels. The drive model incorporates engine, clutch, gears, autobox, differential, and Ackermann steer correction. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveSimData.html" title="Data structure describing non-wheel configuration data of a vehicle that has engine...">PxVehicleDriveSimData</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="b79ed54dbd9ead2aeef21ee3c4e270a9"></a><!-- doxytag: member="PxVehicleDriveSimData4W::PxVehicleDriveSimData4W" ref="b79ed54dbd9ead2aeef21ee3c4e270a9" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveSimData4W::PxVehicleDriveSimData4W </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="db99a930a7426f4835c48574ee77e947"></a><!-- doxytag: member="PxVehicleDriveSimData4W::PxVehicleDriveSimData4W" ref="db99a930a7426f4835c48574ee77e947" args="(const PxEMPTY)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveSimData4W::PxVehicleDriveSimData4W </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="848a87fab754dd9acaafd857b7dbf1e6"></a><!-- doxytag: member="PxVehicleDriveSimData4W::getAckermannGeometryData" ref="848a87fab754dd9acaafd857b7dbf1e6" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE const <a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a>& PxVehicleDriveSimData4W::getAckermannGeometryData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the data describing the Ackermann steer-correction. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fdfd16778fc3f905ecef5552697af8e1"></a><!-- doxytag: member="PxVehicleDriveSimData4W::getBinaryMetaData" ref="fdfd16778fc3f905ecef5552697af8e1" args="(PxOutputStream &stream)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static void PxVehicleDriveSimData4W::getBinaryMetaData </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> & </td> + <td class="paramname"> <em>stream</em> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>Reimplemented from <a class="el" href="classPxVehicleDriveSimData.html#5a3f6a35f390ed5a87fc56e31d656db0">PxVehicleDriveSimData</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5fed6583be837a24605373d155b8170a"></a><!-- doxytag: member="PxVehicleDriveSimData4W::getDiffData" ref="5fed6583be837a24605373d155b8170a" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE const <a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a>& PxVehicleDriveSimData4W::getDiffData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the data describing the differential. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fa8f53655e4b0298fa1a9ad0645ab437"></a><!-- doxytag: member="PxVehicleDriveSimData4W::isValid" ref="fa8f53655e4b0298fa1a9ad0645ab437" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDriveSimData4W::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Test if the 4W-drive simulation data has been setup with legal data. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Call only after setting all components. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>setEnginedata, <a class="el" href="classPxVehicleDriveSimData.html#0edff168e18a4d5c923460cb0ee3fe8b" title="Set the clutch data.">setClutchData</a>, <a class="el" href="classPxVehicleDriveSimData.html#6596d7535d54f6a43a6575b8f4c51748" title="Set the gears data.">setGearsData</a>, setAutoboxData, <a class="el" href="classPxVehicleDriveSimData4W.html#6a0bd7a643cdba6571de4470ddb8533b" title="Set the data describing the differential.">setDiffData</a>, <a class="el" href="classPxVehicleDriveSimData4W.html#5a0a4baf4721c3b213258978ed7003fb" title="Set the data describing the Ackermann steer-correction.">setAckermannGeometryData</a> </dd></dl> + +<p>Reimplemented from <a class="el" href="classPxVehicleDriveSimData.html#a9721ce91e1d9d3a0da51ad8e657d355">PxVehicleDriveSimData</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5a0a4baf4721c3b213258978ed7003fb"></a><!-- doxytag: member="PxVehicleDriveSimData4W::setAckermannGeometryData" ref="5a0a4baf4721c3b213258978ed7003fb" args="(const PxVehicleAckermannGeometryData &ackermannData)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveSimData4W::setAckermannGeometryData </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> & </td> + <td class="paramname"> <em>ackermannData</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the data describing the Ackermann steer-correction. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6a0bd7a643cdba6571de4470ddb8533b"></a><!-- doxytag: member="PxVehicleDriveSimData4W::setDiffData" ref="6a0bd7a643cdba6571de4470ddb8533b" args="(const PxVehicleDifferential4WData &diff)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveSimData4W::setDiffData </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> & </td> + <td class="paramname"> <em>diff</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the data describing the differential. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> </dd></dl> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="24d8342a0d0166c21ae69a1497d54cee"></a><!-- doxytag: member="PxVehicleDriveSimData4W::PxVehicleDrive4W" ref="24d8342a0d0166c21ae69a1497d54cee" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classPxVehicleDrive4W.html">PxVehicleDrive4W</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="8665e6e42fb679b35be211b1306a0ff3"></a><!-- doxytag: member="PxVehicleDriveSimData4W::mAckermannGeometry" ref="8665e6e42fb679b35be211b1306a0ff3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVehicleAckermannGeometryData.html">PxVehicleAckermannGeometryData</a> <a class="el" href="classPxVehicleDriveSimData4W.html#8665e6e42fb679b35be211b1306a0ff3">PxVehicleDriveSimData4W::mAckermannGeometry</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Data for ackermann steer angle computation. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveSimData4W.html#5a0a4baf4721c3b213258978ed7003fb" title="Set the data describing the Ackermann steer-correction.">setAckermannGeometryData</a>, <a class="el" href="classPxVehicleDriveSimData4W.html#848a87fab754dd9acaafd857b7dbf1e6" title="Return the data describing the Ackermann steer-correction.">getAckermannGeometryData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2833f597f39e2ec08492130a795e353e"></a><!-- doxytag: member="PxVehicleDriveSimData4W::mDiff" ref="2833f597f39e2ec08492130a795e353e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVehicleDifferential4WData.html">PxVehicleDifferential4WData</a> <a class="el" href="classPxVehicleDriveSimData4W.html#2833f597f39e2ec08492130a795e353e">PxVehicleDriveSimData4W::mDiff</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Differential simulation data. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveSimData4W.html#6a0bd7a643cdba6571de4470ddb8533b" title="Set the data describing the differential.">setDiffData</a>, <a class="el" href="classPxVehicleDriveSimData4W.html#5fed6583be837a24605373d155b8170a" title="Return the data describing the differential.">getDiffData</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxVehicleDrive4W_8h-source.html">PxVehicleDrive4W.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> |