.. _omni_physx_graph_SceneQuerySweepBoxClosest_1:

.. _omni_physx_graph_SceneQuerySweepBoxClosest:

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

:orphan:

.. meta::
    :title: Sweep, Box, Closest
    :keywords: lang-en omnigraph node PhysX Scene Queries graph scene-query-sweep-box-closest


Sweep, Box, Closest
===================

.. <description>

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

.. </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 colliders should be included in checks.", "False"
    "Dimensions (*inputs:dimensions*)", "``['double[3]', 'float[3]']``", "Box dimensions", "None"
    "Direction (*inputs:direction*)", "``['vectord[3]', 'vectorf[3]']``", "Sweep direction vector", "None"
    "Exec In (*inputs:execIn*)", "``execution``", "Input execution", "None"
    "Origin (*inputs:origin*)", "``['pointd[3]', 'pointf[3]']``", "Sweep origin", "None"
    "Rotation (*inputs:rotation*)", "``['double[3]', 'float[3]']``", "Box rotation in XYZ order Euler angles.", "None"
    "Distance (*inputs:sweepRange*)", "``['double', 'float']``", "Sweep maximum distance. Use negative for infinite. If omitted, infinity is used.", "None"


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

    "Body Prim (*outputs:bodyPrim*)", "``target``", "Associated body prim of the closest collider prim hit by the sweep.", "None"
    "Collider Prim (*outputs:colliderPrim*)", "``target``", "Closest collider prim that is hit by the sweep.", "None"
    "Hit Distance (*outputs:distance*)", "``float``", "The distance from the origin to the point hit.", "None"
    "Exec Out (*outputs:execOut*)", "``execution``", "Output execution", "None"
    "Face Index (*outputs:faceIndex*)", "``int``", "The face index of the point hit.", "None"
    "Hit (*outputs:hit*)", "``bool``", "Returns true if any colliders are hit by the sweep.", "None"
    "Material Prim (*outputs:materialPrim*)", "``target``", "Physics material Prim at the point hit.", "None"
    "Normal (*outputs:normal*)", "``normalf[3]``", "The surface normal of the point hit.", "None"
    "Position (*outputs:position*)", "``pointf[3]``", "The position of the point hit.", "None"


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

    "Unique ID", "omni.physx.graph.SceneQuerySweepBoxClosest"
    "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,collision"
    "uiName", "Sweep, Box, Closest"
    "__tokens", "{}"
    "Categories", "PhysX Scene Queries"
    "Generated Class Name", "OgnPhysXSceneQuerySweepBoxClosestDatabase"
    "Python Module", "omni.physxgraph"

