PxHitBuffer

Inheritance Relationships

Base Type

public PxHitCallback< HitType > (PxHitCallback)

template<typename HitType> struct PxHitBuffer : public PxHitCallback<HitType>

Returns scene query hits (intersections) to the user in a preallocated buffer.

Will clip touch hits to maximum buffer capacity. When clipped, an arbitrary subset of touching hits will be discarded. Overflow does not trigger warnings or errors. block and hasBlock will be valid in finalizeQuery callback and after query completion. Touching hits are guaranteed to have closer or same distance ( <= condition) as the globally nearest blocking hit at the time any processTouches() callback is issued.

See also

PxHitCallback

Note

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

Public Functions

inline PxHitBuffer(HitType *aTouches = NULL, PxU32 aMaxNbTouches = 0)

Initializes the buffer with user memory.

The buffer is initialized with 0 touch hits by default => query will only report a single closest blocking hit. Use PxQueryFlag::eANY_HIT to tell the query to abort and return any first hit encoutered as blocking.

See also

PxHitCallback

Parameters

aTouches – [in] Optional buffer for recording PxQueryHitType::eTOUCH type hits.
aMaxNbTouches – [in] Size of touch buffer.

inline PxU32 getNbAnyHits() const: Computes the number of any hits in this result, blocking or touching.

inline const HitType &getAnyHit(const PxU32 index) const: Convenience iterator used to access any hits in this result, blocking or touching.

inline PxU32 getNbTouches() const

inline const HitType *getTouches() const

inline const HitType &getTouch(const PxU32 index) const

inline PxU32 getMaxNbTouches() const

inline virtual ~PxHitBuffer()

inline virtual void finalizeQuery(): Query finalization callback, called after the last processTouches callback.

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.

Protected Functions

inline virtual PxAgain processTouches(const HitType *buffer, PxU32 nbHits)

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.

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.