PxSceneFlag Struct Reference

flags for configuring properties of the scene More...

#include <PxSceneDesc.h>

Public Types
enum	Enum {   eENABLE_ACTIVETRANSFORMS =(1<<1),   eENABLE_CCD =(1<<2),   eDISABLE_CCD_RESWEEP =(1<<3),   eADAPTIVE_FORCE =(1<<4),   eENABLE_KINEMATIC_STATIC_PAIRS =(1<<5),   eENABLE_KINEMATIC_PAIRS =(1<<6),   eENABLE_PCM = (1 << 9),   eDISABLE_CONTACT_REPORT_BUFFER_RESIZE = (1 << 10),   eDISABLE_CONTACT_CACHE = (1 << 11),   eREQUIRE_RW_LOCK = (1 << 12),   eENABLE_STABILIZATION = (1 << 14),   eENABLE_AVERAGE_POINT = (1 << 15) }

Detailed Description

flags for configuring properties of the scene

See Also

PxScene

Member Enumeration Documentation

enum PxSceneFlag::Enum

Enumerator
eENABLE_ACTIVETRANSFORMS	Enable Active Transform Notification. This flag enables the the Active Transform Notification feature for a scene. This feature defaults to disabled. When disabled, the function PxScene::getActiveTransforms() will always return a NULL list. Note There may be a performance penalty for enabling the Active Transform Notification, hence this flag should only be enabled if the application intends to use the feature. Default: False
eENABLE_CCD	Enables a second broad phase check after integration that makes it possible to prevent objects from tunneling through eachother. PxPairFlag::eDETECT_CCD_CONTACT requires this flag to be specified. Note For this feature to be effective for bodies that can move at a significant velocity, the user should raise the flag PxRigidBodyFlag::eENABLE_CCD for them. This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: False See Also PxRigidBodyFlag::eENABLE_CCD, PxPairFlag::eDETECT_CCD_CONTACT, eDISABLE_CCD_RESWEEP
eDISABLE_CCD_RESWEEP	Enables a simplified swept integration strategy, which sacrifices some accuracy for improved performance. This simplified swept integration approach makes certain assumptions about the motion of objects that are not made when using a full swept integration. These assumptions usually hold but there are cases where they could result in incorrect behavior between a set of fast-moving rigid bodies. A key issue is that fast-moving dynamic objects may tunnel through each-other after a rebound. This will not happen if this mode is disabled. However, this approach will be potentially faster than a full swept integration because it will perform significantly fewer sweeps in non-trivial scenes involving many fast-moving objects. This approach should successfully resist objects passing through the static environment. PxPairFlag::eDETECT_CCD_CONTACT requires this flag to be specified. Note This scene flag requires eENABLE_CCD to be enabled as well. If it is not, this scene flag will do nothing. For this feature to be effective for bodies that can move at a significant velocity, the user should raise the flag PxRigidBodyFlag::eENABLE_CCD for them. This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: False See Also PxRigidBodyFlag::eENABLE_CCD, PxPairFlag::eDETECT_CCD_CONTACT, eENABLE_CCD
eADAPTIVE_FORCE	Enable adaptive forces to accelerate convergence of the solver. Note This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: false
eENABLE_KINEMATIC_STATIC_PAIRS	Enable contact pair filtering between kinematic and static rigid bodies. By default contacts between kinematic and static rigid bodies are suppressed (see PxFilterFlag::eSUPPRESS) and don't get reported to the filter mechanism. Raise this flag if these pairs should go through the filtering pipeline nonetheless. Note This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: false
eENABLE_KINEMATIC_PAIRS	Enable contact pair filtering between kinematic rigid bodies. By default contacts between kinematic bodies are suppressed (see PxFilterFlag::eSUPPRESS) and don't get reported to the filter mechanism. Raise this flag if these pairs should go through the filtering pipeline nonetheless. Note This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: false
eENABLE_PCM	Enable GJK-based distance collision detection system. Note This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: false
eDISABLE_CONTACT_REPORT_BUFFER_RESIZE	Disable contact report buffer resize. Once the contact buffer is full, the rest of the contact reports will not be buffered and sent. Note This flag is not mutable, and must be set in PxSceneDesc at scene creation. Default: false
eDISABLE_CONTACT_CACHE	Disable contact cache. Contact caches are used internally to provide faster contact generation. You can disable all contact caches if memory usage for this feature becomes too high. Default: false
eREQUIRE_RW_LOCK	Require scene-level locking. When set to true this requires that threads accessing the PxScene use the multi-threaded lock methods. Note This flag is not mutable, and must be set in PxSceneDesc at scene creation. See Also PxScene::lockRead PxScene::unlockRead PxScene::lockWrite PxScene::unlockWrite Default: false
eENABLE_STABILIZATION	Enables additional stabilization pass in solver. When set to true, this enables additional stabilization processing to improve that stability of complex interactions between large numbers of bodies. Note that this flag is not mutable and must be set in PxSceneDesc at scene creation. Also, this is an experimental feature which does result in some loss of momentum.
eENABLE_AVERAGE_POINT	Enables average points in contact manifolds. When set to true, this enables additional contacts to be generated per manifold to represent the average point in a manifold. This can stabilize stacking when only a small number of solver iterations is used. Note that this flag is not mutable and must be set in PxSceneDesc at scene creation.

---

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

• PxSceneDesc.h