file_path
stringlengths 21
202
| content
stringlengths 19
1.02M
| size
int64 19
1.02M
| lang
stringclasses 8
values | avg_line_length
float64 5.88
100
| max_line_length
int64 12
993
| alphanum_fraction
float64 0.27
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/exts/omni.kit.welcome.about/omni/kit/welcome/about/extension.py | from typing import List
import carb.settings
import carb.tokens
import omni.client
import omni.ext
import omni.ui as ui
from omni.kit.welcome.window import register_page
from omni.ui import constant as fl
from .style import ABOUT_PAGE_STYLE
_extension_instance = None
class AboutPageExtension(omni.ext.IExt):
def on_startup(self, ext_id):
self.__ext_name = omni.ext.get_extension_name(ext_id)
register_page(self.__ext_name, self.build_ui)
def on_shutdown(self):
global _extension_instance
_extension_instance = None
self._about_widget = None
def build_ui(self) -> None:
with ui.ZStack(style=ABOUT_PAGE_STYLE):
# Background
ui.Rectangle(style_type_name_override="Content")
with ui.VStack():
with ui.VStack(height=fl._find("welcome_page_title_height")):
ui.Spacer()
ui.Label("ABOUT", height=0, alignment=ui.Alignment.CENTER, style_type_name_override="Title.Label")
ui.Spacer()
with ui.HStack():
ui.Spacer(width=fl._find("welcome_content_padding_x"))
with ui.VStack():
with ui.ZStack():
ui.Rectangle(style_type_name_override="Info")
self.__build_content()
ui.Spacer(width=fl._find("welcome_content_padding_x"))
ui.Spacer(height=fl._find("welcome_content_padding_y"))
def __build_content(self):
import omni.kit.app
manager = omni.kit.app.get_app().get_extension_manager()
manager.set_extension_enabled_immediate("omni.kit.window.about", True)
from omni.kit.window.about import AboutWidget
with ui.Frame():
self._about_widget = AboutWidget()
| 1,849 | Python | 32.636363 | 118 | 0.593294 |
omniverse-code/kit/exts/omni.kit.welcome.about/omni/kit/welcome/about/tests/test_page.py | import asyncio
from pathlib import Path
import omni.kit.app
from omni.ui.tests.test_base import OmniUiTest
from ..extension import AboutPageExtension
CURRENT_PATH = Path(__file__).parent
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("tests")
class TestPage(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden_img").absolute()
# After running each test
async def tearDown(self):
await super().tearDown()
async def test_page(self):
window = await self.create_test_window(width=800, height=500)
with window.frame:
ext = AboutPageExtension()
ext.on_startup("omni.kit.welcome.extensions-1.1.0")
ext.build_ui()
ext._about_widget.app_info = "#App Name# #App Version#"
ext._about_widget.versions = ["About test version #1", "About test version #2", "About test version #3"]
class FakePluginImpl():
def __init__(self, name):
self.name = name
class FakePlugin():
def __init__(self, name):
self.libPath = "Lib Path " + name
self.impl = FakePluginImpl("Impl " + name)
self.interfaces = "Interface " + name
ext._about_widget.plugins = [FakePlugin("Test 1"), FakePlugin("Test 2"), FakePlugin("Test 3"), FakePlugin("Test 4")]
await omni.kit.app.get_app().next_update_async()
# Wait for image loaded
await asyncio.sleep(5)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="page.png")
| 1,765 | Python | 35.040816 | 128 | 0.603399 |
omniverse-code/kit/exts/omni.kit.viewport.manipulator.transform/omni/kit/viewport/manipulator/transform/fakeGf.py | import math
from usdrt import Gf
def GfRotation(axis0, angle):
axis = Gf.Vec3d(axis0[0], axis0[1], axis0[2]).GetNormalized()
quat = Gf.Quatd()
s = math.sin(math.radians (angle*0.5 ) )
qx = axis[0] * s
qy = axis[1] * s
qz = axis[2] * s
qw = math.cos( math.radians (angle/2) )
i = Gf.Vec3d(qx, qy, qz)
quat.SetReal(qw)
quat.SetImaginary(i)
return quat
| 397 | Python | 21.11111 | 65 | 0.586902 |
omniverse-code/kit/exts/omni.kit.viewport.manipulator.transform/omni/kit/viewport/manipulator/transform/__init__.py | from .extension import *
from .model import *
| 46 | Python | 14.666662 | 24 | 0.73913 |
omniverse-code/kit/exts/omni.kit.viewport.manipulator.transform/omni/kit/viewport/manipulator/transform/utils.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
import carb
import carb.profiler
import carb.settings
@carb.profiler.profile
def flatten(transform):
"""Convert array[4][4] to array[16]"""
# flatten the matrix by hand
# USING LIST COMPREHENSION IS VERY SLOW (e.g. return [item for sublist in transform for item in sublist]), which takes around 10ms.
m0, m1, m2, m3 = transform[0], transform[1], transform[2], transform[3]
return [
m0[0],
m0[1],
m0[2],
m0[3],
m1[0],
m1[1],
m1[2],
m1[3],
m2[0],
m2[1],
m2[2],
m2[3],
m3[0],
m3[1],
m3[2],
m3[3],
] | 1,078 | Python | 27.394736 | 135 | 0.628942 |
omniverse-code/kit/exts/omni.kit.viewport.manipulator.transform/omni/kit/viewport/manipulator/transform/model.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
from __future__ import annotations
# import asyncio
# import math
# import traceback
from enum import Enum, Flag, IntEnum, auto
# from typing import Dict, List, Sequence, Set, Tuple, Union
# import concurrent.futures
import carb
import carb.dictionary
import carb.events
import carb.profiler
import carb.settings
# import omni.kit.app
from omni.kit.async_engine import run_coroutine
import omni.kit.undo
import omni.timeline
# from omni.kit.manipulator.tool.snap import settings_constants as snap_c
from omni.kit.manipulator.transform import AbstractTransformManipulatorModel, Operation
# from omni.kit.manipulator.transform.settings_constants import c
# from omni.kit.manipulator.transform.settings_listener import OpSettingsListener, SnapSettingsListener
# from omni.ui import scene as sc
# from pxr import Gf, Sdf, Tf, Usd, UsdGeom, UsdUtils
# from .utils import *
# from .settings_constants import Constants as prim_c
class ManipulationMode(IntEnum):
PIVOT = 0 # transform around manipulator pivot
UNIFORM = 1 # set same world transform from manipulator to all prims equally
INDIVIDUAL = 2 # 2: (TODO) transform around each prim's own pivot respectively
class Viewport1WindowState:
def __init__(self):
self._focused_windows = None
focused_windows = []
try:
# For some reason is_focused may return False, when a Window is definitely in fact is the focused window!
# And there's no good solution to this when multiple Viewport-1 instances are open; so we just have to
# operate on all Viewports for a given usd_context.
import omni.kit.viewport_legacy as vp
vpi = vp.acquire_viewport_interface()
for instance in vpi.get_instance_list():
window = vpi.get_viewport_window(instance)
if not window:
continue
focused_windows.append(window)
if focused_windows:
self._focused_windows = focused_windows
for window in self._focused_windows:
# Disable the selection_rect, but enable_picking for snapping
window.disable_selection_rect(True)
# Schedule a picking request so if snap needs it later, it may arrive by the on_change event
window.request_picking()
except Exception:
pass
def get_picked_world_pos(self):
if self._focused_windows:
# Try to reduce to the focused window now after, we've had some mouse-move input
focused_windows = [window for window in self._focused_windows if window.is_focused()]
if focused_windows:
self._focused_windows = focused_windows
for window in self._focused_windows:
window.disable_selection_rect(True)
# request picking FOR NEXT FRAME
window.request_picking()
# get PREVIOUSLY picked pos, it may be None the first frame but that's fine
return window.get_picked_world_pos()
return None
def __del__(self):
self.destroy()
def destroy(self):
self._focused_windows = None
def get_usd_context_name(self):
if self._focused_windows:
return self._focused_windows[0].get_usd_context_name()
else:
return ""
class DataAccessorRegistry():
def __init__(self):
...
def getDataAccessor(self):
self.dataAccessor = DataAccessor()
return self.dataAccessor
class DataAccessor():
def __init__(self):
...
def get_local_to_world_transform(self, obj):
...
def get_parent_to_world_transform(self, obj):
...
def clear_xform_cache(self):
...
class ViewportTransformModel(AbstractTransformManipulatorModel):
def __init__(self, usd_context_name: str = "", viewport_api=None):
super().__init__() | 4,385 | Python | 38.160714 | 117 | 0.662942 |
omniverse-code/kit/exts/omni.kit.viewport.manipulator.transform/omni/kit/viewport/manipulator/transform/gestures.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
from __future__ import annotations
import asyncio
import math
import traceback
from enum import Enum, Flag, IntEnum, auto
from typing import Dict, List, Sequence, Set, Tuple, Union
import concurrent.futures
import carb
import carb.dictionary
import carb.events
import carb.profiler
import carb.settings
import omni.kit.app
from omni.kit.async_engine import run_coroutine
import omni.kit.commands
import omni.kit.undo
import omni.timeline
from omni.kit.manipulator.tool.snap import SnapProviderManager
# from omni.kit.manipulator.tool.snap import settings_constants as snap_c
from omni.kit.manipulator.transform.gestures import (
RotateChangedGesture,
RotateDragGesturePayload,
ScaleChangedGesture,
ScaleDragGesturePayload,
TransformDragGesturePayload,
TranslateChangedGesture,
TranslateDragGesturePayload,
)
from omni.kit.manipulator.transform import Operation
from omni.kit.manipulator.transform.settings_constants import c
from omni.ui import scene as sc
from .model import ViewportTransformModel, ManipulationMode, Viewport1WindowState
from .utils import flatten
from .fakeGf import GfRotation
# from usdrt import Sdf, Usd, UsdGeom
from usdrt import Gf
class ViewportTransformChangedGestureBase:
def __init__(self, usd_context_name: str = "", viewport_api=None):
self._settings = carb.settings.get_settings()
self._usd_context_name = usd_context_name
self._usd_context = omni.usd.get_context(self._usd_context_name)
self._viewport_api = viewport_api # VP2
self._vp1_window_state = None
self._stage_id = None
def on_began(self, payload_type=TransformDragGesturePayload):
self._viewport_on_began()
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, payload_type):
return
model = self.sender.model
if not model:
return
item = self.gesture_payload.changing_item
self._current_editing_op = item.operation
# NOTE! self._begin_xform has no scale. To get the full matrix, do self._begin_scale_mtx * self._begin_xform
self._begin_xform = Gf.Matrix4d(*model.get_as_floats(model.get_item("no_scale_transform_manipulator")))
manip_scale = Gf.Vec3d(*model.get_as_floats(model.get_item("scale_manipulator")))
self._begin_scale_mtx = Gf.Matrix4d(1.0)
self._begin_scale_mtx.SetScale(manip_scale)
model.set_floats(model.get_item("viewport_fps"), [0.0])
model.on_began(self.gesture_payload)
def on_changed(self, payload_type=TransformDragGesturePayload):
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, payload_type):
return
model = self.sender.model
if not model:
return
if self._viewport_api:
fps = self._viewport_api.frame_info.get("fps")
model.set_floats(model.get_item("viewport_fps"), [fps])
model.on_changed(self.gesture_payload)
def on_ended(self, payload_type=TransformDragGesturePayload):
self._viewport_on_ended()
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, payload_type):
return
model = self.sender.model
if not model:
return
item = self.gesture_payload.changing_item
if item.operation != self._current_editing_op:
return
model.set_floats(model.get_item("viewport_fps"), [0.0])
model.on_ended(self.gesture_payload)
self._current_editing_op = None
def on_canceled(self, payload_type=TransformDragGesturePayload):
self._viewport_on_ended()
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, payload_type):
return
model = self.sender.model
if not model:
return
item = self.gesture_payload.changing_item
if item.operation != self._current_editing_op:
return
model.on_canceled(self.gesture_payload)
self._current_editing_op = None
def _publish_delta(self, operation: Operation, delta: List[float]):
if operation == Operation.TRANSLATE:
self._settings.set_float_array(TRANSFORM_GIZMO_TRANSLATE_DELTA_XYZ, delta)
elif operation == Operation.ROTATE:
self._settings.set_float_array(TRANSFORM_GIZMO_ROTATE_DELTA_XYZW, delta)
elif operation == Operation.SCALE:
self._settings.set_float_array(TRANSFORM_GIZMO_SCALE_DELTA_XYZ, delta)
def __set_viewport_manipulating(self, value: int):
# Signal that user-manipulation has started for this stage
if self._stage_id is None:
# self._stage_id = UsdUtils.StageCache.Get().GetId(self._usd_context.get_stage()).ToLongInt()
self._stage_id = self._usd_context.get_stage_id()
key = f"/app/viewport/{self._stage_id}/manipulating"
cur_value = self._settings.get(key) or 0
self._settings.set(key, cur_value + value)
def _viewport_on_began(self):
self._viewport_on_ended()
if self._viewport_api is None:
self._vp1_window_state = Viewport1WindowState()
self.__set_viewport_manipulating(1)
def _viewport_on_ended(self):
if self._vp1_window_state:
self._vp1_window_state.destroy()
self._vp1_window_state = None
if self._stage_id:
self.__set_viewport_manipulating(-1)
self._stage_id = None
class ViewportTranslateChangedGesture(TranslateChangedGesture, ViewportTransformChangedGestureBase):
def __init__(self, snap_manager: SnapProviderManager, **kwargs):
ViewportTransformChangedGestureBase.__init__(self, **kwargs)
TranslateChangedGesture.__init__(self)
self._accumulated_translate = Gf.Vec3d(0)
self._snap_manager = snap_manager
def on_began(self):
ViewportTransformChangedGestureBase.on_began(self, TranslateDragGesturePayload)
self._accumulated_translate = Gf.Vec3d(0)
model = self._get_model(TranslateDragGesturePayload)
if model and self._can_snap(model):
# TODO No need for gesture=self when VP1 has viewport_api
self._snap_manager.on_began(model.consolidated_xformable_prim_data_curr.keys(), gesture=self)
if model:
model.set_floats(model.get_item("translate_delta"), [0, 0, 0])
def on_ended(self):
ViewportTransformChangedGestureBase.on_ended(self, TranslateDragGesturePayload)
model = self._get_model(TranslateDragGesturePayload)
if model and self._can_snap(model):
self._snap_manager.on_ended()
def on_canceled(self):
ViewportTransformChangedGestureBase.on_canceled(self, TranslateDragGesturePayload)
model = self._get_model(TranslateDragGesturePayload)
if model and self._can_snap(model):
self._snap_manager.on_ended()
@carb.profiler.profile
def on_changed(self):
ViewportTransformChangedGestureBase.on_changed(self, TranslateDragGesturePayload)
model = self._get_model(TranslateDragGesturePayload)
if not model:
return
manip_xform = Gf.Matrix4d(*model.get_as_floats(model.get_item("no_scale_transform_manipulator")))
new_manip_xform = Gf.Matrix4d(manip_xform)
rotation_mtx = manip_xform.ExtractRotationMatrix()
rotation_mtx.Orthonormalize()
translate_delta = self.gesture_payload.moved_delta
translate = self.gesture_payload.moved
axis = self.gesture_payload.axis
# slow Gf.Vec3d(*translate_delta)
translate_delta = Gf.Vec3d(translate_delta[0], translate_delta[1], translate_delta[2])
if model.op_settings_listener.translation_mode == c.TRANSFORM_MODE_LOCAL:
translate_delta = translate_delta * rotation_mtx
self._accumulated_translate += translate_delta
def apply_position(snap_world_pos=None, snap_world_orient=None, keep_spacing: bool = True):
nonlocal new_manip_xform
if self.state != sc.GestureState.CHANGED:
return
# only set translate if no snap or only snap to position
item_name = "translate"
if snap_world_pos and (
math.isfinite(snap_world_pos[0])
and math.isfinite(snap_world_pos[1])
and math.isfinite(snap_world_pos[2])
):
if snap_world_orient is None:
new_manip_xform.SetTranslateOnly(Gf.Vec3d(snap_world_pos[0], snap_world_pos[1], snap_world_pos[2]))
new_manip_xform = self._begin_scale_mtx * new_manip_xform
else:
new_manip_xform.SetTranslateOnly(Gf.Vec3d(snap_world_pos[0], snap_world_pos[1], snap_world_pos[2]))
new_manip_xform.SetRotateOnly(snap_world_orient)
# set transform if snap both position and orientation
item_name = "no_scale_transform_manipulator"
else:
new_manip_xform.SetTranslateOnly(self._begin_xform.ExtractTranslation() + self._accumulated_translate)
new_manip_xform = self._begin_scale_mtx * new_manip_xform
model.set_floats(model.get_item("translate_delta"), translate_delta)
if model.custom_manipulator_enabled:
self._publish_delta(Operation.TRANSLATE, translate_delta)
if keep_spacing is False:
mode_item = model.get_item("manipulator_mode")
prev_mode = model.get_as_ints(mode_item)
model.set_ints(mode_item, [int(ManipulationMode.UNIFORM)])
model.set_floats(model.get_item(item_name), flatten(new_manip_xform))
if keep_spacing is False:
model.set_ints(mode_item, prev_mode)
# only do snap to surface if drag the center point
if (
model.snap_settings_listener.snap_enabled
and model.snap_settings_listener.snap_provider
and axis == [1, 1, 1]
):
ndc_location = None
if self._viewport_api:
# No mouse location is available, have to convert back to NDC space
ndc_location = self.sender.transform_space(
sc.Space.WORLD, sc.Space.NDC, self.gesture_payload.ray_closest_point
)
if self._snap_manager.get_snap_pos(
new_manip_xform,
ndc_location,
self.sender.scene_view,
lambda **kwargs: apply_position(
kwargs.get("position", None), kwargs.get("orient", None), kwargs.get("keep_spacing", True)
),
):
return
apply_position()
def _get_model(self, payload_type) -> ViewportTransformModel:
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, payload_type):
return None
return self.sender.model
def _can_snap(self, model: ViewportTransformModel):
axis = self.gesture_payload.axis
if (
model.snap_settings_listener.snap_enabled
and model.snap_settings_listener.snap_provider
and axis == [1, 1, 1]
):
return True
return False
class ViewportRotateChangedGesture(RotateChangedGesture, ViewportTransformChangedGestureBase):
def __init__(self, **kwargs):
ViewportTransformChangedGestureBase.__init__(self, **kwargs)
RotateChangedGesture.__init__(self)
def on_began(self):
ViewportTransformChangedGestureBase.on_began(self, RotateDragGesturePayload)
model = self.sender.model
if model:
model.set_floats(model.get_item("rotate_delta"), [0, 0, 0, 0])
def on_ended(self):
ViewportTransformChangedGestureBase.on_ended(self, RotateDragGesturePayload)
def on_canceled(self):
ViewportTransformChangedGestureBase.on_canceled(self, RotateDragGesturePayload)
@carb.profiler.profile
def on_changed(self):
ViewportTransformChangedGestureBase.on_changed(self, RotateDragGesturePayload)
if (
not self.gesture_payload
or not self.sender
or not isinstance(self.gesture_payload, RotateDragGesturePayload)
):
return
model = self.sender.model
if not model:
return
axis = self.gesture_payload.axis
angle = self.gesture_payload.angle
angle_delta = self.gesture_payload.angle_delta
screen_space = self.gesture_payload.screen_space
free_rotation = self.gesture_payload.free_rotation
axis = Gf.Vec3d(*axis[:3])
rotate = GfRotation(axis, angle)
delta_axis = Gf.Vec4d(*axis, 0.0)
rot_matrix = Gf.Matrix4d(1)
rot_matrix.SetRotate(rotate)
if free_rotation:
rotate = GfRotation(axis, angle_delta)
rot_matrix = Gf.Matrix4d(1)
rot_matrix.SetRotate(rotate)
xform = Gf.Matrix4d(*model.get_as_floats(model.get_item("no_scale_transform_manipulator")))
full_xform = self._begin_scale_mtx * xform
translate = full_xform.ExtractTranslation()
no_translate_mtx = Gf.Matrix4d(full_xform)
no_translate_mtx.SetTranslateOnly(Gf.Vec3d(0))
no_translate_mtx = no_translate_mtx * rot_matrix
new_transform_matrix = no_translate_mtx.SetTranslateOnly(translate)
delta_axis = no_translate_mtx * delta_axis
elif model.op_settings_listener.rotation_mode == c.TRANSFORM_MODE_GLOBAL or screen_space:
begin_full_xform = self._begin_scale_mtx * self._begin_xform
translate = begin_full_xform.ExtractTranslation()
no_translate_mtx = Gf.Matrix4d(begin_full_xform)
no_translate_mtx.SetTranslateOnly(Gf.Vec3d(0))
no_translate_mtx = no_translate_mtx * rot_matrix
new_transform_matrix = no_translate_mtx.SetTranslateOnly(translate)
delta_axis = no_translate_mtx * delta_axis
else:
self._begin_xform = Gf.Matrix4d(*model.get_as_floats(model.get_item("no_scale_transform_manipulator")))
new_transform_matrix = self._begin_scale_mtx * rot_matrix * self._begin_xform
delta_axis.Normalize()
delta_rotate = GfRotation(delta_axis[:3], angle_delta)
quat = delta_rotate #.GetQuaternion()
real = quat.GetReal()
imaginary = quat.GetImaginary()
rd = [imaginary[0], imaginary[1], imaginary[2], real]
model.set_floats(model.get_item("rotate_delta"), rd)
if model.custom_manipulator_enabled:
self._publish_delta(Operation.ROTATE, rd)
model.set_floats(model.get_item("rotate"), flatten(new_transform_matrix))
class ViewportScaleChangedGesture(ScaleChangedGesture, ViewportTransformChangedGestureBase):
def __init__(self, **kwargs):
ViewportTransformChangedGestureBase.__init__(self, **kwargs)
ScaleChangedGesture.__init__(self)
def on_began(self):
ViewportTransformChangedGestureBase.on_began(self, ScaleDragGesturePayload)
model = self.sender.model
if model:
model.set_floats(model.get_item("scale_delta"), [0, 0, 0])
def on_ended(self):
ViewportTransformChangedGestureBase.on_ended(self, ScaleDragGesturePayload)
def on_canceled(self):
ViewportTransformChangedGestureBase.on_canceled(self, ScaleDragGesturePayload)
@carb.profiler.profile
def on_changed(self):
ViewportTransformChangedGestureBase.on_changed(self, ScaleDragGesturePayload)
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, ScaleDragGesturePayload):
return
model = self.sender.model
if not model:
return
axis = self.gesture_payload.axis
scale = self.gesture_payload.scale
axis = Gf.Vec3d(*axis[:3])
scale_delta = scale * axis
scale_vec = Gf.Vec3d()
for i in range(3):
scale_vec[i] = scale_delta[i] if scale_delta[i] else 1
scale_matrix = Gf.Matrix4d(1.0)
scale_matrix.SetScale(scale_vec)
scale_matrix *= self._begin_scale_mtx
new_transform_matrix = scale_matrix * self._begin_xform
s = Gf.Vec3d(*model.get_as_floats(model.get_item("scale_manipulator")))
sd = [s_n / s_o for s_n, s_o in zip([scale_matrix[0][0], scale_matrix[1][1], scale_matrix[2][2]], s)]
model.set_floats(model.get_item("scale_delta"), sd)
if model.custom_manipulator_enabled:
self._publish_delta(Operation.SCALE, sd)
model.set_floats(model.get_item("scale"), flatten(new_transform_matrix))
| 17,358 | Python | 37.747768 | 120 | 0.649038 |
omniverse-code/kit/exts/omni.kit.viewport.manipulator.transform/omni/kit/viewport/manipulator/transform/tests/test_manipulator_transform.py | ## Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
from omni.ui.tests.test_base import OmniUiTest
class TestViewportTransform(OmniUiTest):
# Before running each test
async def setUp(self):
pass
# After running each test
async def tearDown(self):
pass
| 670 | Python | 34.315788 | 77 | 0.756716 |
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/config/extension.toml | [package]
# Semantic Versioning is used: https://semver.org/
version = "0.0.1"
# Lists people or organizations that are considered the "authors" of the package.
authors = ["NVIDIA"]
# The title and description fields are primarly for displaying extension info in UI
title = "content Browser Registry"
description="Registry for all customizations that are added to the Content Browser"
# URL of the extension source repository.
repository = ""
# Keywords for the extension
keywords = ["kit", "ui"]
# Location of change log file in target (final) folder of extension, relative to the root.
# More info on writing changelog: https://keepachangelog.com/en/1.0.0/
changelog="docs/CHANGELOG.md"
# Path (relative to the root) or content of readme markdown file for UI.
readme = "docs/README.md"
# Icon is shown in Extensions window, it is recommended to be square, of size 256x256.
icon = "data/icon.png"
category = "core"
[dependencies]
"omni.kit.window.filepicker" = {}
# Main python module this extension provides, it will be publicly available as "import omni.kit.viewport.registry".
[[python.module]]
name = "omni.kit.window.content_browser_registry"
[settings]
# exts."omni.kit.window.content_browser_registry".xxx = ""
[documentation]
pages = [
"docs/CHANGELOG.md",
]
[[test]]
args = [
"--/app/window/dpiScaleOverride=1.0",
"--/app/window/scaleToMonitor=false",
"--no-window"
]
| 1,408 | TOML | 26.62745 | 115 | 0.727983 |
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/omni/kit/window/content_browser_registry/extension.py | # Copyright (c) 2018-2020, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
import omni.ext
import omni.kit.app
from typing import Callable
from collections import OrderedDict
from omni.kit.window.filepicker import SearchDelegate
g_singleton = None
# Any class derived from `omni.ext.IExt` in top level module (defined in `python.modules` of `extension.toml`) will be
# instantiated when extension gets enabled and `on_startup(ext_id)` will be called. Later when extension gets disabled
# on_shutdown() is called.
class ContentBrowserRegistryExtension(omni.ext.IExt):
"""
This registry extension keeps track of the functioanl customizations that are applied to the Content Browser -
so that they can be re-applied should the browser be re-started.
"""
def __init__(self):
super().__init__()
self._custom_menus = OrderedDict()
self._selection_handlers = set()
self._search_delegate = None
def on_startup(self, ext_id):
# Save away this instance as singleton
global g_singleton
g_singleton = self
def on_shutdown(self):
self._custom_menus.clear()
self._selection_handlers.clear()
self._search_delegate = None
global g_singleton
g_singleton = None
def register_custom_menu(self, context: str, name: str, glyph: str, click_fn: Callable, show_fn: Callable, index: int = -1):
id = f"{context}::{name}"
self._custom_menus[id] = {
'name': name,
'glyph': glyph,
'click_fn': click_fn,
'show_fn': show_fn,
'index': index,
}
def deregister_custom_menu(self, context: str, name: str):
id = f"{context}::{name}"
if id in self._custom_menus:
del self._custom_menus[id]
def register_selection_handler(self, handler: Callable):
self._selection_handlers.add(handler)
def deregister_selection_handler(self, handler: Callable):
if handler in self._selection_handlers:
self._selection_handlers.remove(handler)
def register_search_delegate(self, search_delegate: SearchDelegate):
self._search_delegate = search_delegate
def deregister_search_delegate(self, search_delegate: SearchDelegate):
if self._search_delegate == search_delegate:
self._search_delegate = None
def get_instance():
return g_singleton
| 2,775 | Python | 34.13924 | 128 | 0.675676 |
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/omni/kit/window/content_browser_registry/__init__.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
from typing import Callable, Union, Set
from collections import OrderedDict
from omni.kit.window.filepicker import SearchDelegate
from .extension import ContentBrowserRegistryExtension, get_instance
def custom_menus() -> OrderedDict:
registry = get_instance()
if registry:
return registry._custom_menus
return OrderedDict()
def selection_handlers() -> Set:
registry = get_instance()
if registry:
return registry._selection_handlers
return set()
def search_delegate() -> SearchDelegate:
registry = get_instance()
if registry:
return registry._search_delegate
return None
def register_context_menu(name: str, glyph: str, click_fn: Callable, show_fn: Callable, index: int = -1):
registry = get_instance()
if registry:
registry.register_custom_menu("context", name, glyph, click_fn, show_fn, index=index)
def deregister_context_menu(name: str):
registry = get_instance()
if registry:
registry.deregister_custom_menu("context", name)
def register_listview_menu(name: str, glyph: str, click_fn: Callable, show_fn: Callable, index: int = -1):
registry = get_instance()
if registry:
registry.register_custom_menu("listview", name, glyph, click_fn, show_fn, index=index)
def deregister_listview_menu(name: str):
registry = get_instance()
if registry:
registry.deregister_custom_menu("listview", name)
def register_import_menu(name: str, glyph: str, click_fn: Callable, show_fn: Callable):
registry = get_instance()
if registry:
registry.register_custom_menu("import", name, glyph, click_fn, show_fn)
def deregister_import_menu(name: str):
registry = get_instance()
if registry:
registry.deregister_custom_menu("import", name)
def register_file_open_handler(name: str, open_fn: Callable, file_type: Union[int, Callable]):
registry = get_instance()
if registry:
registry.register_custom_menu("file_open", name, None, open_fn, file_type)
def deregister_file_open_handler(name: str):
registry = get_instance()
if registry:
registry.deregister_custom_menu("file_open", name)
def register_selection_handler(handler: Callable):
registry = get_instance()
if registry:
registry.register_selection_handler(handler)
def deregister_selection_handler(handler: Callable):
registry = get_instance()
if registry:
registry.deregister_selection_handler(handler)
def register_search_delegate(search_delegate: SearchDelegate):
registry = get_instance()
if registry:
registry.register_search_delegate(search_delegate)
def deregister_search_delegate(search_delegate: SearchDelegate):
registry = get_instance()
if registry:
registry.deregister_search_delegate(search_delegate)
| 3,246 | Python | 34.293478 | 106 | 0.718731 |
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/omni/kit/window/content_browser_registry/tests/test_registry.py | ## Copyright (c) 2018-2019, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
import omni.kit.test
import inspect
import omni.kit.window.content_browser_registry as registry
from unittest.mock import Mock
from omni.kit.test.async_unittest import AsyncTestCase
class TestRegistry(AsyncTestCase):
"""Testing Content Browser Registry"""
async def setUp(self):
pass
async def tearDown(self):
pass
async def test_custom_menus(self):
"""Test registering and de-registering custom menus"""
test_menus = [
{
"register_fn": registry.register_context_menu,
"deregister_fn": registry.deregister_context_menu,
"context": "context",
"name": "my context menu",
"glyph": "my glyph",
"click_fn": Mock(),
"show_fn": Mock(),
},
{
"register_fn": registry.register_listview_menu,
"deregister_fn": registry.deregister_listview_menu,
"context": "listview",
"name": "my listview menu",
"glyph": "my glyph",
"click_fn": Mock(),
"show_fn": Mock(),
},
{
"register_fn": registry.register_import_menu,
"deregister_fn": registry.deregister_import_menu,
"context": "import",
"name": "my import menu",
"glyph": None,
"click_fn": Mock(),
"show_fn": Mock(),
},
{
"register_fn": registry.register_file_open_handler,
"deregister_fn": registry.deregister_file_open_handler,
"context": "file_open",
"name": "my file_open handler",
"glyph": None,
"click_fn": Mock(),
"show_fn": Mock(),
}
]
# Register menus
for test_menu in test_menus:
register_fn = test_menu["register_fn"]
if 'glyph' in inspect.getfullargspec(register_fn).args:
register_fn(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"])
else:
register_fn(test_menu["name"], test_menu["click_fn"], test_menu["show_fn"])
# Confirm menus stored to registry
for test_menu in test_menus:
self.assertTrue(f'{test_menu["context"]}::{test_menu["name"]}' in registry.custom_menus())
# De-register all menus
for test_menu in test_menus:
test_menu["deregister_fn"](test_menu["name"])
# Confirm all menus removed from registry
self.assertEqual(len(registry.custom_menus()), 0)
async def test_selection_handlers(self):
"""Test registering selection handlers"""
test_handler_1 = Mock()
test_handler_2 = Mock()
test_handlers = [test_handler_1, test_handler_2, test_handler_1]
self.assertEqual(len(registry.selection_handlers()), 0)
for test_handler in test_handlers:
registry.register_selection_handler(test_handler)
# Confirm each unique handler is stored only once in registry
self.assertEqual(len(registry.selection_handlers()), 2)
async def test_search_delegate(self):
"""Test registering search delegate"""
test_search_delegate = Mock()
self.assertEqual(registry.search_delegate(), None)
registry.register_search_delegate(test_search_delegate)
# Confirm search delegate stored in registry
self.assertEqual(registry.search_delegate(), test_search_delegate)
| 4,061 | Python | 38.057692 | 111 | 0.581138 |
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [0.0.1] - 2022-10-11
### Updated
- Initial version. | 148 | Markdown | 23.833329 | 80 | 0.675676 |
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/docs/README.md | # Content Browser registry extension [omni.kit.window.content_browser_registry]
This helper registry maintains a list of customizations that are added to the content browser.
| 175 | Markdown | 57.666647 | 94 | 0.828571 |
omniverse-code/kit/exts/omni.kit.window.about/config/extension.toml | [package]
# Semantic Versioning is used: https://semver.org/
version = "1.0.3"
# Lists people or organizations that are considered the "authors" of the package.
authors = ["NVIDIA"]
# The title and description fields are primarily for displaying extension info in UI
title = "Kit About Window"
description="Show application/build information."
# URL of the extension source repository.
repository = ""
# Preview image. Folder named "data" automatically goes in git lfs (see .gitattributes file).
preview_image = "data/preview.png"
# One of categories for UI.
category = "Internal"
# Keywords for the extension
keywords = ["kit"]
# https://keepachangelog.com/en/1.0.0/
changelog="docs/CHANGELOG.md"
[dependencies]
"omni.ui" = {}
"omni.usd" = {}
"omni.client" = {}
"omni.kit.menu.utils" = {}
"omni.kit.clipboard" = {}
[[python.module]]
name = "omni.kit.window.about"
[[test]]
args = [
"--/renderer/enabled=pxr",
"--/renderer/active=pxr",
"--/renderer/multiGpu/enabled=false",
"--/renderer/multiGpu/autoEnable=false", # Disable mGPU with PXR due to OM-51026, OM-53611
"--/renderer/multiGpu/maxGpuCount=1",
"--/app/asyncRendering=false",
"--/app/window/dpiScaleOverride=1.0",
"--/app/window/scaleToMonitor=false",
# "--no-window", # Test crashes with this turned on, for some reason
"--/testconfig/isTest=true"
]
dependencies = [
"omni.hydra.pxr",
"omni.kit.renderer.capture",
"omni.kit.ui_test",
"omni.kit.test_suite.helpers",
]
stdoutFailPatterns.include = []
stdoutFailPatterns.exclude = []
| 1,559 | TOML | 25 | 94 | 0.686979 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/about.py | import carb
import carb.settings
import omni.client
import omni.kit.app
import omni.kit.ui
import omni.ext
import omni.kit.menu.utils
from omni.kit.menu.utils import MenuItemDescription
from pathlib import Path
from omni import ui
from .about_actions import register_actions, deregister_actions
from .about_window import AboutWindow
WINDOW_NAME = "About"
MENU_NAME = "Help"
_extension_instance = None
class AboutExtension(omni.ext.IExt):
def on_startup(self, ext_id):
self._ext_name = omni.ext.get_extension_name(ext_id)
self._window = AboutWindow()
self._window.set_visibility_changed_fn(self._on_visibility_changed)
self._menu_entry = MenuItemDescription(
name=WINDOW_NAME,
ticked_fn=self._is_visible,
onclick_action=(self._ext_name, "toggle_window"),
)
omni.kit.menu.utils.add_menu_items([self._menu_entry], name=MENU_NAME)
ui.Workspace.set_show_window_fn(
"About",
lambda value: self._toggle_window(),
)
manager = omni.kit.app.get_app().get_extension_manager()
extension_path = manager.get_extension_path(ext_id)
global _extension_instance
_extension_instance = self
register_actions(self._ext_name, lambda: _extension_instance)
def on_shutdown(self):
global _extension_instance
_extension_instance = None
self._window.destroy()
self._window = None
omni.kit.menu.utils.remove_menu_items([self._menu_entry], name=MENU_NAME)
self._menu_entry = None
deregister_actions(self._ext_name)
def _is_visible(self) -> bool:
return False if self._window is None else self._window.visible
def _on_visibility_changed(self, visible):
self._menu_entry.ticked = visible
omni.kit.menu.utils.refresh_menu_items(MENU_NAME)
def toggle_window(self):
self._window.visible = not self._window.visible
def show(self, visible: bool):
self._window.visible = visible
def menu_show_about(self, plugins):
version_infos = [
f"Omniverse Kit {self.kit_version}",
f"App Name: {self.app_name}",
f"App Version: {self.app_version}",
f"Client Library Version: {self.client_library_version}",
f"USD Resolver Version: {self.usd_resolver_version}",
f"USD Version: {self.usd_version}",
f"MDL SDK Version: {self.mdlsdk_version}",
]
@staticmethod
def _resize_window(window: ui.Window, scrolling_frame: ui.ScrollingFrame):
scrolling_frame.width = ui.Pixel(window.width - 10)
scrolling_frame.height = ui.Pixel(window.height - 305)
def get_instance():
return _extension_instance
| 2,772 | Python | 29.811111 | 81 | 0.644661 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/style.py | from pathlib import Path
from omni import ui
from omni.ui import color as cl
CURRENT_PATH = Path(__file__).parent
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath("data")
ABOUT_STYLE = {
"Window": {"background_color": cl("#1F2123")},
"Line": {"color": 0xFF353332, "border_width": 1.5},
"ScrollingFrame": {"background_color": cl.transparent, "margin_width": 1, "margin_height": 2},
"About.Background": {"image_url": f"{ICON_PATH}/about_backgroud.png"},
"About.Background.Fill": {"background_color": cl("#131415")},
"About.Logo": {"image_url": f"{ICON_PATH}/about_logo.png", "padding": 0, "margin": 0},
"Logo.Frame": {"background_color": cl("#202424"), "padding": 0, "margin": 0},
"Logo.Separator": {"color": cl("#7BB01E"), "border_width": 1.5},
"Text.App": {"font_size": 18, "margin_width": 10, "margin_height": 2},
"Text.Plugin": {"font_size": 14, "margin_width": 10, "margin_height": 2},
"Text.Version": {"font_size": 18, "margin_width": 10, "margin_height": 2},
"Text.Title": {"font_size": 16, "margin_width": 10},
} | 1,083 | Python | 46.130433 | 98 | 0.626039 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/about_window.py | import omni.ui as ui
import omni.kit.clipboard
from .about_widget import AboutWidget
from .style import ABOUT_STYLE
class AboutWindow(ui.Window):
def __init__(self):
super().__init__(
"About",
width=800,
height=540,
flags=ui.WINDOW_FLAGS_NO_SCROLLBAR | ui.WINDOW_FLAGS_NO_DOCKING,
visible=False
)
self.frame.set_build_fn(self._build_ui)
self.frame.set_style(ABOUT_STYLE)
def destroy(self):
self.visible = False
super().destroy()
def _build_ui(self):
with self.frame:
with ui.ZStack():
with ui.VStack():
self._widget = AboutWidget()
ui.Line(height=0)
ui.Spacer(height=4)
with ui.HStack(height=26):
ui.Spacer()
ui.Button("Close", width=80, clicked_fn=self._hide, style={"padding": 0, "margin": 0})
ui.Button(
"###copy_to_clipboard",
style={"background_color": 0x00000000},
mouse_pressed_fn=lambda x, y, b, a: self.__copy_to_clipboard(b),
identifier="copy_to_clipboard",
)
def _hide(self):
self.visible = False
def __copy_to_clipboard(self, button):
if button != 1:
return
omni.kit.clipboard.copy("\n".join(self._widget.versions)) | 1,474 | Python | 30.382978 | 110 | 0.504071 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/__init__.py | from .about import *
from .about_widget import AboutWidget
| 59 | Python | 18.999994 | 37 | 0.79661 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/about_widget.py | from typing import List
import carb
import carb.settings
import omni.kit.app
import omni.ui as ui
from .style import ABOUT_STYLE
class AboutWidget:
def __init__(self):
app = omni.kit.app.get_app()
self._app_info = f"{app.get_app_name()} {app.get_app_version()}"
self._versions = self.__get_versions()
plugins = [p for p in carb.get_framework().get_plugins() if p.impl.name]
self._plugins = sorted(plugins, key=lambda x: x.impl.name)
custom_image = carb.settings.get_settings().get("/app/window/imagePath")
if custom_image:
ABOUT_STYLE['About.Logo']['image_url'] = carb.tokens.get_tokens_interface().resolve(custom_image)
self._frame = ui.Frame(build_fn=self._build_ui, style=ABOUT_STYLE)
@property
def app_info(self) -> List[str]:
return self._app_info
@app_info.setter
def app_info(self, value: str) -> None:
self._app_info = value
with self._frame:
self._frame.call_build_fn()
@property
def versions(self) -> List[str]:
return [self._app_info] + self._versions
@versions.setter
def versions(self, values: List[str]) -> None:
self._versions = values
with self._frame:
self._frame.call_build_fn()
@property
def plugins(self) -> list:
return self._plugins
@plugins.setter
def plugins(self, values: list) -> None:
self._plugins = values
with self._frame:
self._frame.call_build_fn()
def _build_ui(self):
with ui.VStack(spacing=5):
with ui.ZStack(height=0):
with ui.ZStack():
ui.Rectangle(style_type_name_override="About.Background.Fill")
ui.Image(
style_type_name_override="About.Background",
alignment=ui.Alignment.RIGHT_TOP,
)
with ui.VStack():
ui.Spacer(height=10)
self.__build_app_info()
ui.Spacer(height=10)
for version_info in self._versions:
ui.Label(version_info, height=0, style_type_name_override="Text.Version")
ui.Spacer(height=10)
ui.Spacer(height=0)
ui.Label("Loaded plugins", height=0, style_type_name_override="Text.Title")
ui.Line(height=0)
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
):
with ui.VStack(height=0, spacing=1):
for p in self._plugins:
ui.Label(f"{p.impl.name} {p.interfaces}", tooltip=p.libPath, style_type_name_override="Text.Plugin")
def __build_app_info(self):
with ui.HStack(height=0):
ui.Spacer(width=10)
with ui.ZStack(width=0, height=0):
ui.Rectangle(style_type_name_override="Logo.Frame")
with ui.HStack(height=0):
with ui.VStack():
ui.Spacer(height=5)
ui.Image(width=80, height=80, alignment=ui.Alignment.CENTER, style_type_name_override="About.Logo")
ui.Spacer(height=5)
with ui.VStack(width=0):
ui.Spacer(height=10)
ui.Line(alignment=ui.Alignment.LEFT, style_type_name_override="Logo.Separator")
ui.Spacer(height=18)
with ui.VStack(width=0, height=80):
ui.Spacer()
ui.Label("OMNIVERSE", style_type_name_override="Text.App")
ui.Label(self._app_info, style_type_name_override="Text.App")
ui.Spacer()
ui.Spacer()
def __get_versions(self) -> List[str]:
settings = carb.settings.get_settings()
is_running_test = settings.get("/testconfig/isTest")
# omni_usd_resolver isn't loaded until Ar.GetResolver is called.
# In the ext test, nothing does that, so we need to do it
# since the library isn't located in a PATH search entry.
# Unforunately the ext is loaded before the test module runs,
# so we can't do it there.
try:
if is_running_test:
from pxr import Ar
Ar.GetResolver()
import omni.usd_resolver
usd_resolver_version = omni.usd_resolver.get_version()
except ImportError:
usd_resolver_version = None
try:
import omni.usd_libs
usd_version = omni.usd_libs.get_version()
except ImportError:
usd_version = None
try:
# OM-61509: Add MDL SDK and USD version in about window
import omni.mdl.neuraylib
from omni.mdl import pymdlsdk
# get mdl sdk version
neuraylib = omni.mdl.neuraylib.get_neuraylib()
ineuray = neuraylib.getNeurayAPI()
neuray = pymdlsdk.attach_ineuray(ineuray)
# strip off the date and platform info and only keep the version and build info
version = neuray.get_version().split(",")[:2]
mdlsdk_version = ",".join(version)
except ImportError:
mdlsdk_version = None
app = omni.kit.app.get_app()
version_infos = [
f"Omniverse Kit {app.get_kit_version()}",
f"Client Library Version: {omni.client.get_version()}",
f"USD Resolver Version: {usd_resolver_version}",
f"USD Version: {usd_version}",
f"MDL SDK Version: {mdlsdk_version}",
]
return version_infos
| 5,850 | Python | 36.993506 | 124 | 0.549915 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/about_actions.py | import carb
import omni.kit.actions.core
def register_actions(extension_id, get_self_fn):
action_registry = omni.kit.actions.core.get_action_registry()
actions_tag = "About Actions"
omni.kit.actions.core.get_action_registry().register_action(
extension_id,
"toggle_window",
get_self_fn().toggle_window,
display_name="Help->Toggle About Window",
description="Toggle About",
tag=actions_tag,
)
omni.kit.actions.core.get_action_registry().register_action(
extension_id,
"show_window",
lambda v=True: get_self_fn().show(v),
display_name="Help->Show About Window",
description="Show About",
tag=actions_tag,
)
omni.kit.actions.core.get_action_registry().register_action(
extension_id,
"hide_window",
lambda v=False: get_self_fn().show(v),
display_name="Help->Hide About Window",
description="Hide About",
tag=actions_tag,
)
def deregister_actions(extension_id):
action_registry = omni.kit.actions.core.get_action_registry()
action_registry.deregister_all_actions_for_extension(extension_id)
| 1,176 | Python | 29.179486 | 70 | 0.643707 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/tests/test_window_about.py | ## Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
from pathlib import Path
import omni.kit.app
import omni.kit.test
import omni.ui as ui
from omni.ui.tests.test_base import OmniUiTest
CURRENT_PATH = Path(__file__).parent
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("tests")
class TestAboutWindow(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden_img").absolute()
# After running each test
async def tearDown(self):
await super().tearDown()
async def test_about_ui(self):
class FakePluginImpl():
def __init__(self, name):
self.name = name
class FakePlugin():
def __init__(self, name):
self.libPath = "Lib Path " + name
self.impl = FakePluginImpl("Impl " + name)
self.interfaces = "Interface " + name
about = omni.kit.window.about.get_instance()
about.show(True)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
about._window._widget.app_info = "#App Name# #App Version#"
about._window._widget.versions = [
"Omniverse Kit #Version#",
"Client Library Version: #Client Library Version#",
"USD Resolver Version: #USD Resolver Version#",
"USD Version: #USD Version#",
"MDL SDK Version: #MDL SDK Version#",
]
about._window._widget.plugins = [FakePlugin("Test 1"), FakePlugin("Test 2"), FakePlugin("Test 3"), FakePlugin("Test 4")]
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
await self.docked_test_window(
window=about._window,
width=800,
height=510)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_about_ui.png")
| 2,403 | Python | 37.774193 | 128 | 0.63712 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/tests/__init__.py | from .test_window_about import *
from .test_clipboard import *
| 63 | Python | 20.333327 | 32 | 0.761905 |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/tests/test_clipboard.py | ## Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
import pathlib
import sys
import unittest
import omni.kit.app
import omni.kit.test
import omni.ui as ui
from omni.kit import ui_test
from omni.ui.tests.test_base import OmniUiTest
class TestAboutWindowClipboard(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
# After running each test
async def tearDown(self):
await super().tearDown()
# @unittest.skipIf(sys.platform.startswith("linux"), "Pyperclip fails on some TeamCity agents")
async def test_about_clipboard(self):
class FakePluginImpl():
def __init__(self, name):
self.name = name
class FakePlugin():
def __init__(self, name):
self.libPath = "Lib Path " + name
self.impl = FakePluginImpl("Impl " + name)
self.interfaces = "Interface " + name
omni.kit.clipboard.copy("")
about = omni.kit.window.about.get_instance()
about.kit_version = "#Version#"
about.nucleus_version = "#Nucleus Version#"
about.client_library_version = "#Client Library Version#"
about.app_name = "#App Name#"
about.app_version = "#App Version#"
about.usd_resolver_version = "#USD Resolver Version#"
about.usd_version = "#USD Version#"
about.mdlsdk_version = "#MDL SDK Version#"
about_window = about.menu_show_about([FakePlugin("Test 1"), FakePlugin("Test 2"), FakePlugin("Test 3"), FakePlugin("Test 4")])
await ui_test.find("About//Frame/**/Button[*].identifier=='copy_to_clipboard'").click(right_click=True)
await ui_test.human_delay()
clipboard = omni.kit.clipboard.paste()
self.assertEqual(clipboard, "#App Name# #App Version#\nOmniverse Kit #Version#\nClient Library Version: #Client Library Version#\nUSD Resolver Version: #USD Resolver Version#\nUSD Version: #USD Version#\nMDL SDK Version: #MDL SDK Version#")
| 2,390 | Python | 39.525423 | 248 | 0.669038 |
omniverse-code/kit/exts/omni.kit.window.about/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [1.0.3] - 2022-11-17
### Updated
- Swap out pyperclip with linux-friendly copy & paste
## [1.0.2] - 2022-09-13
### Updated
- Fix window/menu visibility issues
## [1.0.1] - 2021-08-18
### Updated
- Updated menu to match other menu styling
## [1.0.0] - 2021-02-26
### Updated
- Added test
## [0.2.1] - 2020-12-08
### Updated
- Added "App Version"
- Added right mouse button copy to clipboard
## [0.2.0] - 2020-12-04
### Updated
- Updated to new UI and added resizing
## [0.1.0] - 2020-10-29
- Ported old version to extensions 2.0
| 632 | Markdown | 18.781249 | 80 | 0.651899 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGpuInteropRenderProductEntry.rst | .. _omni_graph_nodes_GpuInteropRenderProductEntry_1:
.. _omni_graph_nodes_GpuInteropRenderProductEntry:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Gpu Interop Render Product Entry
:keywords: lang-en omnigraph node internal threadsafe nodes gpu-interop-render-product-entry
Gpu Interop Render Product Entry
================================
.. <description>
Entry node for post-processing hydra render results for a single view
.. </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:exec", "``execution``", "Trigger for scheduling dependencies", "None"
"gpuFoundations (*outputs:gpu*)", "``uint64``", "Pointer to shared context containing gpu foundations", "None"
"hydraTime (*outputs:hydraTime*)", "``double``", "Hydra time in stage", "None"
"renderProduct (*outputs:rp*)", "``uint64``", "Pointer to render product for this view", "None"
"simTime (*outputs:simTime*)", "``double``", "Simulation time", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GpuInteropRenderProductEntry"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"Categories", "internal"
"Generated Class Name", "OgnGpuInteropRenderProductEntryDatabase"
"Python Module", "omni.graph.nodes"
| 1,865 | reStructuredText | 28.619047 | 114 | 0.596783 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnExtractAttr.rst | .. _omni_graph_nodes_ExtractAttribute_1:
.. _omni_graph_nodes_ExtractAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Attribute
:keywords: lang-en omnigraph node bundle threadsafe nodes extract-attribute
Extract Attribute
=================
.. <description>
Copies a single attribute from an input bundle to an output attribute directly on the node if it exists in the input bundle and matches the type of the output 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 To Extract (*inputs:attrName*)", "``token``", "Name of the attribute to look for in the bundle", "points"
"Bundle For Extraction (*inputs:data*)", "``bundle``", "Collection of attributes from which the named attribute is to be extracted", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Extracted Attribute (*outputs:output*)", "``any``", "The single attribute extracted from the input bundle", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ExtractAttribute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Attribute"
"Categories", "bundle"
"Generated Class Name", "OgnExtractAttrDatabase"
"Python Module", "omni.graph.nodes"
| 1,901 | reStructuredText | 26.565217 | 168 | 0.599684 |
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRotateVector.rst | .. _omni_graph_nodes_RotateVector_1:
.. _omni_graph_nodes_RotateVector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Rotate Vector
:keywords: lang-en omnigraph node math:operator threadsafe nodes rotate-vector
Rotate Vector
=============
.. <description>
Rotates a 3d direction vector by a specified rotation. Accepts 3x3 matrices, 4x4 matrices, euler angles (XYZ), or quaternions For 4x4 matrices, the transformation information in the matrix is ignored and the vector is treated as a 4-component vector where the fourth component is zero. The result is then projected back to a 3-vector. Supports mixed array inputs, eg a single quaternion 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
"Rotation (*inputs:rotation*)", "``['matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The rotation 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 rotated", "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.RotateVector"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Rotate Vector"
"Categories", "math:operator"
"Generated Class Name", "OgnRotateVectorDatabase"
"Python Module", "omni.graph.nodes"
| 2,396 | reStructuredText | 33.73913 | 413 | 0.586811 |
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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.