.. _omni_graph_ui_nodes_Placer_1:

.. _omni_graph_ui_nodes_Placer:

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

:orphan:

.. meta::
    :title: Placer (BETA)
    :keywords: lang-en omnigraph node graph:action,ui ui_nodes placer


Placer (BETA)
=============

.. <description>

Contruct a Placer widget. The Placer takes a single child and places it at a given position within it.

.. </description>


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

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


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

    "Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
    "Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget.", ""
    "Position (*inputs:position*)", "``double[2]``", "Where to position the child widget within the Placer.", "[0.0, 0.0]"
    "inputs:style", "``string``", "Style to be applied to the Placer and its child. This can later be changed with the WriteWidgetStyle node.", "None"
    "Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"


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

    "Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
    "Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created Placer widget", "None"


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

    "Unique ID", "omni.graph.ui_nodes.Placer"
    "Version", "1"
    "Extension", "omni.graph.ui_nodes"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "tests"
    "uiName", "Placer (BETA)"
    "Categories", "graph:action,ui"
    "Generated Class Name", "OgnPlacerDatabase"
    "Python Module", "omni.graph.ui_nodes"

