physx::PxConvexMeshDesc Class Reference

Descriptor class for #PxConvexMesh. More...

#include <PxConvexMeshDesc.h>

Collaboration diagram for physx::PxConvexMeshDesc:

Public Member Functions
PX_INLINE	PxConvexMeshDesc ()
	constructor sets to default.
PX_INLINE void	setToDefault ()
	(re)sets the structure to the default.
PX_INLINE bool	isValid () const
	Returns true if the descriptor is valid.

Public Attributes
PxBoundedData	points
	Vertex positions data in PxBoundedData format.
PxBoundedData	polygons
	Polygons data in PxBoundedData format.
PxBoundedData	indices
	Polygon indices data in PxBoundedData format.
PxConvexFlags	flags
	Flags bits, combined from values of the enum ::PxConvexFlag.
PxU16	vertexLimit
	Limits the number of vertices of the result convex mesh. Hard maximum limit is 255 and minimum limit is 4 if PxConvexFlag::ePLANE_SHIFTING is used, otherwise the minimum limit is 8.
PxU16	polygonLimit
	Limits the number of polygons of the result convex mesh. Hard maximum limit is 255 and minimum limit is 4.
PxU16	quantizedCount
	Maximum number of vertices after quantization. The quantization is done during the vertex cleaning phase. The quantization is applied when PxConvexFlag::eQUANTIZE_INPUT is specified.
PxSDFDesc *	sdfDesc
	SDF descriptor. When this descriptor is set, signed distance field is calculated for this convex mesh.

Detailed Description

Descriptor class for #PxConvexMesh.

Note

The number of vertices and the number of convex polygons in a cooked convex mesh is limited to 256.

The number of vertices and the number of convex polygons in a GPU compatible convex mesh is limited to 64, and the number of faces per vertex is limited to 32.

See also

PxConvexMesh PxConvexMeshGeometry PxShape PxPhysics.createConvexMesh()

Member Function Documentation

isValid()

PX_INLINE bool physx::PxConvexMeshDesc::isValid

(

)

const

Returns true if the descriptor is valid.

Returns

True if the current settings are valid

Member Data Documentation

flags

PxConvexFlags physx::PxConvexMeshDesc::flags

Flags bits, combined from values of the enum ::PxConvexFlag.

Default: 0

indices

PxBoundedData physx::PxConvexMeshDesc::indices

Polygon indices data in PxBoundedData format.

Pointer to first index.

Default: NULL

This is declared as a void pointer because it is actually either an PxU16 or a PxU32 pointer.

See also

PxHullPolygon PxConvexFlag::e16_BIT_INDICES

points

PxBoundedData physx::PxConvexMeshDesc::points

Vertex positions data in PxBoundedData format.

Default: NULL

polygonLimit

PxU16 physx::PxConvexMeshDesc::polygonLimit

Limits the number of polygons of the result convex mesh. Hard maximum limit is 255 and minimum limit is 4.

Note

The maximum limit for GPU compatible convex meshes is 64.

Range: [4, 255]
Default: 255

polygons

PxBoundedData physx::PxConvexMeshDesc::polygons

Polygons data in PxBoundedData format.

Pointer to first polygon.

Default: NULL

See also

PxHullPolygon

quantizedCount

PxU16 physx::PxConvexMeshDesc::quantizedCount

Maximum number of vertices after quantization. The quantization is done during the vertex cleaning phase. The quantization is applied when PxConvexFlag::eQUANTIZE_INPUT is specified.

See also

PxConvexFlag::eQUANTIZE_INPUT

Range: [4, 65535]
Default: 255

sdfDesc

PxSDFDesc* physx::PxConvexMeshDesc::sdfDesc

SDF descriptor. When this descriptor is set, signed distance field is calculated for this convex mesh.

Default: NULL

vertexLimit

PxU16 physx::PxConvexMeshDesc::vertexLimit

Limits the number of vertices of the result convex mesh. Hard maximum limit is 255 and minimum limit is 4 if PxConvexFlag::ePLANE_SHIFTING is used, otherwise the minimum limit is 8.

Note

Vertex limit is only used when PxConvexFlag::eCOMPUTE_CONVEX is specified.

The please see PxConvexFlag::ePLANE_SHIFTING for algorithm explanation

The maximum limit for GPU compatible convex meshes is 64.

See also

PxConvexFlag::ePLANE_SHIFTING

Range: [4, 255]
Default: 255

---

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

• RavEngine/deps/physx/physx/include/cooking/PxConvexMeshDesc.h