PxVehicleWheels Class Reference
[Vehicle]

Data structure with instanced dynamics data and configuration data of a vehicle with just wheels. More...

#include <PxVehicleWheels.h>

Inheritance diagram for PxVehicleWheels:

[legend]

Collaboration diagram for PxVehicleWheels:

[legend]

List of all members.

Public Member Functions
PX_FORCE_INLINE PxU32	getVehicleType () const
	Return the type of vehicle.
PX_FORCE_INLINE PxRigidDynamic *	getRigidDynamicActor ()
	Get non-const ptr to PxRigidDynamic instance that is the vehicle's physx representation.
PX_FORCE_INLINE const PxRigidDynamic *	getRigidDynamicActor () const
	Get const ptr to PxRigidDynamic instance that is the vehicle's physx representation.
PxReal	computeForwardSpeed () const
	Compute the rigid body velocity component along the forward vector of the rigid body transform.
PxReal	computeSidewaysSpeed () const
	Compute the rigid body velocity component along the right vector of the rigid body transform.
virtual void	requires (PxProcessPxBaseCallback &c)
virtual const char *	getConcreteTypeName () const
	Returns string name of dynamic type.
virtual bool	isKindOf (const char *name) const
	Returns whether a given type name matches with the type of this instance.
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.
Static Public Member Functions
static void	getBinaryMetaData (PxOutputStream &stream)
Public Attributes
PxVehicleWheelsSimData	mWheelsSimData
	Data describing the setup of all the wheels/suspensions/tires.
PxVehicleWheelsDynData	mWheelsDynData
	Data describing the dynamic state of all wheels/suspension/tires.
Protected Member Functions
void	setToRestState ()
	Set all wheels to their rest state.
bool	isValid () const
	Test that all configuration and instanced dynamics data is valid.
virtual void	init (const PxU32 numWheels)
void	free ()
	Deallocate a PxVehicleWheels instance.
void	setup (PxPhysics *physics, PxRigidDynamic *vehActor, const PxVehicleWheelsSimData &wheelsData, const PxU32 nbDrivenWheels, const PxU32 nbNonDrivenWheels)
Static Protected Member Functions
static PxU32	computeByteSize (const PxU32 nbWheels)
static PxU8 *	patchupPointers (const PxU32 nbWheels, PxVehicleWheels *vehWheels, PxU8 *ptr)
Protected Attributes
PxRigidDynamic *	mActor
	The rigid body actor that represents the vehicle in the PhysX SDK.
PxU8	mType
	Vehicle type (eVehicleDriveTypes).
PxU8	mPad [14]
Private Attributes
PxU32	mNbNonDrivenWheels
	Count the number of constraint connectors that have hit their callback when deleting a vehicle. Can only delete the vehicle's memory when all constraint connectors have hit their callback.
PxU8	mOnConstraintReleaseCounter
Friends
class	PxVehicleUpdate
class	PxVehicleConstraintShader

---

Detailed Description

Data structure with instanced dynamics data and configuration data of a vehicle with just wheels.

See also:

PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveTank

---

Constructor & Destructor Documentation

PxVehicleWheels::PxVehicleWheels	(	PxType	concreteType,
		PxBaseFlags	baseFlags
	)			[inline]

PxVehicleWheels::PxVehicleWheels

(

PxBaseFlags

baseFlags

)

[inline]

virtual PxVehicleWheels::~PxVehicleWheels

(

)

[inline, virtual]

---

Member Function Documentation

static PxU32 PxVehicleWheels::computeByteSize

(

const PxU32

nbWheels

)

[static, protected]

See also:

PxVehicleDrive4W::allocate, PxVehicleDriveTank::allocate

Reimplemented in PxVehicleDrive.

PxReal PxVehicleWheels::computeForwardSpeed

(

)

const

Compute the rigid body velocity component along the forward vector of the rigid body transform.

See also:

PxVehicleSetBasisVectors

PxReal PxVehicleWheels::computeSidewaysSpeed

(

)

const

Compute the rigid body velocity component along the right vector of the rigid body transform.

See also:

PxVehicleSetBasisVectors

virtual void PxVehicleWheels::exportExtraData

(

PxSerializationContext &

)

