Public Types | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Friends | List of all members
PxVehicleEngineData Class Reference
Vehicle

#include <PxVehicleComponents.h>

Collaboration diagram for PxVehicleEngineData:
Collaboration graph
[legend]

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. More...
 
PX_FORCE_INLINE PxReal getRecipMaxOmega () const
 Return value of mRecipMaxOmega( = 1.0f / mMaxOmega ) that is automatically set by PxVehicleDriveSimData::setEngineData. More...
 
 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 ). More...
 
PxReal mMOI
 Moment of inertia of the engine around the axis of rotation. More...
 
PxReal mPeakTorque
 Maximum torque available to apply to the engine when the accelerator pedal is at maximum. More...
 
PxReal mMaxOmega
 Maximum rotation speed of the engine. More...
 
PxReal mDampingRateFullThrottle
 Damping rate of engine when full throttle is applied. More...
 
PxReal mDampingRateZeroThrottleClutchEngaged
 Damping rate of engine when full throttle is applied. More...
 
PxReal mDampingRateZeroThrottleClutchDisengaged
 Damping rate of engine when full throttle is applied. More...
 

Private Member Functions

bool isValid () const
 

Private Attributes

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

Friends

class PxVehicleDriveSimData
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES 

Constructor & Destructor Documentation

◆ PxVehicleEngineData() [1/2]

PxVehicleEngineData::PxVehicleEngineData ( )
inline

◆ PxVehicleEngineData() [2/2]

PxVehicleEngineData::PxVehicleEngineData ( const PxEMPTY  )
inline

Member Function Documentation

◆ getRecipMaxOmega()

PX_FORCE_INLINE PxReal PxVehicleEngineData::getRecipMaxOmega ( ) const
inline

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

◆ getRecipMOI()

PX_FORCE_INLINE PxReal PxVehicleEngineData::getRecipMOI ( ) const
inline

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

◆ isValid()

bool PxVehicleEngineData::isValid ( ) const
private

Friends And Related Function Documentation

◆ PxVehicleDriveSimData

friend class PxVehicleDriveSimData
friend

Member Data Documentation

◆ mDampingRateFullThrottle

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)

◆ mDampingRateZeroThrottleClutchDisengaged

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)

◆ mDampingRateZeroThrottleClutchEngaged

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)

◆ mMaxOmega

PxReal PxVehicleEngineData::mMaxOmega

Maximum rotation speed of the engine.

Note
Specified in radians per second (s^-1).

Range: [0, PX_MAX_F32)

◆ mMOI

PxReal PxVehicleEngineData::mMOI

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

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

◆ mPeakTorque

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)

◆ mRecipMaxOmega

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)

◆ mRecipMOI

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)

◆ mTorqueCurve

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: