Data structure with instanced dynamics data for wheels. More...

#include <PxVehicleWheels.h>

Public Member Functions
	PxVehicleWheelsDynData ()

	~PxVehicleWheelsDynData ()

void	setToRestState ()
	Set all wheels to their rest state. More...

void	setTireForceShaderFunction (PxVehicleComputeTireForce tireForceShaderFn)
	Set the tire force shader function. More...

void	setTireForceShaderData (const PxU32 tireId, const void *tireForceShaderData)
	Set the tire force shader data for a specific tire. More...

const void *	getTireForceShaderData (const PxU32 tireId) const
	Get the tire force shader data for a specific tire. More...

void	setWheelRotationSpeed (const PxU32 wheelIdx, const PxReal speed)
	Set the wheel rotation speed (radians per second) about the rolling axis for the specified wheel. More...

PxReal	getWheelRotationSpeed (const PxU32 wheelIdx) const
	Return the rotation speed about the rolling axis of a specified wheel . More...

void	setWheelRotationAngle (const PxU32 wheelIdx, const PxReal angle)
	Set the wheel rotation angle (radians) about the rolling axis of the specified wheel. More...

PxReal	getWheelRotationAngle (const PxU32 wheelIdx) const
	Return the rotation angle about the rolling axis for the specified wheel. More...

void	setUserData (const PxU32 tireIdx, void *userData)
	Set the user data pointer for the specified wheel It has a default value of NULL. More...

void *	getUserData (const PxU32 tireIdx) const
	Get the user data pointer that was set for the specified wheel. More...

void	copy (const PxVehicleWheelsDynData &src, const PxU32 srcWheel, const PxU32 trgWheel)
	Copy the dynamics data of a single wheel unit (wheel, suspension, tire) from srcWheel of src to trgWheel. More...

PxU32	getNbWheelRotationSpeed () const

PxU32	getNbWheelRotationAngle () const

PxVehicleWheels4DynData *	getWheel4DynData () const

PxU32	getNbConstraints () const
	Retrieve the number of PxConstraint objects associated with the vehicle. More...

