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

PxVehicleEngineData Class Reference
+ +[Vehicle] +

#include <PxVehicleComponents.h> +

+

+Collaboration diagram for PxVehicleEngineData:
+
+

Collaboration graph
+ +PxFixedSizeLookupTable\< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES \> +
[legend]
+ +

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

Public Types

enum  { eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES = 8 + }

Public Member Functions

 PxVehicleEngineData ()
PX_FORCE_INLINE PxReal getRecipMOI () const
 Return value of mRecipMOI(=1.0f/mMOI) that is automatically set by PxVehicleDriveSimData::setEngineData.
PX_FORCE_INLINE PxReal getRecipMaxOmega () const
 Return value of mRecipMaxOmega( = 1.0f / mMaxOmega ) that is automatically set by PxVehicleDriveSimData::setEngineData.
 PxVehicleEngineData (const PxEMPTY)

Public Attributes

PxFixedSizeLookupTable
+< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES > 		mTorqueCurve
 Graph of normalized torque (torque/mPeakTorque) against normalized engine speed ( engineRotationSpeed / mMaxOmega ).
PxReal mMOI
 Moment of inertia of the engine around the axis of rotation.
PxReal mPeakTorque
 Maximum torque available to apply to the engine when the accelerator pedal is at maximum.
PxReal mMaxOmega
 Maximum rotation speed of the engine.
PxReal mDampingRateFullThrottle
 Damping rate of engine when full throttle is applied.
PxReal mDampingRateZeroThrottleClutchEngaged
 Damping rate of engine when full throttle is applied.
PxReal mDampingRateZeroThrottleClutchDisengaged
 Damping rate of engine when full throttle is applied.

Private Member Functions

bool isValid () const

Private Attributes

PxReal mRecipMOI
 Reciprocal of the engine moment of inertia.
PxReal mRecipMaxOmega
 Reciprocal of the maximum rotation speed of the engine.

Friends

class PxVehicleDriveSimData
+

Member Enumeration Documentation

+ +
+
+ + + + +
anonymous enum
+
+
+ +

+

Enumerator:
+ + +
eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES  +
+
+ +
+

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PxVehicleEngineData::PxVehicleEngineData (  )  [inline]
+
+
+ +

+ +

+

+ +

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

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
PX_FORCE_INLINE PxReal PxVehicleEngineData::getRecipMaxOmega (  )  const [inline]
+
+
+ +

+Return value of mRecipMaxOmega( = 1.0f / mMaxOmega ) that is automatically set by PxVehicleDriveSimData::setEngineData. +

+ +

+

+ +

+
+ + + + + + + + +
PX_FORCE_INLINE PxReal PxVehicleEngineData::getRecipMOI (  )  const [inline]
+
+
+ +

+Return value of mRecipMOI(=1.0f/mMOI) that is automatically set by PxVehicleDriveSimData::setEngineData. +

+ +

+

+ +

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

+ +

+

+

Friends And Related Function Documentation

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

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxReal PxVehicleEngineData::mDampingRateFullThrottle
+
+
+ +

+Damping rate of engine when full throttle is applied. +

+

Note:
If the clutch is engaged (any gear except neutral) then the damping rate applied at run-time is an interpolation between mDampingRateZeroThrottleClutchEngaged and mDampingRateFullThrottle: mDampingRateZeroThrottleClutchEngaged + (mDampingRateFullThrottle-mDampingRateZeroThrottleClutchEngaged)*acceleratorPedal;

+If the clutch is disengaged (in neutral gear) the damping rate applied at run-time is an interpolation between mDampingRateZeroThrottleClutchDisengaged and mDampingRateFullThrottle: mDampingRateZeroThrottleClutchDisengaged + (mDampingRateFullThrottle-mDampingRateZeroThrottleClutchDisengaged)*acceleratorPedal;

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

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mDampingRateZeroThrottleClutchDisengaged
+
+
+ +

+Damping rate of engine when full throttle is applied. +

+

Note:
If the clutch is engaged (any gear except neutral) then the damping rate applied at run-time is an interpolation between mDampingRateZeroThrottleClutchEngaged and mDampingRateFullThrottle: mDampingRateZeroThrottleClutchEngaged + (mDampingRateFullThrottle-mDampingRateZeroThrottleClutchEngaged)*acceleratorPedal;

+If the clutch is disengaged (in neutral gear) the damping rate applied at run-time is an interpolation between mDampingRateZeroThrottleClutchDisengaged and mDampingRateFullThrottle: mDampingRateZeroThrottleClutchDisengaged + (mDampingRateFullThrottle-mDampingRateZeroThrottleClutchDisengaged)*acceleratorPedal;

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

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mDampingRateZeroThrottleClutchEngaged
+
+
+ +

+Damping rate of engine when full throttle is applied. +

+

Note:
If the clutch is engaged (any gear except neutral) then the damping rate applied at run-time is an interpolation between mDampingRateZeroThrottleClutchEngaged and mDampingRateFullThrottle: mDampingRateZeroThrottleClutchEngaged + (mDampingRateFullThrottle-mDampingRateZeroThrottleClutchEngaged)*acceleratorPedal;

+If the clutch is disengaged (in neutral gear) the damping rate applied at run-time is an interpolation between mDampingRateZeroThrottleClutchDisengaged and mDampingRateFullThrottle: mDampingRateZeroThrottleClutchDisengaged + (mDampingRateFullThrottle-mDampingRateZeroThrottleClutchDisengaged)*acceleratorPedal;

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

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mMaxOmega
+
+
+ +

+Maximum rotation speed of the engine. +

+

Note:
Specified in radians per second (s^-1).
+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mMOI
+
+
+ +

+Moment of inertia of the engine around the axis of rotation. +

+

Note:
Specified in kilograms metres-squared (kg m^2)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mPeakTorque
+
+
+ +

+Maximum torque available to apply to the engine when the accelerator pedal is at maximum. +

+

Note:
The torque available is the value of the accelerator pedal (in range [0, 1]) multiplied by the normalized torque as computed from mTorqueCurve multiplied by mPeakTorque.

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

+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mRecipMaxOmega [private]
+
+
+ +

+Reciprocal of the maximum rotation speed of the engine. +

+

Note:
Not necessary to set this value because it is set by PxVehicleDriveSimData::setEngineData
+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxReal PxVehicleEngineData::mRecipMOI [private]
+
+
+ +

+Reciprocal of the engine moment of inertia. +

+

Note:
Not necessary to set this value because it is set by PxVehicleDriveSimData::setEngineData
+Range: [0, PX_MAX_F32)
+ +
+

+ +

+
+ + + + +
PxFixedSizeLookupTable<eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES> PxVehicleEngineData::mTorqueCurve
+
+
+ +

+Graph of normalized torque (torque/mPeakTorque) against normalized engine speed ( engineRotationSpeed / mMaxOmega ). +

+

Note:
The normalized engine speed is the x-axis of the graph, while the normalized torque is the y-axis of the graph.
+ +
+

+

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