PxVehicleWheels Class Reference

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

#include <PxVehicleWheels.h>

Inheritance diagram for PxVehicleWheels:

Collaboration diagram for PxVehicleWheels:

Public Member Functions
PX_FORCE_INLINE PxU32	getVehicleType () const
	Return the type of vehicle. More...
PX_FORCE_INLINE PxRigidDynamic *	getRigidDynamicActor ()
	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 const char *	getConcreteTypeName () const
	Returns string name of dynamic type. More...
virtual bool	isKindOf (const char *name) const
	Returns whether a given type name matches with the type of this instance. More...
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 void	getBinaryMetaData (PxOutputStream &stream)

Public Attributes
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
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

Static Protected Member Functions
static PxU32	computeByteSize (const PxU32 nbWheels4)
static PxU8 *	patchupPointers (PxVehicleWheels *veh, PxU8 *ptr, const PxU32 nbWheels4, const PxU32 nbWheels, bool renew=true)

Protected Attributes
PxRigidDynamic *	mActor
	The rigid body actor that represents the vehicle in the PhysX SDK. More...
PxU8	mType
	Vehicle type (eVehicleDriveTypes) More...
PxU8	mPad [14]
Protected Attributes inherited from PxBase
PxType	mConcreteType
PxBaseFlags	mBaseFlags

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. More...
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 ( )

inlinevirtual

Member Function Documentation

static PxU32 PxVehicleWheels::computeByteSize ( const PxU32  nbWheels4 )

staticprotected

See Also

PxVehicleDrive4W::allocate, PxVehicleDriveTank::allocate

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

static void PxVehicleWheels::getBinaryMetaData ( PxOutputStream &  stream )

static

virtual const char* PxVehicleWheels::getConcreteTypeName ( ) const

inlinevirtual

Returns string name of dynamic type.

Returns

Class name of most derived type of this object.

Reimplemented from PxBase.

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

PX_FORCE_INLINE PxU32 PxVehicleWheels::getNbNonDrivenWheels ( ) const

inline

PX_FORCE_INLINE PxRigidDynamic* PxVehicleWheels::getRigidDynamicActor ( )

inline

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

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 PxU32 PxVehicleWheels::getVehicleType ( ) const

inline

Return the type of vehicle.

See Also

PxVehicleTypes

void PxVehicleWheels::importExtraData

(

PxDeserializationContext &

)

virtual bool PxVehicleWheels::isKindOf ( const char *  superClass ) const

inlinevirtual

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

Reimplemented from PxBase.

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

References PxBase::isKindOf().

bool PxVehicleWheels::isValid ( ) const

protected

Test that all configuration and instanced dynamics data is valid.

static PxU8* PxVehicleWheels::patchupPointers ( PxVehicleWheels *  veh, PxU8 *  ptr, const PxU32  nbWheels4, const PxU32  nbWheels, bool  renew = true  )

staticprotected

See Also

PxVehicleDrive4W::allocate, PxVehicleDriveTank::allocate

virtual void PxVehicleWheels::release ( )

inlinevirtual

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.

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

protected

See Also

PxVehicleDrive4W::setup, PxVehicleDriveTank::setup

Friends And Related Function Documentation

friend class PxVehicleConstraintShader

friend

friend class PxVehicleUpdate

friend

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

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