From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxVehicleTireData.html | 415 +++++++++++++++++++++ 1 file changed, 415 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleTireData.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleTireData.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleTireData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleTireData.html new file mode 100644 index 00000000..7cfb9606 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleTireData.html @@ -0,0 +1,415 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleTireData Class Reference + + + + + + + +
+

PxVehicleTireData Class Reference
+ +[Vehicle] +

#include <PxVehicleComponents.h> +

+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 PxVehicleTireData ()
PX_FORCE_INLINE PxReal getRecipLongitudinalStiffnessPerUnitGravity () const
 Return Cached value of 1.0/mLongitudinalStiffnessPerUnitGravity.
PX_FORCE_INLINE PxReal getFrictionVsSlipGraphRecipx1Minusx0 () const
 Return Cached value of 1.0f/(mFrictionVsSlipGraph[1][0]-mFrictionVsSlipGraph[0][0]).
PX_FORCE_INLINE PxReal getFrictionVsSlipGraphRecipx2Minusx1 () const
 Return Cached value of 1.0f/(mFrictionVsSlipGraph[2][0]-mFrictionVsSlipGraph[1][0]).

Public Attributes

PxReal mLatStiffX
 Tire lateral stiffness is a graph of tire load that has linear behavior near zero load and flattens at large loads. mLatStiffX describes the minimum normalized load (load/restLoad) that gives a flat lateral stiffness response to load.
PxReal mLatStiffY
 Tire lateral stiffness is a graph of tire load that has linear behavior near zero load and flattens at large loads. mLatStiffY describes the maximum possible value of lateralStiffness/restLoad that occurs when (load/restLoad)>= mLatStiffX.
PxReal mLongitudinalStiffnessPerUnitGravity
 Tire Longitudinal stiffness per unit gravitational acceleration.
PxReal mCamberStiffnessPerUnitGravity
 tire Tire camber stiffness per unity gravitational acceleration.
PxReal mFrictionVsSlipGraph [3][2]
 Graph of friction vs longitudinal slip with 3 points.
PxU32 mType
 Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc.

Private Member Functions

bool isValid () const

Private Attributes

PxReal mRecipLongitudinalStiffnessPerUnitGravity
 Cached value of 1.0/mLongitudinalStiffnessPerUnitGravity.
PxReal mFrictionVsSlipGraphRecipx1Minusx0
 Cached value of 1.0f/(mFrictionVsSlipGraph[1][0]-mFrictionVsSlipGraph[0][0]).
PxReal mFrictionVsSlipGraphRecipx2Minusx1
 Cached value of 1.0f/(mFrictionVsSlipGraph[2][0]-mFrictionVsSlipGraph[1][0]).
PxReal mPad [2]

Friends

class PxVehicleWheels4SimData
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PxVehicleTireData::PxVehicleTireData (  )  [inline]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
PX_FORCE_INLINE PxReal PxVehicleTireData::getFrictionVsSlipGraphRecipx1Minusx0 (  )  const [inline]
+
+
+ +

+Return Cached value of 1.0f/(mFrictionVsSlipGraph[1][0]-mFrictionVsSlipGraph[0][0]). +

+

See also:
PxVehicleWheelsSimData::setTireData
+ +
+

+ +

+
+ + + + + + + + +
PX_FORCE_INLINE PxReal PxVehicleTireData::getFrictionVsSlipGraphRecipx2Minusx1 (  )  const [inline]
+
+
+ +

+Return Cached value of 1.0f/(mFrictionVsSlipGraph[2][0]-mFrictionVsSlipGraph[1][0]). +

+

See also:
PxVehicleWheelsSimData::setTireData
+ +
+

+ +

+
+ + + + + + + + +
PX_FORCE_INLINE PxReal PxVehicleTireData::getRecipLongitudinalStiffnessPerUnitGravity (  )  const [inline]
+
+
+ +

+Return Cached value of 1.0/mLongitudinalStiffnessPerUnitGravity. +

+

See also:
PxVehicleWheelsSimData::setTireData
+ +
+

+ +

+
+ + + + + + + + +
bool PxVehicleTireData::isValid (  )  const [private]
+
+
+ +

+ +

+

+

Friends And Related Function Documentation

+ +
+
+ + + + +
friend class PxVehicleWheels4SimData [friend]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxReal PxVehicleTireData::mCamberStiffnessPerUnitGravity
+
+
+ +

+tire Tire camber stiffness per unity gravitational acceleration. +

+

Note:
Camber stiffness of the tire is calculated as gravitationalAcceleration*mCamberStiffnessPerUnitGravity

+Camber force can be approximated as gravitationalAcceleration*mCamberStiffnessPerUnitGravity*camberAngle.

