Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Friends | List of all members
PxVehicleDrive4W Class Reference

Data structure with instanced dynamics data and configuration data of a vehicle with up to 4 driven wheels and up to 16 non-driven wheels. More...

#include <PxVehicleDrive4W.h>

Inheritance diagram for PxVehicleDrive4W:
Inheritance graph
[legend]
Collaboration diagram for PxVehicleDrive4W:
Collaboration graph
[legend]

Public Member Functions

void free ()
 Deallocate a PxVehicleDrive4W instance. More...
 
void setup (PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimData4W &driveData, const PxU32 nbNonDrivenWheels)
 Set up a vehicle using simulation data for the wheels and drive model. More...
 
void setToRestState ()
 Set a vehicle to its rest state. Aside from the rigid body transform, this will set the vehicle and rigid body to the state they were in immediately after setup or create. More...
 
 PxVehicleDrive4W (PxBaseFlags baseFlags)
 
virtual const char * getConcreteTypeName () const
 Returns string name of dynamic type. More...
 
- Public Member Functions inherited from PxVehicleDrive
 PxVehicleDrive (PxBaseFlags baseFlags)
 
- Public Member Functions inherited from PxVehicleWheels
PX_FORCE_INLINE PxU32 getVehicleType () const
 Return the type of vehicle. More...
 
PX_FORCE_INLINE PxRigidDynamicgetRigidDynamicActor ()
 Get non-const ptr to PxRigidDynamic instance that is the vehicle's physx representation. More...
 
PX_FORCE_INLINE const
PxRigidDynamic
getRigidDynamicActor () const
 Get const ptr to PxRigidDynamic instance that is the vehicle's physx representation. More...
 
PxReal computeForwardSpeed () const
 Compute the rigid body velocity component along the forward vector of the rigid body transform. More...
 
PxReal computeSidewaysSpeed () const
 Compute the rigid body velocity component along the right vector of the rigid body transform. More...
 
virtual void requires (PxProcessPxBaseCallback &c)
 
virtual void exportExtraData (PxSerializationContext &)
 
void importExtraData (PxDeserializationContext &)
 
void resolveReferences (PxDeserializationContext &)
 
PX_FORCE_INLINE PxU32 getNbNonDrivenWheels () const
 
 PxVehicleWheels (PxType concreteType, PxBaseFlags baseFlags)
 
 PxVehicleWheels (PxBaseFlags baseFlags)
 
virtual ~PxVehicleWheels ()
 
virtual void release ()
 Releases the PxBase instance, please check documentation of release in derived class. More...
 
- Public Member Functions inherited from PxBase
template<class T >
T * is ()
 
template<class T >
const T * is () const
 
PX_INLINE PxType getConcreteType () const
 Returns concrete type of object. More...
 
PX_INLINE void setBaseFlag (PxBaseFlag::Enum flag, bool value)
 Set PxBaseFlag. More...
 
PX_INLINE void setBaseFlags (PxBaseFlags inFlags)
 Set PxBaseFlags. More...
 
PX_INLINE PxBaseFlags getBaseFlags () const
 Returns PxBaseFlags. More...
 
virtual bool isReleasable () const
 Whether the object is subordinate. More...
 

Static Public Member Functions

static PxVehicleDrive4Wallocate (const PxU32 nbWheels)
 Allocate a PxVehicleDrive4W instance for a 4WDrive vehicle with nbWheels (= 4 + number of un-driven wheels) More...
 
static PxVehicleDrive4Wcreate (PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimData4W &driveData, const PxU32 nbNonDrivenWheels)
 Allocate and set up a vehicle using simulation data for the wheels and drive model. More...
 
static PxVehicleDrive4WcreateObject (PxU8 *&address, PxDeserializationContext &context)
 
static void getBinaryMetaData (PxOutputStream &stream)
 
- Static Public Member Functions inherited from PxVehicleDrive
static void getBinaryMetaData (PxOutputStream &stream)
 
- Static Public Member Functions inherited from PxVehicleWheels
static void getBinaryMetaData (PxOutputStream &stream)
 

Public Attributes

