PxContactPairHeader Struct Reference

An Instance of this class is passed to PxSimulationEventCallback.onContact(). More...

#include <PxSimulationEventCallback.h>

Collaboration diagram for PxContactPairHeader:

Public Member Functions

PX_INLINE PxContactPairHeader ()
 

Public Attributes

PxRigidActoractors [2]
 The two actors of the notification shape pairs. More...
 
const PxU8 * extraDataStream
 Stream containing extra data as requested in the PxPairFlag flags of the simulation filter. More...
 
PxU16 extraDataStreamSize
 Size of the extra data stream [bytes]. More...
 
PxContactPairHeaderFlags flags
 Additional information on the contact report pair. More...
 
const struct PxContactPairpairs
 pointer to the contact pairs More...
 
PxU32 nbPairs
 number of contact pairs More...
 

Detailed Description

An Instance of this class is passed to PxSimulationEventCallback.onContact().

See also
PxSimulationEventCallback.onContact()

Constructor & Destructor Documentation

◆ PxContactPairHeader()

PX_INLINE PxContactPairHeader::PxContactPairHeader ( )
inline

Member Data Documentation

◆ actors

PxRigidActor* PxContactPairHeader::actors[2]

The two actors of the notification shape pairs.

Note
The actor pointers might reference deleted actors. This will be the case if PxPairFlag::eNOTIFY_TOUCH_LOST or PxPairFlag::eNOTIFY_THRESHOLD_FORCE_LOST events were requested for the pair and one of the involved actors gets deleted or removed from the scene. Check the flags member to see whether that is the case. Do not dereference a pointer to a deleted actor. The pointer to a deleted actor is only provided such that user data structures which might depend on the pointer value can be updated.
See also
PxActor

◆ extraDataStream

const PxU8* PxContactPairHeader::extraDataStream

Stream containing extra data as requested in the PxPairFlag flags of the simulation filter.

This pointer is only valid if any kind of extra data information has been requested for the contact report pair (see PxPairFlag::ePOST_SOLVER_VELOCITY etc.), else it will be NULL.

See also
PxPairFlag

◆ extraDataStreamSize

PxU16 PxContactPairHeader::extraDataStreamSize

Size of the extra data stream [bytes].

◆ flags

PxContactPairHeaderFlags PxContactPairHeader::flags

Additional information on the contact report pair.

See also
PxContactPairHeaderFlag

◆ nbPairs

PxU32 PxContactPairHeader::nbPairs

number of contact pairs

◆ pairs

const struct PxContactPair* PxContactPairHeader::pairs

pointer to the contact pairs


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