Raycast, Closest

Finds the closest collider that is hit by the input ray.

It also provides you with detailed information about the exact point where the collider intersects with the input ray as well as the path to the physics body that the collider belong to.

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
Origin (origin)	pointf[3], pointd[3]	Ray origin
Direction (direction)	vectorf[3], vectord[3]	Ray direction vector
Distance (raycastRange)	float, double	Raycast distance. Use negative for infinite. If omitted, infinity is used.
Both Sides (bothSides)	bool	Sets whether backfaces of colliders should be included in checks.	False

Outputs

Name	Type	Description	Default
execOut	execution	Output execution
hit	bool	Returns true if any colliders are hit by the input ray.
Collider Prim path (colliderPrimPath)	token	Path of the closest collider prim that is hit by the input ray.
bodyPrimPath	token	Path of the associated body prim of the closest collider prim hit by the input ray.
position	pointf[3]	The position of the point hit.
normal	normalf[3]	The surface normal of the point hit.
Hit Distance (distance)	float	The distance from the origin to the point hit.
faceIndex	int	The face index of the point hit.
materialPath	token	Path of the physics material at the point hit.

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.