PxVehicleConstraintConnector

Defined in include/vehicle2/physxConstraints/PxVehiclePhysXConstraintStates.h

Inheritance Relationships

Base Type

• public PxConstraintConnector (PxConstraintConnector)

class PxVehicleConstraintConnector : public PxConstraintConnector

Public Functions

inline PxVehicleConstraintConnector()

inline PxVehicleConstraintConnector(PxVehiclePhysXConstraintState *vehicleConstraintState)

inline ~PxVehicleConstraintConnector()

inline void setConstraintState(PxVehiclePhysXConstraintState *constraintState)

inline 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.

inline virtual const void *getConstantBlock() const

Obtain the pointer to the constraint’s constant data.

inline virtual PxConstraintSolverPrep getPrep() const

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

inline virtual void onConstraintRelease()

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.

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

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

inline virtual void updateOmniPvdProperties() const

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

inline virtual void onComShift(PxU32 actor)

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.

inline virtual void onOriginShift(const PxVec3 &shift)

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.

See also

PxScene.shiftOrigin()

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

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

inline virtual void *getExternalReference(PxU32 &typeID)

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.

See also

PxConstraintInfo PxSimulationEventCallback.onConstraintBreak()

Parameters

typeID – [out] 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.

inline virtual PxBase *getSerializable()

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.

inline virtual void connectToConstraint(PxConstraint*)

Let the connector know it has been connected to a constraint.