PxVehicleDriveSimData4W mDriveSimData
 Simulation data that describes the configuration of the vehicle's drive model. More...
 
- Public Attributes inherited from PxVehicleDrive
PxVehicleDriveDynData mDriveDynData
 Dynamics data of vehicle instance. More...
 
- Public Attributes inherited from PxVehicleWheels
PxVehicleWheelsSimData mWheelsSimData
 Data describing the setup of all the wheels/suspensions/tires. More...
 
PxVehicleWheelsDynData mWheelsDynData
 Data describing the dynamic state of all wheels/suspension/tires. More...
 

Protected Member Functions

 PxVehicleDrive4W ()
 
 ~PxVehicleDrive4W ()
 
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance. More...
 
- Protected Member Functions inherited from PxVehicleDrive
bool isValid () const
 Test that all instanced dynamics data and configuration data have legal values. More...
 
void setToRestState ()
 Set vehicle to rest. More...
 
void free ()
 Deallocate a PxVehicle4WDrive instance. More...
 
void setup (PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxU32 nbDrivenWheels, const PxU32 nbNonDrivenWheels)
 
 PxVehicleDrive (PxType concreteType, PxBaseFlags baseFlags)
 
 ~PxVehicleDrive ()
 
- Protected Member Functions inherited from PxVehicleWheels
void setToRestState ()
 Set all wheels to their rest state. More...
 
bool isValid () const
 Test that all configuration and instanced dynamics data is valid. More...
 
void free ()
 Deallocate a PxVehicleWheels instance. More...
 
void setup (PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxU32 nbDrivenWheels, const PxU32 nbNonDrivenWheels)
 
- Protected Member Functions inherited from PxBase
PX_INLINE PxBase (PxType concreteType, PxBaseFlags baseFlags)
 Constructor setting concrete type and base flags. More...
 
PX_INLINE PxBase (PxBaseFlags baseFlags)
 Deserialization constructor setting base flags. More...
 
virtual ~PxBase ()
 Destructor. More...
 
template<class T >
bool typeMatch () const
 

Private Member Functions

bool isValid () const
 Test if the instanced dynamics and configuration data has legal values. More...
 

Friends

class PxVehicleUpdate
 

Additional Inherited Members

- Static Protected Member Functions inherited from PxVehicleDrive
static PxU32 computeByteSize (const PxU32 nbWheels4)
 
static PxU8patchupPointers (PxVehicleDrive *vehDrive, PxU8 *ptr, const PxU32 nbWheels4, const PxU32 nbWheels)
 
- Protected Attributes inherited from PxVehicleWheels
PxRigidDynamicmActor
 The rigid body actor that represents the vehicle in the PhysX SDK. More...
 
PxU8 mType
 Vehicle type (eVehicleDriveTypes) More...
 
PxU8 mPad [14]
 

Detailed Description

Data structure with instanced dynamics data and configuration data of a vehicle with up to 4 driven wheels and up to 16 non-driven wheels.

Constructor & Destructor Documentation

PxVehicleDrive4W::PxVehicleDrive4W ( )
protected
PxVehicleDrive4W::~PxVehicleDrive4W ( )
inlineprotected
PxVehicleDrive4W::PxVehicleDrive4W ( PxBaseFlags  baseFlags)
inline

Member Function Documentation

static PxVehicleDrive4W* PxVehicleDrive4W::allocate ( const PxU32  nbWheels)
static

Allocate a PxVehicleDrive4W instance for a 4WDrive vehicle with nbWheels (= 4 + number of un-driven wheels)

Parameters
[in]nbWheelsis the number of vehicle wheels (= 4 + number of un-driven wheels)
Returns
The instantiated vehicle.
See Also
free, setup
static PxVehicleDrive4W* PxVehicleDrive4W::create ( PxPhysics physics,
PxRigidDynamic vehActor,
const PxVehicleWheelsSimData wheelsData,
const PxVehicleDriveSimData4W driveData,
const PxU32  nbNonDrivenWheels 
)
static

Allocate and set up a vehicle using simulation data for the wheels and drive model.