PxU32	getConstraints (PxConstraint **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const
	Retrieve all the PxConstraint objects associated with the vehicle. More...

Static Public Member Functions
static void	getBinaryMetaData (PxOutputStream &stream)

Private Member Functions
bool	isValid () const
	Test if wheel dynamics data have legal values. More...

	PxVehicleWheelsDynData (const PxU32 numWheels)

Static Private Member Functions
static PxU32	computeByteSize (const PxU32 numWheels)
	see PxVehicleWheels::allocate More...

static PxU8 *	patchUpPointers (const PxU32 numWheels, PxVehicleWheelsDynData dynData, PxU8 ptr)

Private Attributes
PxVehicleWheels4DynData *	mWheels4DynData
	Dynamics data arranged in blocks of 4 wheels. More...

PxVehicleTireForceCalculator *	mTireForceCalculators
	Shader data and function for tire force calculations. More...

void **	mUserDatas
	A userData pointer can be stored for each wheel. More...

PxU32	mNbWheels4
	Number of blocks of 4 wheels. More...

PxU32	mNbActiveWheels
	Number of wheels (mNbActiveWheels <= (mNbWheels4*4)) More...

PxU32	mPad [3]

Friends
class	PxVehicleWheels

class	PxVehicleDrive4W

class	PxVehicleDriveTank

class	PxVehicleUpdate

Detailed Description

Data structure with instanced dynamics data for wheels.

Constructor & Destructor Documentation

◆ PxVehicleWheelsDynData() [1/2]

PxVehicleWheelsDynData::PxVehicleWheelsDynData ( )

inline

◆ ~PxVehicleWheelsDynData()

PxVehicleWheelsDynData::~PxVehicleWheelsDynData ( )

inline

◆ PxVehicleWheelsDynData() [2/2]

PxVehicleWheelsDynData::PxVehicleWheelsDynData ( const PxU32 numWheels )

private

Member Function Documentation

◆ computeByteSize()

static PxU32 PxVehicleWheelsDynData::computeByteSize ( const PxU32 numWheels )

staticprivate

see PxVehicleWheels::allocate

◆ copy()

void PxVehicleWheelsDynData::copy	(	const PxVehicleWheelsDynData &	src,
		const PxU32	srcWheel,
		const PxU32	trgWheel
	)

Copy the dynamics data of a single wheel unit (wheel, suspension, tire) from srcWheel of src to trgWheel.

Parameters

[in]	src	is the data to be copied.
[in]	srcWheel	is the wheel whose data will be copied from src.
[in]	trgWheel	is the wheel that will be assigned the copied data.

◆ getBinaryMetaData()

static void PxVehicleWheelsDynData::getBinaryMetaData ( PxOutputStream & stream )

static

◆ getConstraints()

PxU32 PxVehicleWheelsDynData::getConstraints	(	PxConstraint **	userBuffer,
		PxU32	bufferSize,
		PxU32	startIndex = `0`
	)		const

Retrieve all the PxConstraint objects associated with the vehicle.

There is one PxConstraint per block of 4 wheels. The count can be extracted through getNbConstraints()

Parameters

[out]	userBuffer	The buffer to store the constraint pointers.
[in]	bufferSize	Size of provided user buffer.
[in]	startIndex	Index of first constraint pointer to be retrieved

Returns: Number of constraint pointers written to the buffer.

See also: PxConstraint getNbConstraints()

◆ getNbConstraints()

PxU32 PxVehicleWheelsDynData::getNbConstraints ( ) const

inline

Retrieve the number of PxConstraint objects associated with the vehicle.

You can use getConstraints() to retrieve the constraint pointers.

Returns: Number of constraints associated with this vehicle.

See also: PxConstraint getConstraints()

◆ getNbWheelRotationAngle()

PxU32 PxVehicleWheelsDynData::getNbWheelRotationAngle ( ) const

inline

◆ getNbWheelRotationSpeed()

PxU32 PxVehicleWheelsDynData::getNbWheelRotationSpeed ( ) const

inline

◆ getTireForceShaderData()

const void* PxVehicleWheelsDynData::getTireForceShaderData ( const PxU32 tireId ) const

Get the tire force shader data for a specific tire.

◆ getUserData()

void* PxVehicleWheelsDynData::getUserData ( const PxU32 tireIdx ) const

Get the user data pointer that was set for the specified wheel.

◆ getWheel4DynData()

PxVehicleWheels4DynData* PxVehicleWheelsDynData::getWheel4DynData ( ) const

inline

◆ getWheelRotationAngle()

PxReal PxVehicleWheelsDynData::getWheelRotationAngle ( const PxU32 wheelIdx ) const

Return the rotation angle about the rolling axis for the specified wheel.

◆ getWheelRotationSpeed()

PxReal PxVehicleWheelsDynData::getWheelRotationSpeed ( const PxU32 wheelIdx ) const

Return the rotation speed about the rolling axis of a specified wheel .

◆ isValid()

bool PxVehicleWheelsDynData::isValid ( ) const

private

Test if wheel dynamics data have legal values.

◆ patchUpPointers()

static PxU8* PxVehicleWheelsDynData::patchUpPointers	(	const PxU32	numWheels,
		PxVehicleWheelsDynData *	dynData,
		PxU8 *	ptr
	)

staticprivate

◆ setTireForceShaderData()

void PxVehicleWheelsDynData::setTireForceShaderData	(	const PxU32	tireId,
		const void *	tireForceShaderData
	)

Set the tire force shader data for a specific tire.

Parameters

[in]	tireId	is the wheel index
[in]	tireForceShaderData	is the data describing the tire.

◆ setTireForceShaderFunction()

void PxVehicleWheelsDynData::setTireForceShaderFunction ( PxVehicleComputeTireForce tireForceShaderFn )

Set the tire force shader function.

Parameters

[in] tireForceShaderFn is the shader function that will be used to compute tire forces.

◆ setToRestState()

void PxVehicleWheelsDynData::setToRestState ( )

Set all wheels to their rest state.

See also: setup

◆ setUserData()

void PxVehicleWheelsDynData::setUserData	(	const PxU32	tireIdx,
		void *	userData
	)

Set the user data pointer for the specified wheel It has a default value of NULL.

Parameters

[in]	tireIdx	is the wheel index
[in]	userData	is the data to be associated with the wheel.

◆ setWheelRotationAngle()

void PxVehicleWheelsDynData::setWheelRotationAngle	(	const PxU32	wheelIdx,
		const PxReal	angle
	)

Set the wheel rotation angle (radians) about the rolling axis of the specified wheel.

Parameters

[in]	wheelIdx	is the wheel index
[in]	angle	is the rotation angle to be applied to the wheel.

◆ setWheelRotationSpeed()

void PxVehicleWheelsDynData::setWheelRotationSpeed	(	const PxU32	wheelIdx,
		const PxReal	speed
	)

Set the wheel rotation speed (radians per second) about the rolling axis for the specified wheel.

Parameters

[in]	wheelIdx	is the wheel index
[in]	speed	is the rotation speed to be applied to the wheel.

Friends And Related Function Documentation

◆ PxVehicleDrive4W

friend class PxVehicleDrive4W

friend

◆ PxVehicleDriveTank

friend class PxVehicleDriveTank

friend

◆ PxVehicleUpdate

friend class PxVehicleUpdate

friend

◆ PxVehicleWheels

friend class PxVehicleWheels

friend

Member Data Documentation

◆ mNbActiveWheels

PxU32 PxVehicleWheelsDynData::mNbActiveWheels

private

Number of wheels (mNbActiveWheels <= (mNbWheels4*4))

◆ mNbWheels4

PxU32 PxVehicleWheelsDynData::mNbWheels4

private

Number of blocks of 4 wheels.

◆ mPad

PxU32 PxVehicleWheelsDynData::mPad[3]

private

◆ mTireForceCalculators

PxVehicleTireForceCalculator* PxVehicleWheelsDynData::mTireForceCalculators

private

Shader data and function for tire force calculations.

◆ mUserDatas

void** PxVehicleWheelsDynData::mUserDatas

private

A userData pointer can be stored for each wheel.

See also: setUserData, getUserData

◆ mWheels4DynData

PxVehicleWheels4DynData* PxVehicleWheelsDynData::mWheels4DynData

private

Dynamics data arranged in blocks of 4 wheels.

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

PxVehicleWheels.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PxVehicleWheelsDynData() [1/2]

◆ ~PxVehicleWheelsDynData()

◆ PxVehicleWheelsDynData() [2/2]

Member Function Documentation

◆ computeByteSize()

◆ copy()

◆ getBinaryMetaData()

◆ getConstraints()

◆ getNbConstraints()

◆ getNbWheelRotationAngle()

◆ getNbWheelRotationSpeed()

◆ getTireForceShaderData()

◆ getUserData()

◆ getWheel4DynData()

◆ getWheelRotationAngle()

◆ getWheelRotationSpeed()

◆ isValid()

◆ patchUpPointers()

◆ setTireForceShaderData()

◆ setTireForceShaderFunction()

◆ setToRestState()

◆ setUserData()

◆ setWheelRotationAngle()

◆ setWheelRotationSpeed()

Friends And Related Function Documentation

◆ PxVehicleDrive4W

◆ PxVehicleDriveTank

◆ PxVehicleUpdate

◆ PxVehicleWheels

Member Data Documentation

◆ mNbActiveWheels

◆ mNbWheels4

◆ mPad

◆ mTireForceCalculators

◆ mUserDatas

◆ mWheels4DynData