PxVehicleDriveSimData4W Class Reference

Data structure describing the drive model components of a vehicle with up to 4 driven wheels and up to 16 un-driven wheels. The drive model incorporates engine, clutch, gears, autobox, differential, and Ackermann steer correction. More...

#include <PxVehicleDrive4W.h>

Inheritance diagram for PxVehicleDriveSimData4W:
Collaboration diagram for PxVehicleDriveSimData4W:

Public Member Functions

 PxVehicleDriveSimData4W ()
 
PX_FORCE_INLINE const PxVehicleDifferential4WDatagetDiffData () const
 Return the data describing the differential. More...
 
PX_FORCE_INLINE const PxVehicleAckermannGeometryDatagetAckermannGeometryData () const
 Return the data describing the Ackermann steer-correction. More...
 
void setDiffData (const PxVehicleDifferential4WData &diff)
 Set the data describing the differential. More...
 
void setAckermannGeometryData (const PxVehicleAckermannGeometryData &ackermannData)
 Set the data describing the Ackermann steer-correction. More...
 
 PxVehicleDriveSimData4W (const PxEMPTY)
 
- Public Member Functions inherited from PxVehicleDriveSimData
PX_FORCE_INLINE const PxVehicleEngineDatagetEngineData () const
 Return the engine data. More...
 
void setEngineData (const PxVehicleEngineData &engine)
 Set the engine data. More...
 
PX_FORCE_INLINE const PxVehicleGearsDatagetGearsData () const
 Return the gears data. More...
 
void setGearsData (const PxVehicleGearsData &gears)
 Set the gears data. More...
 
PX_FORCE_INLINE const PxVehicleClutchDatagetClutchData () const
 Return the clutch data. More...
 
void setClutchData (const PxVehicleClutchData &clutch)
 Set the clutch data. More...
 
PX_FORCE_INLINE const PxVehicleAutoBoxDatagetAutoBoxData () const
 Return the autobox data. More...
 
void setAutoBoxData (const PxVehicleAutoBoxData &autobox)
 Set the autobox data. More...
 
 PxVehicleDriveSimData ()
 
 PxVehicleDriveSimData (const PxEMPTY)
 

Static Public Member Functions

static void getBinaryMetaData (PxOutputStream &stream)
 
- Static Public Member Functions inherited from PxVehicleDriveSimData
static void getBinaryMetaData (PxOutputStream &stream)
 

Private Member Functions

bool isValid () const
 Test if the 4W-drive simulation data has been setup with legal data. More...
 

Private Attributes

PxVehicleDifferential4WData mDiff
 Differential simulation data. More...
 
PxVehicleAckermannGeometryData mAckermannGeometry
 Data for ackermann steer angle computation. More...
 

Friends

class PxVehicleDrive4W
 

Additional Inherited Members

- Protected Member Functions inherited from PxVehicleDriveSimData
bool isValid () const
 Test that a PxVehicleDriveSimData instance has been configured with legal data. Call only after setting all components with setEngineData,setGearsData,setClutchData,setAutoBoxData. More...
 
- Protected Attributes inherited from PxVehicleDriveSimData
PxVehicleEngineData mEngine
 
PxVehicleGearsData mGears
 
PxVehicleClutchData mClutch
 
PxVehicleAutoBoxData mAutoBox
 

Detailed Description

Data structure describing the drive model components of a vehicle with up to 4 driven wheels and up to 16 un-driven wheels. The drive model incorporates engine, clutch, gears, autobox, differential, and Ackermann steer correction.

See also
PxVehicleDriveSimData

Constructor & Destructor Documentation

◆ PxVehicleDriveSimData4W() [1/2]

PxVehicleDriveSimData4W::PxVehicleDriveSimData4W ( )
inline

◆ PxVehicleDriveSimData4W() [2/2]

PxVehicleDriveSimData4W::PxVehicleDriveSimData4W ( const PxEMPTY  )
inline

Member Function Documentation

◆ getAckermannGeometryData()

PX_FORCE_INLINE const PxVehicleAckermannGeometryData& PxVehicleDriveSimData4W::getAckermannGeometryData ( ) const
inline

Return the data describing the Ackermann steer-correction.

See also
PxVehicleAckermannGeometryData

◆ getBinaryMetaData()

static void PxVehicleDriveSimData4W::getBinaryMetaData ( PxOutputStream stream)
static

◆ getDiffData()

PX_FORCE_INLINE const PxVehicleDifferential4WData& PxVehicleDriveSimData4W::getDiffData ( ) const
inline

Return the data describing the differential.

See also
PxVehicleDifferential4WData

◆ isValid()

bool PxVehicleDriveSimData4W::isValid ( ) const
private

Test if the 4W-drive simulation data has been setup with legal data.

Note
Call only after setting all components.
See also
setEnginedata, setClutchData, setGearsData, setAutoboxData, setDiffData, setAckermannGeometryData

◆ setAckermannGeometryData()

void PxVehicleDriveSimData4W::setAckermannGeometryData ( const PxVehicleAckermannGeometryData ackermannData)

Set the data describing the Ackermann steer-correction.

See also
PxVehicleAckermannGeometryData

◆ setDiffData()

void PxVehicleDriveSimData4W::setDiffData ( const PxVehicleDifferential4WData diff)

Set the data describing the differential.

See also
PxVehicleDifferential4WData

Friends And Related Function Documentation

◆ PxVehicleDrive4W

friend class PxVehicleDrive4W
friend

Member Data Documentation

◆ mAckermannGeometry

PxVehicleAckermannGeometryData PxVehicleDriveSimData4W::mAckermannGeometry
private

Data for ackermann steer angle computation.

See also
setAckermannGeometryData, getAckermannGeometryData

◆ mDiff

PxVehicleDifferential4WData PxVehicleDriveSimData4W::mDiff
private

Differential simulation data.

See also
setDiffData, getDiffData

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