.. _omni_graph_ImportUSDPrim_1:

.. _omni_graph_ImportUSDPrim:

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

:orphan:

.. meta::
    :title: import USD prim data
    :keywords: lang-en omnigraph node graph import-u-s-d-prim


import USD prim data
====================

.. <description>

Imports data from a USD prim into attributes in an output bundle

.. </description>


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

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


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

    "inputs:applySkelBinding", "``bool``", "If the input USD prim is a Mesh, and has SkelBindingAPI schema applied, compute skinned points and normals.", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:applyTransform", "``bool``", "If importAttributes is true, apply the transform necessary to transform any transforming attributes into the space of this node.", "False"
    "", "*displayGroup*", "parameters", ""
    "Attributes To Import (*inputs:attrNamesToImport*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be imported  or empty to import all attributes.", ""
    "", "*displayGroup*", "parameters", ""
    "inputs:computeBoundingBox", "``bool``", "Compute and store local bounding box of a prim and its children.", "False"
    "", "*displayGroup*", "parameters", ""
    "inputs:importAttributes", "``bool``", "Import attribute data from the USD prim.", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:importPath", "``bool``", "Record the input USD prim's path into the output bundle in an attribute named ""primPath"".", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:importPrimvarMetadata", "``bool``", "Import metadata like the interpolation type for primvars, and store it as attributes in the output bundle.", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:importTime", "``bool``", "Record the usdTimecode above into the output bundle in an attribute named ""primTime"".", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:importTransform", "``bool``", "Record the transform required to take any attributes of the input USD prim  into the space of this node, i.e. the world transform of the input prim times the  inverse world transform of this node, into the output bundle in an attribute named ""transform"".", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:importType", "``bool``", "Deprecated, prim type is always imported", "True"
    "", "*hidden*", "true", ""
    "", "*displayGroup*", "parameters", ""
    "Attributes To Rename (*inputs:inputAttrNames*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be renamed", ""
    "inputs:keepPrimsSeparate", "``bool``", "Prefix output attribute names with ""prim"" followed by a unique number and a colon,  to keep the attributes for separate input prims separate.  The prim paths will  be in the ""primPaths"" token array attribute.", "True"
    "", "*displayGroup*", "parameters", ""
    "New Attribute Names (*inputs:outputAttrNames*)", "``token``", "Comma or space separated text, listing the new names for the attributes listed in inputAttrNames", ""
    "inputs:prim", "``bundle``", "The USD prim from which to import data.", "None"
    "inputs:renameAttributes", "``bool``", "If true, attributes listed in ""inputAttrNames"" will be imported to attributes with the names specified in ""outputAttrNames"".", "False"
    "", "*displayGroup*", "parameters", ""
    "inputs:timeVaryingAttributes", "``bool``", "Check whether the USD attributes are time-varying and if so, import their data at the time ""usdTimecode"".", "True"
    "", "*displayGroup*", "parameters", ""
    "inputs:usdTimecode", "``double``", "The time at which to evaluate the transform of the USD prim.", "0"
    "", "*displayGroup*", "parameters", ""


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

    "outputs:output", "``bundle``", "Output bundle containing all of the imported data.", "None"


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

    "state:prevApplySkelBinding", "``bool``", "Value of ""applySkelBinding"" input from previous run", "None"
    "state:prevApplyTransform", "``bool``", "Value of ""applyTransform"" input from previous run", "None"
    "state:prevAttrNamesToImport", "``token``", "Value of ""attrNamesToImport"" input from previous run", "None"
    "state:prevComputeBoundingBox", "``bool``", "Value of ""computeBoundingBox"" input from previous run", "None"
    "state:prevImportAttributes", "``bool``", "Value of ""importAttributes"" input from previous run", "None"
    "state:prevImportPath", "``bool``", "Value of ""importPath"" input from previous run", "None"
    "state:prevImportPrimvarMetadata", "``bool``", "Value of ""importPrimvarMetadata"" input from previous run", "None"
    "state:prevImportTime", "``bool``", "Value of ""importTime"" input from previous run", "None"
    "state:prevImportTransform", "``bool``", "Value of ""importTransform"" input from previous run", "None"
    "state:prevImportType", "``bool``", "Value of ""importType"" input from previous run", "None"
    "state:prevInputAttrNames", "``token``", "Value of ""inputAttrNames"" input from previous run", "None"
    "state:prevInvNodeTransform", "``matrixd[4]``", "Inverse transform of the node prim from the previous run.", "None"
    "state:prevKeepPrimsSeparate", "``bool``", "Value of ""keepPrimsSeparate"" input from previous run", "None"
    "state:prevOnlyImportSpecified", "``bool``", "Value of ""onlyImportSpecified"" input from previous run", "None"
    "state:prevOutputAttrNames", "``token``", "Value of ""outputAttrNames"" input from previous run", "None"
    "state:prevPaths", "``token[]``", "Array of paths from the previous run.", "None"
    "state:prevRenameAttributes", "``bool``", "Value of ""renameAttributes"" input from previous run", "None"
    "state:prevTimeVaryingAttributes", "``bool``", "Value of ""timeVaryingAttributes"" input from previous run", "None"
    "state:prevTransforms", "``matrixd[4][]``", "Array of transforms from the previous run.", "None"
    "state:prevUsdTimecode", "``double``", "Value of ""usdTimecode"" input from previous run", "None"


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

    "Unique ID", "omni.graph.ImportUSDPrim"
    "Version", "1"
    "Extension", "omni.graph.io"
    "Icon", "ogn/icons/omni.graph.ImportUSDPrim.svg"
    "Has State?", "True"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "import USD prim data"
    "Generated Class Name", "OgnImportUSDPrimDatabase"
    "Python Module", "omni.graph.io"

