.. _omni_graph_nodes_Timer_2:

.. _omni_graph_nodes_Timer:

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

:orphan:

.. meta::
    :title: Timer
    :keywords: lang-en omnigraph node animation nodes timer


Timer
=====

.. <description>

Timer Node is a node that lets you create animation curve(s), plays back and samples the value(s) along its time to output values.

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

    "Duration (*inputs:duration*)", "``double``", "Number of seconds to play interpolation", "1.0"
    "End Value (*inputs:endValue*)", "``double``", "Value value of the end of the duration", "1.0"
    "Play (*inputs:play*)", "``execution``", "Play the clip from current frame", "None"
    "Start Value (*inputs:startValue*)", "``double``", "Value value of the start of the duration", "0.0"


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

    "Finished (*outputs:finished*)", "``execution``", "The Timer node has finished the playback", "None"
    "Updated (*outputs:updated*)", "``execution``", "The Timer node is ticked, and output value(s) resampled and updated", "None"
    "Value (*outputs:value*)", "``double``", "Value value of the Timer node between 0.0 and 1.0", "0.0"


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

    "Unique ID", "omni.graph.nodes.Timer"
    "Version", "2"
    "Extension", "omni.graph.nodes"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "Timer"
    "Categories", "animation"
    "__categoryDescriptions", "animation,Nodes dealing with Animation"
    "Generated Class Name", "OgnTimerDatabase"
    "Python Module", "omni.graph.nodes"

