PxMeshQuery Class Reference
[Geomutils]

#include <PxMeshQuery.h>


Static Public Member Functions
static PX_PHYSX_COMMON_API void	getTriangle (const PxTriangleMeshGeometry &triGeom, const PxTransform &transform, PxTriangleID triangleIndex, PxTriangle &triangle, PxU32 vertexIndices=NULL, PxU32 adjacencyIndices=NULL)
	Retrieves triangle data from a triangle ID.
static PX_PHYSX_COMMON_API void	getTriangle (const PxHeightFieldGeometry &hfGeom, const PxTransform &transform, PxTriangleID triangleIndex, PxTriangle &triangle, PxU32 *vertexIndices=NULL)
	Retrieves triangle data from a triangle ID.
static PX_PHYSX_COMMON_API PxU32	findOverlapTriangleMesh (const PxGeometry &geom0, const PxTransform &pose0, const PxTriangleMeshGeometry &geom1, const PxTransform &pose1, PxU32 *results, PxU32 maxResults, PxU32 startIndex, bool &overflow)
	Find the mesh triangles which touch the specified geometry object.
static PX_PHYSX_COMMON_API PxU32	findOverlapHeightField (const PxGeometry &geom0, const PxTransform &pose0, const PxHeightFieldGeometry &geom1, const PxTransform &pose1, PxU32 *results, PxU32 maxResults, PxU32 startIndex, bool &overflow)
	Find the height field triangles which touch the specified geometry object.

Member Function Documentation

static PX_PHYSX_COMMON_API PxU32 PxMeshQuery::findOverlapHeightField	(	const PxGeometry &	geom0,
		const PxTransform &	pose0,
		const PxHeightFieldGeometry &	geom1,
		const PxTransform &	pose1,
		PxU32 *	results,
		PxU32	maxResults,
		PxU32	startIndex,
		bool &	overflow
	)			`[static]`

Find the height field triangles which touch the specified geometry object.

Returned triangle indices can be used with getTriangle() to retrieve the triangle properties.

Parameters:

`[in]`	geom0	The geometry object to test for height field overlaps. Supported geometries are PxBoxGeometry
`[in]`	pose0	Pose of the geometry object
`[in]`	geom1	The height field geometry to check overlap against
`[in]`	pose1	Pose of the height field
`[out]`	results	Indices of overlapping triangles
`[in]`	maxResults	Size of 'results' buffer
`[in]`	startIndex	Index of first result to be retrieved. Previous indices are skipped.
`[out]`	overflow	True if a buffer overflow occured

Returns:: Number of overlaps found, i.e. number of elements written to the results buffer

static PX_PHYSX_COMMON_API PxU32 PxMeshQuery::findOverlapTriangleMesh	(	const PxGeometry &	geom0,
		const PxTransform &	pose0,
		const PxTriangleMeshGeometry &	geom1,
		const PxTransform &	pose1,
		PxU32 *	results,
		PxU32	maxResults,
		PxU32	startIndex,
		bool &	overflow
	)			`[static]`

Find the mesh triangles which touch the specified geometry object.

Returned triangle indices can be used with getTriangle() to retrieve the triangle properties.

Parameters:

`[in]`	geom0	The geometry object to test for mesh triangle overlaps. Supported geometries are PxSphereGeometry, PxCapsuleGeometry and PxBoxGeometry
`[in]`	pose0	Pose of the geometry object
`[in]`	geom1	The triangle mesh geometry to check overlap against
`[in]`	pose1	Pose of the triangle mesh
`[out]`	results	Indices of overlapping triangles
`[in]`	maxResults	Size of 'results' buffer
`[in]`	startIndex	Index of first result to be retrieved. Previous indices are skipped.
`[out]`	overflow	True if a buffer overflow occured

Returns:: Number of overlaps found, i.e. number of elements written to the results buffer

static PX_PHYSX_COMMON_API void PxMeshQuery::getTriangle	(	const PxHeightFieldGeometry &	hfGeom,
		const PxTransform &	transform,
		PxTriangleID	triangleIndex,
		PxTriangle &	triangle,
		PxU32 *	vertexIndices = `NULL`
	)			`[static]`

Retrieves triangle data from a triangle ID.

This function can be used together with findOverlapHeightField() to retrieve triangle properties.

Parameters:

`[in]`	hfGeom	Geometry of the height field to extract the triangle from.
`[in]`	transform	Transform for the height field.
`[in]`	triangleIndex	The index of the triangle to retrieve.
`[out]`	triangle	Triangle points in world space.
`[out]`	vertexIndices	Returned vertex indices for given triangle

static PX_PHYSX_COMMON_API void PxMeshQuery::getTriangle	(	const PxTriangleMeshGeometry &	triGeom,
		const PxTransform &	transform,
		PxTriangleID	triangleIndex,
		PxTriangle &	triangle,
		PxU32 *	vertexIndices = `NULL`,
		PxU32 *	adjacencyIndices = `NULL`
	)			`[static]`

Retrieves triangle data from a triangle ID.

This function can be used together with findOverlapTriangleMesh() to retrieve triangle properties.

Parameters:

`[in]`	triGeom	Geometry of the triangle mesh to extract the triangle from.
`[in]`	transform	Transform for the triangle mesh
`[in]`	triangleIndex	The index of the triangle to retrieve.
`[out]`	triangle	Triangle points in world space.
`[out]`	vertexIndices	Returned vertex indices for given triangle
`[out]`	adjacencyIndices	Returned 3 triangle adjacency internal face indices (0xFFFFFFFF if no adjacency). The mesh must be cooked with cooking param buildTriangleAdjacencies enabled.

See also:: PxTriangle PxTriangleFlags PxTriangleID findOverlapTriangleMesh()

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