physx::PxLocalStorageReportCallback< T, capacityT > Class Template Reference

Local storage report callback. More...

#include <PxReportCallback.h>

Inheritance diagram for physx::PxLocalStorageReportCallback< T, capacityT >:

Collaboration diagram for physx::PxLocalStorageReportCallback< T, capacityT >:

Public Member Functions
virtual bool	flushResults (PxU32 nbItems, const T *items)
	Reports query results to users.
virtual bool	processResults (PxU32 nbItems, const T *items)=0
	Reports query results to users.
Public Member Functions inherited from physx::PxReportCallback< T >
	PxReportCallback (T *buffer=NULL, PxU32 capacity=0)

Additional Inherited Members
Public Attributes inherited from physx::PxReportCallback< T >
T *	mBuffer
PxU32	mCapacity
PxU32	mSize
	Current number of items in the buffer. This is entirely managed by the system.

Detailed Description

template<class T, const PxU32 capacityT>
class physx::PxLocalStorageReportCallback< T, capacityT >

Local storage report callback.

This is the same as a regular callback, except the destination buffer is a local buffer within the class.

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

The capacity of the embedded buffer (determined by a template 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

Member Function Documentation

flushResults()

template<class T , const PxU32 capacityT>

virtual bool physx::PxLocalStorageReportCallback< T, capacityT >::flushResults ( PxU32  nbItems, const T *  items  )

inlinevirtual

Reports query results to users.

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

Parameters

[in]	nbItems	Number of reported items
[in]	items	array of reported items

Returns

true to continue the query, false to abort the query

Implements physx::PxReportCallback< T >.

processResults()

template<class T , const PxU32 capacityT>

virtual bool physx::PxLocalStorageReportCallback< T, capacityT >::processResults ( PxU32  nbItems, const T *  items  )

pure virtual

Reports query results to users.

Parameters

[in]	nbItems	Number of reported items
[in]	items	array of reported items

Returns

true to continue the query, false to abort the query

---

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

• RavEngine/deps/physx/physx/include/geometry/PxReportCallback.h