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/structPxWheelQueryResult.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/structPxWheelQueryResult.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxWheelQueryResult.html | 500 |
1 files changed, 500 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxWheelQueryResult.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxWheelQueryResult.html new file mode 100644 index 00000000..e83784de --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxWheelQueryResult.html @@ -0,0 +1,500 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxWheelQueryResult Struct 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>PxWheelQueryResult Struct Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxWheelQueryResult" -->Structure containing data describing the non-persistent state of each suspension/wheel/tire unit. This structure is filled out in PxVehicleUpdates and PxVehicleUpdateSingleVehicleAndStoreTelemetryData. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxVehicleUpdate_8h-source.html">PxVehicleUpdate.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxWheelQueryResult:</div> +<div class="dynsection"> +<p><center><img src="structPxWheelQueryResult__coll__graph.png" border="0" usemap="#PxWheelQueryResult__coll__map" alt="Collaboration graph"></center> +<map name="PxWheelQueryResult__coll__map"> +<area shape="rect" href="classPxMaterial.html" title="Material class to represent a set of surface properties." alt="PxMaterial" coords="24,238,96,259"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="169,107,225,128"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="171,238,224,259"><area shape="rect" href="classPxShape.html" title="Abstract class for collision shapes." alt="PxShape" coords="280,238,344,259"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="79,16,316,38"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="508,107,561,128"><area shape="rect" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector" alt="PxTransform" coords="629,238,712,259"><area shape="rect" href="classPxQuat.html" title="This is a quaternion class. For more information on quaternion mathematics consult..." alt="PxQuat" coords="644,107,697,128"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxWheelQueryResult-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#161b38c47540b17befebc36c02c8e996">PxWheelQueryResult</a> ()</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="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#f2bc73597bdc1096034f5f22f2cbde2a">suspLineStart</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Start point of suspension line raycast/sweep used in the raycast/sweep completed immediately before PxVehicleUpdates. <a href="#f2bc73597bdc1096034f5f22f2cbde2a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#31b6ed853082cacb07e8926dfc0a21b0">suspLineDir</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Directions of suspension line raycast/sweep used in the raycast/sweep completed immediately before PxVehicleUpdates. <a href="#31b6ed853082cacb07e8926dfc0a21b0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#c23b4fa451ee4a45350683bcbc0c9b14">suspLineLength</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Lengths of suspension line raycast/sweep used in raycast/sweep completed immediately before PxVehicleUpdates. <a href="#c23b4fa451ee4a45350683bcbc0c9b14"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#7a21ebf9f8747982774e747a4c096c41">isInAir</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">If suspension travel limits forbid the wheel from touching the drivable surface then isInAir is true. <a href="#7a21ebf9f8747982774e747a4c096c41"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxActor.html">PxActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#c728726399b7e23755086c0a512c308b">tireContactActor</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK.">PxActor</a> instance of the driving surface under the corresponding vehicle wheel. <a href="#c728726399b7e23755086c0a512c308b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxShape.html">PxShape</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#52c57fa129bcf35ccde120c6fe09567e">tireContactShape</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> instance of the driving surface under the corresponding vehicle wheel. <a href="#52c57fa129bcf35ccde120c6fe09567e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classPxMaterial.html">PxMaterial</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#ab6dff9c3117e76f1ffaac4c867b2cca">tireSurfaceMaterial</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> instance of the driving surface under the corresponding vehicle wheel. <a href="#ab6dff9c3117e76f1ffaac4c867b2cca"></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="structPxWheelQueryResult.html#3c95ac8a6cfbdac1f496c193140342e9">tireSurfaceType</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Surface type integer that corresponds to the mapping between tireSurfaceMaterial and integer as described in <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a>. <a href="#3c95ac8a6cfbdac1f496c193140342e9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#265780749830b4cd7b7895eed6133f8a">tireContactPoint</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Point on the drivable surface hit by the most recent suspension raycast or sweep. <a href="#265780749830b4cd7b7895eed6133f8a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#8d048db9af70ed06e0575d979093f538">tireContactNormal</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Normal on the drivable surface at the hit point of the most recent suspension raycast or sweep. <a href="#8d048db9af70ed06e0575d979093f538"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#62c137fe4b995c7a9c3e491bae103180">tireFriction</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Friction experienced by the tire for the combination of tire type and surface type after accounting for the friction vs slip graph. <a href="#62c137fe4b995c7a9c3e491bae103180"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#68a36bfd00e7f38621fca9c415cc7917">suspJounce</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Compression of the suspension spring. <a href="#68a36bfd00e7f38621fca9c415cc7917"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#eefa0e519260b023b395abd28e5c4f01">suspSpringForce</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Magnitude of force applied by the suspension spring along the direction of suspension travel. <a href="#eefa0e519260b023b395abd28e5c4f01"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#e9dd6242afb08aebe9895760785facae">tireLongitudinalDir</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Forward direction of the wheel/tire accounting for steer/toe/camber angle projected on to the contact plane of the drivable surface. <a href="#e9dd6242afb08aebe9895760785facae"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#b35c38cb5001bad2c3cc4daab71d3056">tireLateralDir</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Lateral direction of the wheel/tire accounting for steer/toe/camber angle projected on to the contact plan of the drivable surface. <a href="#b35c38cb5001bad2c3cc4daab71d3056"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#bfdde49461f75cb9e226ed2923d58ce5">longitudinalSlip</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Longitudinal slip of the tire. <a href="#bfdde49461f75cb9e226ed2923d58ce5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#dece3d8e6577b7a0d01527a4b24ca432">lateralSlip</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Lateral slip of the tire. <a href="#dece3d8e6577b7a0d01527a4b24ca432"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#3ca0bd3d303270ad52eb2e784d1b72d4">steerAngle</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Steer angle of the wheel about the "up" vector accounting for input steer and toe and, if applicable, Ackermann steer correction. <a href="#3ca0bd3d303270ad52eb2e784d1b72d4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxTransform.html">PxTransform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxWheelQueryResult.html#55c818d828141bcb635af224516fc107">localPose</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Local pose of the wheel. <a href="#55c818d828141bcb635af224516fc107"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Structure containing data describing the non-persistent state of each suspension/wheel/tire unit. This structure is filled out in PxVehicleUpdates and PxVehicleUpdateSingleVehicleAndStoreTelemetryData. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><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>, PxVehicleUpdateSingleVehicleAndStoreTelemetryData </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="161b38c47540b17befebc36c02c8e996"></a><!-- doxytag: member="PxWheelQueryResult::PxWheelQueryResult" ref="161b38c47540b17befebc36c02c8e996" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxWheelQueryResult::PxWheelQueryResult </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxVehicleTireFriction_8h-source.html#l00053">PxVehicleDrivableSurfaceType::eSURFACE_TYPE_UNKNOWN</a>, <a class="el" href="Px_8h-source.html#l00084">PxIdentity</a>, and <a class="el" href="PxMemory_8h-source.html#l00054">PxMemZero()</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="7a21ebf9f8747982774e747a4c096c41"></a><!-- doxytag: member="PxWheelQueryResult::isInAir" ref="7a21ebf9f8747982774e747a4c096c41" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="structPxWheelQueryResult.html#7a21ebf9f8747982774e747a4c096c41">PxWheelQueryResult::isInAir</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +If suspension travel limits forbid the wheel from touching the drivable surface then isInAir is true. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If the wheel can be placed on the contact plane of the most recent suspension line raycast/sweep then isInAir is false. <p> +If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then isInAir is computed using the contact plane that was hit by the most recent suspension line raycast/sweep. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="dece3d8e6577b7a0d01527a4b24ca432"></a><!-- doxytag: member="PxWheelQueryResult::lateralSlip" ref="dece3d8e6577b7a0d01527a4b24ca432" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#dece3d8e6577b7a0d01527a4b24ca432">PxWheelQueryResult::lateralSlip</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Lateral slip of the tire. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then lateralSlip is 0.0 <p> +The lateral slip angle is approximately PxAtan(vx / PxAbs(vz)) where vx and vz are the components of rigid body velocity at the wheel base along the wheel's lateral and longitudinal directions, respectively. <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the tire lateral slip is computed using the contact plane that was hit by the most recent suspension line raycast or sweep. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="55c818d828141bcb635af224516fc107"></a><!-- doxytag: member="PxWheelQueryResult::localPose" ref="55c818d828141bcb635af224516fc107" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxTransform.html">PxTransform</a> <a class="el" href="structPxWheelQueryResult.html#55c818d828141bcb635af224516fc107">PxWheelQueryResult::localPose</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Local pose of the wheel. +<p> + +</div> +</div><p> +<a class="anchor" name="bfdde49461f75cb9e226ed2923d58ce5"></a><!-- doxytag: member="PxWheelQueryResult::longitudinalSlip" ref="bfdde49461f75cb9e226ed2923d58ce5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#bfdde49461f75cb9e226ed2923d58ce5">PxWheelQueryResult::longitudinalSlip</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Longitudinal slip of the tire. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then longitudinalSlip is 0.0 <p> +The longitudinal slip is approximately (w*r - vz) / PxAbs(vz) where w is the angular speed of the wheel, r is the radius of the wheel, and vz component of rigid body velocity computed at the wheel base along the longitudinal direction of the tire. <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the tire longitudinal slip is computed using the contact plane that was hit by the most recent suspension line raycast or sweep. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3ca0bd3d303270ad52eb2e784d1b72d4"></a><!-- doxytag: member="PxWheelQueryResult::steerAngle" ref="3ca0bd3d303270ad52eb2e784d1b72d4" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#3ca0bd3d303270ad52eb2e784d1b72d4">PxWheelQueryResult::steerAngle</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Steer angle of the wheel about the "up" vector accounting for input steer and toe and, if applicable, Ackermann steer correction. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleWheelData.html#914c7de59fd8443c371e30b42b2e6d84" title="Wheel toe angle. This value is ignored by PxVehicleDriveTank and PxVehicleNoDrive...">PxVehicleWheelData::mToeAngle</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="68a36bfd00e7f38621fca9c415cc7917"></a><!-- doxytag: member="PxWheelQueryResult::suspJounce" ref="68a36bfd00e7f38621fca9c415cc7917" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#68a36bfd00e7f38621fca9c415cc7917">PxWheelQueryResult::suspJounce</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Compression of the suspension spring. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then the jounce is -PxVehicleSuspensionData.mMaxDroop The jounce can never exceed <a class="el" href="classPxVehicleSuspensionData.html#41931d05cc3610c523139d4f975cced6" title="Maximum compression allowed by suspension spring.">PxVehicleSuspensionData.mMaxCompression</a>. Positive values result when the suspension is compressed from the rest position, while negative values mean the suspension is elongated from the rest position. <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the suspension compression is computed using the contact plane that was hit by the most recent suspension line raycast or sweep. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="31b6ed853082cacb07e8926dfc0a21b0"></a><!-- doxytag: member="PxWheelQueryResult::suspLineDir" ref="31b6ed853082cacb07e8926dfc0a21b0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="structPxWheelQueryResult.html#31b6ed853082cacb07e8926dfc0a21b0">PxWheelQueryResult::suspLineDir</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Directions of suspension line raycast/sweep used in the raycast/sweep completed immediately before PxVehicleUpdates. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then (0,0,0) is stored. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><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#g2020b9fcb5092e2a2d81e82ba7461dfd" title="Perform raycasts for all suspension lines for all vehicles.">PxVehicleSuspensionRaycasts</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c23b4fa451ee4a45350683bcbc0c9b14"></a><!-- doxytag: member="PxWheelQueryResult::suspLineLength" ref="c23b4fa451ee4a45350683bcbc0c9b14" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#c23b4fa451ee4a45350683bcbc0c9b14">PxWheelQueryResult::suspLineLength</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Lengths of suspension line raycast/sweep used in raycast/sweep completed immediately before PxVehicleUpdates. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then 0 is stored. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><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#g2020b9fcb5092e2a2d81e82ba7461dfd" title="Perform raycasts for all suspension lines for all vehicles.">PxVehicleSuspensionRaycasts</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f2bc73597bdc1096034f5f22f2cbde2a"></a><!-- doxytag: member="PxWheelQueryResult::suspLineStart" ref="f2bc73597bdc1096034f5f22f2cbde2a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="structPxWheelQueryResult.html#f2bc73597bdc1096034f5f22f2cbde2a">PxWheelQueryResult::suspLineStart</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Start point of suspension line raycast/sweep used in the raycast/sweep completed immediately before PxVehicleUpdates. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then (0,0,0) is stored. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><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#g2020b9fcb5092e2a2d81e82ba7461dfd" title="Perform raycasts for all suspension lines for all vehicles.">PxVehicleSuspensionRaycasts</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="eefa0e519260b023b395abd28e5c4f01"></a><!-- doxytag: member="PxWheelQueryResult::suspSpringForce" ref="eefa0e519260b023b395abd28e5c4f01" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#eefa0e519260b023b395abd28e5c4f01">PxWheelQueryResult::suspSpringForce</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Magnitude of force applied by the suspension spring along the direction of suspension travel. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then the force is 0 <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the suspension spring force is computed using the contact plane that was hit by the most recent suspension line raycast or sweep. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleWheelsSimData.html#a7044f8657ea0b87aa4ca7d3de0f5dd0" title="Return the direction of travel of the suspension of the idth wheel.">PxVehicleWheelsSimData::getSuspTravelDirection</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c728726399b7e23755086c0a512c308b"></a><!-- doxytag: member="PxWheelQueryResult::tireContactActor" ref="c728726399b7e23755086c0a512c308b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxActor.html">PxActor</a>* <a class="el" href="structPxWheelQueryResult.html#c728726399b7e23755086c0a512c308b">PxWheelQueryResult::tireContactActor</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK.">PxActor</a> instance of the driving surface under the corresponding vehicle wheel. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then tireContactActor is NULL. <p> +If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then NULL is stored. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8d048db9af70ed06e0575d979093f538"></a><!-- doxytag: member="PxWheelQueryResult::tireContactNormal" ref="8d048db9af70ed06e0575d979093f538" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="structPxWheelQueryResult.html#8d048db9af70ed06e0575d979093f538">PxWheelQueryResult::tireContactNormal</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Normal on the drivable surface at the hit point of the most recent suspension raycast or sweep. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then the contact normal is (0,0,0). <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then (0,0,0) is stored. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="265780749830b4cd7b7895eed6133f8a"></a><!-- doxytag: member="PxWheelQueryResult::tireContactPoint" ref="265780749830b4cd7b7895eed6133f8a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="structPxWheelQueryResult.html#265780749830b4cd7b7895eed6133f8a">PxWheelQueryResult::tireContactPoint</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Point on the drivable surface hit by the most recent suspension raycast or sweep. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then the contact point is (0,0,0). <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then (0,0,0) is stored. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="52c57fa129bcf35ccde120c6fe09567e"></a><!-- doxytag: member="PxWheelQueryResult::tireContactShape" ref="52c57fa129bcf35ccde120c6fe09567e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxShape.html">PxShape</a>* <a class="el" href="structPxWheelQueryResult.html#52c57fa129bcf35ccde120c6fe09567e">PxWheelQueryResult::tireContactShape</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> instance of the driving surface under the corresponding vehicle wheel. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then tireContactShape is NULL. <p> +If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then NULL is stored. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="62c137fe4b995c7a9c3e491bae103180"></a><!-- doxytag: member="PxWheelQueryResult::tireFriction" ref="62c137fe4b995c7a9c3e491bae103180" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="structPxWheelQueryResult.html#62c137fe4b995c7a9c3e491bae103180">PxWheelQueryResult::tireFriction</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Friction experienced by the tire for the combination of tire type and surface type after accounting for the friction vs slip graph. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then the tire friction is 0. <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the stored tire friction is the value computed in PxVehicleUpdates that immediately followed the last raycast or sweep. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a>, <a class="el" href="classPxVehicleTireData.html">PxVehicleTireData</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b35c38cb5001bad2c3cc4daab71d3056"></a><!-- doxytag: member="PxWheelQueryResult::tireLateralDir" ref="b35c38cb5001bad2c3cc4daab71d3056" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="structPxWheelQueryResult.html#b35c38cb5001bad2c3cc4daab71d3056">PxWheelQueryResult::tireLateralDir</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Lateral direction of the wheel/tire accounting for steer/toe/camber angle projected on to the contact plan of the drivable surface. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then tireLateralDir is (0,0,0) <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the tire lateral direction is computed using the contact plane that was hit by the most recent suspension line raycast or sweep. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e9dd6242afb08aebe9895760785facae"></a><!-- doxytag: member="PxWheelQueryResult::tireLongitudinalDir" ref="e9dd6242afb08aebe9895760785facae" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="structPxWheelQueryResult.html#e9dd6242afb08aebe9895760785facae">PxWheelQueryResult::tireLongitudinalDir</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Forward direction of the wheel/tire accounting for steer/toe/camber angle projected on to the contact plane of the drivable surface. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then tireLongitudinalDir is (0,0,0) <p> +If no raycast or sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then the tire longitudinal direction is computed using the contact plane that was hit by the most recent suspension line raycast or sweep. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ab6dff9c3117e76f1ffaac4c867b2cca"></a><!-- doxytag: member="PxWheelQueryResult::tireSurfaceMaterial" ref="ab6dff9c3117e76f1ffaac4c867b2cca" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classPxMaterial.html">PxMaterial</a>* <a class="el" href="structPxWheelQueryResult.html#ab6dff9c3117e76f1ffaac4c867b2cca">PxWheelQueryResult::tireSurfaceMaterial</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> instance of the driving surface under the corresponding vehicle wheel. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then tireSurfaceMaterial is NULL. <p> +If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then NULL is stored. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3c95ac8a6cfbdac1f496c193140342e9"></a><!-- doxytag: member="PxWheelQueryResult::tireSurfaceType" ref="3c95ac8a6cfbdac1f496c193140342e9" 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="structPxWheelQueryResult.html#3c95ac8a6cfbdac1f496c193140342e9">PxWheelQueryResult::tireSurfaceType</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Surface type integer that corresponds to the mapping between tireSurfaceMaterial and integer as described in <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a>. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If suspension travel limits forbid the wheel from touching the drivable surface then tireSurfaceType is <a class="el" href="structPxVehicleDrivableSurfaceType.html#29596afb2720fc7b82bc4da11cbfea2dd2a01ae83fd1798640e6edcd52148307">PxVehicleDrivableSurfaceType::eSURFACE_TYPE_UNKNOWN</a>. <p> +If no raycast/sweep for the corresponding suspension was performed immediately prior to PxVehicleUpdates then <a class="el" href="structPxVehicleDrivableSurfaceType.html#29596afb2720fc7b82bc4da11cbfea2dd2a01ae83fd1798640e6edcd52148307">PxVehicleDrivableSurfaceType::eSURFACE_TYPE_UNKNOWN</a> is stored. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="PxVehicleUpdate_8h-source.html">PxVehicleUpdate.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> |