PxBroadPhaseCallback Class Referenceabstract

Broad-phase callback to receive broad-phase related events. More...

#include <PxBroadPhase.h>

Public Member Functions

virtual ~PxBroadPhaseCallback ()
 
virtual void onObjectOutOfBounds (PxShape &shape, PxActor &actor)=0
 Out-of-bounds notification. More...
 
virtual void onObjectOutOfBounds (PxAggregate &aggregate)=0
 Out-of-bounds notification. More...
 

Detailed Description

Broad-phase callback to receive broad-phase related events.

Each broadphase callback object is associated with a PxClientID. It is possible to register different callbacks for different clients. The callback functions are called this way:

  • for shapes/actors, the callback assigned to the actors' clients are used
  • for aggregates, the callbacks assigned to clients from aggregated actors are used
Note
SDK state should not be modified from within the callbacks. In particular objects should not be created or destroyed. If state modification is needed then the changes should be stored to a buffer and performed after the simulation step.

Threading: It is not necessary to make this class thread safe as it will only be called in the context of the user thread.

See also
PxSceneDesc PxScene.setBroadPhaseCallback() PxScene.getBroadPhaseCallback()

Constructor & Destructor Documentation

◆ ~PxBroadPhaseCallback()

virtual PxBroadPhaseCallback::~PxBroadPhaseCallback ( )
inlinevirtual

Member Function Documentation

◆ onObjectOutOfBounds() [1/2]

virtual void PxBroadPhaseCallback::onObjectOutOfBounds ( PxShape shape,
PxActor actor 
)
pure virtual

Out-of-bounds notification.

This function is called when an object leaves the broad-phase.

Parameters
[in]shapeShape that left the broad-phase bounds
[in]actorOwner actor

◆ onObjectOutOfBounds() [2/2]

virtual void PxBroadPhaseCallback::onObjectOutOfBounds ( PxAggregate aggregate)
pure virtual

Out-of-bounds notification.

This function is called when an aggregate leaves the broad-phase.

Parameters
[in]aggregateAggregate that left the broad-phase bounds

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