.. _omni_physx_graph_SceneQuerySweepBoxAll_2:

.. _omni_physx_graph_SceneQuerySweepBoxAll:

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

:orphan:

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


Sweep, Box, All
===============

.. <description>

Outputs the rigid bodies and colliders that are 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]']``", "Ray direction vector", "None"
    "Exec In (*inputs:execIn*)", "``execution``", "Input execution", "None"
    "Origin (*inputs:origin*)", "``['pointd[3]', 'pointf[3]']``", "Ray origin", "None"
    "Rotation (*inputs:rotation*)", "``['double[3]', 'float[3]']``", "Box rotation in XYZ order Euler angles.", "None"
    "Sort By Distance (*inputs:sortByDistance*)", "``bool``", "Enable to sort outputs by distance.", "False"
    "Distance (*inputs:sweepRange*)", "``['double', 'float']``", "Sweep 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 Prims (*outputs:bodyPrims*)", "``target``", "A list of the associated body prims for the collider prims that are hit by the sweep.", "None"
    "Collider Prims (*outputs:colliderPrims*)", "``target``", "A list of collider prims that are hit by the sweep.", "None"
    "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"
    "Material Prims (*outputs:materialPrims*)", "``target``", "A list of physics material Prims at 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"


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

    "Unique ID", "omni.physx.graph.SceneQuerySweepBoxAll"
    "Version", "2"
    "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, All"
    "__tokens", "{}"
    "Categories", "PhysX Scene Queries"
    "Generated Class Name", "OgnPhysXSceneQuerySweepBoxAllDatabase"
    "Python Module", "omni.physxgraph"

