Data structure with instanced dynamics data and configuration data of a vehicle with up to 4 driven wheels and up to 16 non-driven wheels. More...

#include <PxVehicleDrive4W.h>

Inheritance diagram for physx::PxVehicleDrive4W:

[legend]

Collaboration diagram for physx::PxVehicleDrive4W:

[legend]

Public Member Functions
void	free ()
	Deallocate a PxVehicleDrive4W instance.

void	setup (PxPhysics physics, PxRigidDynamic vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimData4W &driveData, const PxU32 nbNonDrivenWheels)
	Set up a vehicle using simulation data for the wheels and drive model.

void	setToRestState ()
	Set a vehicle to its rest state. Aside from the rigid body transform, this will set the vehicle and rigid body to the state they were in immediately after setup or create.

	PxVehicleDrive4W (PxBaseFlags baseFlags)

virtual const char *	getConcreteTypeName () const
	Returns string name of dynamic type.

Public Member Functions inherited from physx::PxVehicleDrive
	PxVehicleDrive (PxBaseFlags baseFlags)

Public Member Functions inherited from physx::PxVehicleWheels
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 PxVec3 &forwardAxis=PxVehicleGetDefaultContext().forwardAxis) const
	Compute the rigid body velocity component along the forward vector of the rigid body transform.

PxReal	computeSidewaysSpeed (const PxVec3 &sideAxis=PxVehicleGetDefaultContext().sideAxis) const
	Compute the rigid body velocity component along the right vector of the rigid body transform.

virtual void	requiresObjects (PxProcessPxBaseCallback &c)

virtual void	preExportDataReset ()

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 void	release ()
	Releases the PxBase instance, please check documentation of release in derived class.

Public Member Functions inherited from physx::PxBase
template<class T >
T *	is ()

template<class T >
const T *	is () const

PX_FORCE_INLINE PxType	getConcreteType () const
	Returns concrete type of object.

PX_FORCE_INLINE void	setBaseFlag (PxBaseFlag::Enum flag, bool value)
	Set PxBaseFlag

PX_FORCE_INLINE void	setBaseFlags (PxBaseFlags inFlags)
	Set PxBaseFlags

PX_FORCE_INLINE PxBaseFlags	getBaseFlags () const
	Returns PxBaseFlags.

virtual bool	isReleasable () const
	Whether the object is subordinate.

Static Public Member Functions
static PxVehicleDrive4W *	allocate (const PxU32 nbWheels)
	Allocate a PxVehicleDrive4W instance for a 4WDrive vehicle with nbWheels (= 4 + number of un-driven wheels)

static PxVehicleDrive4W *	create (PxPhysics physics, PxRigidDynamic vehActor, const PxVehicleWheelsSimData &wheelsData, const PxVehicleDriveSimData4W &driveData, const PxU32 nbNonDrivenWheels)
	Allocate and set up a vehicle using simulation data for the wheels and drive model.

static PxVehicleDrive4W *	createObject (PxU8 *&address, PxDeserializationContext &context)

static void	getBinaryMetaData (PxOutputStream &stream)

Static Public Member Functions inherited from physx::PxVehicleDrive
static void	getBinaryMetaData (PxOutputStream &stream)

Static Public Member Functions inherited from physx::PxVehicleWheels
static void	getBinaryMetaData (PxOutputStream &stream)

Public Attributes
PxVehicleDriveSimData4W	mDriveSimData
	Simulation data that describes the configuration of the vehicle's drive model.

Public Attributes inherited from physx::PxVehicleDrive
PxVehicleDriveDynData	mDriveDynData
	Dynamics data of vehicle instance.

Public Attributes inherited from physx::PxVehicleWheels
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
virtual bool	isKindOf (const char *name) const
	Returns whether a given type name matches with the type of this instance.

Protected Member Functions inherited from physx::PxVehicleDrive
bool	isValid () const
	Test that all instanced dynamics data and configuration data have legal values.

void	setToRestState ()
	Set vehicle to rest.

virtual void	init (const PxU32 numWheels)

void	free ()
	Deallocate a PxVehicle4WDrive instance.

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

	PxVehicleDrive (PxType concreteType, PxBaseFlags baseFlags)

Protected Member Functions inherited from physx::PxVehicleWheels
void	setToRestState ()
	Set all wheels to their rest state.

bool	isValid () const
	Test that all configuration and instanced dynamics data is valid.

void	free ()
	Deallocate a PxVehicleWheels instance.

void	onConstraintRelease ()

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

Protected Member Functions inherited from physx::PxBase
PX_INLINE	PxBase (PxType concreteType, PxBaseFlags baseFlags)
	Constructor setting concrete type and base flags.

PX_INLINE	PxBase (PxBaseFlags baseFlags)
	Deserialization constructor setting base flags.

virtual	~PxBase ()
	Destructor.

template<class T >
bool	typeMatch () const

Friends
class	PxVehicleUpdate

Additional Inherited Members
Static Protected Member Functions inherited from physx::PxVehicleDrive
static PxU32	computeByteSize (const PxU32 numWheels)

static PxU8 *	patchupPointers (const PxU32 nbWheels, PxVehicleDrive vehDrive, PxU8 ptr)

Static Protected Member Functions inherited from physx::PxVehicleWheels
static PxU32	computeByteSize (const PxU32 nbWheels)

static PxU8 *	patchupPointers (const PxU32 nbWheels, PxVehicleWheels vehWheels, PxU8 ptr)

Protected Attributes inherited from physx::PxVehicleWheels
PxRigidDynamic *	mActor
	The rigid body actor that represents the vehicle in the PhysX SDK.

PxU8	mType
	Vehicle type (eVehicleDriveTypes)

