Overlap, Prim, All

Returns a list of prim paths of all colliders that overlap the input Prim.

It also provides you with the paths to the physics bodies that the colliders belong to.

The input Prim must either be a geometric shape or a convex mesh.

Note

This node is based on PhysX Scene Queries, benefitting from the fast performance of PhysX collision detection, but it will only detect physics colliders and only when simulation is active.

Installation

To use this Node, you must enable omni.physx.graph in the Extension Manager.

Inputs

Name	Type	Description	Default
execIn	execution	Input execution
Prim Path (primPath)	token	Prim path to check against. This must be a geometric type (UsdGeom).

Outputs

Name	Type	Description	Default
execOut	execution	Output execution
Collider Prim paths (colliderPrimPaths)	token[]	A list of paths of the collider prims that overlap the input Prim.
bodyPrimPaths	token[]	A list of paths of the associated body prims for the collider prims that overlap the input Prim.

Note

The node has an execution in and out connecter to allow you to control exactly when in the graph execution chain that the scene query will be processed, thereby avoiding redundant executions. However, to guarantee that the output data is current, make sure that any other nodes reading it are later in the execution chain, i.e. belong to a node tree connected to the node execution out.

For examples of concrete use of scene query nodes within an ActionGraph, see the OmniGraph demos in the physics demo scenes under Scene Query.