PxBatchQueryResult< HitType > Struct Template Reference

Generic struct for receiving results of single query in a batch. Gets templated on hit type PxRaycastHit, PxSweepHit or PxOverlapHit. More...

#include <PxBatchQueryDesc.h>

Collaboration diagram for PxBatchQueryResult< HitType >:

Public Member Functions
PX_INLINE PxU32	getNbAnyHits () const
	Computes the number of any hits in this result, blocking or touching. More...
PX_INLINE const HitType &	getAnyHit (const PxU32 index) const
	Convenience iterator used to access any hits in this result, blocking or touching. More...

Public Attributes
HitType	block
	Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true. More...
HitType *	touches
PxU32	nbTouches
	Number of touching hits returned by this query, works in tandem with touches pointer. More...
void *	userData
	Copy of the userData pointer specified in the corresponding query. More...
PxU8	queryStatus
	Takes on values from PxBatchQueryStatus::Enum. More...
bool	hasBlock
	True if there was a blocking hit. More...
PxU16	pad
	pads the struct to 16 bytes. More...

Detailed Description

template<typename HitType>
struct PxBatchQueryResult< HitType >

Generic struct for receiving results of single query in a batch. Gets templated on hit type PxRaycastHit, PxSweepHit or PxOverlapHit.

Member Function Documentation

template<typename HitType >

PX_INLINE const HitType& PxBatchQueryResult< HitType >::getAnyHit ( const PxU32  index ) const

inline

Convenience iterator used to access any hits in this result, blocking or touching.

References PX_ASSERT.

template<typename HitType >

PX_INLINE PxU32 PxBatchQueryResult< HitType >::getNbAnyHits ( ) const

inline

Computes the number of any hits in this result, blocking or touching.

Member Data Documentation

template<typename HitType >

HitType PxBatchQueryResult< HitType >::block

Holds the closest blocking hit for a single query in a batch. Only valid if hasBlock is true.

template<typename HitType >

bool PxBatchQueryResult< HitType >::hasBlock

True if there was a blocking hit.

template<typename HitType >

PxU32 PxBatchQueryResult< HitType >::nbTouches

Number of touching hits returned by this query, works in tandem with touches pointer.

template<typename HitType >

PxU16 PxBatchQueryResult< HitType >::pad

pads the struct to 16 bytes.

template<typename HitType >

PxU8 PxBatchQueryResult< HitType >::queryStatus

Takes on values from PxBatchQueryStatus::Enum.

template<typename HitType >

HitType* PxBatchQueryResult< HitType >::touches

    This pointer will either be set to NULL for 0 nbTouches or will point

into the user provided batch query results buffer specified in PxBatchQueryDesc.

template<typename HitType >

void* PxBatchQueryResult< HitType >::userData

Copy of the userData pointer specified in the corresponding query.

---

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

• PxBatchQueryDesc.h