Module de.fabmax.physxjni
Package physx.physics

Enum Class PxSceneFlagEnum

java.lang.Object
java.lang.Enum<PxSceneFlagEnum>
physx.physics.PxSceneFlagEnum
All Implemented Interfaces:
Serializable, Comparable<PxSceneFlagEnum>, Constable
public enum PxSceneFlagEnum extends Enum<PxSceneFlagEnum>
flags for configuring properties of the scene

See also: PxScene

  • Enum Constant Details

    • eENABLE_ACTIVE_ACTORS

      public static final PxSceneFlagEnum eENABLE_ACTIVE_ACTORS
      Enable Active Actors Notification.

      This flag enables the Active Actor Notification feature for a scene. This feature defaults to disabled. When disabled, the function PxScene::getActiveActors() will always return a NULL list.

      Note: There may be a performance penalty for enabling the Active Actor Notification, hence this flag should only be enabled if the application intends to use the feature.

      Default: False

    • eENABLE_CCD

      public static final PxSceneFlagEnum 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. Note: 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

      public static final PxSceneFlagEnum 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. 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. Note: 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

    • eENABLE_PCM

      public static final PxSceneFlagEnum 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: true

    • eDISABLE_CONTACT_REPORT_BUFFER_RESIZE

      public static final PxSceneFlagEnum 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

      public static final PxSceneFlagEnum 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.

      Note: This flag is not mutable, and must be set in PxSceneDesc at scene creation.

      Default: false

    • eREQUIRE_RW_LOCK

      public static final PxSceneFlagEnum 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 See also: PxScene::unlockRead See also: PxScene::lockWrite See also: PxScene::unlockWrite

      Default: false

    • eENABLE_STABILIZATION

      public static final PxSceneFlagEnum 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

      public static final PxSceneFlagEnum 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.

    • eEXCLUDE_KINEMATICS_FROM_ACTIVE_ACTORS

      public static final PxSceneFlagEnum eEXCLUDE_KINEMATICS_FROM_ACTIVE_ACTORS
      Do not report kinematics in list of active actors.

      Since the target pose for kinematics is set by the user, an application can track the activity state directly and use this flag to avoid that kinematics get added to the list of active actors.

      Note: This flag has only an effect in combination with eENABLE_ACTIVE_ACTORS.

      See also: eENABLE_ACTIVE_ACTORS

      Default: false

    • eENABLE_GPU_DYNAMICS

      public static final PxSceneFlagEnum eENABLE_GPU_DYNAMICS

    • eENABLE_ENHANCED_DETERMINISM

      public static final PxSceneFlagEnum eENABLE_ENHANCED_DETERMINISM
      Provides improved determinism at the expense of performance.

      By default, PhysX provides limited determinism guarantees. Specifically, PhysX guarantees that the exact scene (same actors created in the same order) and simulated using the same time-stepping scheme should provide the exact same behaviour.

      However, if additional actors are added to the simulation, this can affect the behaviour of the existing actors in the simulation, even if the set of new actors do not interact with the existing actors.

      This flag provides an additional level of determinism that guarantees that the simulation will not change if additional actors are added to the simulation, provided those actors do not interfere with the existing actors in the scene. Determinism is only guaranteed if the actors are inserted in a consistent order each run in a newly-created scene and simulated using a consistent time-stepping scheme.

      Note that this flag is not mutable and must be set at scene creation.

      Note that enabling this flag can have a negative impact on performance.

      Note that this feature is not currently supported on GPU.

      Default false

    • eENABLE_FRICTION_EVERY_ITERATION

      public static final PxSceneFlagEnum eENABLE_FRICTION_EVERY_ITERATION
      Controls processing friction in all solver iterations

      By default, PhysX processes friction only in the final 3 position iterations, and all velocity iterations. This flag enables friction processing in all position and velocity iterations.

      The default behaviour provides a good trade-off between performance and stability and is aimed primarily at game development.

      When simulating more complex frictional behaviour, such as grasping of complex geometries with a robotic manipulator, better results can be achieved by enabling friction in all solver iterations.

      Note: This flag only has effect with the default solver. The TGS solver always performs friction per-iteration.

    • eENABLE_DIRECT_GPU_API

      public static final PxSceneFlagEnum eENABLE_DIRECT_GPU_API

    • eMUTABLE_FLAGS

      public static final PxSceneFlagEnum eMUTABLE_FLAGS

  • Field Details

    • value

      public final int value

  • Method Details

    • values

      public static PxSceneFlagEnum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PxSceneFlagEnum valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forValue

      public static PxSceneFlagEnum forValue(int value)