.. _omni_graph_nodes_RandomUnitQuaternion_1:

.. _omni_graph_nodes_RandomUnitQuaternion:

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

:orphan:

.. meta::
    :title: Random Unit Quaternion
    :keywords: lang-en omnigraph node math:operator threadsafe nodes random-unit-quaternion


Random Unit Quaternion
======================

.. <description>

Generates a random unit quaternion with uniform distribution.

.. </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

    "inputs:execIn", "``execution``", "The input execution port to output a new random value", "None"
    "Is noise function (*inputs:isNoise*)", "``bool``", "Turn this node into a noise generator function For a given seed, it will then always output the same number(s)", "False"
    "", "*hidden*", "true", ""
    "", "*literalOnly*", "1", ""
    "Seed (*inputs:seed*)", "``uint64``", "The seed of the random generator.", "None"
    "Use seed (*inputs:useSeed*)", "``bool``", "Use the custom seed instead of a random one", "False"


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

    "outputs:execOut", "``execution``", "The output execution port", "None"
    "Random Unit Quaternion (*outputs:random*)", "``quatf[4]``", "The random unit quaternion that was generated", "None"


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

    "state:gen", "``matrixd[3]``", "Random number generator internal state (abusing matrix3d because it is large enough)", "None"


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

    "Unique ID", "omni.graph.nodes.RandomUnitQuaternion"
    "Version", "1"
    "Extension", "omni.graph.nodes"
    "Has State?", "True"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "Random Unit Quaternion"
    "Categories", "math:operator"
    "Generated Class Name", "OgnRandomUnitQuaternionDatabase"
    "Python Module", "omni.graph.nodes"

