Module de.fabmax.physxjni
Package physx.physics

Enum Class PxFilterFlagEnum

java.lang.Object
java.lang.Enum<PxFilterFlagEnum>
physx.physics.PxFilterFlagEnum
All Implemented Interfaces:
Serializable, Comparable<PxFilterFlagEnum>, Constable
public enum PxFilterFlagEnum extends Enum<PxFilterFlagEnum>
Collection of flags describing the filter actions to take for a collision pair.

See also: PxFilterFlags PxSimulationFilterShader PxSimulationFilterCallback

  • Enum Constant Details

    • eKILL

      public static final PxFilterFlagEnum eKILL
      Ignore the collision pair as long as the bounding volumes of the pair objects overlap.

      Killed pairs will be ignored by the simulation and won't run through the filter again until one of the following occurs:

      \li The bounding volumes of the two objects overlap again (after being separated) \li The user enforces a re-filtering (see #PxScene::resetFiltering())

      See also: PxScene::resetFiltering()

    • eSUPPRESS

      public static final PxFilterFlagEnum eSUPPRESS
      Ignore the collision pair as long as the bounding volumes of the pair objects overlap or until filtering relevant data changes for one of the collision objects.

      Suppressed pairs will be ignored by the simulation and won't make another filter request until one of the following occurs:

      \li Same conditions as for killed pairs (see #eKILL) \li The filter data or the filter object attributes change for one of the collision objects

      See also: PxFilterData PxFilterObjectAttributes

    • eCALLBACK

      public static final PxFilterFlagEnum eCALLBACK
      Invoke the filter callback (#PxSimulationFilterCallback::pairFound()) for this collision pair.

      See also: PxSimulationFilterCallback

    • eNOTIFY

      public static final PxFilterFlagEnum eNOTIFY
      Track this collision pair with the filter callback mechanism.

      When the bounding volumes of the collision pair lose contact, the filter callback #PxSimulationFilterCallback::pairLost() will be invoked. Furthermore, the filter status of the collision pair can be adjusted through #PxSimulationFilterCallback::statusChange() once per frame (until a pairLost() notification occurs).

      See also: PxSimulationFilterCallback

    • eDEFAULT

      public static final PxFilterFlagEnum eDEFAULT
      Provided default to get standard behavior:

      The application configure the pair's collision properties once when bounding volume overlap is found and doesn't get asked again about that pair until overlap status or filter properties changes, or re-filtering is requested.

      No notification is provided when bounding volume overlap is lost

      The pair will not be killed or suppressed, so collision detection will be processed

  • Field Details

    • value

      public final int value

  • Method Details

    • values

      public static PxFilterFlagEnum[] 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 PxFilterFlagEnum 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 PxFilterFlagEnum forValue(int value)