PxQueryFilterData Struct Reference

Scene query filtering data. More...

#include <PxQueryFiltering.h>

Collaboration diagram for PxQueryFilterData:

Public Member Functions
PX_INLINE	PxQueryFilterData ()
	default constructor More...
PX_INLINE	PxQueryFilterData (const PxFilterData &fd, PxQueryFlags f)
	constructor to set both filter data and filter flags More...
PX_INLINE	PxQueryFilterData (PxQueryFlags f)
	constructor to set filter flags only More...

Public Attributes
PxFilterData	data
	Filter data associated with the scene query. More...
PxQueryFlags	flags
	Filter flags (see PxQueryFlags) More...
PxClientID	clientId
	ID of the client doing the query (see PxScene.createClient()) More...

Detailed Description

Scene query filtering data.

Whenever the scene query intersects a shape, filtering is performed in the following order:

• For non-batched queries only:
  If the data field is non-zero, and the bitwise-AND value of data AND the shape's queryFilterData is zero, the shape is skipped
• If filter callbacks are enabled in flags field (see PxQueryFlags) they will get invoked accordingly.
• If neither PxQueryFlag::ePREFILTER or PxQueryFlag::ePOSTFILTER is set, the hit defaults to type PxQueryHitType::eBLOCK when the value of PxHitCallback::nbTouches provided with the query is zero and to type PxQueryHitType::eTOUCH when PxHitCallback::nbTouches is positive.

See Also

PxScene.raycast PxScene.sweep PxScene.overlap PxBatchQuery.raycast PxBatchQuery.sweep PxBatchQuery.overlap PxQueryFlag::eANY_HIT

Constructor & Destructor Documentation

PX_INLINE PxQueryFilterData::PxQueryFilterData ( )

inlineexplicit

default constructor

PX_INLINE PxQueryFilterData::PxQueryFilterData ( const PxFilterData &  fd, PxQueryFlags  f  )

inlineexplicit

constructor to set both filter data and filter flags

PX_INLINE PxQueryFilterData::PxQueryFilterData ( PxQueryFlags  f )

inlineexplicit

constructor to set filter flags only

Member Data Documentation

PxClientID PxQueryFilterData::clientId

ID of the client doing the query (see PxScene.createClient())

Referenced by PxScene::overlapMultiple(), PxScene::raycastMultiple(), PxScene::raycastSingle(), PxScene::sweepMultiple(), and PxScene::sweepSingle().

PxFilterData PxQueryFilterData::data

Filter data associated with the scene query.

PxQueryFlags PxQueryFilterData::flags

Filter flags (see PxQueryFlags)

Referenced by PxScene::overlapMultiple().

---

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

• PxQueryFiltering.h