.. _omni_graph_action_Gate_1:

.. _omni_graph_action_Gate:

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

:orphan:

.. meta::
    :title: Gate
    :keywords: lang-en omnigraph node graph:action,flowControl threadsafe action gate


Gate
====

.. <description>

This node controls a flow of execution based on the state of its gate. The gate can be opened or closed by execution pulses sent to the gate controls

.. </description>


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

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


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

    "Enter (*inputs:enter*)", "``execution``", "Incoming execution flow controlled by the gate", "None"
    "Start Closed (*inputs:startClosed*)", "``bool``", "If true the gate will start in a closed state", "False"
    "Toggle (*inputs:toggle*)", "``execution``", "The gate is opened or closed", "None"


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

    "Exit (*outputs:exit*)", "``execution``", "The enter pulses will be passed to this output if the gate is open", "None"


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

    "Unique ID", "omni.graph.action.Gate"
    "Version", "1"
    "Extension", "omni.graph.action"
    "Icon", "ogn/icons/omni.graph.action.Gate.svg"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "Gate"
    "Categories", "graph:action,flowControl"
    "Generated Class Name", "OgnGateDatabase"
    "Python Module", "omni.graph.action"

