Data structure with instanced dynamics data and configuration data of a vehicle with no drive model. More...

#include <PxVehicleNoDrive.h>

Inheritance diagram for physx::PxVehicleNoDrive:

Collaboration diagram for physx::PxVehicleNoDrive:

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

void	setup (PxPhysics physics, PxRigidDynamic vehActor, const PxVehicleWheelsSimData &wheelsData)
	Set up a vehicle using simulation data for the wheels.

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.

void	setBrakeTorque (const PxU32 id, const PxReal brakeTorque)
	Set the brake torque to be applied to a specific wheel.

void	setDriveTorque (const PxU32 id, const PxReal driveTorque)
	Set the drive torque to be applied to a specific wheel.

void	setSteerAngle (const PxU32 id, const PxReal steerAngle)
	Set the steer angle to be applied to a specific wheel.

PxReal	getBrakeTorque (const PxU32 id) const
	Get the brake torque that has been applied to a specific wheel.

PxReal	getDriveTorque (const PxU32 id) const
	Get the drive torque that has been applied to a specific wheel.

PxReal	getSteerAngle (const PxU32 id) const
	Get the steer angle that has been applied to a specific wheel.

	PxVehicleNoDrive (PxBaseFlags baseFlags)

virtual void	exportExtraData (PxSerializationContext &)

void	importExtraData (PxDeserializationContext &)

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

virtual bool	isKindOf (const char *name) const
	Returns whether a given type name matches with the type of this instance.

PxU32	getNbSteerAngle () const

PxU32	getNbDriveTorque () const

PxU32	getNbBrakeTorque () const

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

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 PxVehicleNoDrive *	allocate (const PxU32 nbWheels)
	Allocate a PxVehicleNoDrive instance for a vehicle without drive model and with nbWheels.

static PxVehicleNoDrive *	create (PxPhysics physics, PxRigidDynamic vehActor, const PxVehicleWheelsSimData &wheelsData)
	Allocate and set up a vehicle using simulation data for the wheels.

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

static void	getBinaryMetaData (PxOutputStream &stream)

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

Friends
class	PxVehicleUpdate

Additional Inherited Members
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 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.

virtual void	init (const PxU32 numWheels)

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

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 no drive model.

Member Function Documentation

◆ allocate()

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

static

Allocate a PxVehicleNoDrive instance for a vehicle without drive model and with nbWheels.

Parameters

[in] nbWheels is the number of wheels on the vehicle.

Returns: The instantiated vehicle.

See also: free, setup

◆ create()

PxVehicleNoDrive * physx::PxVehicleNoDrive::create	(	PxPhysics *	physics,
		PxRigidDynamic *	vehActor,
		const PxVehicleWheelsSimData &	wheelsData
	)

static

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

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.

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 PxVehicleWheels::setWheelShapeMapping.

Returns: The instantiated vehicle.

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

◆ exportExtraData()

void PxVehicleNoDrive::exportExtraData ( PxSerializationContext & stream )

virtual

Reimplemented from physx::PxVehicleWheels.

◆ free()

void physx::PxVehicleNoDrive::free ( )

Deallocate a PxVehicleNoDrive instance.

See also: allocate

◆ getBrakeTorque()

PxReal physx::PxVehicleNoDrive::getBrakeTorque ( const PxU32 id ) const

Get the brake torque that has been applied to a specific wheel.

Parameters

[in] id is the wheel being queried for its brake torque

Returns: The brake torque applied to the queried wheel.

◆ getConcreteTypeName()

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

inlinevirtual

Returns string name of dynamic type.

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

Reimplemented from physx::PxVehicleWheels.

◆ getDriveTorque()

PxReal physx::PxVehicleNoDrive::getDriveTorque ( const PxU32 id ) const

Get the drive torque that has been applied to a specific wheel.

Parameters

[in] id is the wheel being queried for its drive torque

Returns: The drive torque applied to the queried wheel.

◆ getSteerAngle()

PxReal physx::PxVehicleNoDrive::getSteerAngle ( const PxU32 id ) const

Get the steer angle that has been applied to a specific wheel.

Parameters

[in] id is the wheel being queried for its steer angle

Returns: The steer angle (in radians) applied to the queried wheel.

◆ isKindOf()

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

inlinevirtual

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

Reimplemented from physx::PxVehicleWheels.

◆ setBrakeTorque()

void physx::PxVehicleNoDrive::setBrakeTorque	(	const PxU32	id,
		const PxReal	brakeTorque
	)

Set the brake torque to be applied to a specific wheel.

Note: The applied brakeTorque persists until the next call to setBrakeTorque; The brake torque is specified in Newton metres.

Parameters

[in]	id	is the wheel being given the brake torque
[in]	brakeTorque	is the value of the brake torque

◆ setDriveTorque()

void physx::PxVehicleNoDrive::setDriveTorque	(	const PxU32	id,
		const PxReal	driveTorque
	)

Set the drive torque to be applied to a specific wheel.

Note: The applied driveTorque persists until the next call to setDriveTorque; The brake torque is specified in Newton metres.

Parameters

[in]	id	is the wheel being given the brake torque
[in]	driveTorque	is the value of the brake torque

◆ setSteerAngle()

void physx::PxVehicleNoDrive::setSteerAngle	(	const PxU32	id,
		const PxReal	steerAngle
	)

Set the steer angle to be applied to a specific wheel.

Note: The applied steerAngle persists until the next call to setSteerAngle; The steer angle is specified in radians.

Parameters

[in]	id	is the wheel being given the steer angle
[in]	steerAngle	is the value of the steer angle in radians.

◆ setToRestState()

void physx::PxVehicleNoDrive::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::PxVehicleNoDrive::setup	(	PxPhysics *	physics,
		PxRigidDynamic *	vehActor,
		const PxVehicleWheelsSimData &	wheelsData
	)

Set up a vehicle using simulation data for the wheels.

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.

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 PxVehicleWheels::setWheelShapeMapping.

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

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

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ allocate()

◆ create()

◆ exportExtraData()

◆ free()

◆ getBrakeTorque()

◆ getConcreteTypeName()

◆ getDriveTorque()

◆ getSteerAngle()

◆ isKindOf()

◆ setBrakeTorque()

◆ setDriveTorque()

◆ setSteerAngle()

◆ setToRestState()

◆ setup()