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/classPxVehicleDriveDynData.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/classPxVehicleDriveDynData.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveDynData.html | 1054 |
1 files changed, 1054 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveDynData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveDynData.html new file mode 100644 index 00000000..4425b0ed --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleDriveDynData.html @@ -0,0 +1,1054 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleDriveDynData 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>PxVehicleDriveDynData Class Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxVehicleDriveDynData" -->Data structure with instanced dynamics data for vehicle with engine, clutch, gears, autobox. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxVehicleDrive_8h-source.html">PxVehicleDrive.h</a>></code> +<p> + +<p> +<a href="classPxVehicleDriveDynData-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 Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classPxVehicleDriveDynData.html#f0a4e42ccd2b88edc0a0f51aa7d8daf8bb804b086657c71c6737676966a60980">eMAX_NB_ANALOG_INPUTS</a> = 16 + }</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="classPxVehicleDriveDynData.html#395909ff575722b78041d67a42fb62f3">setToRestState</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set all dynamics data to zero to bring the vehicle to rest. <a href="#395909ff575722b78041d67a42fb62f3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#702f9f3b98ba914cb313383aef4b45d5">setAnalogInput</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> type, const PxReal analogVal)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an analog control value to drive the vehicle. <a href="#702f9f3b98ba914cb313383aef4b45d5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#9e1607b3b32f31cce5ac247e4bd485cb">getAnalogInput</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> type) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the analog control value that has been applied to the vehicle. <a href="#9e1607b3b32f31cce5ac247e4bd485cb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#fd97592ae5714d45c494957808fa7020">setGearUp</a> (const bool digitalVal)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Inform the vehicle that the gear-up button has been pressed. <a href="#fd97592ae5714d45c494957808fa7020"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#0e31ae1c0d74b575ac10494e94fb325c">setGearDown</a> (const bool digitalVal)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set that the gear-down button has been pressed. <a href="#0e31ae1c0d74b575ac10494e94fb325c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#ba646ba5446cc67060513464c4d26ee0">getGearUp</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the gear-up button has been pressed. <a href="#ba646ba5446cc67060513464c4d26ee0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#f5e79dc6ba1b1c291eb3d97914efb919">getGearDown</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the gear-down button has been pressed. <a href="#f5e79dc6ba1b1c291eb3d97914efb919"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#3a7a66f713691e6c1ce0f97e1dd2d80a">setUseAutoGears</a> (const bool useAutoGears)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the flag that will be used to select auto-gears If useAutoGears is true the auto-box will be active. <a href="#3a7a66f713691e6c1ce0f97e1dd2d80a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#9b917f8ea42e952946fcfb2b2bab4842">getUseAutoGears</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the flag status that is used to select auto-gears. <a href="#9b917f8ea42e952946fcfb2b2bab4842"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#ca4e7fb32e89d14f1f10dd0f42f3b9f3">toggleAutoGears</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggle the auto-gears flag If useAutoGears is true the auto-box will be active. <a href="#ca4e7fb32e89d14f1f10dd0f42f3b9f3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#a7f0d12794afa5fcfa1b5ede6bd2539d">setCurrentGear</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> currentGear)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current gear. <a href="#a7f0d12794afa5fcfa1b5ede6bd2539d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#1a9d80dceea05c123f48141a8b45de82">getCurrentGear</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current gear. <a href="#1a9d80dceea05c123f48141a8b45de82"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#568663354ffa23f4b6f8d9a0194ea0e6">setTargetGear</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> targetGear)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the target gear. <a href="#568663354ffa23f4b6f8d9a0194ea0e6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#edc3a41c46722e33d56bdad10d1c6ff0">getTargetGear</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the target gear. <a href="#edc3a41c46722e33d56bdad10d1c6ff0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#2ba2789e69500d31d1acf2f6e11545cf">startGearChange</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> targetGear)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a gear change to a target gear. <a href="#2ba2789e69500d31d1acf2f6e11545cf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#bac968004f04f286fa6cd9ca4ef5f3ca">forceGearChange</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> targetGear)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Force an immediate gear change to a target gear. <a href="#bac968004f04f286fa6cd9ca4ef5f3ca"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#881b76d5ad721e3e48fa68466e3dbee6">setEngineRotationSpeed</a> (const PxF32 speed)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the rotation speed of the engine (radians per second). <a href="#881b76d5ad721e3e48fa68466e3dbee6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#f01674e16ef7ab5191da7ee30039bee9">getEngineRotationSpeed</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the rotation speed of the engine (radians per second). <a href="#f01674e16ef7ab5191da7ee30039bee9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#58fc433985580dceb7e8b2b6df825c58">getGearSwitchTime</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the time that has passed since the current gear change was initiated. <a href="#58fc433985580dceb7e8b2b6df825c58"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#e6a6856cf2a23722629bb25bdcee3ace">getAutoBoxSwitchTime</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the time that has passed since the autobox last initiated a gear change. <a href="#e6a6856cf2a23722629bb25bdcee3ace"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#f38233e891d581d123bcae2724d57dc7">PxVehicleDriveDynData</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#5395d429ef9607844d63447c2b89c146">PxVehicleDriveDynData</a> (const <a class="el" href="group__foundation.html#g0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#9a88502529a3ddada029d19206c4dc59">getNbAnalogInput</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#ea22183763d8431279917949fb5be912">setGearChange</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> gearChange)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#3f11bc29a393ef9ff3afe79b6996479c">getGearChange</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#8a42ae9182f4e9375b94a19787dafa30">setGearSwitchTime</a> (const PxReal switchTime)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#0de28a83d795f037d4042f0a5601087b">setAutoBoxSwitchTime</a> (const PxReal autoBoxSwitchTime)</td></tr> + +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#2aded5809dd204d7c681455f4d57bdb5">mControlAnalogVals</a> [eMAX_NB_ANALOG_INPUTS]</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">All dynamic data values are public for fast access. <a href="#2aded5809dd204d7c681455f4d57bdb5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#e20cb9ccb893680b788aa7021f808a48">mUseAutoGears</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Auto-gear flag used by vehicle simulation. Set true to enable the autobox, false to disable the autobox. <a href="#e20cb9ccb893680b788aa7021f808a48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#e5ce1f60c6c0d6e7e5107d5931b839ac">mGearUpPressed</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gear-up digital control value used by vehicle simulation. <a href="#e5ce1f60c6c0d6e7e5107d5931b839ac"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#93609be75c31dfeba70480346f97a36b">mGearDownPressed</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gear-down digital control value used by vehicle simulation. <a href="#93609be75c31dfeba70480346f97a36b"></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="classPxVehicleDriveDynData.html#f685ae907b9e9b1cb4066810187f110f">mCurrentGear</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Current gear. <a href="#f685ae907b9e9b1cb4066810187f110f"></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="classPxVehicleDriveDynData.html#13190995031df45f48937b0f8b870edf">mTargetGear</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Target gear (different from current gear if a gear change is underway). <a href="#13190995031df45f48937b0f8b870edf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#fc1398312cd50ef41a8a0bed6384895f">mEnginespeed</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Rotation speed of engine. <a href="#fc1398312cd50ef41a8a0bed6384895f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#3ffacfc2c22757cd9224a32a1a9d5363">mGearSwitchTime</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reported time that has passed since gear change started. <a href="#3ffacfc2c22757cd9224a32a1a9d5363"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#ba3ba5fed122b50456ff96a2464ca0cc">mAutoBoxSwitchTime</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reported time that has passed since last autobox gearup/geardown decision. <a href="#ba3ba5fed122b50456ff96a2464ca0cc"></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="classPxVehicleDriveDynData.html#8cba076ae320b0f43255fba8cb05d9fa">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Test that a <a class="el" href="classPxVehicleDriveDynData.html" title="Data structure with instanced dynamics data for vehicle with engine, clutch, gears...">PxVehicleDriveDynData</a> instance has legal values. <a href="#8cba076ae320b0f43255fba8cb05d9fa"></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="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDriveDynData.html#8cd3352fd2c2070c9f9593071872e42d">mPad</a> [2]</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="classPxVehicleDriveDynData.html#dd078cb4846b424cfcecd6e02dd5c8fc">PxVehicleDrive</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Data structure with instanced dynamics data for vehicle with engine, clutch, gears, autobox. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleWheelsDynData.html" title="Data structure with instanced dynamics data for wheels.">PxVehicleWheelsDynData</a> for wheels dynamics data. </dd></dl> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="f0a4e42ccd2b88edc0a0f51aa7d8daf8"></a><!-- doxytag: member="PxVehicleDriveDynData::@6" ref="f0a4e42ccd2b88edc0a0f51aa7d8daf8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">anonymous enum </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="f0a4e42ccd2b88edc0a0f51aa7d8daf8bb804b086657c71c6737676966a60980"></a><!-- doxytag: member="eMAX_NB_ANALOG_INPUTS" ref="f0a4e42ccd2b88edc0a0f51aa7d8daf8bb804b086657c71c6737676966a60980" args="" -->eMAX_NB_ANALOG_INPUTS</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="f38233e891d581d123bcae2724d57dc7"></a><!-- doxytag: member="PxVehicleDriveDynData::PxVehicleDriveDynData" ref="f38233e891d581d123bcae2724d57dc7" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveDynData::PxVehicleDriveDynData </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="5395d429ef9607844d63447c2b89c146"></a><!-- doxytag: member="PxVehicleDriveDynData::PxVehicleDriveDynData" ref="5395d429ef9607844d63447c2b89c146" args="(const PxEMPTY)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleDriveDynData::PxVehicleDriveDynData </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="bac968004f04f286fa6cd9ca4ef5f3ca"></a><!-- doxytag: member="PxVehicleDriveDynData::forceGearChange" ref="bac968004f04f286fa6cd9ca4ef5f3ca" args="(const PxU32 targetGear)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::forceGearChange </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>targetGear</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Force an immediate gear change to a target gear. +<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>targetGear</em> </td><td>is the gear the vehicle will be given immediately.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9e1607b3b32f31cce5ac247e4bd485cb"></a><!-- doxytag: member="PxVehicleDriveDynData::getAnalogInput" ref="9e1607b3b32f31cce5ac247e4bd485cb" args="(const PxU32 type) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal PxVehicleDriveDynData::getAnalogInput </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>type</em> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the analog control value that has been applied to the vehicle. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the specified analog control value. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxVehicleDrive4WControl.html" title="The control inputs for a PxVehicleDrive4W.">PxVehicleDrive4WControl</a>, <a class="el" href="structPxVehicleDriveNWControl.html" title="The control inputs for a PxVehicleDriveNW.">PxVehicleDriveNWControl</a>, <a class="el" href="structPxVehicleDriveTankControl.html" title="The control inputs for a PxVehicleDriveTank.">PxVehicleDriveTankControl</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e6a6856cf2a23722629bb25bdcee3ace"></a><!-- doxytag: member="PxVehicleDriveDynData::getAutoBoxSwitchTime" ref="e6a6856cf2a23722629bb25bdcee3ace" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE PxReal PxVehicleDriveDynData::getAutoBoxSwitchTime </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the time that has passed since the autobox last initiated a gear change. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The time that has passed since the autobox last initiated a gear change.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleAutoBoxData.html#b58a308ce4750594e3335d953d70281c" title="Set the latency time of the autobox.">PxVehicleAutoBoxData::setLatency</a>, <a class="el" href="classPxVehicleAutoBoxData.html#15e62c013c05a2e492ab81144fb32e5c" title="Get the latency time of the autobox.">PxVehicleAutoBoxData::getLatency</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1a9d80dceea05c123f48141a8b45de82"></a><!-- doxytag: member="PxVehicleDriveDynData::getCurrentGear" ref="1a9d80dceea05c123f48141a8b45de82" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDriveDynData::getCurrentGear </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the current gear. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The vehicle's current gear.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#edc3a41c46722e33d56bdad10d1c6ff0" title="Get the target gear.">getTargetGear</a>, <a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f01674e16ef7ab5191da7ee30039bee9"></a><!-- doxytag: member="PxVehicleDriveDynData::getEngineRotationSpeed" ref="f01674e16ef7ab5191da7ee30039bee9" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE PxReal PxVehicleDriveDynData::getEngineRotationSpeed </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the rotation speed of the engine (radians per second). +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The rotational speed (radians per second) of the engine. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3f11bc29a393ef9ff3afe79b6996479c"></a><!-- doxytag: member="PxVehicleDriveDynData::getGearChange" ref="3f11bc29a393ef9ff3afe79b6996479c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDriveDynData::getGearChange </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f5e79dc6ba1b1c291eb3d97914efb919"></a><!-- doxytag: member="PxVehicleDriveDynData::getGearDown" ref="f5e79dc6ba1b1c291eb3d97914efb919" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDriveDynData::getGearDown </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Check if the gear-down button has been pressed. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The state of the gear-down button. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="58fc433985580dceb7e8b2b6df825c58"></a><!-- doxytag: member="PxVehicleDriveDynData::getGearSwitchTime" ref="58fc433985580dceb7e8b2b6df825c58" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE PxReal PxVehicleDriveDynData::getGearSwitchTime </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the time that has passed since the current gear change was initiated. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The time that has passed since the current gear change was initiated.</dd></dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If no gear change is in process the gear switch time will be zero.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleGearsData.html#b037c108ad8a9488412ae0fbe14520fb" title="Time it takes to switch gear.">PxVehicleGearsData.mSwitchTime</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ba646ba5446cc67060513464c4d26ee0"></a><!-- doxytag: member="PxVehicleDriveDynData::getGearUp" ref="ba646ba5446cc67060513464c4d26ee0" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDriveDynData::getGearUp </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Check if the gear-up button has been pressed. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The state of the gear-up button. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9a88502529a3ddada029d19206c4dc59"></a><!-- doxytag: member="PxVehicleDriveDynData::getNbAnalogInput" ref="9a88502529a3ddada029d19206c4dc59" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDriveDynData::getNbAnalogInput </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="edc3a41c46722e33d56bdad10d1c6ff0"></a><!-- doxytag: member="PxVehicleDriveDynData::getTargetGear" ref="edc3a41c46722e33d56bdad10d1c6ff0" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDriveDynData::getTargetGear </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the target gear. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The vehicle's target gear.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#568663354ffa23f4b6f8d9a0194ea0e6" title="Set the target gear.">setTargetGear</a>, <a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9b917f8ea42e952946fcfb2b2bab4842"></a><!-- doxytag: member="PxVehicleDriveDynData::getUseAutoGears" ref="9b917f8ea42e952946fcfb2b2bab4842" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE bool PxVehicleDriveDynData::getUseAutoGears </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the flag status that is used to select auto-gears. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The active status of the auto-box. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8cba076ae320b0f43255fba8cb05d9fa"></a><!-- doxytag: member="PxVehicleDriveDynData::isValid" ref="8cba076ae320b0f43255fba8cb05d9fa" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleDriveDynData::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Test that a <a class="el" href="classPxVehicleDriveDynData.html" title="Data structure with instanced dynamics data for vehicle with engine, clutch, gears...">PxVehicleDriveDynData</a> instance has legal values. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#395909ff575722b78041d67a42fb62f3" title="Set all dynamics data to zero to bring the vehicle to rest.">setToRestState</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="702f9f3b98ba914cb313383aef4b45d5"></a><!-- doxytag: member="PxVehicleDriveDynData::setAnalogInput" ref="702f9f3b98ba914cb313383aef4b45d5" args="(const PxU32 type, const PxReal analogVal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveDynData::setAnalogInput </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>analogVal</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an analog control value to drive the vehicle. +<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>type</em> </td><td>describes the type of analog control being modified </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>analogVal</em> </td><td>is the new value of the specific analog control. </td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxVehicleDrive4WControl.html" title="The control inputs for a PxVehicleDrive4W.">PxVehicleDrive4WControl</a>, <a class="el" href="structPxVehicleDriveNWControl.html" title="The control inputs for a PxVehicleDriveNW.">PxVehicleDriveNWControl</a>, <a class="el" href="structPxVehicleDriveTankControl.html" title="The control inputs for a PxVehicleDriveTank.">PxVehicleDriveTankControl</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0de28a83d795f037d4042f0a5601087b"></a><!-- doxytag: member="PxVehicleDriveDynData::setAutoBoxSwitchTime" ref="0de28a83d795f037d4042f0a5601087b" args="(const PxReal autoBoxSwitchTime)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setAutoBoxSwitchTime </td> + <td>(</td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>autoBoxSwitchTime</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="a7f0d12794afa5fcfa1b5ede6bd2539d"></a><!-- doxytag: member="PxVehicleDriveDynData::setCurrentGear" ref="a7f0d12794afa5fcfa1b5ede6bd2539d" args="(PxU32 currentGear)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setCurrentGear </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>currentGear</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the current gear. +<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>currentGear</em> </td><td>is the vehicle's gear.</td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If the target gear is different from the current gear the vehicle will attempt to start a gear change from the current gear that has just been set towards the target gear at the next call to PxVehicleUpdates.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#568663354ffa23f4b6f8d9a0194ea0e6" title="Set the target gear.">setTargetGear</a>, <a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="881b76d5ad721e3e48fa68466e3dbee6"></a><!-- doxytag: member="PxVehicleDriveDynData::setEngineRotationSpeed" ref="881b76d5ad721e3e48fa68466e3dbee6" args="(const PxF32 speed)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setEngineRotationSpeed </td> + <td>(</td> + <td class="paramtype">const PxF32 </td> + <td class="paramname"> <em>speed</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the rotation speed of the engine (radians per second). +<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>speed</em> </td><td>is the rotational speed (radians per second) to apply to the engine. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ea22183763d8431279917949fb5be912"></a><!-- doxytag: member="PxVehicleDriveDynData::setGearChange" ref="ea22183763d8431279917949fb5be912" args="(const PxU32 gearChange)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setGearChange </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>gearChange</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="0e31ae1c0d74b575ac10494e94fb325c"></a><!-- doxytag: member="PxVehicleDriveDynData::setGearDown" ref="0e31ae1c0d74b575ac10494e94fb325c" args="(const bool digitalVal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveDynData::setGearDown </td> + <td>(</td> + <td class="paramtype">const bool </td> + <td class="paramname"> <em>digitalVal</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set that the gear-down button has been pressed. +<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>digitalVal</em> </td><td>is the state of the gear-down button.</td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If digitalVal is true the vehicle will attempt to initiate a gear change at the next call to PxVehicleUpdates.<p> +The value of mGearDownPressed is not reset by PxVehicleUpdates </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8a42ae9182f4e9375b94a19787dafa30"></a><!-- doxytag: member="PxVehicleDriveDynData::setGearSwitchTime" ref="8a42ae9182f4e9375b94a19787dafa30" args="(const PxReal switchTime)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setGearSwitchTime </td> + <td>(</td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>switchTime</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="fd97592ae5714d45c494957808fa7020"></a><!-- doxytag: member="PxVehicleDriveDynData::setGearUp" ref="fd97592ae5714d45c494957808fa7020" args="(const bool digitalVal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveDynData::setGearUp </td> + <td>(</td> + <td class="paramtype">const bool </td> + <td class="paramname"> <em>digitalVal</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Inform the vehicle that the gear-up button has been pressed. +<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>digitalVal</em> </td><td>is the state of the gear-up button.</td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If digitalVal is true the vehicle will attempt to initiate a gear change at the next call to PxVehicleUpdates.<p> +The value of mGearUpPressed is not reset by PxVehicleUpdates </dd></dl> + +</div> +</div><p> +<a class="anchor" name="568663354ffa23f4b6f8d9a0194ea0e6"></a><!-- doxytag: member="PxVehicleDriveDynData::setTargetGear" ref="568663354ffa23f4b6f8d9a0194ea0e6" args="(PxU32 targetGear)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setTargetGear </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>targetGear</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the target gear. +<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>targetGear</em> </td><td>is the vehicle's target gear.</td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If the target gear is different from the current gear the vehicle will attempt to start a gear change towards the target gear at the next call to PxVehicleUpdates.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="395909ff575722b78041d67a42fb62f3"></a><!-- doxytag: member="PxVehicleDriveDynData::setToRestState" ref="395909ff575722b78041d67a42fb62f3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleDriveDynData::setToRestState </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set all dynamics data to zero to bring the vehicle to rest. +<p> + +</div> +</div><p> +<a class="anchor" name="3a7a66f713691e6c1ce0f97e1dd2d80a"></a><!-- doxytag: member="PxVehicleDriveDynData::setUseAutoGears" ref="3a7a66f713691e6c1ce0f97e1dd2d80a" args="(const bool useAutoGears)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::setUseAutoGears </td> + <td>(</td> + <td class="paramtype">const bool </td> + <td class="paramname"> <em>useAutoGears</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the flag that will be used to select auto-gears If useAutoGears is true the auto-box will be active. +<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>useAutoGears</em> </td><td>is the active state of the auto-box. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="2ba2789e69500d31d1acf2f6e11545cf"></a><!-- doxytag: member="PxVehicleDriveDynData::startGearChange" ref="2ba2789e69500d31d1acf2f6e11545cf" args="(const PxU32 targetGear)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::startGearChange </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>targetGear</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Start a gear change to a target gear. +<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>targetGear</em> </td><td>is the gear the vehicle will begin a transition towards.</td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The gear change will begin at the next call to PxVehicleUpadates.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ca4e7fb32e89d14f1f10dd0f42f3b9f3"></a><!-- doxytag: member="PxVehicleDriveDynData::toggleAutoGears" ref="ca4e7fb32e89d14f1f10dd0f42f3b9f3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxVehicleDriveDynData::toggleAutoGears </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Toggle the auto-gears flag If useAutoGears is true the auto-box will be active. +<p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="dd078cb4846b424cfcecd6e02dd5c8fc"></a><!-- doxytag: member="PxVehicleDriveDynData::PxVehicleDrive" ref="dd078cb4846b424cfcecd6e02dd5c8fc" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classPxVehicleDrive.html">PxVehicleDrive</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="ba3ba5fed122b50456ff96a2464ca0cc"></a><!-- doxytag: member="PxVehicleDriveDynData::mAutoBoxSwitchTime" ref="ba3ba5fed122b50456ff96a2464ca0cc" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleDriveDynData.html#ba3ba5fed122b50456ff96a2464ca0cc">PxVehicleDriveDynData::mAutoBoxSwitchTime</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reported time that has passed since last autobox gearup/geardown decision. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#395909ff575722b78041d67a42fb62f3" title="Set all dynamics data to zero to bring the vehicle to rest.">setToRestState</a>, <a class="el" href="classPxVehicleAutoBoxData.html#b58a308ce4750594e3335d953d70281c" title="Set the latency time of the autobox.">PxVehicleAutoBoxData::setLatency</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2aded5809dd204d7c681455f4d57bdb5"></a><!-- doxytag: member="PxVehicleDriveDynData::mControlAnalogVals" ref="2aded5809dd204d7c681455f4d57bdb5" args="[eMAX_NB_ANALOG_INPUTS]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleDriveDynData.html#2aded5809dd204d7c681455f4d57bdb5">PxVehicleDriveDynData::mControlAnalogVals</a>[eMAX_NB_ANALOG_INPUTS] </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +All dynamic data values are public for fast access. +<p> +Analog control values used by vehicle simulation. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#702f9f3b98ba914cb313383aef4b45d5" title="Set an analog control value to drive the vehicle.">setAnalogInput</a>, <a class="el" href="classPxVehicleDriveDynData.html#9e1607b3b32f31cce5ac247e4bd485cb" title="Get the analog control value that has been applied to the vehicle.">getAnalogInput</a>, <a class="el" href="structPxVehicleDrive4WControl.html" title="The control inputs for a PxVehicleDrive4W.">PxVehicleDrive4WControl</a>, <a class="el" href="structPxVehicleDriveNWControl.html" title="The control inputs for a PxVehicleDriveNW.">PxVehicleDriveNWControl</a>, <a class="el" href="structPxVehicleDriveTankControl.html" title="The control inputs for a PxVehicleDriveTank.">PxVehicleDriveTankControl</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f685ae907b9e9b1cb4066810187f110f"></a><!-- doxytag: member="PxVehicleDriveDynData::mCurrentGear" ref="f685ae907b9e9b1cb4066810187f110f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxVehicleDriveDynData.html#f685ae907b9e9b1cb4066810187f110f">PxVehicleDriveDynData::mCurrentGear</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Current gear. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#2ba2789e69500d31d1acf2f6e11545cf" title="Start a gear change to a target gear.">startGearChange</a>, <a class="el" href="classPxVehicleDriveDynData.html#bac968004f04f286fa6cd9ca4ef5f3ca" title="Force an immediate gear change to a target gear.">forceGearChange</a>, <a class="el" href="classPxVehicleDriveDynData.html#1a9d80dceea05c123f48141a8b45de82" title="Get the current gear.">getCurrentGear</a>, <a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fc1398312cd50ef41a8a0bed6384895f"></a><!-- doxytag: member="PxVehicleDriveDynData::mEnginespeed" ref="fc1398312cd50ef41a8a0bed6384895f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleDriveDynData.html#fc1398312cd50ef41a8a0bed6384895f">PxVehicleDriveDynData::mEnginespeed</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Rotation speed of engine. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#395909ff575722b78041d67a42fb62f3" title="Set all dynamics data to zero to bring the vehicle to rest.">setToRestState</a>, <a class="el" href="classPxVehicleDriveDynData.html#f01674e16ef7ab5191da7ee30039bee9" title="Return the rotation speed of the engine (radians per second).">getEngineRotationSpeed</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="93609be75c31dfeba70480346f97a36b"></a><!-- doxytag: member="PxVehicleDriveDynData::mGearDownPressed" ref="93609be75c31dfeba70480346f97a36b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPxVehicleDriveDynData.html#93609be75c31dfeba70480346f97a36b">PxVehicleDriveDynData::mGearDownPressed</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gear-down digital control value used by vehicle simulation. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If true a gear change will be initiated towards currentGear-1 (or to reverse if in first).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>setDigitalInput, getDigitalInput </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3ffacfc2c22757cd9224a32a1a9d5363"></a><!-- doxytag: member="PxVehicleDriveDynData::mGearSwitchTime" ref="3ffacfc2c22757cd9224a32a1a9d5363" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleDriveDynData.html#3ffacfc2c22757cd9224a32a1a9d5363">PxVehicleDriveDynData::mGearSwitchTime</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reported time that has passed since gear change started. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#395909ff575722b78041d67a42fb62f3" title="Set all dynamics data to zero to bring the vehicle to rest.">setToRestState</a>, <a class="el" href="classPxVehicleDriveDynData.html#2ba2789e69500d31d1acf2f6e11545cf" title="Start a gear change to a target gear.">startGearChange</a>, <a class="el" href="classPxVehicleGearsData.html#b037c108ad8a9488412ae0fbe14520fb" title="Time it takes to switch gear.">PxVehicleGearsData::mSwitchTime</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e5ce1f60c6c0d6e7e5107d5931b839ac"></a><!-- doxytag: member="PxVehicleDriveDynData::mGearUpPressed" ref="e5ce1f60c6c0d6e7e5107d5931b839ac" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPxVehicleDriveDynData.html#e5ce1f60c6c0d6e7e5107d5931b839ac">PxVehicleDriveDynData::mGearUpPressed</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gear-up digital control value used by vehicle simulation. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If true a gear change will be initiated towards currentGear+1 (or to first gear if in reverse).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>setDigitalInput, getDigitalInput </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8cd3352fd2c2070c9f9593071872e42d"></a><!-- doxytag: member="PxVehicleDriveDynData::mPad" ref="8cd3352fd2c2070c9f9593071872e42d" args="[2]" --> +<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="classPxVehicleDriveDynData.html#8cd3352fd2c2070c9f9593071872e42d">PxVehicleDriveDynData::mPad</a>[2]<code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="13190995031df45f48937b0f8b870edf"></a><!-- doxytag: member="PxVehicleDriveDynData::mTargetGear" ref="13190995031df45f48937b0f8b870edf" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxVehicleDriveDynData.html#13190995031df45f48937b0f8b870edf">PxVehicleDriveDynData::mTargetGear</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Target gear (different from current gear if a gear change is underway). +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#2ba2789e69500d31d1acf2f6e11545cf" title="Start a gear change to a target gear.">startGearChange</a>, <a class="el" href="classPxVehicleDriveDynData.html#bac968004f04f286fa6cd9ca4ef5f3ca" title="Force an immediate gear change to a target gear.">forceGearChange</a>, <a class="el" href="classPxVehicleDriveDynData.html#edc3a41c46722e33d56bdad10d1c6ff0" title="Get the target gear.">getTargetGear</a>, <a class="el" href="classPxVehicleGearsData.html">PxVehicleGearsData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e20cb9ccb893680b788aa7021f808a48"></a><!-- doxytag: member="PxVehicleDriveDynData::mUseAutoGears" ref="e20cb9ccb893680b788aa7021f808a48" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPxVehicleDriveDynData.html#e20cb9ccb893680b788aa7021f808a48">PxVehicleDriveDynData::mUseAutoGears</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Auto-gear flag used by vehicle simulation. Set true to enable the autobox, false to disable the autobox. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDriveDynData.html#3a7a66f713691e6c1ce0f97e1dd2d80a" title="Set the flag that will be used to select auto-gears If useAutoGears is true the auto-box...">setUseAutoGears</a>, <a class="el" href="classPxVehicleDriveDynData.html#3a7a66f713691e6c1ce0f97e1dd2d80a" title="Set the flag that will be used to select auto-gears If useAutoGears is true the auto-box...">setUseAutoGears</a>, <a class="el" href="classPxVehicleDriveDynData.html#ca4e7fb32e89d14f1f10dd0f42f3b9f3" title="Toggle the auto-gears flag If useAutoGears is true the auto-box will be active.">toggleAutoGears</a>, <a class="el" href="classPxVehicleAutoBoxData.html">PxVehicleAutoBoxData</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxVehicleDrive_8h-source.html">PxVehicleDrive.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> |