diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveTank.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveTank.html | 618 |
1 files changed, 618 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveTank.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveTank.html new file mode 100644 index 00000000..b0f56515 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveTank.html @@ -0,0 +1,618 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleDriveTank 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>PxVehicleDriveTank Class Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxVehicleDriveTank" --><!-- doxytag: inherits="PxVehicleDrive" -->Data structure with instanced dynamics data and configuration data of a tank. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxVehicleDriveTank_8h-source.html">PxVehicleDriveTank.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxVehicleDriveTank:</div> +<div class="dynsection"> +<p><center><img src="classPxVehicleDriveTank__inherit__graph.png" border="0" usemap="#PxVehicleDriveTank__inherit__map" alt="Inheritance graph"></center> +<map name="PxVehicleDriveTank__inherit__map"> +<area shape="rect" href="classPxVehicleDrive.html" title="A complete vehicle with instance dynamics data and configuration data for wheels..." alt="PxVehicleDrive" coords="23,155,119,176"><area shape="rect" href="classPxVehicleWheels.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with..." alt="PxVehicleWheels" coords="15,86,127,107"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="43,16,99,38"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxVehicleDriveTank:</div> +<div class="dynsection"> +<p><center><img src="classPxVehicleDriveTank__coll__graph.png" border="0" usemap="#PxVehicleDriveTank__coll__map" alt="Collaboration graph"></center> +<map name="PxVehicleDriveTank__coll__map"> +<area shape="rect" href="classPxVehicleDrive.html" title="A complete vehicle with instance dynamics data and configuration data for wheels..." alt="PxVehicleDrive" coords="2068,185,2164,207"><area shape="rect" href="classPxVehicleWheels.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with..." alt="PxVehicleWheels" coords="1763,127,1875,148"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="389,59,445,80"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="497,85,551,107"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="17,59,255,80"><area shape="rect" href="classPxVehicleWheelsSimData.html" title="Data structure describing configuration data of a vehicle with up to 20 wheels." alt="PxVehicleWheelsSimData" coords="1259,161,1421,183"><area shape="rect" href="classPxVehicleTireLoadFilterData.html" title="Tire load variation can be strongly dependent on the time-step so it is a good idea..." alt="PxVehicleTireLoadFilterData" coords="735,156,908,177"><area shape="rect" href="classPxVehicleAntiRollBarData.html" title="PxVehicleAntiRollBarData" alt="PxVehicleAntiRollBarData" coords="743,225,900,247"><area shape="rect" href="classPxRigidDynamic.html" title="PxRigidDynamic represents a dynamic rigid simulation object in the physics SDK." alt="PxRigidDynamic" coords="1288,92,1392,113"><area shape="rect" href="classPxRigidBody.html" title="PxRigidBody is a base class shared between dynamic rigid body objects." alt="PxRigidBody" coords="779,92,864,113"><area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="601,91,684,112"><area shape="rect" href="classPxVehicleWheelsDynData.html" title="Data structure with instanced dynamics data for wheels." alt="PxVehicleWheelsDynData" coords="1260,231,1420,252"><area shape="rect" href="classPxVehicleDriveDynData.html" title="Data structure with instanced dynamics data for vehicle with engine, clutch, gears..." alt="PxVehicleDriveDynData" coords="1745,185,1892,207"><area shape="rect" href="classPxVehicleDriveSimData.html" title="Data structure describing non-wheel configuration data of a vehicle that has engine..." alt="PxVehicleDriveSimData" coords="2043,324,2189,345"><area shape="rect" href="classPxVehicleGearsData.html" title="PxVehicleGearsData" alt="PxVehicleGearsData" coords="1753,255,1884,276"><area shape="rect" href="classPxVehicleClutchData.html" title="PxVehicleClutchData" alt="PxVehicleClutchData" coords="1755,324,1883,345"><area shape="rect" href="classPxVehicleEngineData.html" title="PxVehicleEngineData" alt="PxVehicleEngineData" coords="1751,393,1887,415"><area shape="rect" href="classPxFixedSizeLookupTable.html" title="PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \>" alt="PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \>" coords="1100,393,1580,415"><area shape="rect" href="classPxVehicleAutoBoxData.html" title="PxVehicleAutoBoxData" alt="PxVehicleAutoBoxData" coords="1748,463,1889,484"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxVehicleDriveTank-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#8570b6024d3da299b1fb3386e05d211d">free</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocate a <a class="el" href="classPxVehicleDriveTank.html" title="Data structure with instanced dynamics data and configuration data of a tank.">PxVehicleDriveTank</a> instance. <a href="#8570b6024d3da299b1fb3386e05d211d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#1cd437995b8664b4d6005a0f636ab318">setup</a> (<a class="el" href="classPxPhysics.html">PxPhysics</a> *physics, <a class="el" href="classPxRigidDynamic.html">PxRigidDynamic</a> *vehActor, const <a class="el" href="classPxVehicleWheelsSimData.html">PxVehicleWheelsSimData</a> &wheelsData, const <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a> &driveData, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbDrivenWheels)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set up a tank using simulation data for the wheels and drive model. <a href="#1cd437995b8664b4d6005a0f636ab318"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#dc228416d792c11e78d41028bf24fad6">setDriveModel</a> (const <a class="el" href="structPxVehicleDriveTankControlModel.html#15800ba4f6142803c1b0d0098a942b13">PxVehicleDriveTankControlModel::Enum</a> driveModel)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the control model used by the tank. <a href="#dc228416d792c11e78d41028bf24fad6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxVehicleDriveTankControlModel.html#15800ba4f6142803c1b0d0098a942b13">PxVehicleDriveTankControlModel::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#746c74417612d45e3e0ed3e7cadb7331">getDriveModel</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the control model used by the tank. <a href="#746c74417612d45e3e0ed3e7cadb7331"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#dbbad11dfa6fb32b6d209ddabf8f9132">setToRestState</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a vehicle to its rest state. Aside from the rigid body transform, this will set the vehicle and rigid body to the state they were in immediately after setup or create. <a href="#dbbad11dfa6fb32b6d209ddabf8f9132"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#af73a5da1f780e4f37b669dfb3e1dd24">PxVehicleDriveTank</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#652ac24e585fd9bde8a95a524113d499">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#652ac24e585fd9bde8a95a524113d499"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#f22ba01c4f83be7141c8d96a30185615">isKindOf</a> (const char *name) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#f22ba01c4f83be7141c8d96a30185615"></a><br></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 <a class="el" href="classPxVehicleDriveTank.html">PxVehicleDriveTank</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#50062f1d584b9db098a6d22db4a72484">allocate</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbWheels)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a PxVehicleTankDrive instance for a tank with nbWheels. <a href="#50062f1d584b9db098a6d22db4a72484"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classPxVehicleDriveTank.html">PxVehicleDriveTank</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#b9e6215ef45bd9c233905d16af15e51e">create</a> (<a class="el" href="classPxPhysics.html">PxPhysics</a> *physics, <a class="el" href="classPxRigidDynamic.html">PxRigidDynamic</a> *vehActor, const <a class="el" href="classPxVehicleWheelsSimData.html">PxVehicleWheelsSimData</a> &wheelsData, const <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a> &driveData, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbDrivenWheels)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate and set up a tank using simulation data for the wheels and drive model. <a href="#b9e6215ef45bd9c233905d16af15e51e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classPxVehicleDriveTank.html">PxVehicleDriveTank</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#8810bf168b44c8ff4d60f9d95bcaca49">createObject</a> (PxU8 *&address, <a class="el" href="classPxDeserializationContext.html">PxDeserializationContext</a> &context)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#494d6b5262d3258b0d3a28ef2ed96a05">getBinaryMetaData</a> (<a class="el" href="classPxOutputStream.html">PxOutputStream</a> &stream)</td></tr> + +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#4070ebf8e6b483c7ec1a018782a14191">mDriveSimData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Simulation data that models vehicle components. <a href="#4070ebf8e6b483c7ec1a018782a14191"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#1d3db837be4782115495f7e5bfcd0a29">PxVehicleDriveTank</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#b3de708a595b35c990d0f10caf60821e">~PxVehicleDriveTank</a> ()</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="classPxVehicleDriveTank.html#63adf47f03d19a8ad4083cc24f429ace">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the instanced dynamics and configuration data has legal values. <a href="#63adf47f03d19a8ad4083cc24f429ace"></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="structPxVehicleDriveTankControlModel.html#15800ba4f6142803c1b0d0098a942b13">PxVehicleDriveTankControlModel::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveTank.html#abddc248b7f189a5f66bec7a0fb4cc20">mDriveModel</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Drive model. <a href="#abddc248b7f189a5f66bec7a0fb4cc20"></a><br></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="classPxVehicleDriveTank.html#68ec7b4f608505eef0775421422791e4">mPad</a> [3]</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="classPxVehicleDriveTank.html#a960a335429c764ff7e258a0ec3ab5f0">PxVehicleUpdate</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Data structure with instanced dynamics data and configuration data of a tank. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="af73a5da1f780e4f37b669dfb3e1dd24"></a><!-- doxytag: member="PxVehicleDriveTank::PxVehicleDriveTank" ref="af73a5da1f780e4f37b669dfb3e1dd24" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveTank::PxVehicleDriveTank </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="1d3db837be4782115495f7e5bfcd0a29"></a><!-- doxytag: member="PxVehicleDriveTank::PxVehicleDriveTank" ref="1d3db837be4782115495f7e5bfcd0a29" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveTank::PxVehicleDriveTank </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b3de708a595b35c990d0f10caf60821e"></a><!-- doxytag: member="PxVehicleDriveTank::~PxVehicleDriveTank" ref="b3de708a595b35c990d0f10caf60821e" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveTank::~PxVehicleDriveTank </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="50062f1d584b9db098a6d22db4a72484"></a><!-- doxytag: member="PxVehicleDriveTank::allocate" ref="50062f1d584b9db098a6d22db4a72484" args="(const PxU32 nbWheels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classPxVehicleDriveTank.html">PxVehicleDriveTank</a>* PxVehicleDriveTank::allocate </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>nbWheels</em> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allocate a PxVehicleTankDrive instance for a tank with nbWheels. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nbWheels</em> </td><td>is the number of wheels on the vehicle.</td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>It is assumed that all wheels are driven wheels.</dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The instantiated vehicle.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#8570b6024d3da299b1fb3386e05d211d" title="Deallocate a PxVehicleDriveTank instance.">free</a>, <a class="el" href="classPxVehicleDriveTank.html#1cd437995b8664b4d6005a0f636ab318" title="Set up a tank using simulation data for the wheels and drive model.">setup</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b9e6215ef45bd9c233905d16af15e51e"></a><!-- doxytag: member="PxVehicleDriveTank::create" ref="b9e6215ef45bd9c233905d16af15e51e" args="(PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimData &driveData, const PxU32 nbDrivenWheels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classPxVehicleDriveTank.html">PxVehicleDriveTank</a>* PxVehicleDriveTank::create </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxPhysics.html">PxPhysics</a> * </td> + <td class="paramname"> <em>physics</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxRigidDynamic.html">PxRigidDynamic</a> * </td> + <td class="paramname"> <em>vehActor</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVehicleWheelsSimData.html">PxVehicleWheelsSimData</a> & </td> + <td class="paramname"> <em>wheelsData</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a> & </td> + <td class="paramname"> <em>driveData</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>nbDrivenWheels</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Allocate and set up a tank using simulation data for the wheels and drive model. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>physics</em> </td><td>is a <a class="el" href="classPxPhysics.html" title="Abstract singleton factory class used for instancing objects in the Physics SDK.">PxPhysics</a> instance that is needed to create special vehicle constraints that are maintained by the tank. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>vehActor</em> </td><td>is a <a class="el" href="classPxRigidDynamic.html" title="PxRigidDynamic represents a dynamic rigid simulation object in the physics SDK.">PxRigidDynamic</a> instance that is used to represent the tank in the PhysX SDK. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>wheelsData</em> </td><td>describes the configuration of all suspension/tires/wheels of the tank. The tank instance takes a copy of this data. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveData</em> </td><td>describes the properties of the tank's drive model (gears/engine/clutch/differential/autobox). The tank instance takes a copy of this data. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nbDrivenWheels</em> </td><td>is the number of wheels on the tank. </td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>It is assumed that the first shapes of the actor are the wheel shapes, followed by the chassis shapes. To break this assumption use <a class="el" href="classPxVehicleWheelsSimData.html#07988e7e4bfd905ae1dd182ef3a1cab1" title="Set mapping between wheel id and position of corresponding wheel shape in the list...">PxVehicleWheelsSimData::setWheelShapeMapping</a>. </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The instantiated vehicle. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#50062f1d584b9db098a6d22db4a72484" title="Allocate a PxVehicleTankDrive instance for a tank with nbWheels.">allocate</a>, <a class="el" href="classPxVehicleDriveTank.html#8570b6024d3da299b1fb3386e05d211d" title="Deallocate a PxVehicleDriveTank instance.">free</a>, <a class="el" href="classPxVehicleDriveTank.html#dbbad11dfa6fb32b6d209ddabf8f9132" title="Set a vehicle to its rest state. Aside from the rigid body transform, this will set...">setToRestState</a>, <a class="el" href="classPxVehicleWheelsSimData.html#07988e7e4bfd905ae1dd182ef3a1cab1" title="Set mapping between wheel id and position of corresponding wheel shape in the list...">PxVehicleWheelsSimData::setWheelShapeMapping</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8810bf168b44c8ff4d60f9d95bcaca49"></a><!-- doxytag: member="PxVehicleDriveTank::createObject" ref="8810bf168b44c8ff4d60f9d95bcaca49" args="(PxU8 *&address, PxDeserializationContext &context)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classPxVehicleDriveTank.html">PxVehicleDriveTank</a>* PxVehicleDriveTank::createObject </td> + <td>(</td> + <td class="paramtype">PxU8 *& </td> + <td class="paramname"> <em>address</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxDeserializationContext.html">PxDeserializationContext</a> & </td> + <td class="paramname"> <em>context</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="8570b6024d3da299b1fb3386e05d211d"></a><!-- doxytag: member="PxVehicleDriveTank::free" ref="8570b6024d3da299b1fb3386e05d211d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveTank::free </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deallocate a <a class="el" href="classPxVehicleDriveTank.html" title="Data structure with instanced dynamics data and configuration data of a tank.">PxVehicleDriveTank</a> instance. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#50062f1d584b9db098a6d22db4a72484" title="Allocate a PxVehicleTankDrive instance for a tank with nbWheels.">allocate</a> </dd></dl> + +<p>Reimplemented from <a class="el" href="classPxVehicleDrive.html#2af80cf3e4d767f1710a8f2e244cb9d5">PxVehicleDrive</a>.</p> + +</div> +</div><p> +<a class="anchor" name="494d6b5262d3258b0d3a28ef2ed96a05"></a><!-- doxytag: member="PxVehicleDriveTank::getBinaryMetaData" ref="494d6b5262d3258b0d3a28ef2ed96a05" args="(PxOutputStream &stream)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static void PxVehicleDriveTank::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="classPxVehicleDrive.html#470aa1489a7b10ac9a1c13ee0d374633">PxVehicleDrive</a>.</p> + +</div> +</div><p> +<a class="anchor" name="652ac24e585fd9bde8a95a524113d499"></a><!-- doxytag: member="PxVehicleDriveTank::getConcreteTypeName" ref="652ac24e585fd9bde8a95a524113d499" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxVehicleDriveTank::getConcreteTypeName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns string name of dynamic type. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl> + +<p>Reimplemented from <a class="el" href="classPxVehicleDrive.html#17195d04ae142a150f66d4b8fdee87ed">PxVehicleDrive</a>.</p> + +</div> +</div><p> +<a class="anchor" name="746c74417612d45e3e0ed3e7cadb7331"></a><!-- doxytag: member="PxVehicleDriveTank::getDriveModel" ref="746c74417612d45e3e0ed3e7cadb7331" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxVehicleDriveTankControlModel.html#15800ba4f6142803c1b0d0098a942b13">PxVehicleDriveTankControlModel::Enum</a> PxVehicleDriveTank::getDriveModel </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the control model used by the tank. +<p> + +</div> +</div><p> +<a class="anchor" name="f22ba01c4f83be7141c8d96a30185615"></a><!-- doxytag: member="PxVehicleDriveTank::isKindOf" ref="f22ba01c4f83be7141c8d96a30185615" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxVehicleDriveTank::isKindOf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>superClass</em> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns whether a given type name matches with the type of this instance. +<p> + +<p>Reimplemented from <a class="el" href="classPxVehicleDrive.html#19c6167aadc9202fcb1bc59c376409c1">PxVehicleDrive</a>.</p> + +<p>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="63adf47f03d19a8ad4083cc24f429ace"></a><!-- doxytag: member="PxVehicleDriveTank::isValid" ref="63adf47f03d19a8ad4083cc24f429ace" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDriveTank::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 instanced dynamics and configuration data has legal values. +<p> + +<p>Reimplemented from <a class="el" href="classPxVehicleDrive.html#95ec8411c57f19eeac7bf0677f00c396">PxVehicleDrive</a>.</p> + +</div> +</div><p> +<a class="anchor" name="dc228416d792c11e78d41028bf24fad6"></a><!-- doxytag: member="PxVehicleDriveTank::setDriveModel" ref="dc228416d792c11e78d41028bf24fad6" args="(const PxVehicleDriveTankControlModel::Enum driveModel)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveTank::setDriveModel </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structPxVehicleDriveTankControlModel.html#15800ba4f6142803c1b0d0098a942b13">PxVehicleDriveTankControlModel::Enum</a> </td> + <td class="paramname"> <em>driveModel</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the control model used by the tank. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>eDRIVE_MODEL_STANDARD: turning achieved by braking on one side, accelerating on the other side. <p> +eDRIVE_MODEL_SPECIAL: turning achieved by accelerating forwards on one side, accelerating backwards on the other side. <p> +The default value is eDRIVE_MODEL_STANDARD </dd></dl> + +</div> +</div><p> +<a class="anchor" name="dbbad11dfa6fb32b6d209ddabf8f9132"></a><!-- doxytag: member="PxVehicleDriveTank::setToRestState" ref="dbbad11dfa6fb32b6d209ddabf8f9132" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveTank::setToRestState </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a vehicle to its rest state. Aside from the rigid body transform, this will set the vehicle and rigid body to the state they were in immediately after setup or create. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Calling setToRestState invalidates the cached raycast hit planes under each wheel meaning that suspension line raycasts need to be performed at least once with PxVehicleSuspensionRaycasts before calling PxVehicleUpdates. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#1cd437995b8664b4d6005a0f636ab318" title="Set up a tank using simulation data for the wheels and drive model.">setup</a>, <a class="el" href="classPxVehicleDriveTank.html#b9e6215ef45bd9c233905d16af15e51e" title="Allocate and set up a tank using simulation data for the wheels and drive model.">create</a>, <a class="el" href="group__vehicle.html#g2020b9fcb5092e2a2d81e82ba7461dfd" title="Perform raycasts for all suspension lines for all vehicles.">PxVehicleSuspensionRaycasts</a>, <a class="el" href="group__vehicle.html#g47aff43683966ca9d1118a1bf4a1f5c2" title="Update an array of vehicles by either applying an acceleration to the rigid body...">PxVehicleUpdates</a> </dd></dl> + +<p>Reimplemented from <a class="el" href="classPxVehicleDrive.html#a5fdf730d2b90e2fdbd2dd34d2a01765">PxVehicleDrive</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1cd437995b8664b4d6005a0f636ab318"></a><!-- doxytag: member="PxVehicleDriveTank::setup" ref="1cd437995b8664b4d6005a0f636ab318" args="(PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimData &driveData, const PxU32 nbDrivenWheels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveTank::setup </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxPhysics.html">PxPhysics</a> * </td> + <td class="paramname"> <em>physics</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxRigidDynamic.html">PxRigidDynamic</a> * </td> + <td class="paramname"> <em>vehActor</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVehicleWheelsSimData.html">PxVehicleWheelsSimData</a> & </td> + <td class="paramname"> <em>wheelsData</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a> & </td> + <td class="paramname"> <em>driveData</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>nbDrivenWheels</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set up a tank using simulation data for the wheels and drive model. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>physics</em> </td><td>is a <a class="el" href="classPxPhysics.html" title="Abstract singleton factory class used for instancing objects in the Physics SDK.">PxPhysics</a> instance that is needed to create special vehicle constraints that are maintained by the vehicle. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>vehActor</em> </td><td>is a <a class="el" href="classPxRigidDynamic.html" title="PxRigidDynamic represents a dynamic rigid simulation object in the physics SDK.">PxRigidDynamic</a> instance that is used to represent the tank in the PhysX SDK. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>wheelsData</em> </td><td>describes the configuration of all suspension/tires/wheels of the tank. The tank instance takes a copy of this data. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveData</em> </td><td>describes the properties of the tank's drive model (gears/engine/clutch/autobox). The tank instance takes a copy of this data. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nbDrivenWheels</em> </td><td>is the number of wheels on the tank. </td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>It is assumed that the first shapes of the actor are the wheel shapes, followed by the chassis shapes. To break this assumption use <a class="el" href="classPxVehicleWheelsSimData.html#07988e7e4bfd905ae1dd182ef3a1cab1" title="Set mapping between wheel id and position of corresponding wheel shape in the list...">PxVehicleWheelsSimData::setWheelShapeMapping</a>. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#50062f1d584b9db098a6d22db4a72484" title="Allocate a PxVehicleTankDrive instance for a tank with nbWheels.">allocate</a>, <a class="el" href="classPxVehicleDriveTank.html#8570b6024d3da299b1fb3386e05d211d" title="Deallocate a PxVehicleDriveTank instance.">free</a>, <a class="el" href="classPxVehicleDriveTank.html#dbbad11dfa6fb32b6d209ddabf8f9132" title="Set a vehicle to its rest state. Aside from the rigid body transform, this will set...">setToRestState</a>, <a class="el" href="classPxVehicleWheelsSimData.html#07988e7e4bfd905ae1dd182ef3a1cab1" title="Set mapping between wheel id and position of corresponding wheel shape in the list...">PxVehicleWheelsSimData::setWheelShapeMapping</a> </dd></dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>nbDrivenWheels must be an even number <p> +The wheels must be arranged according to <a class="el" href="structPxVehicleDriveTankWheelOrder.html" title="The ordering of the wheels of a PxVehicleDriveTank.">PxVehicleDriveTankWheelOrder</a>; that is, the even wheels are on the left side of the tank and the odd wheels are on the right side of the tank. </dd></dl> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="a960a335429c764ff7e258a0ec3ab5f0"></a><!-- doxytag: member="PxVehicleDriveTank::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> + +<p>Reimplemented from <a class="el" href="classPxVehicleDrive.html#a960a335429c764ff7e258a0ec3ab5f0">PxVehicleDrive</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="abddc248b7f189a5f66bec7a0fb4cc20"></a><!-- doxytag: member="PxVehicleDriveTank::mDriveModel" ref="abddc248b7f189a5f66bec7a0fb4cc20" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxVehicleDriveTankControlModel.html#15800ba4f6142803c1b0d0098a942b13">PxVehicleDriveTankControlModel::Enum</a> <a class="el" href="classPxVehicleDriveTank.html#abddc248b7f189a5f66bec7a0fb4cc20">PxVehicleDriveTank::mDriveModel</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Drive model. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#dc228416d792c11e78d41028bf24fad6" title="Set the control model used by the tank.">setDriveModel</a>, <a class="el" href="classPxVehicleDriveTank.html#746c74417612d45e3e0ed3e7cadb7331" title="Return the control model used by the tank.">getDriveModel</a>, <a class="el" href="structPxVehicleDriveTankControlModel.html" title="Two driving models are supported.">PxVehicleDriveTankControlModel</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="4070ebf8e6b483c7ec1a018782a14191"></a><!-- doxytag: member="PxVehicleDriveTank::mDriveSimData" ref="4070ebf8e6b483c7ec1a018782a14191" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a> <a class="el" href="classPxVehicleDriveTank.html#4070ebf8e6b483c7ec1a018782a14191">PxVehicleDriveTank::mDriveSimData</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Simulation data that models vehicle components. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveTank.html#1cd437995b8664b4d6005a0f636ab318" title="Set up a tank using simulation data for the wheels and drive model.">setup</a>, <a class="el" href="classPxVehicleDriveTank.html#b9e6215ef45bd9c233905d16af15e51e" title="Allocate and set up a tank using simulation data for the wheels and drive model.">create</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="68ec7b4f608505eef0775421422791e4"></a><!-- doxytag: member="PxVehicleDriveTank::mPad" ref="68ec7b4f608505eef0775421422791e4" args="[3]" --> +<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="classPxVehicleDriveTank.html#68ec7b4f608505eef0775421422791e4">PxVehicleDriveTank::mPad</a>[3]<code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>Reimplemented from <a class="el" href="classPxVehicleWheels.html#deb429d0017a644524cbc4183e3f24f6">PxVehicleWheels</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxVehicleDriveTank_8h-source.html">PxVehicleDriveTank.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> |