.. _omni_physx_graph_ImmediateComputeGeometryRaycastHits_1:

.. _omni_physx_graph_ImmediateComputeGeometryRaycastHits:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: Compute Geometry Raycast Hits
    :keywords: lang-en omnigraph node PhysX Immediate Queries WriteOnly graph immediate-compute-geometry-raycast-hits


Compute Geometry Raycast Hits
=============================

.. <description>

Compute geometry intersections with an input ray (currently supports mesh prims)

.. </description>


Installation
------------

To use this node enable :ref:`omni.physx.graph<ext_omni_physx_graph>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Both sides (*inputs:bothSides*)", "``bool``", "Sets whether backfaces of meshes should be included in checks.", "False"
    "Direction (*inputs:direction*)", "``['vectord[3]', 'vectorf[3]']``", "Ray direction vector", "None"
    "Exec In (*inputs:execIn*)", "``execution``", "Input execution", "None"
    "Origin (*inputs:origin*)", "``['pointd[3]', 'pointf[3]']``", "Ray origin", "None"
    "Prims (*inputs:prims*)", "``target``", "Prims of interest (currently only supports mesh prims).  Note: if this input is present, the Prims bundle input is ignored.", "None"
    "", "Metadata", "*allowMultiInputs* = 1", ""
    "Prims bundle (optional) (*inputs:primsBundle*)", "``bundle``", "The prims of interest as a bundle. It must be a bundle with one or more prim children. Currently only meshes prim are supported (sourcePrimType == 'Mesh'). From each Mesh prim child reads:  - 'sourcePrimPath'  - 'sourcePrimType'  - 'points'  - 'faceVertexIndices'  - 'faceVertexCounts'  - 'worldMatrix'  - 'sourcePrimPath' (and optionally 'holeIndices', 'orientation', 'meshKey' and 'physics:approximation') attributes", "None"
    "Distance (*inputs:raycastRange*)", "``['double', 'float']``", "Raycast distance. Use negative for infinite. If omitted, infinity is used.", "None"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Hit distances (*outputs:distances*)", "``float[]``", "A list of distances from the origin to the points hit.", "None"
    "Exec Out (*outputs:execOut*)", "``execution``", "Output execution", "None"
    "Face Indexes (*outputs:faceIndexes*)", "``int[]``", "A list of the face indexes of the points hit.", "None"
    "Normals (*outputs:normals*)", "``normalf[3][]``", "A list of surface normals of the points hit.", "None"
    "Positions (*outputs:positions*)", "``pointf[3][]``", "A list of positions of the points hit.", "None"
    "Prims hit (*outputs:primsHit*)", "``target``", "A list of prims that are hit by the input ray.", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.physx.graph.ImmediateComputeGeometryRaycastHits"
    "Version", "1"
    "Extension", "omni.physx.graph"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "python, tests"
    "tags", "physics,physx,simulation,raycast,broadphase,immediate"
    "uiName", "Compute Geometry Raycast Hits"
    "__tokens", "{}"
    "Categories", "PhysX Immediate Queries"
    "Generated Class Name", "OgnPhysXImmediateComputeGeometryRaycastHitsDatabase"
    "Python Module", "omni.physxgraph"