+Specified in kilograms per radian.

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mFrictionVsSlipGraph[3][2]
+
+
+ +

+Graph of friction vs longitudinal slip with 3 points. +

+

Note:
mFrictionVsSlipGraph[0][0] is always zero.

+mFrictionVsSlipGraph[0][1] is the friction available at zero longitudinal slip.

+mFrictionVsSlipGraph[1][0] is the value of longitudinal slip with maximum friction.

+mFrictionVsSlipGraph[1][1] is the maximum friction.

+mFrictionVsSlipGraph[2][0] is the end point of the graph.

+mFrictionVsSlipGraph[2][1] is the value of friction for slips greater than mFrictionVsSlipGraph[2][0].

+The friction value computed from the friction vs longitudinal slip graph is used to scale the friction value for the combination of material and tire type (PxVehicleDrivableSurfaceToTireFrictionPairs).

+mFrictionVsSlipGraph[2][0] > mFrictionVsSlipGraph[1][0] > mFrictionVsSlipGraph[0][0]

+mFrictionVsSlipGraph[1][1] is typically greater than mFrictionVsSlipGraph[0][1]

+mFrictionVsSlipGraph[2][1] is typically smaller than mFrictionVsSlipGraph[1][1]

+longitudinal slips > mFrictionVsSlipGraph[2][0] use friction multiplier mFrictionVsSlipGraph[2][1]

+The final friction value used by the tire model is the value returned by PxVehicleDrivableSurfaceToTireFrictionPairs multiplied by the value computed from mFrictionVsSlipGraph.

+
See also:
PxVehicleDrivableSurfaceToTireFrictionPairs, PxVehicleComputeTireForce
+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mFrictionVsSlipGraphRecipx1Minusx0 [private]
+
+
+ +

+Cached value of 1.0f/(mFrictionVsSlipGraph[1][0]-mFrictionVsSlipGraph[0][0]). +

+

Note:
Not necessary to set this value because it is set by PxVehicleWheelsSimData::setTireData
+
See also:
PxVehicleWheelsSimData::setTireData
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mFrictionVsSlipGraphRecipx2Minusx1 [private]
+
+
+ +

+Cached value of 1.0f/(mFrictionVsSlipGraph[2][0]-mFrictionVsSlipGraph[1][0]). +

+

Note:
Not necessary to set this value because it is set by PxVehicleWheelsSimData::setTireData
+
See also:
PxVehicleWheelsSimData::setTireData
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mLatStiffX
+
+
+ +

+Tire lateral stiffness is a graph of tire load that has linear behavior near zero load and flattens at large loads. mLatStiffX describes the minimum normalized load (load/restLoad) that gives a flat lateral stiffness response to load. +

+Range: [0, PX_MAX_F32)
+ +

+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mLatStiffY
+
+
+ +

+Tire lateral stiffness is a graph of tire load that has linear behavior near zero load and flattens at large loads. mLatStiffY describes the maximum possible value of lateralStiffness/restLoad that occurs when (load/restLoad)>= mLatStiffX. +

+

Note:
If load/restLoad is greater than mLatStiffX then the lateral stiffness is mLatStiffY*restLoad.

+If load/restLoad is less than mLatStiffX then the lateral stiffness is mLastStiffY*(load/mLatStiffX)

+Lateral force can be approximated as lateralStiffness * lateralSlip.

+Specified in per radian.

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mLongitudinalStiffnessPerUnitGravity
+
+
+ +

+Tire Longitudinal stiffness per unit gravitational acceleration. +

+

Note:
Longitudinal stiffness of the tire is calculated as gravitationalAcceleration*mLongitudinalStiffnessPerUnitGravity.

+Longitudinal force can be approximated as gravitationalAcceleration*mLongitudinalStiffnessPerUnitGravity*longitudinalSlip.

+Specified in kilograms per radian.

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mPad[2] [private]
+
+
+ +

+ +

+

+ +

+
+ + + + +
PxReal PxVehicleTireData::mRecipLongitudinalStiffnessPerUnitGravity [private]
+
+
+ +

+Cached value of 1.0/mLongitudinalStiffnessPerUnitGravity. +

+

Note:
Not necessary to set this value because it is set by PxVehicleWheelsSimData::setTireData
+
See also:
PxVehicleWheelsSimData::setTireData
+ +
+

+ +

+
+ + + + +
PxU32 PxVehicleTireData::mType
+
+
+ +

+Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc. +

+

See also:
PxVehicleDrivableSurfaceToTireFrictionPairs
+Range: [0, PX_MAX_F32)
+ +
+

+

The documentation for this class was generated from the following file: +
+ +

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3