Inheritance diagram for physx::PxVehicleConstraintShader:

Collaboration diagram for physx::PxVehicleConstraintShader:

Classes
struct	StickyTireConstraintData

struct	SuspLimitConstraintData

struct	VehicleConstraintData

Public Member Functions
	PxVehicleConstraintShader (PxVehicleWheels vehicle, PxConstraint constraint=NULL)

void	release ()

virtual void	onComShift (PxU32 actor)
	Center-of-mass shift callback.

virtual void	onOriginShift (const PxVec3 &shift)
	Origin shift callback.

virtual void *	prepareData ()
	Pre-simulation data preparation when the constraint is marked dirty, this function is called at the start of the simulation step for the SDK to copy the constraint data block.

virtual bool	updatePvdProperties (pvdsdk::PvdDataStream &pvdConnection, const PxConstraint *c, PxPvdUpdateType::Enum updateType) const
	this function is called by the SDK to update PVD's view of it

virtual void	updateOmniPvdProperties () const
	this function is called by the SDK to update OmniPVD's view of it

virtual void	onConstraintRelease ()
	Constraint release callback.

virtual void *	getExternalReference (PxU32 &typeID)
	Fetches external data for a constraint.

virtual PxBase *	getSerializable ()
	Obtain a reference to a PxBase interface if the constraint has one.

PX_INLINE void	setPxConstraint (PxConstraint *pxConstraint)

PX_INLINE PxConstraint *	getPxConstraint ()

PxConstraintConnector *	getConnector ()

virtual PxConstraintSolverPrep	getPrep () const
	Obtain the shader function pointer used to prep rows for this constraint.

virtual const void *	getConstantBlock () const
	Obtain the pointer to the constraint's constant data.

Public Member Functions inherited from physx::PxConstraintConnector
virtual void	connectToConstraint (PxConstraint *)
	Let the connector know it has been connected to a constraint.

virtual	~PxConstraintConnector ()
	virtual destructor

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

static PxU32	vehicleSuspLimitConstraintSolverPrep (Px1DConstraint constraints, PxVec3p &body0WorldOffset, PxU32 maxConstraints, PxConstraintInvMassScale &, const void constantBlock, const PxTransform &bodyAToWorld, const PxTransform &bodyBToWorld, bool, PxVec3p &cA2w, PxVec3p &cB2w)

static void	visualiseConstraint (PxConstraintVisualizer &viz, const void *constantBlock, const PxTransform &body0Transform, const PxTransform &body1Transform, PxU32 flags)

Public Attributes
VehicleConstraintData	mData

PxConstraint *	mConstraint

Friends
class	PxVehicleWheels

Member Function Documentation

◆ getConstantBlock()

virtual const void * physx::PxVehicleConstraintShader::getConstantBlock ( ) const

inlinevirtual

Obtain the pointer to the constraint's constant data.

Implements physx::PxConstraintConnector.

◆ getExternalReference()

virtual void * physx::PxVehicleConstraintShader::getExternalReference ( PxU32 & typeID )

inlinevirtual

Fetches external data for a constraint.

This function is used by the SDK to acquire a reference to the owner of a constraint and a unique owner type ID. This information will be passed on when a breakable constraint breaks or when PxConstraint::getExternalReference() is called.

Parameters

[out] typeID Unique type identifier of the external object. The value 0xffffffff is reserved and should not be used. Furthermore, if the PhysX extensions library is used, some other IDs are reserved already (see PxConstraintExtIDs)

Returns: Reference to the external object which owns the constraint.

See also: PxConstraintInfo PxSimulationEventCallback.onConstraintBreak()

Implements physx::PxConstraintConnector.

◆ getPrep()

virtual PxConstraintSolverPrep physx::PxVehicleConstraintShader::getPrep ( ) const

inlinevirtual

Obtain the shader function pointer used to prep rows for this constraint.

Implements physx::PxConstraintConnector.

◆ getSerializable()

virtual PxBase * physx::PxVehicleConstraintShader::getSerializable ( )

inlinevirtual

Obtain a reference to a PxBase interface if the constraint has one.

If the constraint does not implement the PxBase interface, it should return NULL.

Implements physx::PxConstraintConnector.

◆ onComShift()

virtual void physx::PxVehicleConstraintShader::onComShift ( PxU32 actor )

inlinevirtual

Center-of-mass shift callback.

This function is called by the SDK when the CoM of one of the actors is moved. Since the API specifies constraint positions relative to actors, and the constraint shader functions are supplied with coordinates relative to bodies, some synchronization is usually required when the application moves an object's center of mass.

Implements physx::PxConstraintConnector.

◆ onConstraintRelease()

virtual void physx::PxVehicleConstraintShader::onConstraintRelease ( )

inlinevirtual

Constraint release callback.

When the SDK deletes a PxConstraint object this function is called by the SDK. In general custom constraints should not be deleted directly by applications: rather, the constraint should respond to a release() request by calling PxConstraint::release(), then wait for this call to release its own resources.

This function is also called when a PxConstraint object is deleted on cleanup due to destruction of the PxPhysics object.

Implements physx::PxConstraintConnector.

◆ onOriginShift()

virtual void physx::PxVehicleConstraintShader::onOriginShift ( const PxVec3 & shift )

inlinevirtual

Origin shift callback.

This function is called by the SDK when the scene origin gets shifted and allows to adjust custom data which contains world space transforms.

Note: If the adjustments affect constraint shader data, it is necessary to call PxConstraint::markDirty() to make sure that the data gets synced at the beginning of the next simulation step.

Parameters

[in] shift Translation vector the origin is shifted by.

See also: PxScene.shiftOrigin()

Implements physx::PxConstraintConnector.

◆ prepareData()

virtual void * physx::PxVehicleConstraintShader::prepareData ( )

inlinevirtual

Pre-simulation data preparation when the constraint is marked dirty, this function is called at the start of the simulation step for the SDK to copy the constraint data block.

Implements physx::PxConstraintConnector.

◆ updateOmniPvdProperties()

virtual void physx::PxVehicleConstraintShader::updateOmniPvdProperties ( ) const

inlinevirtual

this function is called by the SDK to update OmniPVD's view of it

Implements physx::PxConstraintConnector.

◆ updatePvdProperties()

virtual bool physx::PxVehicleConstraintShader::updatePvdProperties	(	pvdsdk::PvdDataStream &	pvdConnection,
		const PxConstraint *	c,
		PxPvdUpdateType::Enum	updateType
	)		const

inlinevirtual

this function is called by the SDK to update PVD's view of it

Implements physx::PxConstraintConnector.

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

RavEngine/deps/physx/physx/source/physxvehicle/src/PxVehicleSuspLimitConstraintShader.h
RavEngine/deps/physx/physx/source/physxvehicle/src/PxVehicleMetaData.cpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Member Function Documentation

◆ getConstantBlock()

◆ getExternalReference()

◆ getPrep()

◆ getSerializable()

◆ onComShift()

◆ onConstraintRelease()

◆ onOriginShift()

◆ prepareData()

◆ updateOmniPvdProperties()

◆ updatePvdProperties()