PxU8	mPad0 [8]

Protected Attributes inherited from physx::PxBase
PxType	mConcreteType

PxBaseFlags	mBaseFlags

PxU32	mBuiltInRefCount

Detailed Description

Data structure with instanced dynamics data and configuration data of a vehicle with up to 4 driven wheels and up to 16 non-driven wheels.

Member Function Documentation

◆ allocate()

PxVehicleDrive4W * physx::PxVehicleDrive4W::allocate ( const PxU32 nbWheels )

static

Allocate a PxVehicleDrive4W instance for a 4WDrive vehicle with nbWheels (= 4 + number of un-driven wheels)

Parameters

[in] nbWheels is the number of vehicle wheels (= 4 + number of un-driven wheels)

Returns: The instantiated vehicle.

See also: free, setup

◆ create()

PxVehicleDrive4W * physx::PxVehicleDrive4W::create	(	PxPhysics *	physics,
		PxRigidDynamic *	vehActor,
		const PxVehicleWheelsSimData &	wheelsData,
		const PxVehicleDriveSimData4W &	driveData,
		const PxU32	nbNonDrivenWheels
	)

static

Allocate and set up a vehicle using simulation data for the wheels and drive model.

Parameters

[in]	physics	is a PxPhysics instance that is needed to create special vehicle constraints that are maintained by the vehicle.
[in]	vehActor	is a PxRigidDynamic instance that is used to represent the vehicle in the PhysX SDK.
[in]	wheelsData	describes the configuration of all suspension/tires/wheels of the vehicle. The vehicle instance takes a copy of this data.
[in]	driveData	describes the properties of the vehicle's drive model (gears/engine/clutch/differential/autobox). The vehicle instance takes a copy of this data.
[in]	nbNonDrivenWheels	is the number of wheels on the vehicle that cannot be connected to the differential (= numWheels - 4).

Note: It is assumed that the first shapes of the actor are the wheel shapes, followed by the chassis shapes. To break this assumption use PxVehicleWheelsSimData::setWheelShapeMapping.; wheelsData must contain data for at least 4 wheels. Unwanted wheels can be disabled with PxVehicleWheelsSimData::disableWheel after calling setup.

Returns: The instantiated vehicle.

See also: allocate, free, setToRestState, PxVehicleWheelsSimData::setWheelShapeMapping

◆ free()

void physx::PxVehicleDrive4W::free ( )

Deallocate a PxVehicleDrive4W instance.

See also: allocate

◆ getConcreteTypeName()

virtual const char * physx::PxVehicleDrive4W::getConcreteTypeName ( ) const

inlinevirtual

Returns string name of dynamic type.

Returns: Class name of most derived type of this object.

Reimplemented from physx::PxVehicleDrive.

◆ isKindOf()

virtual bool physx::PxVehicleDrive4W::isKindOf ( const char * superClass ) const

inlineprotectedvirtual

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

Reimplemented from physx::PxVehicleDrive.

◆ setToRestState()

void physx::PxVehicleDrive4W::setToRestState ( )

Set a vehicle to its rest state. Aside from the rigid body transform, this will set the vehicle and rigid body to the state they were in immediately after setup or create.

Note: Calling setToRestState invalidates the cached raycast hit planes under each wheel meaning that suspension line raycasts need to be performed at least once with PxVehicleSuspensionRaycasts before calling PxVehicleUpdates.

See also: setup, create, PxVehicleSuspensionRaycasts, PxVehicleUpdates

◆ setup()

void physx::PxVehicleDrive4W::setup	(	PxPhysics *	physics,
		PxRigidDynamic *	vehActor,
		const PxVehicleWheelsSimData &	wheelsData,
		const PxVehicleDriveSimData4W &	driveData,
		const PxU32	nbNonDrivenWheels
	)

Set up a vehicle using simulation data for the wheels and drive model.

Parameters

[in]	physics	is a PxPhysics instance that is needed to create special vehicle constraints that are maintained by the vehicle.
[in]	vehActor	is a PxRigidDynamic instance that is used to represent the vehicle in the PhysX SDK.
[in]	wheelsData	describes the configuration of all suspension/tires/wheels of the vehicle. The vehicle instance takes a copy of this data.
[in]	driveData	describes the properties of the vehicle's drive model (gears/engine/clutch/differential/autobox). The vehicle instance takes a copy of this data.
[in]	nbNonDrivenWheels	is the number of wheels on the vehicle that cannot be connected to the differential (= numWheels - 4).

Note: It is assumed that the first shapes of the actor are the wheel shapes, followed by the chassis shapes. To break this assumption use PxVehicleWheelsSimData::setWheelShapeMapping.; wheelsData must contain data for at least 4 wheels. Unwanted wheels can be disabled with PxVehicleWheelsSimData::disableWheel after calling setup.

See also: allocate, free, setToRestState, PxVehicleWheelsSimData::setWheelShapeMapping

Member Data Documentation

◆ mDriveSimData

PxVehicleDriveSimData4W physx::PxVehicleDrive4W::mDriveSimData

Simulation data that describes the configuration of the vehicle's drive model.

See also: setup, create

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

RavEngine/deps/physx/physx/include/vehicle/PxVehicleDrive4W.h
RavEngine/deps/physx/physx/source/physxvehicle/src/PxVehicleDrive4W.cpp
RavEngine/deps/physx/physx/source/physxvehicle/src/PxVehicleMetaData.cpp
RavEngine/deps/physx/physx/source/physxvehicle/src/PxVehicleSerialization.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ allocate()

◆ create()

◆ free()

◆ getConcreteTypeName()

◆ isKindOf()

◆ setToRestState()

◆ setup()

Member Data Documentation

◆ mDriveSimData