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/classPxVehicleDriveNW.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/classPxVehicleDriveNW.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveNW.html | 521 |
1 files changed, 521 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveNW.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveNW.html new file mode 100644 index 00000000..17e46321 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveNW.html @@ -0,0 +1,521 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleDriveNW 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>PxVehicleDriveNW Class Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxVehicleDriveNW" --><!-- doxytag: inherits="PxVehicleDrive" -->Data structure with instanced dynamics data and configuration data of a vehicle with up to PX_MAX_NB_WHEELS driven wheels. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxVehicleDriveNW_8h-source.html">PxVehicleDriveNW.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxVehicleDriveNW:</div> +<div class="dynsection"> +<p><center><img src="classPxVehicleDriveNW__inherit__graph.png" border="0" usemap="#PxVehicleDriveNW__inherit__map" alt="Inheritance graph"></center> +<map name="PxVehicleDriveNW__inherit__map"> +<area shape="rect" href="classPxVehicleDrive.html" title="A complete vehicle with instance dynamics data and configuration data for wheels..." alt="PxVehicleDrive" coords="19,155,115,176"><area shape="rect" href="classPxVehicleWheels.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with..." alt="PxVehicleWheels" coords="11,86,123,107"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="39,16,95,38"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxVehicleDriveNW:</div> +<div class="dynsection"> +<p><center><img src="classPxVehicleDriveNW__coll__graph.png" border="0" usemap="#PxVehicleDriveNW__coll__map" alt="Collaboration graph"></center> +<map name="PxVehicleDriveNW__coll__map"> +<area shape="rect" href="classPxVehicleDrive.html" title="A complete vehicle with instance dynamics data and configuration data for wheels..." alt="PxVehicleDrive" coords="2100,240,2196,261"><area shape="rect" href="classPxVehicleWheels.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with..." alt="PxVehicleWheels" coords="1768,140,1880,161"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="389,37,445,59"><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,63,551,84"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="17,37,255,59"><area shape="rect" href="classPxVehicleWheelsSimData.html" title="Data structure describing configuration data of a vehicle with up to 20 wheels." alt="PxVehicleWheelsSimData" coords="1407,140,1569,161"><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="888,133,1061,155"><area shape="rect" href="classPxVehicleAntiRollBarData.html" title="PxVehicleAntiRollBarData" alt="PxVehicleAntiRollBarData" coords="896,203,1053,224"><area shape="rect" href="classPxRigidDynamic.html" title="PxRigidDynamic represents a dynamic rigid simulation object in the physics SDK." alt="PxRigidDynamic" coords="1436,69,1540,91"><area shape="rect" href="classPxRigidBody.html" title="PxRigidBody is a base class shared between dynamic rigid body objects." alt="PxRigidBody" coords="932,65,1017,87"><area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="601,64,684,85"><area shape="rect" href="classPxVehicleWheelsDynData.html" title="Data structure with instanced dynamics data for wheels." alt="PxVehicleWheelsDynData" coords="1408,209,1568,231"><area shape="rect" href="classPxVehicleDriveDynData.html" title="Data structure with instanced dynamics data for vehicle with engine, clutch, gears..." alt="PxVehicleDriveDynData" coords="1751,240,1897,261"><area shape="rect" href="classPxVehicleDriveSimDataNW.html" title="Data structure describing configuration data of a vehicle with up to PX_MAX_NB_WHEELS..." alt="PxVehicleDriveSimDataNW" coords="2064,341,2232,363"><area shape="rect" href="classPxVehicleDriveSimData.html" title="Data structure describing non-wheel configuration data of a vehicle that has engine..." alt="PxVehicleDriveSimData" coords="1751,348,1897,369"><area shape="rect" href="classPxVehicleGearsData.html" title="PxVehicleGearsData" alt="PxVehicleGearsData" coords="1423,279,1553,300"><area shape="rect" href="classPxVehicleClutchData.html" title="PxVehicleClutchData" alt="PxVehicleClutchData" coords="1424,348,1552,369"><area shape="rect" href="classPxVehicleEngineData.html" title="PxVehicleEngineData" alt="PxVehicleEngineData" coords="1420,417,1556,439"><area shape="rect" href="classPxFixedSizeLookupTable.html" title="PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \>" alt="PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \>" coords="735,417,1215,439"><area shape="rect" href="classPxVehicleAutoBoxData.html" title="PxVehicleAutoBoxData" alt="PxVehicleAutoBoxData" coords="1417,487,1559,508"><area shape="rect" href="classPxVehicleDifferentialNWData.html" title="PxVehicleDifferentialNWData" alt="PxVehicleDifferentialNWData" coords="1736,400,1912,421"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxVehicleDriveNW-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="classPxVehicleDriveNW.html#d3d1999119fff4547dba2549e665f07d">free</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocate a <a class="el" href="classPxVehicleDriveNW.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with...">PxVehicleDriveNW</a> instance. <a href="#d3d1999119fff4547dba2549e665f07d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#72f85747311561f991aa94a525f38b22">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="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</a> &driveData, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbWheels)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set up a vehicle using simulation data for the wheels and drive model. <a href="#72f85747311561f991aa94a525f38b22"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#a66886e48cb1b6e635e804ee8267e5b3">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="#a66886e48cb1b6e635e804ee8267e5b3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#f463dfdb64f6135628c5838908bb5395">PxVehicleDriveNW</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#71ec3a0d4cda296f589ea83179dd7a24">PxVehicleDriveNW</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#28667c1f32ba67eee95f406604c49e1b">~PxVehicleDriveNW</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#ee409a04d9642841d1c58c0edd475686">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#ee409a04d9642841d1c58c0edd475686"></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="classPxVehicleDriveNW.html#1a00b208ede629e459d96bf0b213c87a">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="#1a00b208ede629e459d96bf0b213c87a"></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="classPxVehicleDriveNW.html">PxVehicleDriveNW</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#064d8255c367762368f970a24b164861">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 <a class="el" href="classPxVehicleDriveNW.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with...">PxVehicleDriveNW</a> instance for a NWDrive vehicle with nbWheels. <a href="#064d8255c367762368f970a24b164861"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classPxVehicleDriveNW.html">PxVehicleDriveNW</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#c986d2c96e167a5e8a974fcc9167acfa">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="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</a> &driveData, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbWheels)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate and set up a vehicle using simulation data for the wheels and drive model. <a href="#c986d2c96e167a5e8a974fcc9167acfa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classPxVehicleDriveNW.html">PxVehicleDriveNW</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#4436f48770c4d808cecde067c8c0ed83">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="classPxVehicleDriveNW.html#b8e814ba9f15f49fbd5fa86bf5d1c558">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="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveNW.html#696999b3cc7a910f7dda71f341981640">mDriveSimData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Simulation data that describes the configuration of the vehicle's drive model. <a href="#696999b3cc7a910f7dda71f341981640"></a><br></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="classPxVehicleDriveNW.html#454a474298b6ce4dcd5d0808602df459">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="#454a474298b6ce4dcd5d0808602df459"></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="classPxVehicleDriveNW.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 vehicle with up to PX_MAX_NB_WHEELS driven wheels. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="f463dfdb64f6135628c5838908bb5395"></a><!-- doxytag: member="PxVehicleDriveNW::PxVehicleDriveNW" ref="f463dfdb64f6135628c5838908bb5395" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveNW::PxVehicleDriveNW </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="71ec3a0d4cda296f589ea83179dd7a24"></a><!-- doxytag: member="PxVehicleDriveNW::PxVehicleDriveNW" ref="71ec3a0d4cda296f589ea83179dd7a24" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveNW::PxVehicleDriveNW </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="28667c1f32ba67eee95f406604c49e1b"></a><!-- doxytag: member="PxVehicleDriveNW::~PxVehicleDriveNW" ref="28667c1f32ba67eee95f406604c49e1b" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveNW::~PxVehicleDriveNW </td> + <td>(</td> + <td class="paramname"> </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="064d8255c367762368f970a24b164861"></a><!-- doxytag: member="PxVehicleDriveNW::allocate" ref="064d8255c367762368f970a24b164861" args="(const PxU32 nbWheels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classPxVehicleDriveNW.html">PxVehicleDriveNW</a>* PxVehicleDriveNW::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 <a class="el" href="classPxVehicleDriveNW.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with...">PxVehicleDriveNW</a> instance for a NWDrive vehicle 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="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="classPxVehicleDriveNW.html#d3d1999119fff4547dba2549e665f07d" title="Deallocate a PxVehicleDriveNW instance.">free</a>, <a class="el" href="classPxVehicleDriveNW.html#72f85747311561f991aa94a525f38b22" title="Set up a vehicle using simulation data for the wheels and drive model.">setup</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c986d2c96e167a5e8a974fcc9167acfa"></a><!-- doxytag: member="PxVehicleDriveNW::create" ref="c986d2c96e167a5e8a974fcc9167acfa" args="(PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimDataNW &driveData, const PxU32 nbWheels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classPxVehicleDriveNW.html">PxVehicleDriveNW</a>* PxVehicleDriveNW::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="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</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>nbWheels</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 vehicle 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 vehicle 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 vehicle. The vehicle 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 vehicle's drive model (gears/engine/clutch/differential/autobox). The vehicle instance takes a copy of this data. </td></tr> + <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 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="classPxVehicleDriveNW.html#064d8255c367762368f970a24b164861" title="Allocate a PxVehicleDriveNW instance for a NWDrive vehicle with nbWheels.">allocate</a>, <a class="el" href="classPxVehicleDriveNW.html#d3d1999119fff4547dba2549e665f07d" title="Deallocate a PxVehicleDriveNW instance.">free</a>, <a class="el" href="classPxVehicleDriveNW.html#a66886e48cb1b6e635e804ee8267e5b3" 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="4436f48770c4d808cecde067c8c0ed83"></a><!-- doxytag: member="PxVehicleDriveNW::createObject" ref="4436f48770c4d808cecde067c8c0ed83" args="(PxU8 *&address, PxDeserializationContext &context)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classPxVehicleDriveNW.html">PxVehicleDriveNW</a>* PxVehicleDriveNW::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="d3d1999119fff4547dba2549e665f07d"></a><!-- doxytag: member="PxVehicleDriveNW::free" ref="d3d1999119fff4547dba2549e665f07d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveNW::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="classPxVehicleDriveNW.html" title="Data structure with instanced dynamics data and configuration data of a vehicle with...">PxVehicleDriveNW</a> instance. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveNW.html#064d8255c367762368f970a24b164861" title="Allocate a PxVehicleDriveNW instance for a NWDrive vehicle 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="b8e814ba9f15f49fbd5fa86bf5d1c558"></a><!-- doxytag: member="PxVehicleDriveNW::getBinaryMetaData" ref="b8e814ba9f15f49fbd5fa86bf5d1c558" args="(PxOutputStream &stream)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static void PxVehicleDriveNW::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="ee409a04d9642841d1c58c0edd475686"></a><!-- doxytag: member="PxVehicleDriveNW::getConcreteTypeName" ref="ee409a04d9642841d1c58c0edd475686" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxVehicleDriveNW::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="1a00b208ede629e459d96bf0b213c87a"></a><!-- doxytag: member="PxVehicleDriveNW::isKindOf" ref="1a00b208ede629e459d96bf0b213c87a" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxVehicleDriveNW::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="454a474298b6ce4dcd5d0808602df459"></a><!-- doxytag: member="PxVehicleDriveNW::isValid" ref="454a474298b6ce4dcd5d0808602df459" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDriveNW::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="a66886e48cb1b6e635e804ee8267e5b3"></a><!-- doxytag: member="PxVehicleDriveNW::setToRestState" ref="a66886e48cb1b6e635e804ee8267e5b3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveNW::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="classPxVehicleDriveNW.html#72f85747311561f991aa94a525f38b22" title="Set up a vehicle using simulation data for the wheels and drive model.">setup</a>, <a class="el" href="classPxVehicleDriveNW.html#c986d2c96e167a5e8a974fcc9167acfa" title="Allocate and set up a vehicle 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="72f85747311561f991aa94a525f38b22"></a><!-- doxytag: member="PxVehicleDriveNW::setup" ref="72f85747311561f991aa94a525f38b22" args="(PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimDataNW &driveData, const PxU32 nbWheels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveNW::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="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</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>nbWheels</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 vehicle 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 vehicle 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 vehicle. The vehicle 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 vehicle's drive model (gears/engine/clutch/differential/autobox). The vehicle instance takes a copy of this data. </td></tr> + <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 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="classPxVehicleDriveNW.html#064d8255c367762368f970a24b164861" title="Allocate a PxVehicleDriveNW instance for a NWDrive vehicle with nbWheels.">allocate</a>, <a class="el" href="classPxVehicleDriveNW.html#d3d1999119fff4547dba2549e665f07d" title="Deallocate a PxVehicleDriveNW instance.">free</a>, <a class="el" href="classPxVehicleDriveNW.html#a66886e48cb1b6e635e804ee8267e5b3" 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> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="a960a335429c764ff7e258a0ec3ab5f0"></a><!-- doxytag: member="PxVehicleDriveNW::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="696999b3cc7a910f7dda71f341981640"></a><!-- doxytag: member="PxVehicleDriveNW::mDriveSimData" ref="696999b3cc7a910f7dda71f341981640" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVehicleDriveSimDataNW.html">PxVehicleDriveSimDataNW</a> <a class="el" href="classPxVehicleDriveNW.html#696999b3cc7a910f7dda71f341981640">PxVehicleDriveNW::mDriveSimData</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Simulation data that describes the configuration of the vehicle's drive model. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveNW.html#72f85747311561f991aa94a525f38b22" title="Set up a vehicle using simulation data for the wheels and drive model.">setup</a>, <a class="el" href="classPxVehicleDriveNW.html#c986d2c96e167a5e8a974fcc9167acfa" title="Allocate and set up a vehicle using simulation data for the wheels and drive model...">create</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxVehicleDriveNW_8h-source.html">PxVehicleDriveNW.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> |