PxSceneQueryUpdateMode Struct Reference
[Physics]

Scene query update mode. More...

#include <PxSceneDesc.h>

List of all members.

Public Types
enum	Enum {   eBUILD_ENABLED_COMMIT_ENABLED,   eBUILD_ENABLED_COMMIT_DISABLED,   eBUILD_DISABLED_COMMIT_DISABLED }

---

Detailed Description

Scene query update mode.

When PxScene::fetchResults is called it does scene query related work, with this enum it is possible to set what work is done during the fetchResults.

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

eCOMMIT_ENABLED_BUILD_ENABLED does allow to execute the new AABB tree build step during fetchResults, 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.

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

eCOMMIT_DISABLED_BUILD_DISABLED no further scene query work is executed. The scene queries update needs to be called manually, see PxScene::sceneQueriesUpdate. It is recommended to call PxScene::sceneQueriesUpdate right after fetchResults as the pruning structures are not updated.

---

Member Enumeration Documentation

enum PxSceneQueryUpdateMode::Enum

Enumerator:

eBUILD_ENABLED_COMMIT_ENABLED	Both scene query build and commit are executed.
eBUILD_ENABLED_COMMIT_DISABLED	Scene query build only is executed.
eBUILD_DISABLED_COMMIT_DISABLED	No work is done, no update of scene queries.

---

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

• PxSceneDesc.h