Module de.fabmax.physxjni
Package physx.physics

Enum Class PxSceneQueryUpdateModeEnum

java.lang.Object
java.lang.Enum<PxSceneQueryUpdateModeEnum>
physx.physics.PxSceneQueryUpdateModeEnum
All Implemented Interfaces:
Serializable, Comparable<PxSceneQueryUpdateModeEnum>, Constable
public enum PxSceneQueryUpdateModeEnum extends Enum<PxSceneQueryUpdateModeEnum>
Scene query update mode

This enum controls what work is done when the scene query system is updated. The updates traditionally happen when PxScene::fetchResults is called. This function then calls PxSceneQuerySystem::finalizeUpdates, where the update mode is used.

fetchResults/finalizeUpdates will sync changed bounds during simulation and update the scene query bounds in pruners, this work is mandatory.

eBUILD_ENABLED_COMMIT_ENABLED does allow to execute the new AABB tree build step during fetchResults/finalizeUpdates, additionally the pruner commit is called where any changes are applied. During commit PhysX refits the dynamic scene query tree and if a new tree was built and the build finished the tree is swapped with current AABB tree.

eBUILD_ENABLED_COMMIT_DISABLED does allow to execute the new AABB tree build step during fetchResults/finalizeUpdates. Pruner commit is not called, this means that refit will then occur during the first scene query following fetchResults/finalizeUpdates, or may be forced by the method PxScene::flushQueryUpdates() / PxSceneQuerySystemBase::flushUpdates().

eBUILD_DISABLED_COMMIT_DISABLED no further scene query work is executed. The scene queries update needs to be called manually, see PxScene::sceneQueriesUpdate (see that function's doc for the equivalent PxSceneQuerySystem sequence). It is recommended to call PxScene::sceneQueriesUpdate right after fetchResults/finalizeUpdates as the pruning structures are not updated.

  • Enum Constant Details

    • eBUILD_ENABLED_COMMIT_ENABLED

      public static final PxSceneQueryUpdateModeEnum eBUILD_ENABLED_COMMIT_ENABLED
      Both scene query build and commit are executed.

    • eBUILD_ENABLED_COMMIT_DISABLED

      public static final PxSceneQueryUpdateModeEnum eBUILD_ENABLED_COMMIT_DISABLED
      Scene query build only is executed.

    • eBUILD_DISABLED_COMMIT_DISABLED

      public static final PxSceneQueryUpdateModeEnum eBUILD_DISABLED_COMMIT_DISABLED

  • Field Details

    • value

      public final int value

  • Method Details

    • values

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