file_path
stringlengths 32
153
| content
stringlengths 0
3.14M
|
|---|---|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantColor3f.rst | .. _omni_graph_nodes_ConstantColor3f_1:
.. _omni_graph_nodes_ConstantColor3f:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Color3F
:keywords: lang-en omnigraph node constants nodes constant-color3f
Constant Color3F
================
.. <description>
Holds a 3-component color constant, which is energy-linear RGB
.. </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
"Value (*inputs:value*)", "``colorf[3]``", "The constant value", "[0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantColor3f"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantColor3fDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTimer.rst | .. _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"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnDistance3D.rst | .. _omni_graph_nodes_Distance3D_1:
.. _omni_graph_nodes_Distance3D:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Distance3D
:keywords: lang-en omnigraph node math:operator threadsafe nodes distance3-d
Distance3D
==========
.. <description>
Computes the distance between two 3D points A and B. Which is the length of the vector with start and end points A and B If one input is an array and the other is a single point, the scaler will be broadcast to the size of the array
.. </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
"A (*inputs:a*)", "``['pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]']``", "Vector A", "None"
"B (*inputs:b*)", "``['pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]']``", "Vector B", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:distance", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]']``", "The distance between the input vectors", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Distance3D"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Distance3D"
"Categories", "math:operator"
"Generated Class Name", "OgnDistance3DDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetLocationAtDistanceOnCurve.rst | .. _omni_graph_nodes_GetLocationAtDistanceOnCurve_1:
.. _omni_graph_nodes_GetLocationAtDistanceOnCurve:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Locations At Distances On Curve
:keywords: lang-en omnigraph node internal threadsafe nodes get-location-at-distance-on-curve
Get Locations At Distances On Curve
===================================
.. <description>
DEPRECATED: Use GetLocationAtDistanceOnCurve2
.. </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
"Curve (*inputs:curve*)", "``pointd[3][]``", "The curve to be examined", "[]"
"Distances (*inputs:distance*)", "``double[]``", "The distances along the curve, wrapped to the range 0-1.0", "[]"
"Forward (*inputs:forwardAxis*)", "``token``", "The direction vector from which the returned rotation is relative, one of X, Y, Z", "X"
"Up (*inputs:upAxis*)", "``token``", "The world Up vector, the curve should be in a plane perpendicular with this - one of X, Y, Z", "Y"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Locations on curve at the given distances in world space (*outputs:location*)", "``pointd[3][]``", "Locations", "None"
"World space orientations of the curve at the given distances, may not be smooth for some curves (*outputs:orientation*)", "``quatf[4][]``", "Orientations", "None"
"World space rotations of the curve at the given distances, may not be smooth for some curves (*outputs:rotateXYZ*)", "``vectord[3][]``", "Rotations", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetLocationAtDistanceOnCurve"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Get Locations At Distances On Curve"
"__tokens", "[""x"", ""y"", ""z"", ""X"", ""Y"", ""Z""]"
"Categories", "internal"
"Generated Class Name", "OgnGetLocationAtDistanceOnCurveDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnSourceIndices.rst | .. _omni_graph_nodes_SourceIndices_1:
.. _omni_graph_nodes_SourceIndices:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Source Index Array
:keywords: lang-en omnigraph node math:operator threadsafe nodes source-indices
Extract Source Index Array
==========================
.. <description>
Takes an input array of index values in 'sourceStartsInTarget' encoded as the list of index values at which the output array value will be incremented, starting at the second entry, and with the last entry into the array being the desired sized of the output array 'sourceIndices'. For example the input [1,2,3,5,6,6] would generate an output array of size 5 (last index) consisting of the values [0,0,2,3,3,3]:
- the first two 0s to fill the output array up to index input[1]=2
- the first two 0s to fill the output array up to index input[1]=2
- the 2 to fill the output array up to index input[2]=3
- the three 3s to fill the output array up to index input[3]=6
.. </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:sourceStartsInTarget", "``int[]``", "List of index values encoding the increments for the output array values", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:sourceIndices", "``int[]``", "Decoded list of index values as described by the node algorithm", "[]"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SourceIndices"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Source Index Array"
"Categories", "math:operator"
"Generated Class Name", "OgnSourceIndicesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantUChar.rst | .. _omni_graph_nodes_ConstantUChar_1:
.. _omni_graph_nodes_ConstantUChar:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant UChar
:keywords: lang-en omnigraph node constants nodes constant-u-char
Constant UChar
==============
.. <description>
Holds an 8-bit unsigned character value
.. </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
"Value (*inputs:value*)", "``uchar``", "The constant value", "0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantUChar"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Constant UChar"
"Categories", "constants"
"Generated Class Name", "OgnConstantUCharDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadKeyboardState.rst | .. _omni_graph_nodes_ReadKeyboardState_1:
.. _omni_graph_nodes_ReadKeyboardState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Keyboard State
:keywords: lang-en omnigraph node input:keyboard threadsafe nodes read-keyboard-state
Read Keyboard State
===================
.. <description>
Reads the current state of the keyboard
.. </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
"Key (*inputs:key*)", "``token``", "The key to check the state of", "A"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,Apostrophe,Backslash,Backspace,CapsLock,Comma,Del,Down,End,Enter,Equal,Escape,F1,F10,F11,F12,F2,F3,F4,F5,F6,F7,F8,F9,GraveAccent,Home,Insert,Key0,Key1,Key2,Key3,Key4,Key5,Key6,Key7,Key8,Key9,Left,LeftAlt,LeftBracket,LeftControl,LeftShift,LeftSuper,Menu,Minus,NumLock,Numpad0,Numpad1,Numpad2,Numpad3,Numpad4,Numpad5,Numpad6,Numpad7,Numpad8,Numpad9,NumpadAdd,NumpadDel,NumpadDivide,NumpadEnter,NumpadEqual,NumpadMultiply,NumpadSubtract,PageDown,PageUp,Pause,Period,PrintScreen,Right,RightAlt,RightBracket,RightControl,RightShift,RightSuper,ScrollLock,Semicolon,Slash,Space,Tab,Up", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Alt (*outputs:altOut*)", "``bool``", "True if Alt is held", "None"
"Ctrl (*outputs:ctrlOut*)", "``bool``", "True if Ctrl is held", "None"
"outputs:isPressed", "``bool``", "True if the key is currently pressed, false otherwise", "None"
"Shift (*outputs:shiftOut*)", "``bool``", "True if Shift is held", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadKeyboardState"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Keyboard State"
"Categories", "input:keyboard"
"Generated Class Name", "OgnReadKeyboardStateDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToFloat.rst | .. _omni_graph_nodes_ToFloat_1:
.. _omni_graph_nodes_ToFloat:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Float
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-float
To Float
========
.. <description>
Converts the given input to 32 bit float. The node will attempt to convert array and tuple inputs to floats of the same shape
.. </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
"value (*inputs:value*)", "``['bool', 'bool[]', 'colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numeric value to convert to float", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Float (*outputs:converted*)", "``['float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]']``", "Output float scaler or array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToFloat"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Float"
"Categories", "math:conversion"
"Generated Class Name", "OgnToFloatDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantInt4.rst | .. _omni_graph_nodes_ConstantInt4_1:
.. _omni_graph_nodes_ConstantInt4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Int4
:keywords: lang-en omnigraph node constants nodes constant-int4
Constant Int4
=============
.. <description>
Holds a 4-component int constant.
.. </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
"Value (*inputs:value*)", "``int[4]``", "The constant value", "[0, 0, 0, 0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantInt4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantInt4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToDouble.rst | .. _omni_graph_nodes_ToDouble_1:
.. _omni_graph_nodes_ToDouble:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Double
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-double
To Double
=========
.. <description>
Converts the given input to 64 bit double. The node will attempt to convert array and tuple inputs to doubles of the same shape
.. </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
"value (*inputs:value*)", "``['bool', 'bool[]', 'colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numeric value to convert to double", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Double (*outputs:converted*)", "``['double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]']``", "Output double-based value", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToDouble"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Double"
"Categories", "math:conversion"
"Generated Class Name", "OgnToDoubleDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTranslateToTarget.rst | .. _omni_graph_nodes_TranslateToTarget_2:
.. _omni_graph_nodes_TranslateToTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Translate To Target
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes translate-to-target
Translate To Target
===================
.. <description>
This node smoothly translates a prim object to a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the same translation as the target prim
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:sourcePrim", "``target``", "The source prim to be transformed", "None"
"inputs:sourcePrimPath", "``path``", "The source prim to be transformed, used when 'useSourcePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"inputs:targetPrim", "``bundle``", "The destination prim. The target's translation will be matched by the sourcePrim", "None"
"inputs:targetPrimPath", "``path``", "The destination prim. The target's translation will be matched by the sourcePrim, used when 'useTargetPath' is true", "None"
"inputs:useSourcePath", "``bool``", "When true, the 'sourcePrimPath' attribute is used, otherwise it will read the connection at the 'sourcePrim' attribute", "False"
"inputs:useTargetPath", "``bool``", "When true, the 'targetPrimPath' attribute is used, otherwise it will read the connection at the 'targetPrim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.TranslateToTarget"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Translate To Target"
"Categories", "sceneGraph"
"Generated Class Name", "OgnTranslateToTargetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetLocationAtDistanceOnCurve2.rst | .. _omni_graph_nodes_GetLocationAtDistanceOnCurve2_1:
.. _omni_graph_nodes_GetLocationAtDistanceOnCurve2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Locations At Distances On Curve
:keywords: lang-en omnigraph node internal threadsafe nodes get-location-at-distance-on-curve2
Get Locations At Distances On Curve
===================================
.. <description>
Given a set of curve points and a normalized distance between 0-1.0, return the location on a closed curve. 0 is the first point on the curve, 1.0 is also the first point because the is an implicit segment connecting the first and last points. Values outside the range 0-1.0 will be wrapped to that range, for example -0.4 is equivalent to 0.6 and 1.3 is equivalent to 0.3 This is a simplistic curve-following node, intended for curves in a plane, for prototyping purposes.
.. </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
"Curve (*inputs:curve*)", "``pointd[3][]``", "The curve to be examined", "[]"
"Distance (*inputs:distance*)", "``double``", "The distance along the curve, wrapped to the range 0-1.0", "0.0"
"Forward (*inputs:forwardAxis*)", "``token``", "The direction vector from which the returned rotation is relative, one of X, Y, Z", "X"
"Up (*inputs:upAxis*)", "``token``", "The world Up vector, the curve should be in a plane perpendicular with this - one of X, Y, Z", "Y"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Location on curve at the given distance in world space (*outputs:location*)", "``pointd[3]``", "Location", "None"
"World space orientation of the curve at the given distance, may not be smooth for some curves (*outputs:orientation*)", "``quatf[4]``", "Orientation", "None"
"World space rotation of the curve at the given distance, may not be smooth for some curves (*outputs:rotateXYZ*)", "``vectord[3]``", "Rotations", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetLocationAtDistanceOnCurve2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Get Locations At Distances On Curve"
"__tokens", "[""x"", ""y"", ""z"", ""X"", ""Y"", ""Z""]"
"Categories", "internal"
"Generated Class Name", "OgnGetLocationAtDistanceOnCurve2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToString.rst | .. _omni_graph_nodes_ToString_1:
.. _omni_graph_nodes_ToString:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To String
:keywords: lang-en omnigraph node function threadsafe nodes to-string
To String
=========
.. <description>
Converts the given input to a string equivalent.
.. </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
"value (*inputs:value*)", "``any``", "The value to be converted to a string. Numeric values are converted using C++'s std::ostringstream << operator. This can result in the values being converted to exponential form. E.g: 1.234e+06 Arrays of numeric values are converted to Python list syntax. E.g: [1.5, -0.03] A uchar value is converted to a single, unquoted character. An array of uchar values is converted to an unquoted string. Avoid zero values (i.e. null chars) in the array as the behavior is undefined and may vary over time. A single token is converted to its unquoted string equivalent. An array of tokens is converted to Python list syntax with each token enclosed in double quotes. E.g. [""first"", ""second""]", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"String (*outputs:converted*)", "``string``", "Output string", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToString"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To String"
"Categories", "function"
"Generated Class Name", "OgnToStringDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnHasVariantSet.rst | .. _omni_graph_nodes_HasVariantSet_2:
.. _omni_graph_nodes_HasVariantSet:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Has Variant Set
:keywords: lang-en omnigraph node graph:action,sceneGraph,variants ReadOnly nodes has-variant-set
Has Variant Set
===============
.. <description>
Query the existence of a variantSet on a prim
.. </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:prim", "``target``", "The prim with the variantSet", "None"
"inputs:variantSetName", "``token``", "The variantSet name", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:exists", "``bool``", "Variant exists", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.HasVariantSet"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.HasVariantSet.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Has Variant Set"
"Categories", "graph:action,sceneGraph,variants"
"Generated Class Name", "OgnHasVariantSetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTimelineSet.rst | .. _omni_graph_nodes_SetTimeline_1:
.. _omni_graph_nodes_SetTimeline:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set main timeline
:keywords: lang-en omnigraph node time compute-on-request nodes set-timeline
Set main timeline
=================
.. <description>
Set properties of the main timeline
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input that triggers the execution of this node.", "None"
"Property Name (*inputs:propName*)", "``token``", "The name of the property to set.", "Frame"
"", "*displayGroup*", "parameters", ""
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "Frame,Time,StartFrame,StartTime,EndFrame,EndTime,FramesPerSecond", ""
"Property Value (*inputs:propValue*)", "``double``", "The value of the property to set.", "0.0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Clamp to range (*outputs:clamped*)", "``bool``", "Was the input frame or time clamped to the playback range?", "None"
"Execute Out (*outputs:execOut*)", "``execution``", "The output that is triggered when this node executed.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SetTimeline"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Set main timeline"
"Categories", "time"
"Generated Class Name", "OgnTimelineSetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimsV2.rst | .. _omni_graph_nodes_ReadPrimsV2_1:
.. _omni_graph_nodes_ReadPrimsV2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prims
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prims-v2
Read Prims
==========
.. <description>
Reads primitives and outputs multiple primitive in a bundle.
.. </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:_debugStamp", "``int``", "For internal testing only, and subject to change. Please do not depend on this attribute! When not zero, this _debugStamp attribute will be copied to root and child bundles that change When a full update is performed, the negative _debugStamp is written. When only derived attributes (like bounding boxes and world matrices) are updated, _debugStamp + 1000000 is written", "0"
"", "*literalOnly*", "1", ""
"", "*hidden*", "true", ""
"Apply Skel Binding (*inputs:applySkelBinding*)", "``bool``", "If an input USD prim is skinnable and has the SkelBindingAPI schema applied, read skeletal data and apply SkelBinding to deform the prim. The output bundle will have additional child bundles created to hold data for the skeleton and skel animation prims if present. After evaluation, deformed points and normals will be written to the `points` and `normals` attributes, while non-deformed points and normals will be copied to the `points:default` and `normals:default` attributes.", "False"
"Attribute Name Pattern (*inputs:attrNamesToImport*)", "``string``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"Compute Bounding Box (*inputs:computeBoundingBox*)", "``bool``", "For each primitive compute local bounding box and store them as 'bboxMinCorner', 'bboxMaxCorner' and 'bboxTransform' attributes.", "False"
"Bundle change tracking (*inputs:enableBundleChangeTracking*)", "``bool``", "Enable change tracking for output bundle, its children and attributes. The change tracking system for bundles has some overhead, but enables users to inspect the changes that occurred in a bundle. Through inspecting the type of changes user can mitigate excessive computations.", "False"
"USD change tracking (*inputs:enableChangeTracking*)", "``bool``", "Should the output bundles only be updated when the associated USD prims change? This uses a USD notice handler, and has a small overhead, so if you know that the imported USD prims will change frequently, you might want to disable this.", "True"
"Prim Path Pattern (*inputs:pathPattern*)", "``string``", "A list of wildcard patterns used to match the prim paths that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['/Cube0', '/Cube1', '/Box'] '*' - match any '* ^/Box' - match any, but exclude '/Box' '* ^/Cube*' - match any, but exclude '/Cube0' and '/Cube1'", ""
"Prims (*inputs:prims*)", "``target``", "The root prim(s) that pattern matching uses to search from. If 'pathPattern' input is empty, the directly connected prims will be read. Otherwise, all the subtree (including root) will be tested against pattern matcher inputs, and the matched prims will be read into the output bundle. If no prims are connected, and 'pathPattern' is none empty, absolute root ""/"" will be searched as root prim.", "None"
"", "*allowMultiInputs*", "1", ""
"Prim Type Pattern (*inputs:typePattern*)", "``string``", "A list of wildcard patterns used to match the prim types that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['Mesh', 'Cone', 'Cube'] '*' - match any '* ^Mesh' - match any, but exclude 'Mesh' '* ^Cone ^Cube' - match any, but exclude 'Cone' and 'Cube'", "*"
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primsBundle", "``bundle``", "An output bundle containing multiple prims as children. Each child contains data attributes and two additional token attributes named sourcePrimPath and sourcePrimType which contains the path of the Prim being read", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:applySkelBinding", "``bool``", "State from previous evaluation", "False"
"state:attrNamesToImport", "``string``", "State from previous evaluation", "None"
"state:computeBoundingBox", "``bool``", "State from previous evaluation", "False"
"state:enableBundleChangeTracking", "``bool``", "State from previous evaluation", "False"
"state:enableChangeTracking", "``bool``", "State from previous evaluation", "False"
"state:pathPattern", "``string``", "State from previous evaluation", "None"
"state:typePattern", "``string``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "-1"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimsV2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Prims"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimsV2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWriteVariable.rst | .. _omni_graph_core_WriteVariable_2:
.. _omni_graph_core_WriteVariable:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Variable
:keywords: lang-en omnigraph node internal WriteOnly core write-variable
Write Variable
==============
.. <description>
Node that writes a value to a variable
.. </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``", "Input execution state", "None"
"inputs:graph", "``target``", "Ignored. Do not use", "None"
"", "*hidden*", "true", ""
"inputs:targetPath", "``token``", "Ignored. Do not use.", "None"
"", "*hidden*", "true", ""
"inputs:value", "``any``", "The new value to be written", "None"
"inputs:variableName", "``token``", "The name of the graph variable to use.", ""
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "Output execution", "None"
"outputs:value", "``any``", "The written variable value", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.core.WriteVariable"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Write Variable"
"Categories", "internal"
"Generated Class Name", "OgnWriteVariableDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnSelectIf.rst | .. _omni_graph_nodes_SelectIf_1:
.. _omni_graph_nodes_SelectIf:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Select If
:keywords: lang-en omnigraph node flowControl threadsafe nodes select-if
Select If
=========
.. <description>
Selects an output from the given inputs based on a boolean condition. If the condition is an array, and the inputs are arrays of equal length, and values will be selected from ifTrue, ifFalse depending on the bool at the same index. If one input is an array and the other is a scaler of the same base type, the scaler will be extended to the length of the other input.
.. </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:condition", "``['bool', 'bool[]']``", "The selection variable", "None"
"If False (*inputs:ifFalse*)", "``any``", "Value if condition is False", "None"
"If True (*inputs:ifTrue*)", "``any``", "Value if condition is True", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``any``", "The selected value from ifTrue and ifFalse", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SelectIf"
"Version", "1"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.SelectIf.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Select If"
"Categories", "flowControl"
"Generated Class Name", "OgnSelectIfDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCopyAttr.rst | .. _omni_graph_nodes_CopyAttribute_1:
.. _omni_graph_nodes_CopyAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Copy Attributes From Bundles
:keywords: lang-en omnigraph node bundle nodes copy-attribute
Copy Attributes From Bundles
============================
.. <description>
Copies all attributes from one input bundle and specified attributes from a second input bundle to the output bundle.
.. </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
"Full Bundle To Copy (*inputs:fullData*)", "``bundle``", "Collection of attributes to fully copy to the output", "None"
"Extracted Names For Partial Copy (*inputs:inputAttrNames*)", "``token``", "Comma or space separated text, listing the names of attributes to copy from partialData", ""
"New Names For Partial Copy (*inputs:outputAttrNames*)", "``token``", "Comma or space separated text, listing the new names of attributes copied from partialData", ""
"Partial Bundle To Copy (*inputs:partialData*)", "``bundle``", "Collection of attributes from which to select named attributes", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Bundle Of Copied Attributes (*outputs:data*)", "``bundle``", "Collection of attributes consisting of all attributes from input 'fullData' and selected inputs from input 'partialData'", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CopyAttribute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Copy Attributes From Bundles"
"Categories", "bundle"
"Generated Class Name", "OgnCopyAttrDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrim.rst | .. _omni_graph_nodes_ReadPrim_9:
.. _omni_graph_nodes_ReadPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prim
Read Prim
=========
.. <description>
DEPRECATED - use ReadPrimAttributes!
.. </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
"Attributes To Import (*inputs:attrNamesToImport*)", "``token``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"Compute Bounding Box (*inputs:computeBoundingBox*)", "``bool``", "For each primitive compute local bounding box and store them as 'bboxMinCorner', 'bboxMaxCorner' and 'bboxTransform' attributes.", "False"
"inputs:prim", "``bundle``", "The prims to be read from when 'usePathPattern' is false", "None"
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primBundle", "``bundle``", "A bundle of the target Prim attributes. In addition to the data attributes, there is a token attribute named sourcePrimPath which contains the path of the Prim being read", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:attrNamesToImport", "``uint64``", "State from previous evaluation", "None"
"state:computeBoundingBox", "``bool``", "State from previous evaluation", "False"
"state:primPath", "``uint64``", "State from previous evaluation", "None"
"state:primTypes", "``uint64``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "NaN"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrim"
"Version", "9"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Read Prim"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnIncrement.rst | .. _omni_graph_nodes_Increment_1:
.. _omni_graph_nodes_Increment:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Increment
:keywords: lang-en omnigraph node math:operator threadsafe nodes increment
Increment
=========
.. <description>
Add a double argument to any type (element-wise). This includes simple values, tuples, arrays, and arrays of tuples. The output type is always the same as the type of input:value. For example: tuple + double results a tuple. Chopping is used for approximation. For example: 4 + 3.2 will result 7. The default increment value is 1.0.
.. </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
"Increment amount (*inputs:increment*)", "``double``", "The number added to the first operand", "1.0"
"Value (*inputs:value*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The operand that to be increased", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Result of the increment", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Increment"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Increment"
"Categories", "math:operator"
"Generated Class Name", "OgnIncrementDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnClearVariantSelection.rst | .. _omni_graph_nodes_ClearVariantSelection_2:
.. _omni_graph_nodes_ClearVariantSelection:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Clear Variant Selection
:keywords: lang-en omnigraph node graph:action,sceneGraph,variants WriteOnly nodes clear-variant-selection
Clear Variant Selection
=======================
.. <description>
This node will clear the variant selection of the prim on the active layer. Final variant selection will be determined by layer composition below your active layer. In a single layer stage, this will be the fallback variant defined in your variantSet.
.. </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", "None"
"inputs:prim", "``target``", "The prim with the variantSet", "None"
"inputs:setVariant", "``bool``", "Sets the variant selection when finished rather than writing to the attribute values", "False"
"inputs:variantSetName", "``token``", "The variantSet name", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ClearVariantSelection"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.ClearVariantSelection.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Clear Variant Selection"
"Categories", "graph:action,sceneGraph,variants"
"Generated Class Name", "OgnClearVariantSelectionDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantQuatf.rst | .. _omni_graph_nodes_ConstantQuatf_1:
.. _omni_graph_nodes_ConstantQuatf:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Quatf
:keywords: lang-en omnigraph node constants nodes constant-quatf
Constant Quatf
==============
.. <description>
Holds a single-precision quaternion constant: A real coefficient and three imaginary coefficients.
.. </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
"Value (*inputs:value*)", "``quatf[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantQuatf"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantQuatfDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnDivide.rst | .. _omni_graph_nodes_Divide_1:
.. _omni_graph_nodes_Divide:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Divide
:keywords: lang-en omnigraph node math:operator threadsafe nodes divide
Divide
======
.. <description>
Computes the division of two values: A / B. The result is the same type as the numerator if the numerator is a decimal type. Otherwise the result is a double. Vectors can be divided only by a scaler, the result being a vector in the same direction with a scaled length. Note that there are combinations of inputs that can result in a loss of precision due to different value ranges. Division by zero is an error.
.. </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
"A (*inputs:a*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numerator A", "None"
"B (*inputs:b*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The denominator B", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Result of division", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Divide"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Divide"
"Categories", "math:operator"
"Generated Class Name", "OgnDivideDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnIsPrimActive.rst | .. _omni_graph_nodes_IsPrimActive_1:
.. _omni_graph_nodes_IsPrimActive:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Is Prim Active
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes is-prim-active
Is Prim Active
==============
.. <description>
Query if a Prim is active or not in the stage.
.. </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
"Prim Path (*inputs:prim*)", "``path``", "The prim path to be queried", ""
"Prim (*inputs:primTarget*)", "``target``", "The prim to be queried", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:active", "``bool``", "Whether the prim is active or not", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.IsPrimActive"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Is Prim Active"
"Categories", "sceneGraph"
"Generated Class Name", "OgnIsPrimActiveDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantDouble4.rst | .. _omni_graph_nodes_ConstantDouble4_1:
.. _omni_graph_nodes_ConstantDouble4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Double4
:keywords: lang-en omnigraph node constants nodes constant-double4
Constant Double4
================
.. <description>
Holds a 4-component double constant.
.. </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
"Value (*inputs:value*)", "``double[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantDouble4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantDouble4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnNoOp.rst | .. _omni_graph_nodes_Noop_1:
.. _omni_graph_nodes_Noop:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: No-Op
:keywords: lang-en omnigraph node debug threadsafe nodes noop
No-Op
=====
.. <description>
Empty node used only as a placeholder
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Noop"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "No-Op"
"Categories", "debug"
"Generated Class Name", "OgnNoOpDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMakeVector2.rst | .. _omni_graph_nodes_MakeVector2_1:
.. _omni_graph_nodes_MakeVector2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make 2-Vector
:keywords: lang-en omnigraph node math:conversion threadsafe nodes make-vector2
Make 2-Vector
=============
.. <description>
Merge 2 input values into a single output vector. If the inputs are arrays, the output will be an array of vectors.
.. </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
"X (*inputs:x*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The first component of the vector", "None"
"Y (*inputs:y*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The second component of the vector", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Vector (*outputs:tuple*)", "``['double[2]', 'double[2][]', 'float[2]', 'float[2][]', 'half[2]', 'half[2][]', 'int[2]', 'int[2][]']``", "Output vector(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MakeVector2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "compose,combine,join"
"uiName", "Make 2-Vector"
"Categories", "math:conversion"
"Generated Class Name", "OgnMakeVector2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrims.rst | .. _omni_graph_nodes_WritePrims_1:
.. _omni_graph_nodes_WritePrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prims (Legacy)
:keywords: lang-en omnigraph node sceneGraph,bundle WriteOnly nodes write-prims
Write Prims (Legacy)
====================
.. <description>
DEPRECATED - use WritePrimsV2!
.. </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
"Attribute Name Pattern (*inputs:attrNamesToExport*)", "``string``", "A list of wildcard patterns used to match primitive attributes by name. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['xFormOp:translate', 'xformOp:scale','radius'] '*' - match any 'xformOp:*' - matches 'xFormOp:translate' and 'xformOp:scale' '* ^radius' - match any, but exclude 'radius' '* ^xformOp*' - match any, but exclude 'xFormOp:translate', 'xformOp:scale'", "*"
"inputs:execIn", "``execution``", "The input execution (for action graphs only)", "None"
"Prim Path Pattern (*inputs:pathPattern*)", "``string``", "A list of wildcard patterns used to match primitives by path. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['/Cube0', '/Cube1', '/Box'] '*' - match any '* ^/Box' - match any, but exclude '/Box' '* ^/Cube*' - match any, but exclude '/Cube0' and '/Cube1'", "*"
"Prims Bundle (*inputs:primsBundle*)", "``bundle``", "The bundle(s) of multiple prims to be written back. The sourcePrimPath attribute is used to find the destination prim.", "None"
"", "*allowMultiInputs*", "1", ""
"Prim Type Pattern (*inputs:typePattern*)", "``string``", "A list of wildcard patterns used to match primitives by type. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['Mesh', 'Cone', 'Cube'] '*' - match any '* ^Mesh' - match any, but exclude 'Mesh' '* ^Cone ^Cube' - match any, but exclude 'Cone' and 'Cube'", "*"
"Persist To USD (*inputs:usdWriteBack*)", "``bool``", "Whether or not the value should be written back to USD, or kept a Fabric only value", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port (for action graphs only)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrims"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Write Prims (Legacy)"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnWritePrimsDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAppendPath.rst | .. _omni_graph_nodes_AppendPath_1:
.. _omni_graph_nodes_AppendPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Append Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes append-path
Append Path
===========
.. <description>
Generates a path token by appending the given relative path token to the given root or prim path token
.. </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:path", "``['token', 'token[]']``", "The path token(s) to be appended to. Must be a base or prim path (ex. /World)", "None"
"inputs:suffix", "``token``", "The prim or prim-property path to append (ex. Cube or Cube.attr)", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:path", "``['token', 'token[]']``", "The new path token(s) (ex. /World/Cube or /World/Cube.attr)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:path", "``token``", "Snapshot of previously seen path", "None"
"state:suffix", "``token``", "Snapshot of previously seen suffix", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AppendPath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "paths"
"uiName", "Append Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnAppendPathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnArrayResize.rst | .. _omni_graph_nodes_ArrayResize_1:
.. _omni_graph_nodes_ArrayResize:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Array Resize
:keywords: lang-en omnigraph node math:array threadsafe nodes array-resize
Array Resize
============
.. <description>
Resizes an array. If the new size is larger, zeroed values will be added to the end.
.. </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
"Array (*inputs:array*)", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The array to be modified", "None"
"inputs:newSize", "``int``", "The new size of the array, negative values are treated as size of 0", "0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Array (*outputs:array*)", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The modified array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ArrayResize"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Array Resize"
"Categories", "math:array"
"Generated Class Name", "OgnArrayResizeDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrim.rst | .. _omni_graph_nodes_WritePrim_3:
.. _omni_graph_nodes_WritePrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prim Attributes
:keywords: lang-en omnigraph node sceneGraph WriteOnly nodes write-prim
Write Prim Attributes
=====================
.. <description>
Exposes attributes for a single Prim on the USD stage as inputs to this node. When this node computes it writes any of these connected inputs to the target Prim. Any inputs which are not connected will not be written.
.. </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", "None"
"Prim (*inputs:prim*)", "``target``", "The prim to be written to", "None"
"Persist To USD (*inputs:usdWriteBack*)", "``bool``", "Whether or not the value should be written back to USD, or kept a Fabric only value", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrim"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Write Prim Attributes"
"Categories", "sceneGraph"
"Generated Class Name", "OgnWritePrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCurveFrame.rst | .. _omni_graph_nodes_CurveToFrame_1:
.. _omni_graph_nodes_CurveToFrame:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Crate Curve From Frame
:keywords: lang-en omnigraph node geometry:generator threadsafe nodes curve-to-frame
Crate Curve From Frame
======================
.. <description>
Create a frame object based on a curve description
.. </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
"Curve Points (*inputs:curvePoints*)", "``float[3][]``", "Points on the curve to be framed", "[]"
"Curve Vertex Counts (*inputs:curveVertexCounts*)", "``int[]``", "Vertex counts for the curve points", "[]"
"Curve Vertex Starts (*inputs:curveVertexStarts*)", "``int[]``", "Vertex starting points", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Out Vectors (*outputs:out*)", "``float[3][]``", "Out vector directions on the curve frame", "None"
"Tangents (*outputs:tangent*)", "``float[3][]``", "Tangents on the curve frame", "None"
"Up Vectors (*outputs:up*)", "``float[3][]``", "Up vectors on the curve frame", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CurveToFrame"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Crate Curve From Frame"
"Categories", "geometry:generator"
"Generated Class Name", "OgnCurveFrameDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRandomUnitVector.rst | .. _omni_graph_nodes_RandomUnitVector_1:
.. _omni_graph_nodes_RandomUnitVector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Random Unit Vector
:keywords: lang-en omnigraph node math:operator threadsafe nodes random-unit-vector
Random Unit Vector
==================
.. <description>
Generates a random vector with uniform distribution on the unit sphere.
.. </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 Vector (*outputs:random*)", "``vectorf[3]``", "The random unit vector 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.RandomUnitVector"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Random Unit Vector"
"Categories", "math:operator"
"Generated Class Name", "OgnRandomUnitVectorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimAttribute.rst | .. _omni_graph_nodes_ReadPrimAttribute_3:
.. _omni_graph_nodes_ReadPrimAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim Attribute
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes read-prim-attribute
Read Prim Attribute
===================
.. <description>
Given a path to a prim on the current USD stage and the name of an attribute on that prim, gets the value of that attribute, at the global timeline value.
.. </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
"Attribute Name (*inputs:name*)", "``token``", "The name of the attribute to get on the specified prim", ""
"inputs:prim", "``target``", "The prim to be read from when 'usePath' is false", "None"
"inputs:primPath", "``token``", "The path of the prim to be modified when 'usePath' is true", "None"
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim attribute. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``any``", "The attribute value", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:correctlySetup", "``bool``", "Wheter or not the instance is properly setup", "False"
"state:importPath", "``uint64``", "Path at which data has been imported", "None"
"state:srcAttrib", "``uint64``", "A TokenC to the source attribute", "None"
"state:srcPath", "``uint64``", "A PathC to the source prim", "None"
"state:srcPathAsToken", "``uint64``", "A TokenC to the source prim", "None"
"state:time", "``double``", "The timecode at which we have imported the value", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimAttribute"
"Version", "3"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.ReadPrimAttribute.svg"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "usd"
"uiName", "Read Prim Attribute"
"Categories", "sceneGraph"
"Generated Class Name", "OgnReadPrimAttributeDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetAttrNames.rst | .. _omni_graph_nodes_GetAttributeNames_1:
.. _omni_graph_nodes_GetAttributeNames:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Attribute Names From Bundle
:keywords: lang-en omnigraph node bundle threadsafe nodes get-attribute-names
Get Attribute Names From Bundle
===============================
.. <description>
Retrieves the names of all of the attributes contained in the input bundle, optionally sorted.
.. </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
"Bundle To Examine (*inputs:data*)", "``bundle``", "Collection of attributes from which to extract names", "None"
"Sort Output (*inputs:sort*)", "``bool``", "If true, the names will be output in sorted order (default, for consistency). If false, the order is not be guaranteed to be consistent between systems or over time, so do not rely on the order downstream in this case.", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attribute Names (*outputs:output*)", "``token[]``", "Names of all of the attributes contained in the input bundle", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetAttributeNames"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Attribute Names From Bundle"
"Categories", "bundle"
"Generated Class Name", "OgnGetAttrNamesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetParentPrims.rst | .. _omni_graph_nodes_GetParentPrims_1:
.. _omni_graph_nodes_GetParentPrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Parent Prims
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-parent-prims
Get Parent Prims
================
.. <description>
Generates parent paths from one or more targeted paths (ex. /World/Cube -> /World)
.. </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:prims", "``target``", "Input prim paths (ex. /World/Cube)", "None"
"", "*allowMultiInputs*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:parentPrims", "``target``", "Computed parent paths (ex. /World)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetParentPrims"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Parent Prims"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetParentPrimsDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCreateTubeTopology.rst | .. _omni_graph_nodes_CreateTubeTopology_1:
.. _omni_graph_nodes_CreateTubeTopology:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Create Tube Topology
:keywords: lang-en omnigraph node geometry:generator threadsafe nodes create-tube-topology
Create Tube Topology
====================
.. <description>
Creates the face vertex counts and indices describing a tube topology with the given number of rows and columns.
.. </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
"Column Array (*inputs:cols*)", "``int[]``", "Array of columns in the topology to be generated", "[]"
"Row Array (*inputs:rows*)", "``int[]``", "Array of rows in the topology to be generated", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Face Vertex Counts (*outputs:faceVertexCounts*)", "``int[]``", "Array of vertex counts for each face in the tube topology", "None"
"Face Vertex Indices (*outputs:faceVertexIndices*)", "``int[]``", "Array of vertex indices for each face in the tube topology", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CreateTubeTopology"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Create Tube Topology"
"Categories", "geometry:generator"
"Generated Class Name", "OgnCreateTubeTopologyDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnEachZero.rst | .. _omni_graph_nodes_EachZero_1:
.. _omni_graph_nodes_EachZero:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Each Zero
:keywords: lang-en omnigraph node math:condition threadsafe nodes each-zero
Each Zero
=========
.. <description>
Outputs a boolean, or array of booleans, indicating which input values are zero within a specified tolerance.
.. </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
"Tolerance (*inputs:tolerance*)", "``double``", "How close the value must be to 0 to be considered ""zero"".", "0.0"
"Value (*inputs:value*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Value(s) to check for zero.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "If 'value' is a scalar then 'result' will be a boolean set to true if 'value' is zero. If 'value' is non-scalar (array, tuple, matrix, etc) then 'result' will be an array of booleans, one for each element/component of the input. If those elements are themselves non-scalar (e.g. an array of vectors) they will be considered zero only if all of the sub-elements are zero. For example, if 'value' is [3, 0, 1] then 'result' will be [true, false, true] because the second element is zero. But if 'value' is [[3, 0, 1], [-5, 4, 17]] then 'result' will be [false, false] because neither of the two vectors is fully zero.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.EachZero"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Each Zero"
"Categories", "math:condition"
"Generated Class Name", "OgnEachZeroDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnLengthAlongCurve.rst | .. _omni_graph_nodes_LengthAlongCurve_1:
.. _omni_graph_nodes_LengthAlongCurve:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Length Along Curve
:keywords: lang-en omnigraph node geometry:analysis threadsafe nodes length-along-curve
Length Along Curve
==================
.. <description>
Find the length along the curve of a set of points
.. </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
"Curve Points (*inputs:curvePoints*)", "``float[3][]``", "Points on the curve to be framed", "[]"
"Curve Vertex Counts (*inputs:curveVertexCounts*)", "``int[]``", "Vertex counts for the curve points", "[]"
"Curve Vertex Starts (*inputs:curveVertexStarts*)", "``int[]``", "Vertex starting points", "[]"
"Normalize (*inputs:normalize*)", "``bool``", "If true then normalize the curve length to a 0, 1 range", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:length", "``float[]``", "List of lengths along the curve corresponding to the input points", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.LengthAlongCurve"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Length Along Curve"
"Categories", "geometry:analysis"
"Generated Class Name", "OgnLengthAlongCurveDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTransformVector.rst | .. _omni_graph_nodes_TransformVector_1:
.. _omni_graph_nodes_TransformVector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Transform Vector
:keywords: lang-en omnigraph node math:operator threadsafe nodes transform-vector
Transform Vector
================
.. <description>
Applies a transformation matrix to a row vector, returning the result. returns vector * matrix If the vector is one dimension smaller than the matrix (eg a 4x4 matrix and a 3d vector), The last component of the vector will be treated as a 1. The result is then projected back to a 3-vector. Supports mixed array inputs, eg a single matrix and an array of vectors.
.. </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
"Matrix (*inputs:matrix*)", "``['matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]']``", "The transformation matrix to be applied", "None"
"Vector (*inputs:vector*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The row vector(s) to be translated", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The transformed row vector(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.TransformVector"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Transform Vector"
"Categories", "math:operator"
"Generated Class Name", "OgnTransformVectorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAbsolute.rst | .. _omni_graph_nodes_Absolute_1:
.. _omni_graph_nodes_Absolute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Absolute
:keywords: lang-en omnigraph node math:operator threadsafe nodes absolute
Absolute
========
.. <description>
Compute the absolute value of a vector, array of vectors, scalar or array of scalars If an array of vectors are passed in, the output will be an array of corresponding absolute 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
"inputs:input", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The vector(s) or scalar(s) to take the absolute value of", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:absolute", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The resulting absolute(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Absolute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "absolute"
"uiName", "Absolute"
"Categories", "math:operator"
"Generated Class Name", "OgnAbsoluteDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimAttributes.rst | .. _omni_graph_nodes_ReadPrimAttributes_3:
.. _omni_graph_nodes_ReadPrimAttributes:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim Attributes
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prim-attributes
Read Prim Attributes
====================
.. <description>
Read Prim attributes and exposes them as dynamic attributes Does not produce output bundle.
.. </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
"Attribute Name Pattern (*inputs:attrNamesToImport*)", "``string``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"inputs:prim", "``target``", "The prim to be read from when 'usePath' is false", "None"
"Prim Path (*inputs:primPath*)", "``path``", "The path of the prim to be read from when 'usePath' is true", ""
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
"Use Path (*inputs:usePath*)", "``bool``", "When true, the 'primPath' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primBundle", "``bundle``", "A bundle of the target Prim attributes. In addition to the data attributes, there are token attributes named sourcePrimPath and sourcePrimType which contains the path of the Prim being read", "None"
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:attrNamesToImport", "``string``", "State from previous evaluation", "None"
"state:primPath", "``uint64``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "NaN"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimAttributes"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Prim Attributes"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimAttributesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadVariable.rst | .. _omni_graph_core_ReadVariable_2:
.. _omni_graph_core_ReadVariable:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Variable
:keywords: lang-en omnigraph node internal threadsafe core read-variable
Read Variable
=============
.. <description>
Node that reads a value from a variable
.. </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:graph", "``target``", "Ignored. Do not use", "None"
"", "*hidden*", "true", ""
"inputs:targetPath", "``token``", "Ignored. Do not use.", "None"
"", "*hidden*", "true", ""
"inputs:variableName", "``token``", "The name of the graph variable to use.", ""
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``any``", "The variable value that we returned.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.core.ReadVariable"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Read Variable"
"Categories", "internal"
"Generated Class Name", "OgnReadVariableDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMoveToTarget.rst | .. _omni_graph_nodes_MoveToTarget_2:
.. _omni_graph_nodes_MoveToTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Move To Target
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes move-to-target
Move To Target
==============
.. <description>
This node smoothly translates, rotates, and scales a prim object to a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the translation, rotation, and scale of the target prim.
Note: The Prim must have xform:orient in transform stack in order to interpolate rotations
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:sourcePrim", "``target``", "The source prim to be transformed", "None"
"inputs:sourcePrimPath", "``path``", "The source prim to be transformed, used when 'useSourcePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"inputs:targetPrim", "``target``", "The destination prim. The target's translation, rotation, and scale will be matched by the sourcePrim", "None"
"inputs:targetPrimPath", "``path``", "The destination prim. The target's translation, rotation, and scale will be matched by the sourcePrim, used when 'useTargetPath' is true", "None"
"inputs:useSourcePath", "``bool``", "When true, the 'sourcePrimPath' attribute is used, otherwise it will read the connection at the 'sourcePrim' attribute", "False"
"inputs:useTargetPath", "``bool``", "When true, the 'targetPrimPath' attribute is used, otherwise it will read the connection at the 'targetPrim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MoveToTarget"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Move To Target"
"Categories", "sceneGraph"
"Generated Class Name", "OgnMoveToTargetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantUInt.rst | .. _omni_graph_nodes_ConstantUInt_1:
.. _omni_graph_nodes_ConstantUInt:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant UInt
:keywords: lang-en omnigraph node constants nodes constant-u-int
Constant UInt
=============
.. <description>
Holds a 32 bit unsigned integer value
.. </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
"Value (*inputs:value*)", "``uint``", "The constant value", "0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantUInt"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Constant UInt"
"Categories", "constants"
"Generated Class Name", "OgnConstantUIntDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimPath.rst | .. _omni_graph_nodes_GetPrimPath_3:
.. _omni_graph_nodes_GetPrimPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prim Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-prim-path
Get Prim Path
=============
.. <description>
Generates a path from the specified relationship. This is useful when an absolute prim path may change.
.. </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:prim", "``target``", "The prim to determine the path of", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:path", "``path``", "The absolute path of the given prim as a string", "None"
"outputs:primPath", "``token``", "The absolute path of the given prim as a token", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimPath"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prim Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimPathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetGraphTargetPrim.rst | .. _omni_graph_nodes_GetGraphTargetPrim_1:
.. _omni_graph_nodes_GetGraphTargetPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Graph Target Prim
:keywords: lang-en omnigraph node sceneGraph nodes get-graph-target-prim
Get Graph Target Prim
=====================
.. <description>
Access the target prim the graph is being executed on. If the graph is executing itself, this will output the prim of the graph. Otherwise the graph is being executed via instancing, then this will output the prim of the target instance.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:prim", "``target``", "The graph target as a prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetGraphTargetPrim"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Graph Target Prim"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetGraphTargetPrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTrig.rst | .. _omni_graph_nodes_Trig_1:
.. _omni_graph_nodes_Trig:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Trigonometric Operation
:keywords: lang-en omnigraph node math:operator,math:conversion threadsafe nodes trig
Trigonometric Operation
=======================
.. <description>
Trigonometric operation of one input in degrees. Supported operations are:
SIN, COS, TAN, ARCSIN, ARCCOS, ARCTAN, DEGREES, RADIANS
.. </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:a", "``['double', 'float', 'half', 'timecode']``", "Input to the function", "None"
"Operation (*inputs:operation*)", "``token``", "The operation to perform", "SIN"
"", "*allowedTokens*", "SIN,COS,TAN,ARCSIN,ARCCOS,ARCTAN,DEGREES,RADIANS", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['double', 'float', 'half', 'timecode']``", "The result of the function", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Trig"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Trigonometric Operation"
"Categories", "math:operator,math:conversion"
"Generated Class Name", "OgnTrigDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantBool.rst | .. _omni_graph_nodes_ConstantBool_1:
.. _omni_graph_nodes_ConstantBool:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Bool
:keywords: lang-en omnigraph node constants nodes constant-bool
Constant Bool
=============
.. <description>
Holds a boolean value
.. </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
"Value (*inputs:value*)", "``bool``", "The constant value", "False"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantBool"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantBoolDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRandomBoolean.rst | .. _omni_graph_nodes_RandomBoolean_1:
.. _omni_graph_nodes_RandomBoolean:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Random Boolean
:keywords: lang-en omnigraph node math:operator threadsafe nodes random-boolean
Random Boolean
==============
.. <description>
Generates a random boolean value.
.. </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 Boolean (*outputs:random*)", "``bool``", "The random boolean value 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.RandomBoolean"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Random Boolean"
"Categories", "math:operator"
"Generated Class Name", "OgnRandomBooleanDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAppendString.rst | .. _omni_graph_nodes_AppendString_1:
.. _omni_graph_nodes_AppendString:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Append String (Deprecated)
:keywords: lang-en omnigraph node function threadsafe nodes append-string
Append String (Deprecated)
==========================
.. <description>
Creates a new token or string by appending the given token or string. token[] inputs will be appended element-wise.
.. </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:suffix", "``['string', 'token', 'token[]']``", "The string to be appended", "None"
"inputs:value", "``['string', 'token', 'token[]']``", "The string(s) to be appended to", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``['string', 'token', 'token[]']``", "The new string(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AppendString"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Append String (Deprecated)"
"Categories", "function"
"Generated Class Name", "OgnAppendStringDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAnd.rst | .. _omni_graph_nodes_BooleanAnd_2:
.. _omni_graph_nodes_BooleanAnd:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Boolean AND
:keywords: lang-en omnigraph node math:condition threadsafe nodes boolean-and
Boolean AND
===========
.. <description>
Boolean AND on two or more inputs. If the inputs are arrays, AND operations will be performed pair-wise. The input sizes must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.
.. </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:a", "``['bool', 'bool[]']``", "Input A: bool or bool array.", "None"
"inputs:b", "``['bool', 'bool[]']``", "Input B: bool or bool array.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "The result of the boolean AND - an array of booleans if either input is an array, otherwise a boolean.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BooleanAnd"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Boolean AND"
"Categories", "math:condition"
"Generated Class Name", "OgnAndDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRound.rst | .. _omni_graph_nodes_Round_1:
.. _omni_graph_nodes_Round:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Round
:keywords: lang-en omnigraph node math:operator threadsafe nodes round
Round
=====
.. <description>
Round a decimal input to the given number of decimals. Accepts float, double, half, or arrays / tuples of the aformentioned types
.. </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
"Decimals (*inputs:decimals*)", "``int``", "The number of decimal places to round to. Negative numbers specify the number of positions left of the decimal", "0"
"Input (*inputs:input*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The input data to round", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Output (*outputs:output*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The resultant rounded numbers", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Round"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Round"
"Categories", "math:operator"
"Generated Class Name", "OgnRoundDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRotateToOrientation.rst | .. _omni_graph_nodes_RotateToOrientation_2:
.. _omni_graph_nodes_RotateToOrientation:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Rotate To Orientation
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes rotate-to-orientation
Rotate To Orientation
=====================
.. <description>
Perform a smooth rotation maneuver, rotating a prim to a desired orientation given a speed and easing factor
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:prim", "``target``", "The prim to be rotated", "None"
"inputs:primPath", "``path``", "The source prim to be transformed, used when 'usePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"Target Orientation (*inputs:target*)", "``vectord[3]``", "The desired orientation as euler angles (XYZ) in local space", "[0.0, 0.0, 0.0]"
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RotateToOrientation"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Rotate To Orientation"
"Categories", "sceneGraph"
"Generated Class Name", "OgnRotateToOrientationDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnXor.rst | .. _omni_graph_nodes_BooleanXor_1:
.. _omni_graph_nodes_BooleanXor:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Boolean XOR
:keywords: lang-en omnigraph node math:condition threadsafe nodes boolean-xor
Boolean XOR
===========
.. <description>
Boolean XOR on two inputs. If a and b are arrays, XOR operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.
.. </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:a", "``['bool', 'bool[]']``", "Input A: bool or bool array.", "None"
"inputs:b", "``['bool', 'bool[]']``", "Input B: bool or bool array.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "The result of the boolean XOR - an array of booleans if either input is an array, otherwise a boolean.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BooleanXor"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Boolean XOR"
"Categories", "math:condition"
"Generated Class Name", "OgnXorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnBreakVector2.rst | .. _omni_graph_nodes_BreakVector2_1:
.. _omni_graph_nodes_BreakVector2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Break 2-Vector
:keywords: lang-en omnigraph node math:conversion threadsafe nodes break-vector2
Break 2-Vector
==============
.. <description>
Split vector into 2 component 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
"Vector (*inputs:tuple*)", "``['double[2]', 'float[2]', 'half[2]', 'int[2]']``", "2-vector to be broken", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"X (*outputs:x*)", "``['double', 'float', 'half', 'int']``", "The first component of the vector", "None"
"Y (*outputs:y*)", "``['double', 'float', 'half', 'int']``", "The second component of the vector", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BreakVector2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "decompose,separate,isolate"
"uiName", "Break 2-Vector"
"Categories", "math:conversion"
"Generated Class Name", "OgnBreakVector2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnNormalize.rst | .. _omni_graph_nodes_Normalize_1:
.. _omni_graph_nodes_Normalize:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Normalize
:keywords: lang-en omnigraph node math:operator threadsafe nodes normalize
Normalize
=========
.. <description>
Normalize the input vector. If the input vector has a magnitude of zero, the null vector is returned.
.. </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
"Vector (*inputs:vector*)", "``['double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]']``", "Vector to normalize", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]']``", "Normalized vector", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Normalize"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Normalize"
"Categories", "math:operator"
"Generated Class Name", "OgnNormalizeDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantColor4f.rst | .. _omni_graph_nodes_ConstantColor4f_1:
.. _omni_graph_nodes_ConstantColor4f:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Color4F
:keywords: lang-en omnigraph node constants nodes constant-color4f
Constant Color4F
================
.. <description>
Holds a 4-component color constant, which is energy-linear RGBA, not pre-alpha multiplied
.. </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
"Value (*inputs:value*)", "``colorf[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantColor4f"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantColor4fDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantFloat.rst | .. _omni_graph_nodes_ConstantFloat_1:
.. _omni_graph_nodes_ConstantFloat:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Float
:keywords: lang-en omnigraph node constants nodes constant-float
Constant Float
==============
.. <description>
Holds a 32 bit floating point value
.. </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
"Value (*inputs:value*)", "``float``", "The constant value", "0.0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantFloat"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantFloatDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnStopAllSound.rst | .. _omni_graph_nodes_StopAllSound_1:
.. _omni_graph_nodes_StopAllSound:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Stop All Sound
:keywords: lang-en omnigraph node sound nodes stop-all-sound
Stop All Sound
==============
.. <description>
Stop playing all sounds
.. </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", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.StopAllSound"
"Version", "1"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.StopAllSound.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Stop All Sound"
"Categories", "sound"
"Generated Class Name", "OgnStopAllSoundDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantFloat4.rst | .. _omni_graph_nodes_ConstantFloat4_1:
.. _omni_graph_nodes_ConstantFloat4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Float4
:keywords: lang-en omnigraph node constants nodes constant-float4
Constant Float4
===============
.. <description>
Holds a 4-component float constant.
.. </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
"Value (*inputs:value*)", "``float[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantFloat4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantFloat4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantDouble2.rst | .. _omni_graph_nodes_ConstantDouble2_1:
.. _omni_graph_nodes_ConstantDouble2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Double2
:keywords: lang-en omnigraph node constants nodes constant-double2
Constant Double2
================
.. <description>
Holds a 2-component double constant.
.. </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
"Value (*inputs:value*)", "``double[2]``", "The constant value", "[0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantDouble2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantDouble2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantHalf4.rst | .. _omni_graph_nodes_ConstantHalf4_1:
.. _omni_graph_nodes_ConstantHalf4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Half4
:keywords: lang-en omnigraph node constants nodes constant-half4
Constant Half4
==============
.. <description>
Holds a 4-component half constant.
.. </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
"Value (*inputs:value*)", "``half[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantHalf4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantHalf4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetRelativePath.rst | .. _omni_graph_nodes_GetRelativePath_1:
.. _omni_graph_nodes_GetRelativePath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Relative Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-relative-path
Get Relative Path
=================
.. <description>
Generates a path token relative to anchor from path.(ex. (/World, /World/Cube) -> /Cube)
.. </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:anchor", "``token``", "Path token to compute relative to (ex. /World)", ""
"inputs:path", "``['token', 'token[]']``", "Path token to convert to a relative path (ex. /World/Cube)", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:relativePath", "``['token', 'token[]']``", "Relative path token (ex. /Cube)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:anchor", "``token``", "Snapshot of previously seen rootPath", "None"
"state:path", "``token``", "Snapshot of previously seen path", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetRelativePath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Relative Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetRelativePathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantTexCoord2f.rst | .. _omni_graph_nodes_ConstantTexCoord2f_1:
.. _omni_graph_nodes_ConstantTexCoord2f:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Tex Coord2F
:keywords: lang-en omnigraph node constants nodes constant-tex-coord2f
Constant Tex Coord2F
====================
.. <description>
Holds a 2D uv texture coordinate.
.. </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
"Value (*inputs:value*)", "``texcoordf[2]``", "The constant value", "[0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantTexCoord2f"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantTexCoord2fDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAnyZero.rst | .. _omni_graph_nodes_AnyZero_1:
.. _omni_graph_nodes_AnyZero:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Any Zero
:keywords: lang-en omnigraph node math:condition threadsafe nodes any-zero
Any Zero
========
.. <description>
Outputs a boolean indicating if any of the input values are zero within a specified tolerance.
.. </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
"Tolerance (*inputs:tolerance*)", "``double``", "How close the value must be to 0 to be considered ""zero"".", "0.0"
"Value (*inputs:value*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Value(s) to check for zero.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``bool``", "If 'value' is a scalar then 'result' will be true if 'value' is zero. If 'value' is non-scalar (array, tuple, matrix, etc) then 'result' will be true if any of its elements are zero. If those elements are themselves non-scalar (e.g. an array of vectors) they will be considered zero only if all of the sub-elements are zero. For example, if 'value' is [3, 0, 1] then 'result' will be true because the second element is zero. But if 'value' is [[3, 0, 1], [-5, 4, 17]] then 'result' will be false because neither of the two vectors is fully zero.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AnyZero"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Any Zero"
"Categories", "math:condition"
"Generated Class Name", "OgnAnyZeroDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrims.rst | .. _omni_graph_nodes_GetPrims_2:
.. _omni_graph_nodes_GetPrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prims
:keywords: lang-en omnigraph node bundle nodes get-prims
Get Prims
=========
.. <description>
Filters primitives in the input bundle by path and type.
.. </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:bundle", "``bundle``", "The bundle to be read from", "None"
"Inverse (*inputs:inverse*)", "``bool``", "By default all primitives matching the path patterns and types are added to the output bundle; when this option is on, all mismatching primitives will be added instead.", "False"
"Path Pattern (*inputs:pathPattern*)", "``string``", "A list of wildcard patterns used to match primitive path. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['/Cube0', '/Cube1', '/Box'] '*' - match any '* ^/Box' - match any, but exclude '/Box' '* ^/Cube*' - match any, but exclude '/Cube0' and '/Cube1'", "*"
"inputs:prims", "``target``", "The prim to be extracted from Multiple Primitives in Bundle.", "None"
"", "*allowMultiInputs*", "1", ""
"Type Pattern (*inputs:typePattern*)", "``string``", "A list of wildcard patterns used to match primitive type. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['Mesh', 'Cone', 'Cube'] '*' - match any '* ^Mesh' - match any, but exclude 'Mesh' '* ^Cone ^Cube' - match any, but exclude 'Cone' and 'Cube'", "*"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:bundle", "``bundle``", "The output bundle that contains filtered primitives", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrims"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prims"
"Categories", "bundle"
"Generated Class Name", "OgnGetPrimsDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToHalf.rst | .. _omni_graph_nodes_ToHalf_1:
.. _omni_graph_nodes_ToHalf:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Half
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-half
To Half
=======
.. <description>
Converts the given input to 16 bit float. The node will attempt to convert array and tuple inputs to halfs of the same shape
.. </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
"value (*inputs:value*)", "``['bool', 'bool[]', 'colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numeric value to convert to half", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Half (*outputs:converted*)", "``['half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]']``", "Output half scaler or array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToHalf"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Half"
"Categories", "math:conversion"
"Generated Class Name", "OgnToHalfDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMakeVector3.rst | .. _omni_graph_nodes_MakeVector3_1:
.. _omni_graph_nodes_MakeVector3:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make 3-Vector
:keywords: lang-en omnigraph node math:conversion threadsafe nodes make-vector3
Make 3-Vector
=============
.. <description>
Merge 3 input values into a single output vector. If the inputs are arrays, the output will be an array of vectors.
.. </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
"X (*inputs:x*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The first component of the vector", "None"
"Y (*inputs:y*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The second component of the vector", "None"
"Z (*inputs:z*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The third component of the vector", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Vector (*outputs:tuple*)", "``['double[3]', 'double[3][]', 'float[3]', 'float[3][]', 'half[3]', 'half[3][]', 'int[3]', 'int[3][]']``", "Output 3-vector(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MakeVector3"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "compose,combine,join"
"uiName", "Make 3-Vector"
"Categories", "math:conversion"
"Generated Class Name", "OgnMakeVector3Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantInt.rst | .. _omni_graph_nodes_ConstantInt_1:
.. _omni_graph_nodes_ConstantInt:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Int
:keywords: lang-en omnigraph node constants nodes constant-int
Constant Int
============
.. <description>
Holds a 32 bit signed integer constant value
.. </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
"Value (*inputs:value*)", "``int``", "The constant value", "0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantInt"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantIntDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantPath.rst | .. _omni_graph_nodes_ConstantPath_1:
.. _omni_graph_nodes_ConstantPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Path
:keywords: lang-en omnigraph node constants nodes constant-path
Constant Path
=============
.. <description>
Holds a path constant value
.. </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
"Value (*inputs:value*)", "``path``", "The constant value", ""
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantPath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantPathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRotateToTarget.rst | .. _omni_graph_nodes_RotateToTarget_2:
.. _omni_graph_nodes_RotateToTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Rotate To Target
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes rotate-to-target
Rotate To Target
================
.. <description>
This node smoothly rotates a prim object to match a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the rotation as the target prim.
Note: The Prim must have xform:orient in transform stack in order to interpolate rotations
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:sourcePrim", "``target``", "The source prim to be transformed", "None"
"inputs:sourcePrimPath", "``path``", "The source prim to be transformed, used when 'useSourcePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"inputs:targetPrim", "``target``", "The destination prim. The target's rotation will be matched by the sourcePrim", "None"
"inputs:targetPrimPath", "``path``", "The destination prim. The target's rotation will be matched by the sourcePrim, used when 'useTargetPath' is true", "None"
"inputs:useSourcePath", "``bool``", "When true, the 'sourcePrimPath' attribute is used, otherwise it will read the connection at the 'sourcePrim' attribute", "False"
"inputs:useTargetPath", "``bool``", "When true, the 'targetPrimPath' attribute is used, otherwise it will read the connection at the 'targetPrim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RotateToTarget"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Rotate To Target"
"Categories", "sceneGraph"
"Generated Class Name", "OgnRotateToTargetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRandomNumeric.rst | .. _omni_graph_nodes_RandomNumeric_1:
.. _omni_graph_nodes_RandomNumeric:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Random Numeric
:keywords: lang-en omnigraph node math:operator threadsafe nodes random-numeric
Random Numeric
==============
.. <description>
Generates a random numeric value in a range, using a uniform distribution. The range is specified with two inputs: minimum and maximum. These inputs can be numbers, vectors, tuples or arrays of these. If one input has a higher dimension than the other, then the input with lower dimension will be repeated to match the dimension of the other input (broadcasting).
.. </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", ""
"Maximum (*inputs:max*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The maximum of the random range, inclusive of integral numbers exclusive for real numbers. Can be a number, vector, tuple, or array of these. The default value is double 1.", "None"
"Minimum (*inputs:min*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The minimum of the random range (inclusive). Can be a number, vector, tuple, or array of these. The default value is double 0.", "None"
"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 Numeric (*outputs:random*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The random numeric value 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.RandomNumeric"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Random Numeric"
"Categories", "math:operator"
"Generated Class Name", "OgnRandomNumericDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMakeTransformLookAt.rst | .. _omni_graph_nodes_MakeTransformLookAt_1:
.. _omni_graph_nodes_MakeTransformLookAt:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make Transformation Matrix Look At
:keywords: lang-en omnigraph node math:operator threadsafe nodes make-transform-look-at
Make Transformation Matrix Look At
==================================
.. <description>
Make a transformation matrix from eye, center world-space position and an up vector. Forward vector is negative Z direction computed from eye-center and normalized. Up is positive Y direction. Right is the positive X direction.
.. </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:center", "``vectord[3]``", "The desired center position in world-space", "[0, 0, 0]"
"inputs:eye", "``vectord[3]``", "The desired look at position in world-space", "[1, 0, 0]"
"inputs:up", "``vectord[3]``", "The desired up vector", "[0, 1, 0]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:transform", "``matrixd[4]``", "The resulting transformation matrix", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MakeTransformLookAt"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Make Transformation Matrix Look At"
"Categories", "math:operator"
"Generated Class Name", "OgnMakeTransformLookAtDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnIsPrimSelected.rst | .. _omni_graph_nodes_IsPrimSelected_1:
.. _omni_graph_nodes_IsPrimSelected:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Is Prim Selected
:keywords: lang-en omnigraph node sceneGraph ReadOnly nodes is-prim-selected
Is Prim Selected
================
.. <description>
Checks if the prim at the given path is currently selected
.. </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:prim", "``target``", "The prim to check", "None"
"inputs:primPath", "``token``", "The prim path to check", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:isSelected", "``bool``", "True if the given path is in the current stage selection", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.IsPrimSelected"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Is Prim Selected"
"Categories", "sceneGraph"
"Generated Class Name", "OgnIsPrimSelectedDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCrossProduct.rst | .. _omni_graph_nodes_CrossProduct_1:
.. _omni_graph_nodes_CrossProduct:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Cross Product
:keywords: lang-en omnigraph node math:operator threadsafe nodes cross-product
Cross Product
=============
.. <description>
Compute the cross product of two (arrays of) vectors of the same size The cross product of two 3d vectors is a vector perpendicular to both inputs If arrays of vectors are provided, the cross-product is computed row-wise between a and b
.. </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
"A (*inputs:a*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The first vector in the cross product", "None"
"B (*inputs:b*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The second vector in the cross product", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Product (*outputs:product*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The resulting product", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CrossProduct"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Cross Product"
"Categories", "math:operator"
"Generated Class Name", "OgnCrossProductDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrimsV2.rst | .. _omni_graph_nodes_WritePrimsV2_1:
.. _omni_graph_nodes_WritePrimsV2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prims
:keywords: lang-en omnigraph node sceneGraph,bundle WriteOnly nodes write-prims-v2
Write Prims
===========
.. <description>
Write back bundle(s) containing multiple prims to the stage.
.. </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
"Attribute Name Pattern (*inputs:attrNamesToExport*)", "``string``", "A list of wildcard patterns used to match primitive attributes by name. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['xFormOp:translate', 'xformOp:scale','radius'] '*' - match any 'xformOp:*' - matches 'xFormOp:translate' and 'xformOp:scale' '* ^radius' - match any, but exclude 'radius' '* ^xformOp*' - match any, but exclude 'xFormOp:translate', 'xformOp:scale'", "*"
"inputs:execIn", "``execution``", "The input execution (for action graphs only)", "None"
"Layer Identifier (*inputs:layerIdentifier*)", "``token``", "Identifier of the layer to export to. If empty, it'll be exported to the current edit target at the time of usd wirte back.' This is only used when ""Persist To USD"" is enabled.", ""
"Prim Path Pattern (*inputs:pathPattern*)", "``string``", "A list of wildcard patterns used to match primitives by path. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['/Cube0', '/Cube1', '/Box'] '*' - match any '* ^/Box' - match any, but exclude '/Box' '* ^/Cube*' - match any, but exclude '/Cube0' and '/Cube1'", "*"
"Prims (*inputs:prims*)", "``target``", "Target(s) to which the prims in 'primsBundle' will be written to. There is a 1:1 mapping between root prims paths in 'primsBundle' and the Target Prims targets *For advanced usage, if 'primsBundle' contains hierarchy, the unique common ancesor paths will have the 1:1 mapping to Target Prims targets, with the descendant paths remapped. *NOTE* See 'scatterUnderTargets' input for modified exporting behavior *WARNING* this can create new prims on the stage. If attributes or prims are removed from 'primsBundle' in subsequent evaluation, they will be removed from targets as well.", "None"
"", "*allowMultiInputs*", "1", ""
"Prims Bundle (*inputs:primsBundle*)", "``bundle``", "The bundle(s) of multiple prims to be written back. The sourcePrimPath attribute is used to find the destination prim.", "None"
"", "*allowMultiInputs*", "1", ""
"Scatter Under Targets (*inputs:scatterUnderTargets*)", "``bool``", "If true, the target prims become the parent prims that the bundled prims will be exported *UNDER*. If multiple prims targets are provided, the primsBundle will be duplicated *UNDER* each target prims.", "False"
"Prim Type Pattern (*inputs:typePattern*)", "``string``", "A list of wildcard patterns used to match primitives by type. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['Mesh', 'Cone', 'Cube'] '*' - match any '* ^Mesh' - match any, but exclude 'Mesh' '* ^Cone ^Cube' - match any, but exclude 'Cone' and 'Cube'", "*"
"Persist To USD (*inputs:usdWriteBack*)", "``bool``", "Whether or not the value should be written back to USD, or kept a Fabric only value", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port (for action graphs only)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:attrNamesToExport", "``string``", "State from previous evaluation", "*"
"state:layerIdentifier", "``token``", "State from previous evaluation", ""
"state:pathPattern", "``string``", "State from previous evaluation", "*"
"state:primBundleDirtyId", "``uint64``", "State from previous evaluation", "None"
"state:scatterUnderTargets", "``bool``", "State from previous evaluation", "False"
"state:typePattern", "``string``", "State from previous evaluation", "*"
"state:usdWriteBack", "``bool``", "State from previous evaluation", "True"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrimsV2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Write Prims"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnWritePrimsV2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCompare.rst | .. _omni_graph_nodes_Compare_1:
.. _omni_graph_nodes_Compare:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Compare
:keywords: lang-en omnigraph node math:condition threadsafe nodes compare
Compare
=======
.. <description>
Outputs the truth value of a comparison operation. Tuples are compared in lexicographic order. If one input is an array and the other is a scaler, the scaler will be broadcast to the size of the array
.. </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:a", "``any``", "Input A", "None"
"inputs:b", "``any``", "Input B", "None"
"Operation (*inputs:operation*)", "``token``", "The comparison operation to perform (>,<,>=,<=,==,!=))", ">"
"", "*allowedTokens*", ">,<,>=,<=,==,!=", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "The result of the comparison operation", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Compare"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Compare"
"Categories", "math:condition"
"Generated Class Name", "OgnCompareDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnEndsWith.rst | .. _omni_graph_nodes_EndsWith_1:
.. _omni_graph_nodes_EndsWith:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Ends With
:keywords: lang-en omnigraph node function threadsafe nodes ends-with
Ends With
=========
.. <description>
Determines if a string ends with a given string value
.. </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:suffix", "``string``", "The suffix to test", ""
"inputs:value", "``string``", "The string to check", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:isSuffix", "``bool``", "True if 'value' ends with 'suffix'", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.EndsWith"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Ends With"
"Categories", "function"
"Generated Class Name", "OgnEndsWithDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetVariantSetNames.rst | .. _omni_graph_nodes_GetVariantSetNames_2:
.. _omni_graph_nodes_GetVariantSetNames:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Variant Set Names
:keywords: lang-en omnigraph node graph:action,sceneGraph,variants ReadOnly nodes get-variant-set-names
Get Variant Set Names
=====================
.. <description>
Get variantSet names on a prim
.. </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:prim", "``target``", "The prim with the variantSet", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:variantSetNames", "``token[]``", "List of variantSet names", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetVariantSetNames"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.GetVariantSetNames.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Variant Set Names"
"Categories", "graph:action,sceneGraph,variants"
"Generated Class Name", "OgnGetVariantSetNamesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadStageSelection.rst | .. _omni_graph_nodes_ReadStageSelection_1:
.. _omni_graph_nodes_ReadStageSelection:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Stage Selection
:keywords: lang-en omnigraph node sceneGraph ReadOnly nodes read-stage-selection
Read Stage Selection
====================
.. <description>
Outputs the current stage selection as a list of paths
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:selectedPrims", "``token[]``", "The currently selected path(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadStageSelection"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Stage Selection"
"Categories", "sceneGraph"
"Generated Class Name", "OgnReadStageSelectionDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetVariantNames.rst | .. _omni_graph_nodes_GetVariantNames_2:
.. _omni_graph_nodes_GetVariantNames:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Variant Names
:keywords: lang-en omnigraph node graph:action,sceneGraph,variants ReadOnly nodes get-variant-names
Get Variant Names
=================
.. <description>
Get variant names from a variantSet on a prim
.. </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:prim", "``target``", "The prim with the variantSet", "None"
"inputs:variantSetName", "``token``", "The variantSet name", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:variantNames", "``token[]``", "List of variant names", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetVariantNames"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.GetVariantNames.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Variant Names"
"Categories", "graph:action,sceneGraph,variants"
"Generated Class Name", "OgnGetVariantNamesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMoveToTransform.rst | .. _omni_graph_nodes_MoveToTransform_2:
.. _omni_graph_nodes_MoveToTransform:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Move to Transform
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes move-to-transform
Move to Transform
=================
.. <description>
Perform a transformation maneuver, moving a prim to a target transformation given a speed and easing factor. Transformation, Rotation, and Scale from a 4x4 transformation matrix will be applied Note: The Prim must have xform:orient in transform stack in order to interpolate rotations
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:prim", "``target``", "The prim to be transformed", "None"
"inputs:primPath", "``path``", "The source prim to be transformed, used when 'usePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"Target Transform (*inputs:target*)", "``matrixd[4]``", "The desired local transform", "[[1.0, 0.0, 0.0, 0.0], [0.0, 1.0, 0.0, 0.0], [0.0, 0.0, 1.0, 0.0], [0.0, 0.0, 0.0, 1.0]]"
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MoveToTransform"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Move to Transform"
"Categories", "sceneGraph"
"Generated Class Name", "OgnMoveToTransformDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToDeg.rst | .. _omni_graph_nodes_ToDeg_1:
.. _omni_graph_nodes_ToDeg:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Degrees
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-deg
To Degrees
==========
.. <description>
Convert radian input into degrees
.. </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
"Radians (*inputs:radians*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'timecode']``", "Angle value in radians to be converted", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Degrees (*outputs:degrees*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'timecode']``", "Angle value in degrees", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToDeg"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Degrees"
"Categories", "math:conversion"
"Generated Class Name", "OgnToDegDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnBundleInspector.rst | .. _omni_graph_nodes_BundleInspector_3:
.. _omni_graph_nodes_BundleInspector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Bundle Inspector
:keywords: lang-en omnigraph node bundle nodes bundle-inspector
Bundle Inspector
================
.. <description>
This node creates independent outputs containing information about the contents of a bundle attribute. It can be used for testing or debugging what is inside a bundle as it flows through the graph. The bundle is inspected recursively, so any bundles inside of the main bundle have their contents added to the output as well. The bundle contents can be printed when the node evaluates, and it passes the input straight through unchanged so you can insert this node between two nodes to inspect the data flowing through the graph.
.. </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
"Bundle To Analyze (*inputs:bundle*)", "``bundle``", "The attribute bundle to be inspected", "None"
"Inspect Depth (*inputs:inspectDepth*)", "``int``", "The depth that the inspector is going to traverse and print. 0 means just attributes on the input bundles. 1 means its immediate children. -1 means infinity.", "1"
"Print Contents (*inputs:print*)", "``bool``", "Setting to true prints the contents of the bundle when the node evaluates", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Array Depths (*outputs:arrayDepths*)", "``int[]``", "List of the array depths of attributes present in the bundle", "None"
"Attribute Count (*outputs:attributeCount*)", "``uint64``", "Number of attributes present in the bundle. Every other output is an array that should have this number of elements in it.", "None"
"Bundle Passthrough (*outputs:bundle*)", "``bundle``", "The attribute bundle passed through as-is from the input bundle", "None"
"Child Count (*outputs:childCount*)", "``uint64``", "Number of child bundles present in the bundle.", "None"
"Attribute Count (*outputs:count*)", "``uint64``", "Number of attributes present in the bundle. Every other output is an array that should have this number of elements in it.", "None"
"", "*hidden*", "true", ""
"Attribute Names (*outputs:names*)", "``token[]``", "List of the names of attributes present in the bundle", "None"
"Attribute Roles (*outputs:roles*)", "``token[]``", "List of the names of the roles of attributes present in the bundle", "None"
"Tuple Counts (*outputs:tupleCounts*)", "``int[]``", "List of the tuple counts of attributes present in the bundle", "None"
"Attribute Base Types (*outputs:types*)", "``token[]``", "List of the types of attributes present in the bundle", "None"
"Attribute Values (*outputs:values*)", "``token[]``", "List of the bundled attribute values, converted to token format", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BundleInspector"
"Version", "3"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.BundleInspector.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Bundle Inspector"
"Categories", "bundle"
"Generated Class Name", "OgnBundleInspectorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTranslateToLocation.rst | .. _omni_graph_nodes_TranslateToLocation_2:
.. _omni_graph_nodes_TranslateToLocation:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Translate To Location
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes translate-to-location
Translate To Location
=====================
.. <description>
Perform a smooth translation maneuver, translating a prim to a desired point given a speed and easing factor
.. </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
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:prim", "``target``", "The prim to be translated", "None"
"inputs:primPath", "``path``", "The source prim to be transformed, used when 'usePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"inputs:target", "``vectord[3]``", "The desired local position", "[0.0, 0.0, 0.0]"
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.TranslateToLocation"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Translate To Location"
"Categories", "sceneGraph"
"Generated Class Name", "OgnTranslateToLocationDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnNand.rst | .. _omni_graph_nodes_BooleanNand_2:
.. _omni_graph_nodes_BooleanNand:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Boolean NAND
:keywords: lang-en omnigraph node math:condition threadsafe nodes boolean-nand
Boolean NAND
============
.. <description>
Boolean NAND on two or more inputs. If the inputs are arrays, NAND operations will be performed pair-wise. The input sizes must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.
.. </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:a", "``['bool', 'bool[]']``", "Input A: bool or bool array.", "None"
"inputs:b", "``['bool', 'bool[]']``", "Input B: bool or bool array.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "The result of the boolean NAND - an array of booleans if either input is an array, otherwise a boolean.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BooleanNand"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Boolean NAND"
"Categories", "math:condition"
"Generated Class Name", "OgnNandDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMultiply.rst | .. _omni_graph_nodes_Multiply_2:
.. _omni_graph_nodes_Multiply:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Multiply
:keywords: lang-en omnigraph node math:operator threadsafe nodes multiply
Multiply
========
.. <description>
Computes the element-wise product of two or more inputs (multiplication). If one input has a higher dimension than the others, then the input with lower dimension will be repeated to match the dimension of the higher dimension input (broadcasting). eg: scalar * tuple, tuple * array of tuples, scalar * array of tuples.
.. </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:a", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "First number to multiply", "None"
"inputs:b", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Second number to multiply", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:product", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Product of the two numbers", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Multiply"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Multiply"
"Categories", "math:operator"
"Generated Class Name", "OgnMultiplyDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnExtractPrim.rst | .. _omni_graph_nodes_ExtractPrim_1:
.. _omni_graph_nodes_ExtractPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Prim
:keywords: lang-en omnigraph node bundle nodes extract-prim
Extract Prim
============
.. <description>
Extract a child bundle that contains a primitive with requested path/prim. This node is designed to work with Multiple Primitives in a Bundle. It searches for a child bundle in the input bundle, with 'sourcePrimPath' that matches 'inputs:prim' or 'inputs:primPath'. The found child bundle will be provided to 'outputs_primBundle', or invalid, bundle otherwise.
.. </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:prim", "``target``", "The prim to be extracted from Multiple Primitives in Bundle.", "None"
"Prim Path (*inputs:primPath*)", "``path``", "The path of the prim to be extracted from Multiple Primitives in Bundle.", ""
"Prims Bundle (*inputs:prims*)", "``bundle``", "The Multiple Primitives in Bundle to extract from.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primBundle", "``bundle``", "The extracted Single Primitive in Bundle", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ExtractPrim"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Prim"
"Categories", "bundle"
"Generated Class Name", "OgnExtractPrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnSetMatrix4Rotation.rst | .. _omni_graph_nodes_SetMatrix4Rotation_1:
.. _omni_graph_nodes_SetMatrix4Rotation:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set Rotation
:keywords: lang-en omnigraph node math:operator threadsafe nodes set-matrix4-rotation
Set Rotation
============
.. <description>
Sets the rotation of the given matrix4d value which represents a linear transformation. Does not modify the translation (row 3) of the matrix.
.. </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:fixedRotationAxis", "``token``", "The axis of the given rotation", "Y"
"", "*allowedTokens*", "X,Y,Z", ""
"inputs:matrix", "``['matrixd[4]', 'matrixd[4][]']``", "The matrix to be modified", "None"
"Rotation (*inputs:rotationAngle*)", "``['double', 'double[]']``", "The rotation in degrees that the matrix will apply about the given rotationAxis.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:matrix", "``['matrixd[4]', 'matrixd[4][]']``", "The updated matrix", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SetMatrix4Rotation"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Set Rotation"
"Categories", "math:operator"
"Generated Class Name", "OgnSetMatrix4RotationDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAsin.rst | .. _omni_graph_nodes_Asin_1:
.. _omni_graph_nodes_Asin:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Arcsine
:keywords: lang-en omnigraph node math:operator threadsafe nodes asin
Arcsine
=======
.. <description>
Trigonometric operation arcsin of one input in degrees.
.. </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:value", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'timecode']``", "Angle value in degrees whose inverse sine is to be found", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:value*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'timecode']``", "The arcsin value of the input angle in degrees", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Asin"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Arcsine"
"Categories", "math:operator"
"Generated Class Name", "OgnAsinDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGpuInteropCudaEntry.rst | .. _omni_graph_nodes_GpuInteropCudaEntry_1:
.. _omni_graph_nodes_GpuInteropCudaEntry:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: GpuInterop Cuda Entry
:keywords: lang-en omnigraph node threadsafe nodes gpu-interop-cuda-entry
GpuInterop Cuda Entry
=====================
.. <description>
Entry point for Cuda RTX Renderer Postprocessing
.. </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:sourceName", "``string``", "Source name of the AOV", "ldrColor"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"bufferSize (*outputs:bufferSize*)", "``uint``", "Size of the buffer", "None"
"cudaMipmappedArray (*outputs:cudaMipmappedArray*)", "``uint64``", "Pointer to the CUDA Mipmapped Array", "None"
"externalTimeOfSimFrame (*outputs:externalTimeOfSimFrame*)", "``int64``", "The external time on the master node, matching the simulation frame used to render this frame", "None"
"format (*outputs:format*)", "``uint64``", "Format", "None"
"frameId (*outputs:frameId*)", "``int64``", "Frame identifier", "None"
"height (*outputs:height*)", "``uint``", "Height", "None"
"hydraTime (*outputs:hydraTime*)", "``double``", "Hydra time in stage", "None"
"isBuffer (*outputs:isBuffer*)", "``bool``", "True if the entry exposes a buffer as opposed to a texture", "None"
"mipCount (*outputs:mipCount*)", "``uint``", "Mip Count", "None"
"simTime (*outputs:simTime*)", "``double``", "Simulation time", "None"
"stream (*outputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "None"
"width (*outputs:width*)", "``uint``", "Width", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GpuInteropCudaEntry"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "GpuInterop Cuda Entry"
"Generated Class Name", "OgnGpuInteropCudaEntryDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnNoise.rst | .. _omni_graph_nodes_Noise_1:
.. _omni_graph_nodes_Noise:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Noise
:keywords: lang-en omnigraph node math:operator threadsafe nodes noise
Noise
=====
.. <description>
Sample values from a Perlin noise field.
The noise field for any given seed is static: the same input position will always give the same result. This is useful in many areas, such as texturing and animation, where repeatability is essential. If you want a result that varies then you will need to vary either the position or the seed. For example, connecting the 'frame' output of an OnTick node to position will provide a noise result which varies from frame to frame. Perlin noise is locally smooth, meaning that small changes in the sample position will produce small changes in the resulting noise. Varying the seed value will produce a more chaotic result.
Another characteristic of Perlin noise is that it is zero at the corners of each cell in the field. In practical terms this means that integral positions, such as 5.0 in a one-dimensional field or (3.0, -1.0) in a two-dimensional field, will return a result of 0.0. Thus, if the source of your sample positions provides only integral values then all of your results will be zero. To avoid this try offsetting your position values by a fractional amount, such as 0.5.
.. </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:position", "``['float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]']``", "Position(s) within the noise field to be sampled. For a given seed, the same position will always return the same noise value.", "None"
"inputs:seed", "``uint``", "Seed for generating the noise field.", "0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:result", "``['float', 'float[]']``", "Value at the selected position(s) in the noise field.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Noise"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Noise"
"Categories", "math:operator"
"Generated Class Name", "OgnNoiseDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnModulo.rst | .. _omni_graph_nodes_Modulo_1:
.. _omni_graph_nodes_Modulo:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Modulo
:keywords: lang-en omnigraph node math:operator threadsafe nodes modulo
Modulo
======
.. <description>
Computes the modulo of integer inputs (A % B), which is the remainder of A / B If B is zero, the result is zero. If A and B are both non-negative the result is non-negative, otherwise the sign of the result is undefined.
.. </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
"A (*inputs:a*)", "``['int', 'int64', 'uchar', 'uint', 'uint64']``", "The dividend of (A % B)", "None"
"B (*inputs:b*)", "``['int', 'int64', 'uchar', 'uint', 'uint64']``", "The divisor of (A % B)", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['int', 'int64', 'uchar', 'uint', 'uint64']``", "Modulo (A % B), the remainder of A / B", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Modulo"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Modulo"
"Categories", "math:operator"
"Generated Class Name", "OgnModuloDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnArrayRotate.rst | .. _omni_graph_nodes_ArrayRotate_1:
.. _omni_graph_nodes_ArrayRotate:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Array Rotate
:keywords: lang-en omnigraph node math:array threadsafe nodes array-rotate
Array Rotate
============
.. <description>
Shifts the elements of an array by the specified number of steps to the right and wraps elements from one end to the other. A negative step will shift to the left.
.. </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:array", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The array to be modified", "None"
"inputs:steps", "``int``", "The number of steps to shift, negative means shift left instead of right", "0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:array", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The modified array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ArrayRotate"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Array Rotate"
"Categories", "math:array"
"Generated Class Name", "OgnArrayRotateDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimBundle.rst | .. _omni_graph_nodes_ReadPrimBundle_7:
.. _omni_graph_nodes_ReadPrimBundle:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim into Bundle
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prim-bundle
Read Prim into Bundle
=====================
.. <description>
DEPRECATED - use ReadPrims!
.. </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
"Attributes To Import (*inputs:attrNamesToImport*)", "``token``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"Compute Bounding Box (*inputs:computeBoundingBox*)", "``bool``", "For each primitive compute local bounding box and store them as 'bboxMinCorner', 'bboxMaxCorner' and 'bboxTransform' attributes.", "False"
"inputs:prim", "``target``", "The prims to be read from when 'usePath' is false", "None"
"Prim Path (*inputs:primPath*)", "``token``", "The paths of the prims to be read from when 'usePath' is true", ""
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
"Use Path (*inputs:usePath*)", "``bool``", "When true, the 'primPath' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primBundle", "``bundle``", "A bundle containing multiple prims as children. Each child contains data attributes and two additional token attributes named sourcePrimPath and sourcePrimType which contain the path and the type of the Prim being read", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:attrNamesToImport", "``uint64``", "State from previous evaluation", "None"
"state:computeBoundingBox", "``bool``", "State from previous evaluation", "False"
"state:primPath", "``uint64``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "NaN"
"state:usePath", "``bool``", "State from previous evaluation", "False"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimBundle"
"Version", "7"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.ReadPrimBundle.svg"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Read Prim into Bundle"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimBundleDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAdd.rst | .. _omni_graph_nodes_Add_2:
.. _omni_graph_nodes_Add:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Add
:keywords: lang-en omnigraph node math:operator threadsafe nodes add
Add
===
.. <description>
Add two or more values of any numeric type (element-wise). This includes simple values, tuples, arrays, and arrays of tuples. If one input has a higher dimension than the other, then the input with lower dimension will be repeated to match the dimension of the other input (broadcasting). eg: scalar + tuple, tuple + array of tuples, scalar + array of tuples.
.. </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:a", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "First number or collection of numbers to add", "None"
"inputs:b", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Second number or collection of numbers to add", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:sum", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Sum of the two numbers or collection of numbers", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Add"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Add"
"Categories", "math:operator"
"Generated Class Name", "OgnAddDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantDouble3.rst | .. _omni_graph_nodes_ConstantDouble3_1:
.. _omni_graph_nodes_ConstantDouble3:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Double3
:keywords: lang-en omnigraph node constants nodes constant-double3
Constant Double3
================
.. <description>
Holds a 3-component double constant.
.. </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
"Value (*inputs:value*)", "``double[3]``", "The constant value", "[0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantDouble3"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantDouble3Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnArrayFindValue.rst | .. _omni_graph_nodes_ArrayFindValue_1:
.. _omni_graph_nodes_ArrayFindValue:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Array Find Value
:keywords: lang-en omnigraph node math:array threadsafe nodes array-find-value
Array Find Value
================
.. <description>
Searches for a value in an array, returns the index of the first occurrence of the value, or -1 if not found.
.. </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
"Array (*inputs:array*)", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The array to be searched", "None"
"inputs:value", "``['bool', 'colord[3]', 'colord[4]', 'colorf[3]', 'colorf[4]', 'colorh[3]', 'colorh[4]', 'double', 'double[2]', 'double[3]', 'double[4]', 'float', 'float[2]', 'float[3]', 'float[4]', 'frame[4]', 'half', 'half[2]', 'half[3]', 'half[4]', 'int', 'int64', 'int[2]', 'int[3]', 'int[4]', 'matrixd[3]', 'matrixd[4]', 'normald[3]', 'normalf[3]', 'normalh[3]', 'pointd[3]', 'pointf[3]', 'pointh[3]', 'quatd[4]', 'quatf[4]', 'quath[4]', 'texcoordd[2]', 'texcoordd[3]', 'texcoordf[2]', 'texcoordf[3]', 'texcoordh[2]', 'texcoordh[3]', 'timecode', 'token', 'transform[4]', 'uchar', 'uint', 'uint64', 'vectord[3]', 'vectorf[3]', 'vectorh[3]']``", "The value to be found", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Index (*outputs:index*)", "``int``", "The index of the first occurrence of value, or -1 if not found", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ArrayFindValue"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Array Find Value"
"Categories", "math:array"
"Generated Class Name", "OgnArrayFindValueDatabase"
"Python Module", "omni.graph.nodes"
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.