file_path
stringlengths 20
202
| content
stringlengths 9
3.85M
| size
int64 9
3.85M
| lang
stringclasses 9
values | avg_line_length
float64 3.33
100
| max_line_length
int64 8
993
| alphanum_fraction
float64 0.26
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadTime.rst
|
.. _omni_graph_nodes_ReadTime_1:
.. _omni_graph_nodes_ReadTime:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Time
:keywords: lang-en omnigraph node time threadsafe nodes read-time
Read Time
=========
.. <description>
Holds the values related to the current global time and the timeline
.. </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
"Absolute Simulation Time (Seconds) (*outputs:absoluteSimTime*)", "``double``", "The accumulated total of elapsed times between rendered frames", "None"
"Delta (Seconds) (*outputs:deltaSeconds*)", "``double``", "The number of seconds elapsed since the last OmniGraph update", "None"
"Animation Time (Frames) (*outputs:frame*)", "``double``", "The global animation time in frames, equivalent to (time * fps), during playback", "None"
"Is Playing (*outputs:isPlaying*)", "``bool``", "True during global animation timeline playback", "None"
"Animation Time (Seconds) (*outputs:time*)", "``double``", "The global animation time in seconds during playback", "None"
"Time Since Start (Seconds) (*outputs:timeSinceStart*)", "``double``", "Elapsed time since the App started", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadTime"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Time"
"Categories", "time"
"Generated Class Name", "OgnReadTimeDatabase"
"Python Module", "omni.graph.nodes"
| 2,032 |
reStructuredText
| 30.765625 | 156 | 0.602362 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnArrayRemoveValue.rst
|
.. _omni_graph_nodes_ArrayRemoveValue_1:
.. _omni_graph_nodes_ArrayRemoveValue:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Array Remove Value
:keywords: lang-en omnigraph node math:array threadsafe nodes array-remove-value
Array Remove Value
==================
.. <description>
Removes the first occurrence of the given value from an array. If removeAll is true, removes all occurrences
.. </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:removeAll", "``bool``", "If true, removes all occurences of the value.", "False"
"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 removed", "None"
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"
"outputs:found", "``bool``", "true if a value was removed, false otherwise", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ArrayRemoveValue"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Array Remove Value"
"Categories", "math:array"
"Generated Class Name", "OgnArrayRemoveValueDatabase"
"Python Module", "omni.graph.nodes"
| 3,940 |
reStructuredText
| 54.507041 | 800 | 0.530203 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToRad.rst
|
.. _omni_graph_nodes_ToRad_1:
.. _omni_graph_nodes_ToRad:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Radians
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-rad
To Radians
==========
.. <description>
Convert degree input into 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
"Degrees (*inputs:degrees*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'timecode']``", "Angle value in degrees to be converted", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Radians (*outputs:radians*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'timecode']``", "Angle value in radians", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToRad"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Radians"
"Categories", "math:conversion"
"Generated Class Name", "OgnToRadDatabase"
"Python Module", "omni.graph.nodes"
| 1,632 |
reStructuredText
| 23.014706 | 162 | 0.542892 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRpResourceExampleDeformer.rst
|
.. _omni_graph_nodes_RpResourceExampleDeformer_1:
.. _omni_graph_nodes_RpResourceExampleDeformer:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: RpResource Example Deformer Node
:keywords: lang-en omnigraph node nodes rp-resource-example-deformer
RpResource Example Deformer Node
================================
.. <description>
Allocate CUDA-interoperable RpResource
.. </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
"Deform Scale (*inputs:deformScale*)", "``float``", "Deformation control", "1.0"
"Displacement Axis (*inputs:displacementAxis*)", "``int``", "dimension in which mesh is translated", "0"
"Point Counts (*inputs:pointCountCollection*)", "``uint64[]``", "Pointer to point counts collection", "[]"
"Position Scale (*inputs:positionScale*)", "``float``", "Deformation control", "1.0"
"Prim Paths (*inputs:primPathCollection*)", "``token[]``", "Pointer to prim path collection", "[]"
"Resource Pointer Collection (*inputs:resourcePointerCollection*)", "``uint64[]``", "Pointer to RpResource collection", "[]"
"Run Deformer (*inputs:runDeformerKernel*)", "``bool``", "Whether cuda kernel will be executed", "True"
"stream (*inputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "0"
"Time Scale (*inputs:timeScale*)", "``float``", "Deformation control", "0.01"
"Verbose (*inputs:verbose*)", "``bool``", "verbose printing", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Point Counts (*outputs:pointCountCollection*)", "``uint64[]``", "Point count for each prim being deformed", "None"
"Prim Paths (*outputs:primPathCollection*)", "``token[]``", "Path for each prim being deformed", "None"
"Reload (*outputs:reload*)", "``bool``", "Force RpResource reload", "False"
"Resource Pointer Collection (*outputs:resourcePointerCollection*)", "``uint64[]``", "Pointers to RpResources (two resources per prim are assumed -- one for rest positions and one for deformed positions)", "None"
"stream (*outputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:sequenceCounter", "``uint64``", "tick counter for animation", "0"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RpResourceExampleDeformer"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "RpResource Example Deformer Node"
"__tokens", "{""points"": ""points"", ""transform"": ""transform"", ""rpResource"": ""rpResource"", ""pointCount"": ""pointCount"", ""primPath"": ""primPath"", ""testToken"": ""testToken"", ""uintData"": ""uintData""}"
"Generated Class Name", "OgnRpResourceExampleDeformerDatabase"
"Python Module", "omni.graph.nodes"
| 3,443 |
reStructuredText
| 37.266666 | 222 | 0.610805 |
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"
| 2,175 |
reStructuredText
| 28.405405 | 130 | 0.584828 |
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"
| 1,950 |
reStructuredText
| 27.275362 | 234 | 0.559487 |
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"
| 2,556 |
reStructuredText
| 33.093333 | 167 | 0.595853 |
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"
| 2,319 |
reStructuredText
| 31.222222 | 415 | 0.616645 |
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"
| 2,530 |
reStructuredText
| 33.671232 | 662 | 0.628854 |
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"
| 2,935 |
reStructuredText
| 37.12987 | 195 | 0.62862 |
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"
| 2,145 |
reStructuredText
| 30.558823 | 737 | 0.613054 |
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"
| 2,097 |
reStructuredText
| 27.351351 | 122 | 0.577492 |
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"
| 6,754 |
reStructuredText
| 69.364583 | 613 | 0.677821 |
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"
| 2,003 |
reStructuredText
| 24.692307 | 95 | 0.547179 |
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"
| 2,058 |
reStructuredText
| 28 | 368 | 0.593294 |
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"
| 2,288 |
reStructuredText
| 31.239436 | 196 | 0.618881 |
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"
| 3,215 |
reStructuredText
| 36.835294 | 610 | 0.625816 |
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"
| 1,623 |
reStructuredText
| 22.536232 | 95 | 0.554529 |
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"
| 3,679 |
reStructuredText
| 48.066666 | 652 | 0.616472 |
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"
| 2,049 |
reStructuredText
| 24.625 | 134 | 0.565642 |
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"
| 1,937 |
reStructuredText
| 26.685714 | 217 | 0.588539 |
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"
| 2,027 |
reStructuredText
| 27.166666 | 111 | 0.571288 |
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"
| 2,406 |
reStructuredText
| 28 | 177 | 0.588944 |
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"
| 2,980 |
reStructuredText
| 33.264367 | 206 | 0.612416 |
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"
| 2,026 |
reStructuredText
| 28.376811 | 275 | 0.600691 |
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"
| 1,993 |
reStructuredText
| 27.485714 | 138 | 0.593578 |
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"
| 1,974 |
reStructuredText
| 26.816901 | 116 | 0.582067 |
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"
| 2,219 |
reStructuredText
| 31.173913 | 365 | 0.590807 |
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"
| 1,800 |
reStructuredText
| 23.013333 | 95 | 0.539444 |
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"
| 1,685 |
reStructuredText
| 23.434782 | 103 | 0.569139 |
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"
| 1,574 |
reStructuredText
| 25.694915 | 238 | 0.590216 |
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"
| 1,893 |
reStructuredText
| 25.305555 | 116 | 0.570523 |
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"
| 2,496 |
reStructuredText
| 32.293333 | 151 | 0.601362 |
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"
| 2,007 |
reStructuredText
| 28.529411 | 303 | 0.534131 |
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"
| 2,010 |
reStructuredText
| 24.455696 | 115 | 0.564677 |
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"
| 2,895 |
reStructuredText
| 38.671232 | 516 | 0.600345 |
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"
| 2,032 |
reStructuredText
| 28.042857 | 227 | 0.594488 |
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"
| 1,635 |
reStructuredText
| 22.710145 | 104 | 0.563303 |
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"
| 2,069 |
reStructuredText
| 29 | 236 | 0.573224 |
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"
| 5,550 |
reStructuredText
| 58.688171 | 652 | 0.649369 |
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"
| 1,539 |
reStructuredText
| 21.31884 | 95 | 0.545159 |
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"
| 1,408 |
reStructuredText
| 22.881356 | 95 | 0.570312 |
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"
| 3,811 |
reStructuredText
| 46.061728 | 528 | 0.653897 |
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"
| 2,092 |
reStructuredText
| 28.9 | 360 | 0.607553 |
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"
| 1,968 |
reStructuredText
| 26.732394 | 161 | 0.582317 |
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"
| 2,546 |
reStructuredText
| 31.653846 | 181 | 0.593087 |
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"
| 2,849 |
reStructuredText
| 39.140845 | 621 | 0.646894 |
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"
| 1,840 |
reStructuredText
| 25.681159 | 222 | 0.547826 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRenderPreprocessEntry.rst
|
.. _omni_graph_nodes_RenderPreProcessEntry_1:
.. _omni_graph_nodes_RenderPreProcessEntry:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Render Preprocess Entry
:keywords: lang-en omnigraph node nodes render-pre-process-entry
Render Preprocess Entry
=======================
.. <description>
Entry point for RTX Renderer Preprocessing
.. </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
"hydraTime (*outputs:hydraTime*)", "``double``", "Hydra time in stage", "None"
"simTime (*outputs:simTime*)", "``double``", "Simulation time", "None"
"stream (*outputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RenderPreProcessEntry"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Render Preprocess Entry"
"Generated Class Name", "OgnRenderPreprocessEntryDatabase"
"Python Module", "omni.graph.nodes"
| 1,530 |
reStructuredText
| 24.516666 | 95 | 0.571242 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGraphTarget.rst
|
.. _omni_graph_nodes_GraphTarget_1:
.. _omni_graph_nodes_GraphTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Graph Target
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes graph-target
Get Graph Target
================
.. <description>
Access the target prim the graph is being executed on. If the graph is executing itself, this will output the prim path of the graph. Otherwise the graph is being executed via instancing, then this will output the prim path of the target instance.
.. </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:targetPath", "``token``", "Deprecated. Do not use.", ""
"", "*hidden*", "true", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primPath", "``token``", "The target prim path", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GraphTarget"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Graph Target"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGraphTargetDatabase"
"Python Module", "omni.graph.nodes"
| 1,747 |
reStructuredText
| 24.333333 | 248 | 0.576417 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimRelationship.rst
|
.. _omni_graph_nodes_ReadPrimRelationship_1:
.. _omni_graph_nodes_ReadPrimRelationship:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim Relationship
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes read-prim-relationship
Read Prim Relationship
======================
.. <description>
Reads the target(s) of a relationship on a given 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
"Relationship Name (*inputs:name*)", "``token``", "The name of the relationship to read", ""
"inputs:prim", "``target``", "The prim with the named relationship to read", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``target``", "The relationship target(s)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:correctlySetup", "``bool``", "Whether or not the instance is properly setup", "False"
"state:name", "``token``", "The prefetched relationship name", "None"
"state:prim", "``target``", "The currently prefetched prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimRelationship"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "usd"
"uiName", "Read Prim Relationship"
"Categories", "sceneGraph"
"Generated Class Name", "OgnReadPrimRelationshipDatabase"
"Python Module", "omni.graph.nodes"
| 2,073 |
reStructuredText
| 24.925 | 97 | 0.582248 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRenameAttr.rst
|
.. _omni_graph_nodes_RenameAttribute_1:
.. _omni_graph_nodes_RenameAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Rename Attributes In Bundles
:keywords: lang-en omnigraph node bundle nodes rename-attribute
Rename Attributes In Bundles
============================
.. <description>
Changes the names of attributes from an input bundle for the corresponding output bundle. Attributes whose names are not in the 'inputAttrNames' list will be copied from the input bundle to the output bundle without changing the name.
.. </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
"Original Attribute Bundle (*inputs:data*)", "``bundle``", "Collection of attributes to be renamed", "None"
"Attributes To Rename (*inputs:inputAttrNames*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be renamed", ""
"New Attribute Names (*inputs:outputAttrNames*)", "``token``", "Comma or space separated text, listing the new names for the attributes listed in inputAttrNames", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Bundle Of Renamed Attributes (*outputs:data*)", "``bundle``", "Final bundle of attributes, with attributes renamed based on inputAttrNames and outputAttrNames", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RenameAttribute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Rename Attributes In Bundles"
"Categories", "bundle"
"Generated Class Name", "OgnRenameAttrDatabase"
"Python Module", "omni.graph.nodes"
| 2,233 |
reStructuredText
| 30.914285 | 234 | 0.622481 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetMatrix4Quaternion.rst
|
.. _omni_graph_nodes_GetMatrix4Quaternion_1:
.. _omni_graph_nodes_GetMatrix4Quaternion:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Rotation Quaternion
:keywords: lang-en omnigraph node math:operator threadsafe nodes get-matrix4-quaternion
Get Rotation Quaternion
=======================
.. <description>
Gets the rotation of the given matrix4d value which represents a linear transformation. Returns a quaternion
.. </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:matrix", "``['matrixd[4]', 'matrixd[4][]']``", "The transformation matrix", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:quaternion", "``['quatd[4]', 'quatd[4][]']``", "quaternion representing the orientation of the matrix transformation", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetMatrix4Quaternion"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Rotation Quaternion"
"Categories", "math:operator"
"Generated Class Name", "OgnGetMatrix4QuaternionDatabase"
"Python Module", "omni.graph.nodes"
| 1,754 |
reStructuredText
| 24.808823 | 138 | 0.586659 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnHasAttr.rst
|
.. _omni_graph_nodes_HasAttribute_1:
.. _omni_graph_nodes_HasAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Has Attribute
:keywords: lang-en omnigraph node bundle threadsafe nodes has-attribute
Has Attribute
=============
.. <description>
Inspect an input bundle for a named attribute, setting output to true if it exists
.. </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 To Find (*inputs:attrName*)", "``token``", "Name of the attribute to look for in the bundle", "points"
"Bundle To Check (*inputs:data*)", "``bundle``", "Collection of attributes that may contain the named attribute", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Attribute In Bundle (*outputs:output*)", "``bool``", "True if the named attribute was found in the bundle", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.HasAttribute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Has Attribute"
"Categories", "bundle"
"Generated Class Name", "OgnHasAttrDatabase"
"Python Module", "omni.graph.nodes"
| 1,760 |
reStructuredText
| 24.521739 | 124 | 0.577841 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTimelineLoop.rst
|
.. _omni_graph_nodes_LoopTimeline_1:
.. _omni_graph_nodes_LoopTimeline:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set playback looping
:keywords: lang-en omnigraph node time compute-on-request nodes loop-timeline
Set playback looping
====================
.. <description>
Controls looping playback 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"
"Loop (*inputs:loop*)", "``bool``", "Enable or disable playback looping?", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"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.LoopTimeline"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Set playback looping"
"Categories", "time"
"Generated Class Name", "OgnTimelineLoopDatabase"
"Python Module", "omni.graph.nodes"
| 1,717 |
reStructuredText
| 23.89855 | 119 | 0.570181 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnPartialSum.rst
|
.. _omni_graph_nodes_PartialSum_1:
.. _omni_graph_nodes_PartialSum:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Compute Integer Array Partial Sums
:keywords: lang-en omnigraph node math:operator threadsafe nodes partial-sum
Compute Integer Array Partial Sums
==================================
.. <description>
Compute the partial sums of the input integer array named 'array' and put the result in an output integer array named 'partialSum'. A partial sum is the sum of all of the elements up to but not including a certain point in an array, so output element 0 is always 0, element 1 is array[0], element 2 is array[0] + array[1], etc.
.. </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", "``int[]``", "List of integers whose partial sum is to be computed", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:partialSum", "``int[]``", "Array whose nth value equals the nth partial sum of the input 'array'", "[]"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.PartialSum"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Compute Integer Array Partial Sums"
"Categories", "math:operator"
"Generated Class Name", "OgnPartialSumDatabase"
"Python Module", "omni.graph.nodes"
| 1,946 |
reStructuredText
| 27.632353 | 330 | 0.5889 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetLookAtRotation.rst
|
.. _omni_graph_nodes_GetLookAtRotation_1:
.. _omni_graph_nodes_GetLookAtRotation:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Look At Rotation
:keywords: lang-en omnigraph node math:operator threadsafe nodes get-look-at-rotation
Get Look At Rotation
====================
.. <description>
Computes the rotation angles to align a forward direction vector to a direction vector formed by starting at 'start' and pointing at 'target'. The forward vector is the 'default' orientation of the asset being rotated, usually +X or +Z
.. </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:forward", "``double[3]``", "The direction vector to be aligned with the look vector", "[0.0, 0.0, 1.0]"
"inputs:start", "``pointd[3]``", "The position to look from", "[0.0, 0.0, 0.0]"
"inputs:target", "``pointd[3]``", "The position to look at", "[0.0, 0.0, 0.0]"
"inputs:up", "``double[3]``", "The direction considered to be 'up'. If not specified scene-up will be used.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:orientation", "``quatd[4]``", "The orientation quaternion equivalent to outputs:rotateXYZ", "None"
"outputs:rotateXYZ", "``double[3]``", "The rotation vector [X, Y, Z]", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetLookAtRotation"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Look At Rotation"
"Categories", "math:operator"
"Generated Class Name", "OgnGetLookAtRotationDatabase"
"Python Module", "omni.graph.nodes"
| 2,221 |
reStructuredText
| 29.861111 | 237 | 0.591625 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetMatrix4Translation.rst
|
.. _omni_graph_nodes_GetMatrix4Translation_1:
.. _omni_graph_nodes_GetMatrix4Translation:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Translation
:keywords: lang-en omnigraph node math:operator threadsafe nodes get-matrix4-translation
Get Translation
===============
.. <description>
Gets the translation of the given matrix4d value which represents a linear transformation. Returns a vector3
.. </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:matrix", "``['matrixd[4]', 'matrixd[4][]']``", "The matrix to be modified", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Translation (*outputs:translation*)", "``['vectord[3]', 'vectord[3][]']``", "The translation from the transformation matrix", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetMatrix4Translation"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Translation"
"Categories", "math:operator"
"Generated Class Name", "OgnGetMatrix4TranslationDatabase"
"Python Module", "omni.graph.nodes"
| 1,726 |
reStructuredText
| 24.397058 | 137 | 0.58343 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnInvertMatrix.rst
|
.. _omni_graph_nodes_OgnInvertMatrix_1:
.. _omni_graph_nodes_OgnInvertMatrix:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Invert Matrix
:keywords: lang-en omnigraph node math:operator threadsafe nodes ogn-invert-matrix
Invert Matrix
=============
.. <description>
Invert a matrix or an array of matrices. Returns the FLOAT_MAX * identity if the matrix is singular
.. </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:matrix", "``['matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]']``", "The input matrix or matrices to invert", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:invertedMatrix", "``['matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]']``", "the resulting inverted matrix or matrices", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.OgnInvertMatrix"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Invert Matrix"
"Categories", "math:operator"
"Generated Class Name", "OgnInvertMatrixDatabase"
"Python Module", "omni.graph.nodes"
| 1,731 |
reStructuredText
| 24.470588 | 149 | 0.569035 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnIsEmpty.rst
|
.. _omni_graph_nodes_IsEmpty_1:
.. _omni_graph_nodes_IsEmpty:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Is Empty
:keywords: lang-en omnigraph node function threadsafe nodes is-empty
Is Empty
========
.. <description>
Checks if the given input is empty. An input is considered empty if there is no data. A string or array of size 0 is considered empty whereas a blank string ' ' is not empty. A float with value 0.0 and int[2] with value [0, 0] are not empty.
.. </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
"Input (*inputs:input*)", "``any``", "The input to check if empty", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Empty (*outputs:isEmpty*)", "``bool``", "True if the input is empty, false otherwise", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.IsEmpty"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Is Empty"
"Categories", "function"
"Generated Class Name", "OgnIsEmptyDatabase"
"Python Module", "omni.graph.nodes"
| 1,698 |
reStructuredText
| 23.985294 | 241 | 0.566549 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnExtractBundle.rst
|
.. _omni_graph_nodes_ExtractBundle_3:
.. _omni_graph_nodes_ExtractBundle:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Bundle
:keywords: lang-en omnigraph node bundle nodes extract-bundle
Extract Bundle
==============
.. <description>
Exposes readable attributes for a bundle as outputs on this node. When this node computes it will read the latest attribute values from the target bundle into these node attributes
.. </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"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:passThrough", "``bundle``", "The input bundle passed as-is", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ExtractBundle"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Bundle"
"Categories", "bundle"
"Generated Class Name", "OgnExtractBundleDatabase"
"Python Module", "omni.graph.nodes"
| 1,649 |
reStructuredText
| 23.264706 | 180 | 0.57732 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMakeArray.rst
|
.. _omni_graph_nodes_MakeArray_1:
.. _omni_graph_nodes_MakeArray:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make Array
:keywords: lang-en omnigraph node math:array nodes make-array
Make Array
==========
.. <description>
Makes an output array attribute from input values, in the order of the inputs. If 'arraySize' is less than 5, the top 'arraySize' elements will be taken. If 'arraySize' is greater than 5 element e will be repeated to fill the remaining space
.. </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[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]']``", "Element 1", "None"
"inputs:arraySize", "``int``", "The size of the array to create", "0"
"inputs:b", "``['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]']``", "Element 2", "None"
"inputs:c", "``['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]']``", "Element 3", "None"
"inputs:d", "``['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]']``", "Element 4", "None"
"inputs:e", "``['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]']``", "Element 5", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:array", "``['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 of copied values of inputs in the given order", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MakeArray"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Make Array"
"Categories", "math:array"
"Generated Class Name", "OgnMakeArrayDatabase"
"Python Module", "omni.graph.nodes"
| 5,751 |
reStructuredText
| 76.729729 | 812 | 0.541297 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnInsertAttr.rst
|
.. _omni_graph_nodes_InsertAttribute_1:
.. _omni_graph_nodes_InsertAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Insert Attribute
:keywords: lang-en omnigraph node bundle nodes insert-attribute
Insert Attribute
================
.. <description>
Copies all attributes from an input bundle to the output bundle, as well as copying an additional 'attrToInsert' attribute from the node itself with a specified name.
.. </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 To Insert (*inputs:attrToInsert*)", "``any``", "The the attribute to be copied from the node to the output bundle", "None"
"Original Bundle (*inputs:data*)", "``bundle``", "Initial bundle of attributes", "None"
"Attribute Name (*inputs:outputAttrName*)", "``token``", "The name of the new output attribute in the bundle", "attr0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Bundle With Inserted Attribute (*outputs:data*)", "``bundle``", "Bundle of input attributes with the new one inserted with the specified name", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.InsertAttribute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Insert Attribute"
"Categories", "bundle"
"Generated Class Name", "OgnInsertAttrDatabase"
"Python Module", "omni.graph.nodes"
| 2,003 |
reStructuredText
| 27.628571 | 166 | 0.601098 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetGraphTargetId.rst
|
.. _omni_graph_nodes_GetGraphTargetId_1:
.. _omni_graph_nodes_GetGraphTargetId:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Graph Target Id
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-graph-target-id
Get Graph Target Id
===================
.. <description>
Access a unique id for the target prim the graph is being executed on.
.. </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:targetId", "``uint64``", "The target prim id", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetGraphTargetId"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetGraphTargetIdDatabase"
"Python Module", "omni.graph.nodes"
| 1,359 |
reStructuredText
| 22.448275 | 95 | 0.562178 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadGamepadState.rst
|
.. _omni_graph_nodes_ReadGamepadState_1:
.. _omni_graph_nodes_ReadGamepadState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Gamepad State
:keywords: lang-en omnigraph node input:gamepad threadsafe nodes read-gamepad-state
Read Gamepad State
==================
.. <description>
Reads the current state of the gamepad
.. </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
"Deadzone (*inputs:deadzone*)", "``float``", "Threshold from [0, 1] that the value must pass for it to be registered as input", "0.1"
"Element (*inputs:gamepadElement*)", "``token``", "The gamepad element to check the state of", "Left Stick X Axis"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "Left Stick X Axis,Left Stick Y Axis,Right Stick X Axis,Right Stick Y Axis,Left Trigger,Right Trigger,Face Button Bottom,Face Button Right,Face Button Left,Face Button Top,Left Shoulder,Right Shoulder,Special Left,Special Right,Left Stick Button,Right Stick Button,D-Pad Up,D-Pad Right,D-Pad Down,D-Pad Left", ""
"Gamepad ID (*inputs:gamepadId*)", "``uint``", "Gamepad id number starting from 0", "0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:isPressed", "``bool``", "True if the gamepad element is currently pressed, false otherwise", "None"
"outputs:value", "``float``", "Value of how much the gamepad element is being pressed. [0, 1] for buttons [-1, 1] for stick and trigger", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadGamepadState"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Gamepad State"
"Categories", "input:gamepad"
"Generated Class Name", "OgnReadGamepadStateDatabase"
"Python Module", "omni.graph.nodes"
| 2,404 |
reStructuredText
| 31.945205 | 339 | 0.612729 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToUint64.rst
|
.. _omni_graph_nodes_ToUint64_1:
.. _omni_graph_nodes_ToUint64:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Uint64
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-uint64
To Uint64
=========
.. <description>
Converts the given input to a 64 bit unsigned integer of the same shape. Negative integers are converted by adding them to 2**64, decimal numbers are truncated.
.. </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[]', 'double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int64', 'int64[]', 'int[]', 'uchar', 'uchar[]', 'uint', 'uint[]']``", "The numeric value to convert to uint64", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Uint64 (*outputs:converted*)", "``['uint64', 'uint64[]']``", "Converted output", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToUint64"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Uint64"
"Categories", "math:conversion"
"Generated Class Name", "OgnToUint64Database"
"Python Module", "omni.graph.nodes"
| 1,791 |
reStructuredText
| 25.352941 | 238 | 0.557789 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetParentPath.rst
|
.. _omni_graph_nodes_GetParentPath_1:
.. _omni_graph_nodes_GetParentPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Parent Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-parent-path
Get Parent Path
===============
.. <description>
Generates a parent path token from another path token. (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:path", "``['token', 'token[]']``", "One or more path tokens to compute a parent path from. (ex. /World/Cube)", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:parentPath", "``['token', 'token[]']``", "Parent path token (ex. /World)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:path", "``token``", "Snapshot of previously seen path", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetParentPath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Parent Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetParentPathDatabase"
"Python Module", "omni.graph.nodes"
| 1,830 |
reStructuredText
| 22.77922 | 129 | 0.557377 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMatrixMultiply.rst
|
.. _omni_graph_nodes_MatrixMultiply_1:
.. _omni_graph_nodes_MatrixMultiply:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Matrix Multiply
:keywords: lang-en omnigraph node math:operator threadsafe nodes matrix-multiply
Matrix Multiply
===============
.. <description>
Computes the matrix product of the inputs. Inputs must be compatible. Also accepts tuples (treated as vectors) as inputs. Tuples in input A will be treated as row vectors. Tuples in input B will be treated as column vectors. Arrays of inputs will be computed element-wise with broadcasting if necessary.
.. </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[4]', 'colorf[3]', 'colorf[4]', 'colorh[3]', 'colorh[4]', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'frame[4]', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', '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]', 'transform[4]', 'vectord[3]', 'vectorf[3]', 'vectorh[3]']``", "First matrix or row vector to multiply", "None"
"B (*inputs:b*)", "``['colord[3]', 'colord[4]', 'colorf[3]', 'colorf[4]', 'colorh[3]', 'colorh[4]', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'frame[4]', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', '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]', 'transform[4]', 'vectord[3]', 'vectorf[3]', 'vectorh[3]']``", "Second matrix or column vector to multiply", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Product (*outputs:output*)", "``['colord[3]', 'colord[4]', 'colorf[3]', 'colorf[4]', 'colorh[3]', '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]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', '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]', 'transform[4]', 'vectord[3]', 'vectorf[3]', 'vectorh[3]']``", "Product of the two matrices", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MatrixMultiply"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Matrix Multiply"
"Categories", "math:operator"
"Generated Class Name", "OgnMatrixMultiplyDatabase"
"Python Module", "omni.graph.nodes"
| 3,923 |
reStructuredText
| 55.869564 | 794 | 0.557227 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMakeTransform.rst
|
.. _omni_graph_nodes_MakeTransform_1:
.. _omni_graph_nodes_MakeTransform:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make Transformation Matrix from TRS
:keywords: lang-en omnigraph node math:operator threadsafe nodes make-transform
Make Transformation Matrix from TRS
===================================
.. <description>
Make a transformation matrix that performs a translation, rotation (in euler angles), and scale in that order
.. </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:rotationXYZ", "``vectord[3]``", "The desired orientation in euler angles (XYZ)", "[0, 0, 0]"
"inputs:scale", "``vectord[3]``", "The desired scaling factor about the X, Y, and Z axis respectively", "[1, 1, 1]"
"inputs:translation", "``vectord[3]``", "the desired translation as a vector", "[0, 0, 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.MakeTransform"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Make Transformation Matrix from TRS"
"Categories", "math:operator"
"Generated Class Name", "OgnMakeTransformDatabase"
"Python Module", "omni.graph.nodes"
| 1,942 |
reStructuredText
| 26.757142 | 119 | 0.581874 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrimMaterial.rst
|
.. _omni_graph_nodes_WritePrimMaterial_1:
.. _omni_graph_nodes_WritePrimMaterial:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prim Material
:keywords: lang-en omnigraph node sceneGraph WriteOnly nodes write-prim-material
Write Prim Material
===================
.. <description>
Given a path to a prim and a path to a material on the current USD stage, assigns the material to the prim. Gives an error if the given prim or material can not be 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
"inputs:execIn", "``execution``", "Input execution", "None"
"inputs:material", "``target``", "The material to be assigned to the prim", "None"
"Material Path (*inputs:materialPath*)", "``path``", "The path of the material to be assigned to the prim", ""
"inputs:prim", "``target``", "Prim to be assigned a material.", "None"
"Prim Path (*inputs:primPath*)", "``path``", "Path of the prim to be assigned a material.", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "Output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrimMaterial"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Write Prim Material"
"Categories", "sceneGraph"
"Generated Class Name", "OgnWritePrimMaterialDatabase"
"Python Module", "omni.graph.nodes"
| 2,055 |
reStructuredText
| 27.555555 | 173 | 0.586861 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAttrType.rst
|
.. _omni_graph_nodes_AttributeType_1:
.. _omni_graph_nodes_AttributeType:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Attribute Type Information
:keywords: lang-en omnigraph node bundle threadsafe nodes attribute-type
Extract Attribute Type Information
==================================
.. <description>
Queries information about the type of a specified attribute in an input 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 To Query (*inputs:attrName*)", "``token``", "The name of the attribute to be queried", "input"
"Bundle To Examine (*inputs:data*)", "``bundle``", "Bundle of attributes to examine", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attribute Array Depth (*outputs:arrayDepth*)", "``int``", "Zero for a single value, one for an array, two for an array of arrays. Set to -1 if the named attribute was not in the bundle.", "None"
"Attribute Base Type (*outputs:baseType*)", "``int``", "An integer representing the type of the individual components. Set to -1 if the named attribute was not in the bundle.", "None"
"Attribute Component Count (*outputs:componentCount*)", "``int``", "Number of components in each tuple, e.g. one for float, three for point3f, 16 for matrix4d. Set to -1 if the named attribute was not in the bundle.", "None"
"Full Attribute Type (*outputs:fullType*)", "``int``", "A single int representing the full type information. Set to -1 if the named attribute was not in the bundle.", "None"
"Attribute Role (*outputs:role*)", "``int``", "An integer representing semantic meaning of the type, e.g. point3f vs. normal3f vs. vector3f vs. float3. Set to -1 if the named attribute was not in the bundle.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AttributeType"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Attribute Type Information"
"Categories", "bundle"
"Generated Class Name", "OgnAttrTypeDatabase"
"Python Module", "omni.graph.nodes"
| 2,702 |
reStructuredText
| 36.027397 | 228 | 0.622132 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimRelationship.rst
|
.. _omni_graph_nodes_GetPrimRelationship_3:
.. _omni_graph_nodes_GetPrimRelationship:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prim Relationship
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes get-prim-relationship
Get Prim Relationship
=====================
.. <description>
DEPRECATED - Use ReadPrimRelationship!
.. </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
"Relationship Name (*inputs:name*)", "``token``", "Name of the relationship property", ""
"Prim Path (*inputs:path*)", "``token``", "Path of the prim with the relationship property", "None"
"inputs:prim", "``target``", "The prim with the relationship", "None"
"inputs:usePath", "``bool``", "When true, the 'path' 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
"Paths (*outputs:paths*)", "``token[]``", "The prim paths for the given relationship", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimRelationship"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prim Relationship"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimRelationshipDatabase"
"Python Module", "omni.graph.nodes"
| 1,959 |
reStructuredText
| 26.605633 | 148 | 0.587034 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimsAtPath.rst
|
.. _omni_graph_nodes_GetPrimsAtPath_1:
.. _omni_graph_nodes_GetPrimsAtPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prims At Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-prims-at-path
Get Prims At Path
=================
.. <description>
This node computes a prim path from either a single or an array of pth tokens.
.. </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[]']``", "A token or token array to compute representing a path.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:prims", "``target``", "The output prim paths", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:path", "``token``", "Snapshot of previously seen path", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimsAtPath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prims At Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimsAtPathDatabase"
"Python Module", "omni.graph.nodes"
| 1,794 |
reStructuredText
| 22.311688 | 111 | 0.560758 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRpResourceExampleAllocator.rst
|
.. _omni_graph_nodes_RpResourceExampleAllocator_1:
.. _omni_graph_nodes_RpResourceExampleAllocator:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: RpResource Example Allocator Node
:keywords: lang-en omnigraph node nodes rp-resource-example-allocator
RpResource Example Allocator Node
=================================
.. <description>
Allocate CUDA-interoperable RpResource
.. </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 Points (*inputs:points*)", "``float[3][]``", "Points attribute input. Points and a prim path may be supplied directly as an alternative to a bundle input.", "[]"
"Prim path input (*inputs:primPath*)", "``token``", "Prim path input. Points and a prim path may be supplied directly as an alternative to a bundle input.", ""
"Reload (*inputs:reload*)", "``bool``", "Force RpResource reload", "False"
"stream (*inputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "0"
"Verbose (*inputs:verbose*)", "``bool``", "verbose printing", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Point Counts (*outputs:pointCountCollection*)", "``uint64[]``", "Point count for each prim being deformed", "None"
"Prim Paths (*outputs:primPathCollection*)", "``token[]``", "Path for each prim being deformed", "None"
"Reload (*outputs:reload*)", "``bool``", "Force RpResource reload", "False"
"Resource Pointer Collection (*outputs:resourcePointerCollection*)", "``uint64[]``", "Pointers to RpResources (two resources per prim are allocated -- one for rest positions and one for deformed positions)", "None"
"stream (*outputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RpResourceExampleAllocator"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "RpResource Example Allocator Node"
"Generated Class Name", "OgnRpResourceExampleAllocatorDatabase"
"Python Module", "omni.graph.nodes"
| 2,643 |
reStructuredText
| 34.253333 | 219 | 0.613318 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimLocalToWorldTransform.rst
|
.. _omni_graph_nodes_GetPrimLocalToWorldTransform_2:
.. _omni_graph_nodes_GetPrimLocalToWorldTransform:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prim Local to World Transform
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes get-prim-local-to-world-transform
Get Prim Local to World Transform
=================================
.. <description>
Given a path to a prim on the current USD stage, return the the transformation matrix. that transforms a vector from the local frame to the global frame
.. </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 used as the local coordinate system when 'usePath' is false", "None"
"inputs:primPath", "``token``", "The path of the prim used as the local coordinate system when 'usePath' is true", ""
"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", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:localToWorldTransform", "``matrixd[4]``", "the local to world transformation matrix for the prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimLocalToWorldTransform"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prim Local to World Transform"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimLocalToWorldTransformDatabase"
"Python Module", "omni.graph.nodes"
| 2,191 |
reStructuredText
| 30.314285 | 185 | 0.616157 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnDeformedPointsToHydra.rst
|
.. _omni_graph_nodes_DeformedPointsToHydra_1:
.. _omni_graph_nodes_DeformedPointsToHydra:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Deformed Points to Hydra
:keywords: lang-en omnigraph node nodes deformed-points-to-hydra
Deformed Points to Hydra
========================
.. <description>
Copy deformed points into rpresource and send to hydra
.. </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 Points (*inputs:points*)", "``float[3][]``", "Points attribute input. Points and a prim path may be supplied directly as an alternative to a bundle input.", "[]"
"Prim path input (*inputs:primPath*)", "``token``", "Prim path input. Points and a prim path may be supplied directly as an alternative to a bundle input.", ""
"Send to hydra (*inputs:sendToHydra*)", "``bool``", "send to hydra", "False"
"stream (*inputs:stream*)", "``uint64``", "Pointer to the CUDA Stream", "0"
"Verbose (*inputs:verbose*)", "``bool``", "verbose printing", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Reload (*outputs:reload*)", "``bool``", "Force RpResource reload", "False"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.DeformedPointsToHydra"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Deformed Points to Hydra"
"Generated Class Name", "OgnDeformedPointsToHydraDatabase"
"Python Module", "omni.graph.nodes"
| 2,068 |
reStructuredText
| 28.140845 | 171 | 0.586074 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnBooleanExpr.rst
|
.. _omni_graph_nodes_BooleanExpr_1:
.. _omni_graph_nodes_BooleanExpr:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Boolean Expression
:keywords: lang-en omnigraph node math:operator nodes boolean-expr
Boolean Expression
==================
.. <description>
NOTE: DEPRECATED AS OF 1.26.0 IN FAVOUR OF INDIVIDAL BOOLEAN OP NODES Boolean operation on two inputs. The supported operations are:
AND, OR, NAND, NOR, XOR, XNOR
.. </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``", "Input A", "False"
"inputs:b", "``bool``", "Input B", "False"
"Operator (*inputs:operator*)", "``token``", "The boolean operation to perform (AND, OR, NAND, NOR, XOR, XNOR)", "AND"
"", "*allowedTokens*", "AND,OR,NAND,NOR,XOR,XNOR", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``bool``", "The result of the boolean expression", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BooleanExpr"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Boolean Expression"
"Categories", "math:operator"
"Generated Class Name", "OgnBooleanExprDatabase"
"Python Module", "omni.graph.nodes"
| 1,889 |
reStructuredText
| 24.890411 | 132 | 0.568025 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnArrayLength.rst
|
.. _omni_graph_nodes_ArrayLength_1:
.. _omni_graph_nodes_ArrayLength:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Attribute Array Length
:keywords: lang-en omnigraph node math:array threadsafe nodes array-length
Extract Attribute Array Length
==============================
.. <description>
Outputs the length of a specified array attribute in an input bundle, or 1 if the attribute is not an array attribute
.. </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:attrName*)", "``token``", "Name of the attribute whose array length will be queried", "points"
"Attribute Bundle (*inputs:data*)", "``bundle``", "Collection of attributes that may contain the named attribute", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Array Length (*outputs:length*)", "``uint64``", "The length of the array attribute in the input bundle", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ArrayLength"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Attribute Array Length"
"Categories", "math:array"
"Generated Class Name", "OgnArrayLengthDatabase"
"Python Module", "omni.graph.nodes"
| 1,872 |
reStructuredText
| 26.144927 | 125 | 0.588141 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnATan2.rst
|
.. _omni_graph_nodes_ATan2_1:
.. _omni_graph_nodes_ATan2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Atan2
:keywords: lang-en omnigraph node math:operator nodes a-tan2
Atan2
=====
.. <description>
Outputs the arc tangent of a/b 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:a", "``['double', 'float', 'half', 'timecode']``", "Input A", "None"
"inputs:b", "``['double', 'float', 'half', 'timecode']``", "Input B", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['double', 'float', 'half', 'timecode']``", "The result of ATan2(A,B)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ATan2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Atan2"
"Categories", "math:operator"
"Generated Class Name", "OgnATan2Database"
"Python Module", "omni.graph.nodes"
| 1,574 |
reStructuredText
| 21.826087 | 114 | 0.531766 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnPlaySound.rst
|
.. _omni_graph_nodes_PlaySound_2:
.. _omni_graph_nodes_PlaySound:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Play Sound
:keywords: lang-en omnigraph node sound nodes play-sound
Play Sound
==========
.. <description>
Plays a sound
.. </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 sound Prim to play", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution", "None"
"outputs:soundId", "``uint64``", "The sound identifier", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.PlaySound"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.PlaySound.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Play Sound"
"Categories", "sound"
"Generated Class Name", "OgnPlaySoundDatabase"
"Python Module", "omni.graph.nodes"
| 1,619 |
reStructuredText
| 21.816901 | 95 | 0.549722 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstructArray.rst
|
.. _omni_graph_nodes_ConstructArray_1:
.. _omni_graph_nodes_ConstructArray:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make Array
:keywords: lang-en omnigraph node math:array threadsafe nodes construct-array
Make Array
==========
.. <description>
Makes an output array attribute from input values, in the order of the inputs. If 'arraySize' is less than the number of input elements, the top 'arraySize' elements will be used. If 'arraySize' is greater than the number of input elements, the last input element will be repeated to fill the remaining space.
.. </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:arraySize", "``int``", "The size of the array to create", "1"
"", "*literalOnly*", "1", ""
"Array Type (*inputs:arrayType*)", "``token``", "The type of the array ('auto' infers the type from the first connected and resolved input)", "auto"
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "auto,bool[],double[],float[],half[],int[],int64[],token[],uchar[],uint[],uint64[],double[2][],double[3][],double[4][],matrixd[3][],matrixd[4][],float[2][],float[3][],float[4][],half[2][],half[3][],half[4][],int[2][],int[3][],int[4][]", ""
"inputs:input0", "``any``", "Input array element", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:array", "``any``", "The array of copied values of inputs in the given order", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstructArray"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Make Array"
"Categories", "math:array"
"Generated Class Name", "OgnConstructArrayDatabase"
"Python Module", "omni.graph.nodes"
| 2,352 |
reStructuredText
| 31.232876 | 309 | 0.58631 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantUInt64.rst
|
.. _omni_graph_nodes_ConstantUInt64_1:
.. _omni_graph_nodes_ConstantUInt64:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant UInt64
:keywords: lang-en omnigraph node constants nodes constant-u-int64
Constant UInt64
===============
.. <description>
Holds a 64 bit signed 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*)", "``uint64``", "The constant value", "0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantUInt64"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Constant UInt64"
"Categories", "constants"
"Generated Class Name", "OgnConstantUInt64Database"
"Python Module", "omni.graph.nodes"
| 1,353 |
reStructuredText
| 21.566666 | 95 | 0.546933 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrimAttribute.rst
|
.. _omni_graph_nodes_WritePrimAttribute_2:
.. _omni_graph_nodes_WritePrimAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prim Attribute
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes write-prim-attribute
Write Prim Attribute
====================
.. <description>
Given a path to a prim on the current USD stage and the name of an attribute on that prim, sets the value of that attribute. Does nothing if the given Prim or attribute can not be found. If the attribute is found but it is not a compatible type, an error will be issued.
.. </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"
"Attribute Name (*inputs:name*)", "``token``", "The name of the attribute to set on the specified prim", ""
"inputs:prim", "``target``", "The prim to be modified when 'usePath' is false", "None"
"inputs:primPath", "``token``", "The path of the prim to be modified when 'usePath' is true", ""
"Persist To USD (*inputs:usdWriteBack*)", "``bool``", "Whether or not the value should be written back to USD, or kept a Fabric only value", "True"
"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"
"inputs:value", "``any``", "The new value to be written", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "Output execution", "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:destAttrib", "``uint64``", "A TokenC to the destination attrib", "None"
"state:destPath", "``uint64``", "A PathC to the destination prim", "None"
"state:destPathToken", "``uint64``", "The TokenC version of destPath'", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrimAttribute"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.WritePrimAttribute.svg"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Write Prim Attribute"
"Categories", "sceneGraph"
"Generated Class Name", "OgnWritePrimAttributeDatabase"
"Python Module", "omni.graph.nodes"
| 3,030 |
reStructuredText
| 33.83908 | 273 | 0.616172 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrims.rst
|
.. _omni_graph_nodes_ReadPrims_3:
.. _omni_graph_nodes_ReadPrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prims (Legacy)
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prims
Read Prims (Legacy)
===================
.. <description>
DEPRECATED - use ReadPrimsV2!
.. </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
"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"
"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'", ""
"inputs:prims", "``target``", "The prims to be read from when 'useFindPrims' is false", "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"
"Use Find Prims (*inputs:useFindPrims*)", "``bool``", "When true, the 'pathPattern' and 'typePattern' attribute is used as the pattern to search for the prims to 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: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:pathPattern", "``string``", "State from previous evaluation", "None"
"state:primPaths", "``uint64[]``", "State from previous evaluation", "None"
"state:typePattern", "``string``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "-1"
"state:useFindPrims", "``bool``", "State from previous evaluation", "False"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrims"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Read Prims (Legacy)"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimsDatabase"
"Python Module", "omni.graph.nodes"
| 5,473 |
reStructuredText
| 57.860214 | 613 | 0.653389 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRpResourceExampleHydra.rst
|
.. _omni_graph_nodes_RpResourceExampleHydra_1:
.. _omni_graph_nodes_RpResourceExampleHydra:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: RpResource to Hydra Example Node
:keywords: lang-en omnigraph node nodes rp-resource-example-hydra
RpResource to Hydra Example Node
================================
.. <description>
Send RpResource to Hydra
.. </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
"Point Counts (*inputs:pointCountCollection*)", "``uint64[]``", "Point count for each prim being deformed", "[]"
"Prim Paths (*inputs:primPathCollection*)", "``token[]``", "Path for each prim being deformed", "[]"
"Resource Pointer Collection (*inputs:resourcePointerCollection*)", "``uint64[]``", "Pointers to RpResources (two resources per prim are assumed -- one for rest positions and one for deformed positions)", "[]"
"Send to Hydra (*inputs:sendToHydra*)", "``bool``", "Send rpresource pointer to hydra using the specified prim path", "False"
"Verbose (*inputs:verbose*)", "``bool``", "verbose printing", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Reload (*outputs:reload*)", "``bool``", "Force RpResource reload", "False"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RpResourceExampleHydra"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "RpResource to Hydra Example Node"
"__tokens", "{""points"": ""points"", ""transform"": ""transform"", ""rpResource"": ""rpResource"", ""pointCount"": ""pointCount"", ""uintData"": ""uintData""}"
"Generated Class Name", "OgnRpResourceExampleHydraDatabase"
"Python Module", "omni.graph.nodes"
| 2,310 |
reStructuredText
| 31.097222 | 214 | 0.593506 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTimelineGet.rst
|
.. _omni_graph_nodes_GetTimeline_1:
.. _omni_graph_nodes_GetTimeline:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get main timeline
:keywords: lang-en omnigraph node time compute-on-request nodes get-timeline
Get main timeline
=================
.. <description>
Get the main timeline properties
.. </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
"End Frame (*outputs:endFrame*)", "``double``", "The end frame of the main timeline's play range.", "None"
"End Time (*outputs:endTime*)", "``double``", "The end time (in seconds) of the main timeline's play range.", "None"
"Current Frame (*outputs:frame*)", "``double``", "The current frame number of the main timeline's playhead.", "None"
"Frames Per Second (*outputs:framesPerSecond*)", "``double``", "The number of frames per second of the main timeline.", "None"
"Is Looping (*outputs:isLooping*)", "``bool``", "Is the main timeline currently looping?", "None"
"Is Playing (*outputs:isPlaying*)", "``bool``", "Is the main timeline currently playing?", "None"
"Start Frame (*outputs:startFrame*)", "``double``", "The start frame of the main timeline's play range.", "None"
"Start Time (*outputs:startTime*)", "``double``", "The start time (in seconds) of the main timeline's play range.", "None"
"Current Time (*outputs:time*)", "``double``", "The current time (in seconds) of the main timeline's playhead.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetTimeline"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get main timeline"
"Categories", "time"
"Generated Class Name", "OgnTimelineGetDatabase"
"Python Module", "omni.graph.nodes"
| 2,307 |
reStructuredText
| 33.447761 | 130 | 0.596446 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnFindPrims.rst
|
.. _omni_graph_nodes_FindPrims_2:
.. _omni_graph_nodes_FindPrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Find Prims
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes find-prims
Find Prims
==========
.. <description>
Finds Prims on the stage which match the given criteria
.. </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:ignoreSystemPrims", "``bool``", "Ignore system prims such as omni graph nodes that shouldn't be considered during the import.", "False"
"Prim Name Prefix (*inputs:namePrefix*)", "``token``", "Only prims with a name starting with the given prefix will be returned.", ""
"Prim Path Pattern (*inputs:pathPattern*)", "``token``", "A list of wildcard patterns used to match the prim paths 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:recursive", "``bool``", "False means only consider children of the root prim, True means all prims in the hierarchy", "False"
"Attribute Names (*inputs:requiredAttributes*)", "``string``", "A space-separated list of attribute names that are required to be present on matched prims", ""
"Relationship Name (*inputs:requiredRelationship*)", "``token``", "The name of a relationship which must have a target specified by requiredRelationshipTarget or requiredTarget", ""
"Relationship Prim Path (*inputs:requiredRelationshipTarget*)", "``path``", "The path that must be a target of the requiredRelationship", ""
"Relationship Prim (*inputs:requiredTarget*)", "``target``", "The target of the requiredRelationship", "None"
"Root Prim (*inputs:rootPrim*)", "``target``", "Only children of the given prim will be considered. If rootPrim is specified, rootPrimPath will be ignored.", "None"
"Root Prim Path (*inputs:rootPrimPath*)", "``token``", "Only children of the given prim will be considered. Empty will search the whole stage.", ""
"Prim Type Pattern (*inputs:type*)", "``token``", "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'", "*"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primPaths", "``token[]``", "A list of Prim paths as tokens which match the given type", "None"
"outputs:prims", "``target``", "A list of Prim paths which match the given type", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:ignoreSystemPrims", "``bool``", "last corresponding input seen", "None"
"state:inputType", "``token``", "last corresponding input seen", "None"
"state:namePrefix", "``token``", "last corresponding input seen", "None"
"state:pathPattern", "``token``", "last corresponding input seen", "None"
"state:recursive", "``bool``", "last corresponding input seen", "None"
"state:requiredAttributes", "``string``", "last corresponding input seen", "None"
"state:requiredRelationship", "``token``", "last corresponding input seen", "None"
"state:requiredRelationshipTarget", "``string``", "last corresponding input seen", "None"
"state:requiredTarget", "``target``", "last corresponding input seen", "None"
"state:rootPrim", "``target``", "last corresponding input seen", "None"
"state:rootPrimPath", "``token``", "last corresponding input seen", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.FindPrims"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Find Prims"
"Categories", "sceneGraph"
"Generated Class Name", "OgnFindPrimsDatabase"
"Python Module", "omni.graph.nodes"
| 4,971 |
reStructuredText
| 49.734693 | 532 | 0.638906 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnBundleConstructor.rst
|
.. _omni_graph_nodes_BundleConstructor_1:
.. _omni_graph_nodes_BundleConstructor:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Bundle Constructor
:keywords: lang-en omnigraph node bundle nodes bundle-constructor
Bundle Constructor
==================
.. <description>
This node creates a bundle mirroring all of the dynamic input attributes that have been added to it. If no dynamic attributes exist then the bundle will be empty. See the 'InsertAttribute' node for something that can construct a bundle from existing connected attributes.
.. </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
"Constructed Bundle (*outputs:bundle*)", "``bundle``", "The bundle consisting of copies of all of the dynamic input attributes.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BundleConstructor"
"Version", "1"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.BundleConstructor.svg"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Bundle Constructor"
"Categories", "bundle"
"Generated Class Name", "OgnBundleConstructorDatabase"
"Python Module", "omni.graph.nodes"
| 1,716 |
reStructuredText
| 27.616666 | 271 | 0.613636 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimPaths.rst
|
.. _omni_graph_nodes_GetPrimPaths_1:
.. _omni_graph_nodes_GetPrimPaths:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prim Paths
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-prim-paths
Get Prim Paths
==============
.. <description>
Generates a path array from the specified relationship. This is useful when absolute prim paths 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:prims", "``target``", "Relationship to prims on the stage", "None"
"", "*allowMultiInputs*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primPaths", "``token[]``", "The absolute paths of the given prims as a token array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimPaths"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prim Paths"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimPathsDatabase"
"Python Module", "omni.graph.nodes"
| 1,659 |
reStructuredText
| 23.057971 | 107 | 0.567812 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnInterpolator.rst
|
.. _omni_graph_nodes_Interpolator_1:
.. _omni_graph_nodes_Interpolator:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Interpolator
:keywords: lang-en omnigraph node math:operator threadsafe nodes interpolator
Interpolator
============
.. <description>
Time sample interpolator
.. </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
"Knot Array (*inputs:knots*)", "``float[]``", "Array of knots on the time sample curve", "[]"
"Interpolation Point (*inputs:param*)", "``float``", "Time sample interpolation point", "0.0"
"Value Array (*inputs:values*)", "``float[]``", "Array of time sample values", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Interpolated Value (*outputs:value*)", "``float``", "Value in the time samples, interpolated at the given parameter location", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Interpolator"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Interpolator"
"Categories", "math:operator"
"Generated Class Name", "OgnInterpolatorDatabase"
"Python Module", "omni.graph.nodes"
| 1,773 |
reStructuredText
| 24.342857 | 138 | 0.570784 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrimRelationship.rst
|
.. _omni_graph_nodes_WritePrimRelationship_1:
.. _omni_graph_nodes_WritePrimRelationship:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prim Relationship
:keywords: lang-en omnigraph node sceneGraph WriteOnly nodes write-prim-relationship
Write Prim Relationship
=======================
.. <description>
Writes the target(s) to a relationship on a given 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:execIn", "``execution``", "The input execution port", "None"
"Relationship Name (*inputs:name*)", "``token``", "The name of the relationship to write", ""
"inputs:prim", "``target``", "The prim to write the relationship 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"
"inputs:value", "``target``", "The target(s) to write to the relationship", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:correctlySetup", "``bool``", "Whether or not the instance is properly setup", "False"
"state:name", "``token``", "The prefetched relationship name", "None"
"state:prim", "``target``", "The currently prefetched prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrimRelationship"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "usd"
"uiName", "Write Prim Relationship"
"Categories", "sceneGraph"
"Generated Class Name", "OgnWritePrimRelationshipDatabase"
"Python Module", "omni.graph.nodes"
| 2,383 |
reStructuredText
| 27.722891 | 151 | 0.59253 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimMaterial.rst
|
.. _omni_graph_nodes_ReadPrimMaterial_2:
.. _omni_graph_nodes_ReadPrimMaterial:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim Material
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes read-prim-material
Read Prim Material
==================
.. <description>
Given a path to a prim on the current USD stage, outputs the material of the prim. Gives an error if the given prim can not be 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
"inputs:prim", "``target``", "The prim with the material to be read. If both this and primPath inputs are set, this input takes priority.", "None"
"Prim Path (*inputs:primPath*)", "``path``", "Path of the prim with the material to be read.", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Material Path (*outputs:material*)", "``path``", "The material of the input prim", "None"
"Material (*outputs:materialPrim*)", "``target``", "The prim containing the material of the input prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimMaterial"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Prim Material"
"Categories", "sceneGraph"
"Generated Class Name", "OgnReadPrimMaterialDatabase"
"Python Module", "omni.graph.nodes"
| 1,977 |
reStructuredText
| 27.257142 | 150 | 0.590288 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRemoveAttr.rst
|
.. _omni_graph_nodes_RemoveAttribute_2:
.. _omni_graph_nodes_RemoveAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Remove Attributes From Bundles
:keywords: lang-en omnigraph node bundle nodes remove-attribute
Remove Attributes From Bundles
==============================
.. <description>
Copies all attributes from an input bundle to the output bundle, except for any specified to be removed.
.. </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
"Allow Remove Prim Internal (*inputs:allowRemovePrimInternal*)", "``bool``", "When on, then primitive internal attributes can be removed('sourcePrimPath' etc...)", "False"
"Attributes To Remove (*inputs:attrNamesToRemove*)", "``token``", "A list of wildcard patterns used to match the attribute names that are to be removed from the output bundle 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'", ""
"Original Bundle (*inputs:data*)", "``bundle``", "Collection of attributes to be partially copied to the output", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Bundle After Removal (*outputs:data*)", "``bundle``", "Final bundle of attributes, with the attributes specified by attrNamesToRemove omitted", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RemoveAttribute"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Remove Attributes From Bundles"
"Categories", "bundle"
"Generated Class Name", "OgnRemoveAttrDatabase"
"Python Module", "omni.graph.nodes"
| 2,577 |
reStructuredText
| 35.828571 | 631 | 0.622429 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimDirectionVector.rst
|
.. _omni_graph_nodes_GetPrimDirectionVector_2:
.. _omni_graph_nodes_GetPrimDirectionVector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prim Direction Vector
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes get-prim-direction-vector
Get Prim Direction Vector
=========================
.. <description>
Given a prim, find its direction vectors (up vector, forward vector, right vector, etc.)
.. </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 connection to the input prim - this attribute is used when 'usePath' is false", "None"
"inputs:primPath", "``token``", "The path of the input prim - this attribute is used when 'usePath' is true", ""
"inputs:usePath", "``bool``", "When true, it will use the 'primPath' attribute as the path to the prim, otherwise it will read the connection at the 'prim' attribute", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Backward Vector (*outputs:backwardVector*)", "``double[3]``", "The backward vector of the prim", "None"
"Down Vector (*outputs:downVector*)", "``double[3]``", "The down vector of the prim", "None"
"Forward Vector (*outputs:forwardVector*)", "``double[3]``", "The forward vector of the prim", "None"
"Left Vector (*outputs:leftVector*)", "``double[3]``", "The left vector of the prim", "None"
"Right Vector (*outputs:rightVector*)", "``double[3]``", "The right vector of the prim", "None"
"Up Vector (*outputs:upVector*)", "``double[3]``", "The up vector of the prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimDirectionVector"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prim Direction Vector"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimDirectionVectorDatabase"
"Python Module", "omni.graph.nodes"
| 2,543 |
reStructuredText
| 32.92 | 178 | 0.604404 |
omniverse-code/kit/exts/omni.graph.nodes/config/extension.toml
|
[package]
title = "OmniGraph Nodes"
version = "1.48.3"
category = "Graph"
readme = "docs/README.md"
changelog = "docs/CHANGELOG.md"
description = "Contains a library of OmniGraph nodes"
repository = ""
keywords = ["omnigraph", "nodes"]
# Main module for the Python interface
[[python.module]]
name = "omni.graph.nodes"
# Watch the .ogn files for hot reloading (only works for Python files)
[fswatcher.patterns]
include = ["*.ogn", "*.py"]
exclude = ["Ogn*Database.py"]
# Other extensions that need to load before this one
[dependencies]
"omni.usd" = {}
"omni.kit.async_engine" = {}
"omni.kit.commands" = {}
"omni.graph" = {}
"omni.graph.tools" = {}
"omni.kit.stage_templates" = {}
"omni.kit.pipapi" = {}
"omni.graph.ui" = {optional=true}
"omni.hydra.scene_delegate" = {}
[[native.plugin]]
path = "bin/*.plugin"
recursive = false
# numpy is used by tests
[python.pipapi]
requirements = ["numpy"] # SWIPAT filed under: http://nvbugs/3193231
[[test]]
timeout = 1200
stdoutFailPatterns.exclude = [
"*[omni.graph.core.plugin] getTypes called on non-existent path*",
]
pythonTests.unreliable = [
"*test_omnigraph_utility_nodes", # OM-70691
"*test_copy_attr", # OM-65070
"*test_remove_attr", # OM-63107
]
[documentation]
deps = [
["kit-sdk", "_build/docs/kit-sdk/latest"], # WAR to include omni.graph refs until that workflow is moved
]
pages = [
"docs/Overview.md",
"docs/CHANGELOG.md",
]
| 1,420 |
TOML
| 22.683333 | 108 | 0.673239 |
omniverse-code/kit/exts/omni.graph.nodes/omni/graph/nodes/ogn/OgnArraySetIndexDatabase.py
|
"""Support for simplified access to data on nodes of type omni.graph.nodes.ArraySetIndex
Sets an element of an array. If the given index is negative it will be an offset from the end of the array.
"""
from typing import Any
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnArraySetIndexDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.nodes.ArraySetIndex
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.array
inputs.index
inputs.resizeToFit
inputs.value
Outputs:
outputs.array
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('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][]', 1, 'Array', 'The array to be modified', {}, True, None, False, ''),
('inputs:index', 'int', 0, 'Index', 'The index into the array, a negative value indexes from the end of the array', {}, True, 0, False, ''),
('inputs:resizeToFit', 'bool', 0, None, 'When true, and the given positive index is larger than the highest index in the array\nresize the output array to length 1 + index, and fill the new spaces with zeros', {}, True, False, False, ''),
('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]', 1, None, 'The value to set at the given index', {}, True, None, False, ''),
('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][]', 1, 'Array', 'The modified array', {}, True, None, False, ''),
])
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def array(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute inputs.array"""
return og.RuntimeAttribute(self._attributes.array.get_attribute_data(), self._context, True)
@array.setter
def array(self, value_to_set: Any):
"""Assign another attribute's value to outputs.array"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.array.value = value_to_set.value
else:
self.array.value = value_to_set
@property
def index(self):
data_view = og.AttributeValueHelper(self._attributes.index)
return data_view.get()
@index.setter
def index(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.index)
data_view = og.AttributeValueHelper(self._attributes.index)
data_view.set(value)
@property
def resizeToFit(self):
data_view = og.AttributeValueHelper(self._attributes.resizeToFit)
return data_view.get()
@resizeToFit.setter
def resizeToFit(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.resizeToFit)
data_view = og.AttributeValueHelper(self._attributes.resizeToFit)
data_view.set(value)
@property
def value(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute inputs.value"""
return og.RuntimeAttribute(self._attributes.value.get_attribute_data(), self._context, True)
@value.setter
def value(self, value_to_set: Any):
"""Assign another attribute's value to outputs.value"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.value.value = value_to_set.value
else:
self.value.value = value_to_set
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def array(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute outputs.array"""
return og.RuntimeAttribute(self._attributes.array.get_attribute_data(), self._context, False)
@array.setter
def array(self, value_to_set: Any):
"""Assign another attribute's value to outputs.array"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.array.value = value_to_set.value
else:
self.array.value = value_to_set
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnArraySetIndexDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnArraySetIndexDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnArraySetIndexDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 9,089 |
Python
| 56.898089 | 670 | 0.645506 |
omniverse-code/kit/exts/omni.graph.nodes/omni/graph/nodes/ogn/OgnRotateToOrientationDatabase.py
|
"""Support for simplified access to data on nodes of type omni.graph.nodes.RotateToOrientation
Perform a smooth rotation maneuver, rotating a prim to a desired orientation given a speed and easing factor
"""
import numpy
import usdrt
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnRotateToOrientationDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.nodes.RotateToOrientation
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.execIn
inputs.exponent
inputs.prim
inputs.primPath
inputs.speed
inputs.stop
inputs.target
inputs.usePath
Outputs:
outputs.finished
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:execIn', 'execution', 0, 'Execute In', 'The input execution', {}, True, None, False, ''),
('inputs:exponent', 'float', 0, None, 'The blend exponent, which is the degree of the ease curve\n (1 = linear, 2 = quadratic, 3 = cubic, etc). ', {ogn.MetadataKeys.DEFAULT: '2.0'}, True, 2.0, False, ''),
('inputs:prim', 'target', 0, None, 'The prim to be rotated', {}, False, [], False, ''),
('inputs:primPath', 'path', 0, None, "The source prim to be transformed, used when 'usePath' is true", {}, False, None, True, 'Use prim input with a GetPrimsAtPath node instead'),
('inputs:speed', 'double', 0, None, 'The peak speed of approach (Units / Second)', {ogn.MetadataKeys.DEFAULT: '1.0'}, True, 1.0, False, ''),
('inputs:stop', 'execution', 0, 'Stop', 'Stops the maneuver', {}, True, None, False, ''),
('inputs:target', 'vector3d', 0, 'Target Orientation', 'The desired orientation as euler angles (XYZ) in local space', {}, True, [0.0, 0.0, 0.0], False, ''),
('inputs:usePath', 'bool', 0, None, "When true, the 'primPath' attribute is used, otherwise it will read the connection at the 'prim' attribute", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, True, 'Use prim input with a GetPrimsAtPath node instead'),
('outputs:finished', 'execution', 0, 'Finished', 'The output execution, sent one the maneuver is completed', {}, True, None, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.execIn = og.AttributeRole.EXECUTION
role_data.inputs.prim = og.AttributeRole.TARGET
role_data.inputs.primPath = og.AttributeRole.PATH
role_data.inputs.stop = og.AttributeRole.EXECUTION
role_data.inputs.target = og.AttributeRole.VECTOR
role_data.outputs.finished = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def execIn(self):
data_view = og.AttributeValueHelper(self._attributes.execIn)
return data_view.get()
@execIn.setter
def execIn(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.execIn)
data_view = og.AttributeValueHelper(self._attributes.execIn)
data_view.set(value)
@property
def exponent(self):
data_view = og.AttributeValueHelper(self._attributes.exponent)
return data_view.get()
@exponent.setter
def exponent(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.exponent)
data_view = og.AttributeValueHelper(self._attributes.exponent)
data_view.set(value)
@property
def prim(self):
data_view = og.AttributeValueHelper(self._attributes.prim)
return data_view.get()
@prim.setter
def prim(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.prim)
data_view = og.AttributeValueHelper(self._attributes.prim)
data_view.set(value)
self.prim_size = data_view.get_array_size()
@property
def primPath(self):
data_view = og.AttributeValueHelper(self._attributes.primPath)
return data_view.get()
@primPath.setter
def primPath(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.primPath)
data_view = og.AttributeValueHelper(self._attributes.primPath)
data_view.set(value)
self.primPath_size = data_view.get_array_size()
@property
def speed(self):
data_view = og.AttributeValueHelper(self._attributes.speed)
return data_view.get()
@speed.setter
def speed(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.speed)
data_view = og.AttributeValueHelper(self._attributes.speed)
data_view.set(value)
@property
def stop(self):
data_view = og.AttributeValueHelper(self._attributes.stop)
return data_view.get()
@stop.setter
def stop(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.stop)
data_view = og.AttributeValueHelper(self._attributes.stop)
data_view.set(value)
@property
def target(self):
data_view = og.AttributeValueHelper(self._attributes.target)
return data_view.get()
@target.setter
def target(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.target)
data_view = og.AttributeValueHelper(self._attributes.target)
data_view.set(value)
@property
def usePath(self):
data_view = og.AttributeValueHelper(self._attributes.usePath)
return data_view.get()
@usePath.setter
def usePath(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usePath)
data_view = og.AttributeValueHelper(self._attributes.usePath)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def finished(self):
data_view = og.AttributeValueHelper(self._attributes.finished)
return data_view.get()
@finished.setter
def finished(self, value):
data_view = og.AttributeValueHelper(self._attributes.finished)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnRotateToOrientationDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnRotateToOrientationDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnRotateToOrientationDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 10,132 |
Python
| 44.439462 | 263 | 0.639755 |
omniverse-code/kit/exts/omni.graph.nodes/omni/graph/nodes/ogn/OgnReadPrimsBundleDatabase.py
|
"""Support for simplified access to data on nodes of type omni.graph.nodes.ReadPrimsBundle
Reads primitives and outputs multiple primitive in a bundle.
"""
from typing import Any
import numpy
import usdrt
import carb
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnReadPrimsBundleDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.nodes.ReadPrimsBundle
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.attrNamesToImport
inputs.primPaths
inputs.prims
inputs.usdTimecode
inputs.usePaths
Outputs:
outputs.primsBundle
State:
state.attrNamesToImport
state.primPaths
state.usdTimecode
state.usePaths
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:attrNamesToImport', 'string', 0, 'Attributes To Import', "A list of wildcard patterns used to match the attribute names that are to be imported\n\nSupported syntax of wildcard pattern:\n '*' - match an arbitrary number of any characters\n '?' - match any single character\n '^' - (caret) is used to define a pattern that is to be excluded\n\nExample of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size']\n '*' - match any\n '* ^points' - match any, but exclude 'points'\n '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", {ogn.MetadataKeys.DEFAULT: '"*"'}, True, "*", False, ''),
('inputs:primPaths', 'path,token,token[]', 1, 'Prim Paths', "The paths of the prims to be read from when 'usePaths' is true", {}, False, None, False, ''),
('inputs:prims', 'target', 0, None, "The prims to be read from when 'usePaths' is false", {ogn.MetadataKeys.ALLOW_MULTI_INPUTS: '1'}, False, [], False, ''),
('inputs:usdTimecode', 'timecode', 0, 'Time', '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', {ogn.MetadataKeys.DEFAULT: '"NaN"'}, True, float("NaN"), False, ''),
('inputs:usePaths', 'bool', 0, 'Use Paths', "When true, the 'primPaths' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('outputs:primsBundle', 'bundle', 0, None, 'An output bundle containing multiple prims as children.\nEach child contains data attributes and two additional token attributes named sourcePrimPath and sourcePrimType\nwhich contain the path and the type of the Prim being read', {}, True, None, False, ''),
('state:attrNamesToImport', 'string', 0, None, 'State from previous evaluation', {}, True, None, False, ''),
('state:primPaths', 'uint64[]', 0, None, 'State from previous evaluation', {}, True, None, False, ''),
('state:usdTimecode', 'timecode', 0, None, 'State from previous evaluation', {ogn.MetadataKeys.DEFAULT: '"NaN"'}, True, float("NaN"), False, ''),
('state:usePaths', 'bool', 0, None, 'State from previous evaluation', {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.attrNamesToImport = og.AttributeRole.TEXT
role_data.inputs.prims = og.AttributeRole.TARGET
role_data.inputs.usdTimecode = og.AttributeRole.TIMECODE
role_data.outputs.primsBundle = og.AttributeRole.BUNDLE
role_data.state.attrNamesToImport = og.AttributeRole.TEXT
role_data.state.usdTimecode = og.AttributeRole.TIMECODE
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def attrNamesToImport(self):
data_view = og.AttributeValueHelper(self._attributes.attrNamesToImport)
return data_view.get()
@attrNamesToImport.setter
def attrNamesToImport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.attrNamesToImport)
data_view = og.AttributeValueHelper(self._attributes.attrNamesToImport)
data_view.set(value)
self.attrNamesToImport_size = data_view.get_array_size()
@property
def primPaths(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute inputs.primPaths"""
return og.RuntimeAttribute(self._attributes.primPaths.get_attribute_data(), self._context, True)
@primPaths.setter
def primPaths(self, value_to_set: Any):
"""Assign another attribute's value to outputs.primPaths"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.primPaths.value = value_to_set.value
else:
self.primPaths.value = value_to_set
@property
def prims(self):
data_view = og.AttributeValueHelper(self._attributes.prims)
return data_view.get()
@prims.setter
def prims(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.prims)
data_view = og.AttributeValueHelper(self._attributes.prims)
data_view.set(value)
self.prims_size = data_view.get_array_size()
@property
def usdTimecode(self):
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
return data_view.get()
@usdTimecode.setter
def usdTimecode(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usdTimecode)
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
data_view.set(value)
@property
def usePaths(self):
data_view = og.AttributeValueHelper(self._attributes.usePaths)
return data_view.get()
@usePaths.setter
def usePaths(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usePaths)
data_view = og.AttributeValueHelper(self._attributes.usePaths)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=False, gpu_ptr_kinds={})
self._batchedWriteValues = { }
@property
def primsBundle(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute outputs.primsBundle"""
return self.__bundles.primsBundle
@primsBundle.setter
def primsBundle(self, bundle: og.BundleContents):
"""Overwrite the bundle attribute outputs.primsBundle with a new bundle"""
if not isinstance(bundle, og.BundleContents):
carb.log_error("Only bundle attributes can be assigned to another bundle attribute")
self.__bundles.primsBundle.bundle = bundle
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.attrNamesToImport_size = None
self.primPaths_size = None
@property
def attrNamesToImport(self):
data_view = og.AttributeValueHelper(self._attributes.attrNamesToImport)
self.attrNamesToImport_size = data_view.get_array_size()
return data_view.get()
@attrNamesToImport.setter
def attrNamesToImport(self, value):
data_view = og.AttributeValueHelper(self._attributes.attrNamesToImport)
data_view.set(value)
self.attrNamesToImport_size = data_view.get_array_size()
@property
def primPaths(self):
data_view = og.AttributeValueHelper(self._attributes.primPaths)
self.primPaths_size = data_view.get_array_size()
return data_view.get()
@primPaths.setter
def primPaths(self, value):
data_view = og.AttributeValueHelper(self._attributes.primPaths)
data_view.set(value)
self.primPaths_size = data_view.get_array_size()
@property
def usdTimecode(self):
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
return data_view.get()
@usdTimecode.setter
def usdTimecode(self, value):
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
data_view.set(value)
@property
def usePaths(self):
data_view = og.AttributeValueHelper(self._attributes.usePaths)
return data_view.get()
@usePaths.setter
def usePaths(self, value):
data_view = og.AttributeValueHelper(self._attributes.usePaths)
data_view.set(value)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnReadPrimsBundleDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnReadPrimsBundleDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnReadPrimsBundleDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 12,275 |
Python
| 49.727273 | 678 | 0.655886 |
omniverse-code/kit/exts/omni.graph.nodes/omni/graph/nodes/ogn/OgnSetMatrix4RotationDatabase.py
|
"""Support for simplified access to data on nodes of type omni.graph.nodes.SetMatrix4Rotation
Sets the rotation of the given matrix4d value which represents a linear transformation. Does not modify the translation (row
3) of the matrix.
"""
from typing import Any
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnSetMatrix4RotationDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.nodes.SetMatrix4Rotation
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.fixedRotationAxis
inputs.matrix
inputs.rotationAngle
Outputs:
outputs.matrix
Predefined Tokens:
tokens.X
tokens.Y
tokens.Z
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:fixedRotationAxis', 'token', 0, None, 'The axis of the given rotation', {ogn.MetadataKeys.ALLOWED_TOKENS: 'X,Y,Z', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '["X", "Y", "Z"]', ogn.MetadataKeys.DEFAULT: '"Y"'}, True, "Y", False, ''),
('inputs:matrix', 'matrixd[4],matrixd[4][]', 1, None, 'The matrix to be modified', {}, True, None, False, ''),
('inputs:rotationAngle', 'double,double[]', 1, 'Rotation', 'The rotation in degrees that the matrix will apply about the given rotationAxis.', {}, True, None, False, ''),
('outputs:matrix', 'matrixd[4],matrixd[4][]', 1, None, 'The updated matrix', {}, True, None, False, ''),
])
class tokens:
X = "X"
Y = "Y"
Z = "Z"
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def fixedRotationAxis(self):
data_view = og.AttributeValueHelper(self._attributes.fixedRotationAxis)
return data_view.get()
@fixedRotationAxis.setter
def fixedRotationAxis(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.fixedRotationAxis)
data_view = og.AttributeValueHelper(self._attributes.fixedRotationAxis)
data_view.set(value)
@property
def matrix(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute inputs.matrix"""
return og.RuntimeAttribute(self._attributes.matrix.get_attribute_data(), self._context, True)
@matrix.setter
def matrix(self, value_to_set: Any):
"""Assign another attribute's value to outputs.matrix"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.matrix.value = value_to_set.value
else:
self.matrix.value = value_to_set
@property
def rotationAngle(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute inputs.rotationAngle"""
return og.RuntimeAttribute(self._attributes.rotationAngle.get_attribute_data(), self._context, True)
@rotationAngle.setter
def rotationAngle(self, value_to_set: Any):
"""Assign another attribute's value to outputs.rotationAngle"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.rotationAngle.value = value_to_set.value
else:
self.rotationAngle.value = value_to_set
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def matrix(self) -> og.RuntimeAttribute:
"""Get the runtime wrapper class for the attribute outputs.matrix"""
return og.RuntimeAttribute(self._attributes.matrix.get_attribute_data(), self._context, False)
@matrix.setter
def matrix(self, value_to_set: Any):
"""Assign another attribute's value to outputs.matrix"""
if isinstance(value_to_set, og.RuntimeAttribute):
self.matrix.value = value_to_set.value
else:
self.matrix.value = value_to_set
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnSetMatrix4RotationDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnSetMatrix4RotationDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnSetMatrix4RotationDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 7,338 |
Python
| 46.655844 | 244 | 0.658354 |
omniverse-code/kit/exts/omni.graph.nodes/omni/graph/nodes/ogn/OgnPartialSumDatabase.py
|
"""Support for simplified access to data on nodes of type omni.graph.nodes.PartialSum
Compute the partial sums of the input integer array named 'array' and put the result in an output integer array named 'partialSum'.
A partial sum is the sum of all of the elements up to but not including a certain point in an array, so output element 0
is always 0, element 1 is array[0], element 2 is array[0] + array[1], etc.
"""
import numpy
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnPartialSumDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.nodes.PartialSum
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.array
Outputs:
outputs.partialSum
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:array', 'int[]', 0, None, 'List of integers whose partial sum is to be computed', {ogn.MetadataKeys.DEFAULT: '[]'}, True, [], False, ''),
('outputs:partialSum', 'int[]', 0, None, "Array whose nth value equals the nth partial sum of the input 'array'", {ogn.MetadataKeys.DEFAULT: '[]'}, True, [], False, ''),
])
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def array(self):
data_view = og.AttributeValueHelper(self._attributes.array)
return data_view.get()
@array.setter
def array(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.array)
data_view = og.AttributeValueHelper(self._attributes.array)
data_view.set(value)
self.array_size = data_view.get_array_size()
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.partialSum_size = 0
self._batchedWriteValues = { }
@property
def partialSum(self):
data_view = og.AttributeValueHelper(self._attributes.partialSum)
return data_view.get(reserved_element_count=self.partialSum_size)
@partialSum.setter
def partialSum(self, value):
data_view = og.AttributeValueHelper(self._attributes.partialSum)
data_view.set(value)
self.partialSum_size = data_view.get_array_size()
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnPartialSumDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnPartialSumDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnPartialSumDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 5,613 |
Python
| 47.817391 | 177 | 0.672902 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.