PxHitCallback

Defined in include/PxQueryReport.h

Inheritance Relationships

Base Type

Derived Type

template<typename HitType>
struct PxHitCallback : public PxQueryThreadContext

This callback class facilitates reporting scene query hits (intersections) to the user.

User overrides the virtual processTouches function to receive hits in (possibly multiple) fixed size blocks.

See also

PxHitBuffer PxRaycastHit PxSweepHit PxOverlapHit PxRaycastCallback PxOverlapCallback PxSweepCallback

Note

PxHitBuffer derives from this class and is used to receive touching hits in a fixed size buffer.

Note

Since the compiler doesn’t look in template dependent base classes when looking for non-dependent names

Note

with some compilers it will be necessary to use “this->hasBlock” notation to access a parent variable

Note

in a child callback class.

Note

Pre-made typedef shorthands, such as PxRaycastCallback can be used for raycast, overlap and sweep queries.

Subclassed by PxHitBuffer< HitType >

Public Functions

inline PxHitCallback(HitType *aTouches, PxU32 aMaxNbTouches)

Initializes the class with user provided buffer.

See also

PxHitCallback.hasBlock PxHitCallback.block

Note

if aTouches is NULL and aMaxNbTouches is 0, only the closest blocking hit will be recorded by the query.

Note

If PxQueryFlag::eANY_HIT flag is used as a query parameter, hasBlock will be set to true and blockingHit will be used to receive the result.

Note

Both eTOUCH and eBLOCK hits will be registered as hasBlock=true and stored in PxHitCallback.block when eANY_HIT flag is used.

Parameters

  • aTouches – [in] Optional buffer for recording PxQueryHitType::eTOUCH type hits.

  • aMaxNbTouches – [in] Size of touch buffer.

virtual PxAgain processTouches(const HitType *buffer, PxU32 nbHits) = 0

virtual callback function used to communicate query results to the user.

This callback will always be invoked with touches as a buffer if touches was specified as non-NULL. All reported touch hits are guaranteed to be closer than the closest blocking hit.

See also

PxAgain PxRaycastHit PxSweepHit PxOverlapHit

Note

There is a significant performance penalty in case multiple touch callbacks are issued (up to 2x)

Note

to avoid the penalty use a bigger buffer so that all touching hits can be reported in a single buffer.

Note

If true (again) is returned from the callback, nbTouches will be reset to 0,

Note

If false is returned, nbTouched will remain unchanged.

Note

By the time processTouches is first called, the globally closest blocking hit is already determined,

Note

values of hasBlock and block are final and all touch hits are guaranteed to be closer than the blocking hit.

Note

touches and maxNbTouches can be modified inside of processTouches callback.

Parameters

  • buffer – [in] Callback will report touch hits to the user in this buffer. This pointer will be the same as touches.

  • nbHits – [in] Number of touch hits reported in buffer. This number will not exceed maxNbTouches.

Returns

true to continue receiving callbacks in case there are more hits or false to stop.

inline virtual void finalizeQuery()

Query finalization callback, called after the last processTouches callback.

inline virtual ~PxHitCallback()
inline bool hasAnyHits()

Returns true if any blocking or touching hits were encountered during a query.

Public Members

HitType block

Holds the closest blocking hit result for the query. Invalid if hasBlock is false.

bool hasBlock

Set to true if there was a blocking hit during query.

HitType *touches

User specified buffer for touching hits.

PxU32 maxNbTouches

Size of the user specified touching hits buffer.

Note

If set to 0 all hits will default to PxQueryHitType::eBLOCK, otherwise to PxQueryHitType::eTOUCH

Note

Hit type returned from pre-filter overrides this default

PxU32 nbTouches

Number of touching hits returned by the query.

Used with PxHitBuffer.

Note

If true (PxAgain) is returned from the callback, nbTouches will be reset to 0.