Parameters
[in]physicsis a PxPhysics instance that is needed to create special vehicle constraints that are maintained by the vehicle.
[in]vehActoris a PxRigidDynamic instance that is used to represent the vehicle in the PhysX SDK.
[in]wheelsDatadescribes the configuration of all suspension/tires/wheels of the vehicle. The vehicle instance takes a copy of this data.
[in]driveDatadescribes the properties of the vehicle's drive model (gears/engine/clutch/differential/autobox). The vehicle instance takes a copy of this data.
[in]nbNonDrivenWheelsis the number of wheels on the vehicle that cannot be connected to the differential (= numWheels - 4).
Note
It is assumed that the first shapes of the actor are the wheel shapes, followed by the chassis shapes. To break this assumption use PxVehicleWheelsSimData::setWheelShapeMapping.
wheelsData must contain data for at least 4 wheels. Unwanted wheels can be disabled with PxVehicleWheelsSimData::disableWheel after calling setup.
Returns
The instantiated vehicle.
See Also
allocate, free, setToRestState, PxVehicleWheelsSimData::setWheelShapeMapping
static PxVehicleDrive4W* PxVehicleDrive4W::createObject ( PxU8 *&  address,
PxDeserializationContext context 
)
static
void PxVehicleDrive4W::free ( )

Deallocate a PxVehicleDrive4W instance.

See Also
allocate
static void PxVehicleDrive4W::getBinaryMetaData ( PxOutputStream stream)
static
virtual const char* PxVehicleDrive4W::getConcreteTypeName ( ) const
inlinevirtual

Returns string name of dynamic type.

Returns
Class name of most derived type of this object.

Reimplemented from PxVehicleDrive.

virtual bool PxVehicleDrive4W::isKindOf ( const char *  superClass) const
inlineprotectedvirtual

Returns whether a given type name matches with the type of this instance.

Reimplemented from PxVehicleDrive.

References PxBase::isKindOf().

bool PxVehicleDrive4W::isValid ( ) const
private

Test if the instanced dynamics and configuration data has legal values.

void PxVehicleDrive4W::setToRestState ( )

Set a vehicle to its rest state. Aside from the rigid body transform, this will set the vehicle and rigid body to the state they were in immediately after setup or create.

Note
Calling setToRestState invalidates the cached raycast hit planes under each wheel meaning that suspension line raycasts need to be performed at least once with PxVehicleSuspensionRaycasts before calling PxVehicleUpdates.
See Also
setup, create, PxVehicleSuspensionRaycasts, PxVehicleUpdates
void PxVehicleDrive4W::setup ( PxPhysics physics,
PxRigidDynamic vehActor,
const PxVehicleWheelsSimData wheelsData,
const PxVehicleDriveSimData4W driveData,
const PxU32  nbNonDrivenWheels 
)

Set up a vehicle using simulation data for the wheels and drive model.

Parameters
[in]physicsis a PxPhysics instance that is needed to create special vehicle constraints that are maintained by the vehicle.
[in]vehActoris a PxRigidDynamic instance that is used to represent the vehicle in the PhysX SDK.
[in]wheelsDatadescribes the configuration of all suspension/tires/wheels of the vehicle. The vehicle instance takes a copy of this data.
[in]driveDatadescribes the properties of the vehicle's drive model (gears/engine/clutch/differential/autobox). The vehicle instance takes a copy of this data.
[in]nbNonDrivenWheelsis the number of wheels on the vehicle that cannot be connected to the differential (= numWheels - 4).
Note
It is assumed that the first shapes of the actor are the wheel shapes, followed by the chassis shapes. To break this assumption use PxVehicleWheelsSimData::setWheelShapeMapping.
wheelsData must contain data for at least 4 wheels. Unwanted wheels can be disabled with PxVehicleWheelsSimData::disableWheel after calling setup.
See Also
allocate, free, setToRestState, PxVehicleWheelsSimData::setWheelShapeMapping

Friends And Related Function Documentation

friend class PxVehicleUpdate
friend

Member Data Documentation

PxVehicleDriveSimData4W PxVehicleDrive4W::mDriveSimData

Simulation data that describes the configuration of the vehicle's drive model.

See Also
setup, create

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


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