PxQueryFilterCallback

Defined in include/PxQueryFiltering.h

class PxQueryFilterCallback

Scene query filtering callbacks.

Custom filtering logic for scene query intersection candidates. If an intersection candidate object passes the data based filter (see PxQueryFilterData), filtering callbacks are executed if requested (see PxQueryFilterData.flags)

  • If PxQueryFlag::ePREFILTER is set, the preFilter function runs before exact intersection tests. If this function returns PxQueryHitType::eTOUCH or PxQueryHitType::eBLOCK, exact testing is performed to determine the intersection location.

The preFilter function may overwrite the copy of queryFlags it receives as an argument to specify any of PxHitFlag::eMODIFIABLE_FLAGS on a per-shape basis. Changes apply only to the shape being filtered, and changes to other flags are ignored.

  • If PxQueryFlag::ePREFILTER is not set, precise intersection testing is performed using the original query’s filterData.flags.

  • If PxQueryFlag::ePOSTFILTER is set, the postFilter function is called for each intersection to determine the touch/block status. This overrides any touch/block status previously returned from the preFilter function for this shape.

Filtering calls are not guaranteed to be sorted along the ray or sweep direction.

See also

PxScene.raycast PxScene.sweep PxScene.overlap PxQueryFlags PxHitFlags

Public Functions

virtual PxQueryHitType::Enum preFilter(const PxFilterData &filterData, const PxShape *shape, const PxRigidActor *actor, PxHitFlags &queryFlags) = 0

This filter callback is executed before the exact intersection test if PxQueryFlag::ePREFILTER flag was set.

Parameters

  • filterData – [in] custom filter data specified as the query’s filterData.data parameter.

  • shape – [in] A shape that has not yet passed the exact intersection test.

  • actor – [in] The shape’s actor.

  • queryFlags – [inout] scene query flags from the query’s function call (only flags from PxHitFlag::eMODIFIABLE_FLAGS bitmask can be modified)

Returns

the updated type for this hit (see PxQueryHitType)

virtual PxQueryHitType::Enum postFilter(const PxFilterData &filterData, const PxQueryHit &hit, const PxShape *shape, const PxRigidActor *actor) = 0

This filter callback is executed if the exact intersection test returned true and PxQueryFlag::ePOSTFILTER flag was set.

Parameters

  • filterData – [in] custom filter data of the query

  • hit – [in] Scene query hit information. faceIndex member is not valid for overlap queries. For sweep and raycast queries the hit information can be cast to PxSweepHit and PxRaycastHit respectively.

  • shape – [in] Hit shape

  • actor – [in] Hit actor

Returns

the updated hit type for this hit (see PxQueryHitType)

inline virtual ~PxQueryFilterCallback()

virtual destructor