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/classPxVehicleClutchData.html | 215 +++++++++++++++++++++ 1 file changed, 215 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleClutchData.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleClutchData.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleClutchData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleClutchData.html new file mode 100644 index 00000000..04c8fba7 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleClutchData.html @@ -0,0 +1,215 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleClutchData Class Reference + + + + + + + +
+

PxVehicleClutchData Class Reference
+ +[Vehicle] +

#include <PxVehicleComponents.h> +

+ +

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

Public Member Functions

 PxVehicleClutchData ()
 PxVehicleClutchData (const PxEMPTY)

Public Attributes

PxReal mStrength
 Strength of clutch.
PxVehicleClutchAccuracyMode::Enum mAccuracyMode
 The engine and wheel rotation speeds that are coupled through the clutch can be updated by choosing one of two modes: eESTIMATE and eBEST_POSSIBLE.
PxU32 mEstimateIterations
 Tune the mathematical accuracy and computational cost of the computed estimate to the wheel and engine rotation speeds if eESTIMATE is chosen.

Private Member Functions

bool isValid () const

Private Attributes

PxU8 mPad [4]

Friends

class PxVehicleDriveSimData
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PxVehicleClutchData::PxVehicleClutchData (  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PxVehicleClutchData::PxVehicleClutchData (const   PxEMPTY  )  [inline]
+
+
+ +

+ +

+

+

Member Function Documentation

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

+ +

+

+

Friends And Related Function Documentation

+ +
+
+ + + + +
friend class PxVehicleDriveSimData [friend]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxVehicleClutchAccuracyMode::Enum PxVehicleClutchData::mAccuracyMode
+
+
+ +

+The engine and wheel rotation speeds that are coupled through the clutch can be updated by choosing one of two modes: eESTIMATE and eBEST_POSSIBLE. +

+

Note:
If eESTIMATE is chosen the vehicle sdk will update the wheel and engine rotation speeds with estimated values to the implemented clutch model.

+If eBEST_POSSIBLE is chosen the vehicle sdk will compute the best possible solution (within floating point tolerance) to the implemented clutch model. This is the recommended mode.

+The clutch model remains the same if either eESTIMATE or eBEST_POSSIBLE is chosen but the accuracy and computational cost of the solution to the model can be tuned as required.

+ +
+

+ +

+
+ + + + +
PxU32 PxVehicleClutchData::mEstimateIterations
+
+
+ +

+Tune the mathematical accuracy and computational cost of the computed estimate to the wheel and engine rotation speeds if eESTIMATE is chosen. +

+

Note:
As mEstimateIterations increases the computational cost of the clutch also increases and the solution approaches the solution that would be computed if eBEST_POSSIBLE was chosen instead.

+This has no effect if eBEST_POSSIBLE is chosen as the accuracy mode.

+A value of zero is not allowed if eESTIMATE is chosen as the accuracy mode.

+ +
+

+ +

+
+ + + + +
PxU8 PxVehicleClutchData::mPad[4] [private]
+
+
+ +

+ +

+

+ +

+
+ + + + +
PxReal PxVehicleClutchData::mStrength
+
+
+ +

+Strength of clutch. +

+

Note:
The clutch is the mechanism that couples the engine to the wheels. A stronger clutch more strongly couples the engine to the wheels, while a clutch of strength zero completely decouples the engine from the wheels. Stronger clutches more quickly bring the wheels and engine into equilibrium, while weaker clutches take longer, resulting in periods of clutch slip and delays in power transmission from the engine to the wheels. The torque generated by the clutch is proportional to the clutch strength and the velocity difference between the engine's rotational speed and the rotational speed of the driven wheels after accounting for the gear ratio. The torque at the clutch is applied negatively to the engine and positively to the driven wheels.

+Specified in kilograms metres-squared per second (kg m^2 s^-1)

+Range: (0,MAX_NB_GEAR_RATIOS)
+ +
+

+

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