physx::vehicle2::PxVehicleWheelConstraintGroupState Struct Reference

Specify groups of wheels that are to be constrained to have pre-determined angular velocity relationship. More...

#include <PxVehicleDrivetrainStates.h>

Public Member Functions
PX_FORCE_INLINE void	setToDefault ()
void	addConstraintGroup (const PxU32 nbWheelsInGroupToAdd, const PxU32 *const wheelIdsInGroupToAdd, const PxF32 *constraintMultipliers)
	Add a wheel constraint group by specifying the number of wheels in the group, an array of wheel ids specifying each wheel in the group and a desired rotational speed relationship.
PX_FORCE_INLINE PxU32	getNbConstraintGroups () const
	Return the number of wheel constraint groups in the vehicle.
PX_FORCE_INLINE PxU32	getNbWheelsInConstraintGroup (const PxU32 i) const
	Return the number of wheels in the ith constraint group.
PX_FORCE_INLINE PxU32	getWheelInConstraintGroup (const PxU32 j, const PxU32 i) const
	Return the wheel id of the jth wheel in the ith constraint group.
PX_FORCE_INLINE PxReal	getMultiplierInConstraintGroup (const PxU32 j, const PxU32 i) const
	Return the constraint multiplier of the jth wheel in the ith constraint group.

Public Attributes
PxU32	nbGroups
	The number of constraint groups in the vehicle.
PxU32	nbWheelsPerGroup [PxVehicleLimits::eMAX_NB_AXLES]
	The number of wheels in each group.
PxU32	groupToWheelIds [PxVehicleLimits::eMAX_NB_AXLES]
	The list of wheel ids for the ith group begins at wheelIdsInGroupOrder[groupToWheelIds[i]].
PxU32	wheelIdsInGroupOrder [PxVehicleLimits::eMAX_NB_WHEELS]
	The list of all wheel ids in constraint groups.
PxF32	wheelMultipliersInGroupOrder [PxVehicleLimits::eMAX_NB_WHEELS]
	The constraint multipliers for each constraint group.
PxU32	nbWheelsInGroups
	The number of wheels in a constraint group.

Detailed Description

Specify groups of wheels that are to be constrained to have pre-determined angular velocity relationship.

Member Function Documentation

addConstraintGroup()

void physx::vehicle2::PxVehicleWheelConstraintGroupState::addConstraintGroup ( const PxU32  nbWheelsInGroupToAdd, const PxU32 *const  wheelIdsInGroupToAdd, const PxF32 *  constraintMultipliers  )

inline

Add a wheel constraint group by specifying the number of wheels in the group, an array of wheel ids specifying each wheel in the group and a desired rotational speed relationship.

Parameters

[in]	nbWheelsInGroupToAdd	is the number of wheels in the group to be added.
[in]	wheelIdsInGroupToAdd	is an array of wheel ids specifying all the wheels in the group to be added.
[in]	constraintMultipliers	is an array of constraint multipliers describing the desired relationship of the wheel rotational speeds.

Note

constraintMultipliers[j] specifies the target rotational speed of the jth wheel in the constraint group as a multiplier of the rotational speed of the zeroth wheel in the group.

getMultiplierInConstraintGroup()

PX_FORCE_INLINE PxReal physx::vehicle2::PxVehicleWheelConstraintGroupState::getMultiplierInConstraintGroup ( const PxU32  j, const PxU32  i  ) const

inline

Return the constraint multiplier of the jth wheel in the ith constraint group.

Parameters

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

Returns

The constraint multiplier of the jth wheel in the ith constraint group.

getNbConstraintGroups()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleWheelConstraintGroupState::getNbConstraintGroups ( ) const

inline

Return the number of wheel constraint groups in the vehicle.

Returns

The number of wheel constraint groups.

See also

getNbWheelsInConstraintGroup()

getNbWheelsInConstraintGroup()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleWheelConstraintGroupState::getNbWheelsInConstraintGroup ( const PxU32  i ) const

inline

Return the number of wheels in the ith constraint group.

Parameters

[in]

i

specifies the constraint group to be queried for its wheel count.

Returns

The number of wheels in the specified constraint group.

See also

getWheelInConstraintGroup()

getWheelInConstraintGroup()

PX_FORCE_INLINE PxU32 physx::vehicle2::PxVehicleWheelConstraintGroupState::getWheelInConstraintGroup ( const PxU32  j, const PxU32  i  ) const

inline

Return the wheel id of the jth wheel in the ith constraint group.

Parameters

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

Returns

The wheel id of the jth wheel in the ith constraint group.

See also

getNbWheelsInConstraintGroup()

---

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

• RavEngine/deps/physx/physx/include/vehicle2/drivetrain/PxVehicleDrivetrainStates.h