PxRegularReportCallback

Defined in include/geometry/PxReportCallback.h

Inheritance Relationships

Base Type

template<class T>
class PxRegularReportCallback : public PxReportCallback<T>

Regular report callback.

This reports results like a regular callback would:

  • without explicit buffer management from users

  • by default, one item at a time

This customized callback sends results to users via the processResults() function.

The capacity parameter dictates how many items can be reported at a time, i.e. how many times the flushResults/processResults function will be called by the system.

See also

PxReportCallback

Public Functions

inline PxRegularReportCallback(const PxU32 capacity = 1)
inline virtual bool flushResults(PxU32 nbItems, const T *items)

Reports query results to users.

This will be called by the system as many times as necessary to report all results.

Parameters
  • nbItems[in] Number of reported items

  • items[in] array of reported items

Returns

true to continue the query, false to abort the query

virtual bool processResults(PxU32 nbItems, const T *items) = 0

Reports query results to users.

Parameters
  • nbItems[in] Number of reported items

  • items[in] array of reported items

Returns

true to continue the query, false to abort the query

Public Members

T *mBuffer
PxU32 mCapacity
PxU32 mSize

Current number of items in the buffer. This is entirely managed by the system.