[virtual]

Reimplemented in PxVehicleNoDrive.

void PxVehicleWheels::free

(

)

[protected]

Deallocate a PxVehicleWheels instance.

See also:

PxVehicleDrive4W::free, PxVehicleDriveTank::free

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

static void PxVehicleWheels::getBinaryMetaData

(

PxOutputStream &

stream

)

[static]

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

virtual const char* PxVehicleWheels::getConcreteTypeName

(

)

const [inline, virtual]

Returns string name of dynamic type.

Returns:

Class name of most derived type of this object.

Implements PxBase.

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

PX_FORCE_INLINE PxU32 PxVehicleWheels::getNbNonDrivenWheels

(

)

const [inline]

PX_FORCE_INLINE const PxRigidDynamic* PxVehicleWheels::getRigidDynamicActor

(

)

const [inline]

Get const ptr to PxRigidDynamic instance that is the vehicle's physx representation.

PX_FORCE_INLINE PxRigidDynamic* PxVehicleWheels::getRigidDynamicActor

(

)

[inline]

Get non-const ptr to PxRigidDynamic instance that is the vehicle's physx representation.

PX_FORCE_INLINE PxU32 PxVehicleWheels::getVehicleType

(

)

const [inline]

Return the type of vehicle.

See also:

PxVehicleTypes

void PxVehicleWheels::importExtraData

(

PxDeserializationContext &

)

Reimplemented in PxVehicleNoDrive.

virtual void PxVehicleWheels::init

(

const PxU32

numWheels

)

[protected, virtual]

Reimplemented in PxVehicleDrive.

virtual bool PxVehicleWheels::isKindOf

(

const char *

superClass

)

const [inline, virtual]

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

Reimplemented from PxBase.

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

References PxBase::isKindOf().

bool PxVehicleWheels::isValid

(

)

const [protected]

Test that all configuration and instanced dynamics data is valid.

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

static PxU8* PxVehicleWheels::patchupPointers	(	const PxU32	nbWheels,
		PxVehicleWheels *	vehWheels,
		PxU8 *	ptr
	)			[static, protected]

virtual void PxVehicleWheels::release

(

)

[inline, virtual]

Releases the PxBase instance, please check documentation of release in derived class.

Implements PxBase.

virtual void PxVehicleWheels::requires

(

PxProcessPxBaseCallback &

c

)

[virtual]

void PxVehicleWheels::resolveReferences

(

PxDeserializationContext &

)

void PxVehicleWheels::setToRestState

(

)

[protected]

Set all wheels to their rest state.

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

void PxVehicleWheels::setup	(	PxPhysics *	physics,
		PxRigidDynamic *	vehActor,
		const PxVehicleWheelsSimData &	wheelsData,
		const PxU32	nbDrivenWheels,
		const PxU32	nbNonDrivenWheels
	)			[protected]

See also:

PxVehicleDrive4W::setup, PxVehicleDriveTank::setup

Reimplemented in PxVehicleDrive.

---

Friends And Related Function Documentation

friend class PxVehicleConstraintShader [friend]

friend class PxVehicleUpdate [friend]

Reimplemented in PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, and PxVehicleNoDrive.

---

Member Data Documentation

PxRigidDynamic* PxVehicleWheels::mActor [protected]

The rigid body actor that represents the vehicle in the PhysX SDK.

PxU32 PxVehicleWheels::mNbNonDrivenWheels [private]

Count the number of constraint connectors that have hit their callback when deleting a vehicle. Can only delete the vehicle's memory when all constraint connectors have hit their callback.

PxU8 PxVehicleWheels::mOnConstraintReleaseCounter [private]

PxU8 PxVehicleWheels::mPad[14] [protected]

Reimplemented in PxVehicleDriveTank, and PxVehicleNoDrive.

PxU8 PxVehicleWheels::mType [protected]

Vehicle type (eVehicleDriveTypes).

PxVehicleWheelsDynData PxVehicleWheels::mWheelsDynData

Data describing the dynamic state of all wheels/suspension/tires.

PxVehicleWheelsSimData PxVehicleWheels::mWheelsSimData

Data describing the setup of all the wheels/suspensions/tires.

---

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

• PxVehicleWheels.h