PxSimulationStatistics Class Reference
[Physics]

Class used to retrieve statistics for a simulation step. More...

#include <PxSimulationStatistics.h>


Public Types
enum	VolumeType { eRIGID_BODY, ePARTICLE_SYSTEM, eVOLUME_COUNT }
	Identifies each type of broadphase volume. More...
enum	RbPairStatsType { eDISCRETE_CONTACT_PAIRS, eSWEPT_INTEGRATION_PAIRS, eMODIFIED_CONTACT_PAIRS, eTRIGGER_PAIRS }
	Different types of rigid body collision pair statistics. More...
Public Member Functions
PxU32	getNumBroadPhaseAdds (VolumeType type) const
	Get number of broadphase volumes of a certain type added for the current simulation step.
PxU32	getNumBroadPhaseRemoves (VolumeType type) const
	Get number of broadphase volumes of a certain type removed for the current simulation step.
PxU32	getRbPairStats (RbPairStatsType pairType, PxGeometryType::Enum g0, PxGeometryType::Enum g1) const
	Get number of shape collision pairs of a certain type processed for the current simulation step.
	PxSimulationStatistics ()
Public Attributes
PxU32	numActiveConstraints
	Number of active PxConstraint objects (joints etc.) for the current simulation step.
PxU32	numActiveDynamicBodies
	Number of active dynamic bodies for the current simulation step.
PxU32	numActiveKinematicBodies
	Number of active kinematic bodies for the current simulation step.
PxU32	numStaticBodies
	Number of static bodies for the current simulation step.
PxU32	numDynamicBodies
	Number of dynamic bodies for the current simulation step.
PxU32	numShapes [PxGeometryType::eGEOMETRY_COUNT]
	Number of shapes of each geometry type.
PxU32	numAxisSolverConstraints
	The number of 1D axis constraints(joints+contact) present in the current simulation step.
PxU32	numBroadPhaseAdds [eVOLUME_COUNT]
PxU32	numBroadPhaseRemoves [eVOLUME_COUNT]
PxU32	numDiscreteContactPairs [PxGeometryType::eGEOMETRY_COUNT][PxGeometryType::eGEOMETRY_COUNT]
PxU32	numSweptIntegrationPairs [PxGeometryType::eGEOMETRY_COUNT][PxGeometryType::eGEOMETRY_COUNT]
PxU32	numModifiedContactPairs [PxGeometryType::eGEOMETRY_COUNT][PxGeometryType::eGEOMETRY_COUNT]
PxU32	numTriggerPairs [PxGeometryType::eGEOMETRY_COUNT][PxGeometryType::eGEOMETRY_COUNT]

Detailed Description

Class used to retrieve statistics for a simulation step.

Platform:

PC SW: Yes
PS3 : Yes
XB360: Yes
WII : Yes

See also:: PxScene::getSimulationStatistics()

Member Enumeration Documentation

enum PxSimulationStatistics::RbPairStatsType

Different types of rigid body collision pair statistics.

See also:: getRbPairStats

Enumerator:

eDISCRETE_CONTACT_PAIRS	Shape pairs processed as discrete contact pairs for the current simulation step.
eSWEPT_INTEGRATION_PAIRS	Shape pairs processed as swept integration pairs for the current simulation step. Note: Counts the pairs for which special CCD (continuous collision detection) work was actually done and NOT the number of pairs which were configured for CCD. Furthermore, there can be multiple CCD passes and all processed pairs of all passes are summed up, hence the number can be larger than the amount of pairs which have been configured for CCD. See also: PxPairFlag::eSWEPT_INTEGRATION_LINEAR
eMODIFIED_CONTACT_PAIRS	Shape pairs processed with user contact modification enabled for the current simulation step. See also: PxContactModifyCallback
eTRIGGER_PAIRS	Trigger shape pairs processed for the current simulation step. See also: PxShapeFlag::eTRIGGER_SHAPE

enum PxSimulationStatistics::VolumeType

Identifies each type of broadphase volume.

See also:: numBroadPhaseAdds numBroadPhaseRemoves

Enumerator:

eRIGID_BODY

A volume belonging to a rigid body object.

See also:: PxRigidStatic PxRigidDynamic PxArticulationLink

ePARTICLE_SYSTEM

A volume belonging to a particle system.

See also:: PxParticleSystem PxParticleFluid

eVOLUME_COUNT

Constructor & Destructor Documentation

PxSimulationStatistics::PxSimulationStatistics ( ) [inline]

References PxGeometryType::eGEOMETRY_COUNT.

Member Function Documentation

PxU32 PxSimulationStatistics::getNumBroadPhaseAdds ( VolumeType type ) const [inline]

Get number of broadphase volumes of a certain type added for the current simulation step.

Parameters:

[in] type The volume type for which to get the number

Returns:: Number of broadphase volumes added.

See also:: VolumType

References PX_ASSERT.

PxU32 PxSimulationStatistics::getNumBroadPhaseRemoves ( VolumeType type ) const [inline]

Get number of broadphase volumes of a certain type removed for the current simulation step.

Parameters:

[in] type The volume type for which to get the number

Returns:: Number of broadphase volumes removed.

See also:: VolumType

References PX_ASSERT.

PxU32 PxSimulationStatistics::getRbPairStats	(	RbPairStatsType	pairType,
		PxGeometryType::Enum	g0,
		PxGeometryType::Enum	g1
	)			const `[inline]`

Get number of shape collision pairs of a certain type processed for the current simulation step.

There is an entry for each geometry pair type.

Note:: entry[i][j] = entry[j][i], hence, if you want the sum of all pair types, you need to discard the symmetric entries

Parameters:

`[in]`	pairType	The type of pair for which to get information
`[in]`	g0	The geometry type of one pair object
`[in]`	g1	The geometry type of the other pair object