physx::vehicle2::PxVehicleAxleDescription Struct Reference

Public Member Functions
PX_FORCE_INLINE void	setToDefault ()
void	addAxle (const PxU32 nbWheelsOnAxle, const PxU32 *const wheelIdsOnAxle)
	Add an axle to the vehicle by specifying the number of wheels on the axle and an array of wheel ids specifying each wheel on the axle.
PX_FORCE_INLINE PxU32	getNbAxles () const
	Return the number of axles on the vehicle.
PX_FORCE_INLINE PxU32	getNbWheelsOnAxle (const PxU32 i) const
	Return the number of wheels on the ith axle.
PX_FORCE_INLINE PxU32	getWheelOnAxle (const PxU32 j, const PxU32 i) const
	Return the wheel id of the jth wheel on the ith axle.
PX_FORCE_INLINE PxU32	getNbWheels () const
	Return the number of wheels on the vehicle.
PX_FORCE_INLINE PxU32	getAxle (const PxU32 wheelId) const
	Return the axle of a specified wheel.
PX_FORCE_INLINE bool	isValid () const
	PX_COMPILE_TIME_ASSERT (PxVehicleLimits::eMAX_NB_AXLES==PxVehicleLimits::eMAX_NB_WHEELS)

Public Attributes
PxU32	nbAxles
	The number of axles on the vehicle.
PxU32	nbWheelsPerAxle [PxVehicleLimits::eMAX_NB_AXLES]
	The number of wheels on each axle.
PxU32	axleToWheelIds [PxVehicleLimits::eMAX_NB_AXLES]
	The list of wheel ids for the ith axle begins at wheelIdsInAxleOrder[axleToWheelIds[i]].
PxU32	wheelIdsInAxleOrder [PxVehicleLimits::eMAX_NB_WHEELS]
	The list of all wheel ids on the vehicle.
PxU32	nbWheels
	The number of wheels on the vehicle.

Member Function Documentation

addAxle()

void physx::vehicle2::PxVehicleAxleDescription::addAxle ( const PxU32  nbWheelsOnAxle, const PxU32 *const  wheelIdsOnAxle  )

inline

Add an axle to the vehicle by specifying the number of wheels on the axle and an array of wheel ids specifying each wheel on the axle.

Parameters

[in]	nbWheelsOnAxle	is the number of wheels on the axle to be added.
[in]	wheelIdsOnAxle	is an array of wheel ids specifying all the wheels on the axle to be added.

getAxle()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleAxleDescription::getAxle ( const PxU32  wheelId ) const

inline

Return the axle of a specified wheel.

Parameters

[in]

wheelId

is the wheel whose axle is to be queried.

Returns

The axle of the specified wheel.

getNbAxles()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleAxleDescription::getNbAxles ( ) const

inline

Return the number of axles on the vehicle.

Returns

The number of axles.

See also

getNbWheelsOnAxle()

getNbWheels()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleAxleDescription::getNbWheels ( ) const

inline

Return the number of wheels on the vehicle.

Returns

The number of wheels.

getNbWheelsOnAxle()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleAxleDescription::getNbWheelsOnAxle ( const PxU32  i ) const

inline

Return the number of wheels on the ith axle.

Parameters

[in]

i

specifies the axle to be queried for its wheel count.

Returns

The number of wheels on the specified axle.

See also

getWheelOnAxle()

getWheelOnAxle()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleAxleDescription::getWheelOnAxle ( const PxU32  j, const PxU32  i  ) const

inline

Return the wheel id of the jth wheel on the ith axle.

Parameters

[in]	j	specifies that the wheel id to be returned is the jth wheel in the list of wheels on the specified axle.
[in]	i	specifies the axle to be queried.

Returns

The wheel id of the jth wheel on the ith axle.

See also

getNbWheelsOnAxle()

---

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

• RavEngine/deps/physx/physx/include/vehicle2/PxVehicleParams.h