.. _omni_graph_nodes_RpResourceExampleDeformer_1:

.. _omni_graph_nodes_RpResourceExampleDeformer:

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

:orphan:

.. meta::
    :title: RpResource Example Deformer Node
    :keywords: lang-en omnigraph node nodes rp-resource-example-deformer


RpResource Example Deformer Node
================================

.. <description>

Allocate CUDA-interoperable RpResource

.. </description>


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

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


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

    "Deform Scale (*inputs:deformScale*)", "``float``", "Deformation control", "1.0"
    "Displacement Axis (*inputs:displacementAxis*)", "``int``", "dimension in which mesh is translated", "0"
    "Point Counts (*inputs:pointCountCollection*)", "``uint64[]``", "Pointer to point counts collection", "[]"
    "Position Scale (*inputs:positionScale*)", "``float``", "Deformation control", "1.0"
    "Prim Paths (*inputs:primPathCollection*)", "``token[]``", "Pointer to prim path collection", "[]"
    "Resource Pointer Collection (*inputs:resourcePointerCollection*)", "``uint64[]``", "Pointer to RpResource collection", "[]"
    "Run Deformer (*inputs:runDeformerKernel*)", "``bool``", "Whether cuda kernel will be executed", "True"
    "stream (*inputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "0"
    "Time Scale (*inputs:timeScale*)", "``float``", "Deformation control", "0.01"
    "Verbose (*inputs:verbose*)", "``bool``", "verbose printing", "False"


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

    "Point Counts (*outputs:pointCountCollection*)", "``uint64[]``", "Point count for each prim being deformed", "None"
    "Prim Paths (*outputs:primPathCollection*)", "``token[]``", "Path for each prim being deformed", "None"
    "Reload (*outputs:reload*)", "``bool``", "Force RpResource reload", "False"
    "Resource Pointer Collection (*outputs:resourcePointerCollection*)", "``uint64[]``", "Pointers to RpResources  (two resources per prim are assumed -- one for rest positions and one for deformed positions)", "None"
    "stream (*outputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "None"


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

    "state:sequenceCounter", "``uint64``", "tick counter for animation", "0"


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

    "Unique ID", "omni.graph.nodes.RpResourceExampleDeformer"
    "Version", "1"
    "Extension", "omni.graph.nodes"
    "Has State?", "True"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "RpResource Example Deformer Node"
    "__tokens", "{""points"": ""points"", ""transform"": ""transform"", ""rpResource"": ""rpResource"", ""pointCount"": ""pointCount"", ""primPath"": ""primPath"", ""testToken"": ""testToken"", ""uintData"": ""uintData""}"
    "Generated Class Name", "OgnRpResourceExampleDeformerDatabase"
    "Python Module", "omni.graph.nodes"

