file_path
stringlengths 21
224
| content
stringlengths 0
80.8M
|
|---|---|
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/PACKAGE-LICENSES/omni.kit.window.content_browser_registry-LICENSE.md | Copyright (c) 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. |
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"
]
|
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
|
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)
|
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)
|
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/omni/kit/window/content_browser_registry/tests/__init__.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.
##
from .test_registry import *
|
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. |
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.
|
omniverse-code/kit/exts/omni.kit.window.content_browser_registry/docs/index.rst | omni.kit.window.content_browser_registry
########################################
.. toctree::
:maxdepth: 1
CHANGELOG
|
omniverse-code/kit/exts/omni.kit.window.about/PACKAGE-LICENSES/omni.kit.window.about-LICENSE.md | Copyright (c) 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. |
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 = []
|
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
|
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},
} |
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)) |
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/__init__.py | from .about import *
from .about_widget import AboutWidget
|
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
|
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)
|
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")
|
omniverse-code/kit/exts/omni.kit.window.about/omni/kit/window/about/tests/__init__.py | from .test_window_about import *
from .test_clipboard import *
|
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#")
|
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
|
omniverse-code/kit/exts/omni.kit.window.about/docs/index.rst | omni.kit.window.about
###########################
.. toctree::
:maxdepth: 1
CHANGELOG
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/nodes.json | {
"nodes": {
"omni.graph.nodes.Interpolator": {
"description": "Time sample interpolator",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantBool": {
"description": "Holds a boolean value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantColor3f": {
"description": "Holds a 3-component color constant, which is energy-linear RGB",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantColor4f": {
"description": "Holds a 4-component color constant, which is energy-linear RGBA, not pre-alpha multiplied",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantDouble": {
"description": "Holds a 64 bit floating point value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantDouble2": {
"description": "Holds a 2-component double constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantDouble3": {
"description": "Holds a 3-component double constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantDouble4": {
"description": "Holds a 4-component double constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantFloat": {
"description": "Holds a 32 bit floating point value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantFloat2": {
"description": "Holds a 2-component float constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantFloat3": {
"description": "Holds a 3-component float constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantFloat4": {
"description": "Holds a 4-component float constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantHalf": {
"description": "Holds a 16-bit floating point value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantHalf2": {
"description": "Holds a 2-component half constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantHalf3": {
"description": "Holds a 3-component half-precision constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantHalf4": {
"description": "Holds a 4-component half constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantInt": {
"description": "Holds a 32 bit signed integer constant value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantInt2": {
"description": "Holds a 2-component int constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantInt4": {
"description": "Holds a 4-component int constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantInt64": {
"description": "Holds a 64 bit signed integer constant value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantPath": {
"description": "Holds a path constant value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantPi": {
"description": "Holds a 64-bit floating point constant value that is a multiple of Pi",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantPoint3d": {
"description": "Holds a 3-component double constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantPoint3f": {
"description": "Holds a 3-component float constant.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantQuatd": {
"description": "Holds a double-precision quaternion constant: A real coefficient and three imaginary coefficients",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantQuatf": {
"description": "Holds a single-precision quaternion constant: A real coefficient and three imaginary coefficients.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantString": {
"description": "Holds a string constant value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantTexCoord2f": {
"description": "Holds a 2D uv texture coordinate.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantTexCoord2h": {
"description": "Holds a 2D uv texture coordinate.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantTexCoord3f": {
"description": "Holds a 3D uvw texture coordinate.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantTexCoord3h": {
"description": "Holds a 3D uvw texture coordinate.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantToken": {
"description": "Holds a token value, which is a 64-bit value representing an interned string",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantUChar": {
"description": "Holds an 8-bit unsigned character value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantUInt": {
"description": "Holds a 32 bit unsigned integer value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstantUInt64": {
"description": "Holds a 64 bit signed integer value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayLength": {
"description": "Outputs the length of a specified array attribute in an input bundle, or 1 if the attribute is not an array attribute",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.AttributeType": {
"description": "Queries information about the type of a specified attribute in an input bundle",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.CopyAttribute": {
"description": "Copies all attributes from one input bundle and specified attributes from a second input bundle to the output bundle.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.UpdateTickEvent": {
"description": "Triggers on update ticks.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ExtractAttribute": {
"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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ExtractBundle": {
"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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GatherByPath": {
"description": "Node to vectorize data by paths passed in via input. PROTOTYPE DO NOT USE. Requires GatherPrototype",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetAttributeNames": {
"description": "Retrieves the names of all of the attributes contained in the input bundle, optionally sorted.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GpuInteropCudaEntry": {
"description": "Entry point for Cuda RTX Renderer Postprocessing",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GpuInteropRenderProductEntry": {
"description": "Entry node for post-processing hydra render results for a single view ",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GraphTarget": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.HasAttribute": {
"description": "Inspect an input bundle for a named attribute, setting output to true if it exists",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.InsertAttribute": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.IsPrimActive": {
"description": "Query if a Prim is active or not in the stage.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Noop": {
"description": "Empty node used only as a placeholder",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadOmniGraphValue": {
"description": "Imports a data value from the Fabric cache that is located at the given path and attribute name. This is for data that is not already present in OmniGraph as that data can be accessed through a direct connection to the underlying OmniGraph node.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadPrim": {
"description": "Exposes readable attributes for a single Prim on the USD stage as outputs on this node. When this node computes it will read the latest attribute values from the target Prim into these node attributes",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadPrimAttribute": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadPrimBundle": {
"description": "Exposes the authored attributes for a single Prim on the USD stage as a bundle output on this node. When this node computes it will read the latest attribute values from the target Prim into the bundle attributes. It will also expose the world matrix if available under the attribute \"worldMatrix\". It can optionally compute the bounding box of the prim, and expose it under the following attributes: \"bboxTransform\", \"bboxMinCorner\", \"bboxMaxCorner\".",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadPrimMaterial": {
"description": "Given a path to a prim on the current USD stage, outputs the material of the prim. Gives an error if the given prim can not be found.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadSetting": {
"description": "Node that reads a value from a kit application setting",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadTime": {
"description": "Holds the values related to the current global time and the timeline",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.core.ReadVariable": {
"description": "Node that reads a value from a variable",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RemoveAttribute": {
"description": "Copies all attributes from an input bundle to the output bundle, except for any specified to be removed.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RenameAttribute": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RenderPostProcessEntry": {
"description": "Entry point for RTX Renderer Postprocessing",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RenderPreProcessEntry": {
"description": "Entry point for RTX Renderer Preprocessing",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.WritePrim": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.WritePrimAttribute": {
"description": "Given a path to a prim on the current USD stage and the name of an attribute on that prim, sets the value of that attribute. Does nothing if the given Prim or attribute can not be found. If the attribute is found but it is not a compatible type, an error will be issued.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.WritePrimMaterial": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.WriteSetting": {
"description": "Node that writes a value to a kit application setting. Issues an error if input::value type does not match setting type.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.core.WriteVariable": {
"description": "Node that writes a value to a variable",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.CreateTubeTopology": {
"description": "Creates the face vertex counts and indices describing a tube topology with the given number of rows and columns.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.CurveToFrame": {
"description": "Create a frame object based on a curve description",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.CurveTubePositions": {
"description": "Generate tube positions from a curve description",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.CurveTubeST": {
"description": "Compute curve tube ST values",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.LengthAlongCurve": {
"description": "Find the length along the curve of a set of points",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.DeformedPointsToHydra": {
"description": "Copy deformed points into rpresource and send to hydra",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RpResourceExampleAllocator": {
"description": "Allocate CUDA-interoperable RpResource",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RpResourceExampleDeformer": {
"description": "Allocate CUDA-interoperable RpResource",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RpResourceExampleHydra": {
"description": "Send RpResource to Hydra",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadGamepadState": {
"description": "Reads the current state of the gamepad",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadKeyboardState": {
"description": "Reads the current state of the keyboard",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BooleanAnd": {
"description": "Boolean AND on two inputs. If a and b are arrays, AND operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BooleanExpr": {
"description": "NOTE: DEPRECATED AS OF 1.26.0 IN FAVOUR OF INDIVIDAL BOOLEAN OP NODES Boolean operation on two inputs. The supported operations are:\n AND, OR, NAND, NOR, XOR, XNOR",
"version": 1,
"extension": "omni.graph.nodes",
"language": "Python"
},
"omni.graph.nodes.BooleanNand": {
"description": "Boolean NAND on two inputs. If a and b are arrays, NAND operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BooleanNor": {
"description": "Boolean NOR on two inputs. If a and b are arrays, NOR operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BooleanNot": {
"description": "Inverts a bool or bool array",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BooleanOr": {
"description": "Boolean OR on two inputs. If a and b are arrays, OR operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BooleanXor": {
"description": "Boolean XOR on two inputs. If a and b are arrays, XOR operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ATan2": {
"description": "Outputs the arc tangent of a/b in degrees",
"version": 1,
"extension": "omni.graph.nodes",
"language": "Python"
},
"omni.graph.nodes.Acos": {
"description": "Trigonometric operation arccosine of one input in degrees.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Add": {
"description": "Add two values of any numeric type (element-wise). This includes simple values, tuples, arrays, and arrays of tuples. If one input has a higher dimension than the other, then the input with lower dimension will be repeated to match the dimension of the other input (broadcasting). eg: scalar + tuple, tuple + array of tuples, scalar + array of tuples.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.AnyZero": {
"description": "Outputs a boolean indicating if any of the input values are zero within a specified tolerance.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Asin": {
"description": "Trigonometric operation arcsin of one input in degrees.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Atan": {
"description": "Trigonometric operation arctangent of one input in degrees.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Ceil": {
"description": "Computes the ceil of the given decimal number a, which is the smallest integral value greater than a",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Clamp": {
"description": "Clamp a number or array of numbers to a specified range. If an array of numbers is provided as the input and lower/upper are scalers Then each input numeric will be clamped to the range [lower, upper] If all inputs are arrays, clamping will be done element-wise. lower & upper are broadcast against input Error will be reported if lower > upper.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConcatenateFloat3Arrays": {
"description": "Flatten the array of float3 arrays in 'inputArrays' by concatenating all of the array contents into a single float3 array in 'outputArray'. The sizes of each of the input arrays is preserved in the output 'arraySizes'.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Cos": {
"description": "Trigonometric operation cosine of one input in degrees.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.CrossProduct": {
"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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Divide": {
"description": "Computes the division of two values: A / B. The result is the same type as the numerator if the numerator is a decimal type. Otherwise the result is a double. Vectors can be divided only by a scaler, the result being a vector in the same direction with a scaled length. Note that there are combinations of inputs that can result in a loss of precision due to different value ranges. Division by zero is an error.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.DotProduct": {
"description": "Compute the dot product of two (arrays of) vectors. If two arrays of vectors are provided, then the dot product will be taken element-wise. Inputs must be the same shape",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.EachZero": {
"description": "Outputs a boolean, or array of booleans, indicating which input values are zero within a specified tolerance.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Ease": {
"description": "Easing function which iterpolates between a start and end value. Vectors are eased component-wise. The easing functions can be applied to decimal types. Linear: Interpolates between start and finish at a fixed rate. EaseIn: Starts slowly and ends fast according to an exponential, the slope is determined by the 'exponent' input. EaseOut: Same as EaseIn, but starts fast and ends slow EaseInOut: Combines EaseIn and EaseOut SinIn: Starts slowly and ends fast according to a sinusoidal curve SinOut: Same as SinIn, but starts fast and ends slow SinInOut: Combines SinIn and SinOut",
"version": 2,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.FMod": {
"description": "Computes the floating point remainder of A / B. If B is zero, the result is zero. The returned value has the same sign as A",
"version": 1,
"extension": "omni.graph.nodes",
"language": "Python"
},
"omni.graph.nodes.Floor": {
"description": "Computes the floor of the given decimal number a, which is the largest integral value not greater than a",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetLocationAtDistanceOnCurve": {
"description": "Given a set of curve points and a normalized distance between 0-1.0, return the location on a closed curve. 0 is the first point on the curve, 1.0 is also the first point because the is an implicit segment connecting the first and last points. Values outside the range 0-1.0 will be wrapped to that range, for example -0.4 is equivalent to 0.6 and 1.3 is equivalent to 0.3 This is a simplistic curve-following node, intended for curves in a plane, for prototyping purposes.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetLookAtRotation": {
"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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Increment": {
"description": "Add a double argument to any type (element-wise). This includes simple values, tuples, arrays, and arrays of tuples. The output type is always the same as the type of input:value. For example: tuple + double results a tuple. Chopping is used for approximation. For example: 4 + 3.2 will result 7. The default increment value is 1.0. ",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.InterpolateTo": {
"description": "Function which iterpolates one step from a current value to a target value with a given speed. Vectors are interpolated component-wise. Interpolation can be applied to decimal types. The interpolation provides an eased approach to the target, adjust speed and exponent to tweak the curve. The formula is: result = current + (target - current) * (1 - clamp(0, speed * deltaSeconds, 1))^exp. For quaternions, the node performs a spherical linear interpolation (SLERP) with alpha = (1 - clamp(0, speed * deltaSeconds, 1))^exp",
"version": 2,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.OgnInvertMatrix": {
"description": "Invert a matrix or an array of matrices. Returns the FLOAT_MAX * identity if the matrix is singular",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.IsZero": {
"description": "Outputs a boolean indicating if all of the input values are zero within a specified tolerance.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Magnitude": {
"description": "Compute the magnitude of a vector, array of vectors, or a scalar If a scalar is passed in, the absolute value will be returned If an array of vectors are passed in, the output will be an array of corresponding magnitudes",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MatrixMultiply": {
"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. ",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Multiply": {
"description": "Computes the element-wise product of two inputs A and B (multiplication). If one input has a higher dimension than the other, then the input with lower dimension will be repeated to match the dimension of the other input (broadcasting). eg: scalar * tuple, tuple * array of tuples, scalar * array of tuples.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Negate": {
"description": "Computes the result of multiplying a vector, scalar, or array of vectors or scalars by -1. The input must not be unsigned.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Noise": {
"description": "Sample values from a Perlin noise field.\n 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.\n 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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Normalize": {
"description": "Normalize the input vector. If the input vector has a magnitude of zero, the null vector is returned.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.NthRoot": {
"description": "Computes the nth root of value. The result is the same type as the input value if the numerator is a decimal type. Otherwise the result is a double. If the input is a vector or matrix, then the node will calculate the square root of each element , and output a vector or matrix of the same size. Note that there are combinations of inputs that can result in a loss of precision due to different value ranges. Taking roots of a negative number will give a result of NaN except for cube root.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.PartialSum": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Round": {
"description": "Round a decimal input to the given number of decimals. Accepts float, double, half, or arrays / tuples of the aformentioned types",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Sin": {
"description": "Trigonometric operation sine of one input in degrees.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.SourceIndices": {
"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]:\n - the first two 0s to fill the output array up to index input[1]=2\n - the first two 0s to fill the output array up to index input[1]=2\n - the 2 to fill the output array up to index input[2]=3\n - the three 3s to fill the output array up to index input[3]=6",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Subtract": {
"description": "Subtracts two values of any numeric type.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Tan": {
"description": "Trigonometric operation tangent of one input in degrees.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToDeg": {
"description": "Convert radian input into degrees",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToRad": {
"description": "Convert degree input into radians",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Trig": {
"description": "Trigonometric operation of one input in degrees. Supported operations are:\n SIN, COS, TAN, ARCSIN, ARCCOS, ARCTAN, DEGREES, RADIANS",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetMatrix4Quaternion": {
"description": "Gets the rotation of the given matrix4d value which represents a linear transformation. Returns a quaternion",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetMatrix4Rotation": {
"description": "Gets the rotation of the given matrix4d value which represents a linear transformation. Returns euler angles (XYZ)",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetMatrix4Translation": {
"description": "Gets the translation of the given matrix4d value which represents a linear transformation. Returns a vector3",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetPrimDirectionVector": {
"description": "Given a prim, find its direction vectors (up vector, forward vector, right vector, etc.)",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetPrimLocalToWorldTransform": {
"description": "Given a path to a prim on the current USD stage, return the the transformation matrix. that transforms a vector from the local frame to the global frame ",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MakeTransform": {
"description": "Make a transformation matrix that performs a translation, rotation (in euler angles), and scale in that order",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MakeTransformLookAt": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MoveToTarget": {
"description": "This node smoothly translates, rotates, and scales a prim object to a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the translation, rotation, and scale of the target prim.\n Note: The Prim must have xform:orient in transform stack in order to interpolate rotations",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MoveToTransform": {
"description": "Perform a transformation maneuver, moving a prim to a target transformation given a speed and easing factor. Transformation, Rotation, and Scale from a 4x4 transformation matrix will be applied Note: The Prim must have xform:orient in transform stack in order to interpolate rotations",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RotateToOrientation": {
"description": "Perform a smooth rotation maneuver, rotating a prim to a desired orientation given a speed and easing factor",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RotateToTarget": {
"description": "This node smoothly rotates a prim object to match a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the rotation as the target prim.\n Note: The Prim must have xform:orient in transform stack in order to interpolate rotations",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.RotateVector": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ScaleToSize": {
"description": "Perform a smooth scaling maneuver, scaling a prim to a desired size tuple given a speed and easing factor",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.SetMatrix4Quaternion": {
"description": "Sets the rotation of the given matrix4d value which represents a linear transformation. Does not modify the translation (row 3) of the matrix.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.SetMatrix4Rotation": {
"description": "Sets the rotation of the given matrix4d value which represents a linear transformation. Does not modify the translation (row 3) of the matrix.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.SetMatrix4Translation": {
"description": "Sets the translation of the given matrix4d value which represents a linear transformation. Does not modify the orientation (row 0-2) of the matrix.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.TransformVector": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.TranslateToLocation": {
"description": "Perform a smooth translation maneuver, translating a prim to a desired point given a speed and easing factor",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.TranslateToTarget": {
"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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.IsPrimSelected": {
"description": "Checks if the prim at the given path is currently selected",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ReadStageSelection": {
"description": "Outputs the current stage selection as a list of paths",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.AppendPath": {
"description": "Creates a USD path by appending the given relative path to the given root or prim path",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.AppendString": {
"description": "Creates a new token or string by appending the given token or string. token[] inputs will be appended element-wise.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayFill": {
"description": "Creates a copy of the input array, filled with the given value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayFindValue": {
"description": "Searches for a value in an array, returns the index of the first occurrence of the value, or -1 if not found.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayGetSize": {
"description": "Returns the number of elements in an array",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayIndex": {
"description": "Copies an element of an input array into an output",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayInsertValue": {
"description": "Inserts an element at the given index. The indexing is zero-based, so 0 adds an element to the front of the array and index = Length inserts at the end of the array. The index will be clamped to the range (0, Length), so an index of -1 will add to the front, and an index larger than the array size will append to the end.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayRemoveIndex": {
"description": "Removes an element of an array by index. If the given index is negative it will be an offset from the end of the array.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayRemoveValue": {
"description": "Removes the first occurrence of the given value from an array. If removeAll is true, removes all occurrences",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayResize": {
"description": "Resizes an array. If the new size is larger, zeroed values will be added to the end.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArrayRotate": {
"description": "Shifts the elements of an array by the specified number of steps to the right and wraps elements from one end to the other. A negative step will shift to the left.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ArraySetIndex": {
"description": "Sets an element of an array. If the given index is negative it will be an offset from the end of the array.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BreakVector2": {
"description": "Split vector into 2 component values.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BreakVector3": {
"description": "Split vector into 3 component values.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BreakVector4": {
"description": "Split vector into 4 component values.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.BundleConstructor": {
"description": "This node creates a bundle mirroring all of the dynamic input attributes that have been added to it. If no dynamic attributes exist then the bundle will be empty. See the 'InsertAttribute' node for something that can construct a bundle from existing connected attributes.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "Python"
},
"omni.graph.nodes.BundleInspector": {
"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.",
"version": 2,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.Compare": {
"description": "Outputs the truth value of a comparison operation. Tuples are compared in lexicographic order. If one input is an array and the other is a scaler, the scaler will be broadcast to the size of the array",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ConstructArray": {
"description": "Makes an output array attribute from input values, in the order of the inputs. If 'arraySize' is less than the number of input elements, the top 'arraySize' elements will be used. If 'arraySize' is greater than the number of input elements, the last input element will be repeated to fill the remaining space.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.EndsWith": {
"description": "Determines if a string ends with a given string value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.FindPrims": {
"description": "Finds Prims on the stage which match the given criteria",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetGatheredAttribute": {
"description": "Copies gathered scaler/vector attribute values from the Gather buckets into an array attribute PROTOTYPE DO NOT USE, Requires GatherPrototype",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetPrimPath": {
"description": "Generates a path from the specified relationship. This is useful when an absolute prim path may change.",
"version": 2,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.GetPrimRelationship": {
"description": "Outputs the paths of the prims associated with a relationship property,",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MakeArray": {
"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",
"version": 1,
"extension": "omni.graph.nodes",
"language": "Python"
},
"omni.graph.nodes.MakeVector2": {
"description": "Merge 2 input values into a single output vector. If the inputs are arrays, the output will be an array of vectors.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MakeVector3": {
"description": "Merge 3 input values into a single output vector. If the inputs are arrays, the output will be an array of vectors.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.MakeVector4": {
"description": "Merge 4 input values into a single output vector. If the inputs are arrays, the output will be an array of vectors.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.SelectIf": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.SetGatheredAttribute": {
"description": "Writes a value into the given Gathered attribute. If the number elements of the value is less than the gathered attribute, the value will be broadcast to all prims. If the given value has more elements than the gathered attribute, an error will be produced. PROTOTYPE DO NOT USE, Requires GatherPrototype",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.StartsWith": {
"description": "Determines if a string starts with a given string value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToDouble": {
"description": "Converts the given input to 64 bit double. The node will attempt to convert array and tuple inputs to doubles of the same shape",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToFloat": {
"description": "Converts the given input to 32 bit float. The node will attempt to convert array and tuple inputs to floats of the same shape",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToString": {
"description": "Converts the given input to a string equivalent.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToToken": {
"description": "Converts the given input to a string equivalent and provides the Token value",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
},
"omni.graph.nodes.ToUint64": {
"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.",
"version": 1,
"extension": "omni.graph.nodes",
"language": "C++"
}
}
}
|
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"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadSetting.rst | .. _omni_graph_nodes_ReadSetting_1:
.. _omni_graph_nodes_ReadSetting:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Setting
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes read-setting
Read Setting
============
.. <description>
Node that reads a value from a kit application setting
.. </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:settingPath", "``string``", "The path of the setting", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``['bool', 'bool[]', 'colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'token', 'token[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The value of the setting that is returned", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadSetting"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Setting"
"Categories", "sceneGraph"
"Generated Class Name", "OgnReadSettingDatabase"
"Python Module", "omni.graph.nodes"
|
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"
|
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"
|
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"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnBreakVector4.rst | .. _omni_graph_nodes_BreakVector4_1:
.. _omni_graph_nodes_BreakVector4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Break 4-Vector
:keywords: lang-en omnigraph node math:conversion threadsafe nodes break-vector4
Break 4-Vector
==============
.. <description>
Split vector into 4 component values.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Vector (*inputs:tuple*)", "``['double[4]', 'float[4]', 'half[4]', 'int[4]']``", "4-vector to be broken", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"W (*outputs:w*)", "``['double', 'float', 'half', 'int']``", "The fourth component of the vector", "None"
"X (*outputs:x*)", "``['double', 'float', 'half', 'int']``", "The first component of the vector", "None"
"Y (*outputs:y*)", "``['double', 'float', 'half', 'int']``", "The second component of the vector", "None"
"Z (*outputs:z*)", "``['double', 'float', 'half', 'int']``", "The third component of the vector", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BreakVector4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "decompose,separate,isolate"
"uiName", "Break 4-Vector"
"Categories", "math:conversion"
"Generated Class Name", "OgnBreakVector4Database"
"Python Module", "omni.graph.nodes"
|
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"
|
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"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToToken.rst | .. _omni_graph_nodes_ToToken_1:
.. _omni_graph_nodes_ToToken:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Token
:keywords: lang-en omnigraph node function threadsafe nodes to-token
To Token
========
.. <description>
Converts the given input to a string equivalent and provides the Token value
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"value (*inputs:value*)", "``any``", "The value to be converted to a token", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Token (*outputs:converted*)", "``token``", "Stringified output as a Token", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToToken"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Token"
"Categories", "function"
"Generated Class Name", "OgnToTokenDatabase"
"Python Module", "omni.graph.nodes"
|
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"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantColor3f.rst | .. _omni_graph_nodes_ConstantColor3f_1:
.. _omni_graph_nodes_ConstantColor3f:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Color3F
:keywords: lang-en omnigraph node constants nodes constant-color3f
Constant Color3F
================
.. <description>
Holds a 3-component color constant, which is energy-linear RGB
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``colorf[3]``", "The constant value", "[0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantColor3f"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantColor3fDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTimer.rst | .. _omni_graph_nodes_Timer_2:
.. _omni_graph_nodes_Timer:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Timer
:keywords: lang-en omnigraph node animation nodes timer
Timer
=====
.. <description>
Timer Node is a node that lets you create animation curve(s), plays back and samples the value(s) along its time to output values.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Duration (*inputs:duration*)", "``double``", "Number of seconds to play interpolation", "1.0"
"End Value (*inputs:endValue*)", "``double``", "Value value of the end of the duration", "1.0"
"Play (*inputs:play*)", "``execution``", "Play the clip from current frame", "None"
"Start Value (*inputs:startValue*)", "``double``", "Value value of the start of the duration", "0.0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The Timer node has finished the playback", "None"
"Updated (*outputs:updated*)", "``execution``", "The Timer node is ticked, and output value(s) resampled and updated", "None"
"Value (*outputs:value*)", "``double``", "Value value of the Timer node between 0.0 and 1.0", "0.0"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Timer"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Timer"
"Categories", "animation"
"__categoryDescriptions", "animation,Nodes dealing with Animation"
"Generated Class Name", "OgnTimerDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnDistance3D.rst | .. _omni_graph_nodes_Distance3D_1:
.. _omni_graph_nodes_Distance3D:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Distance3D
:keywords: lang-en omnigraph node math:operator threadsafe nodes distance3-d
Distance3D
==========
.. <description>
Computes the distance between two 3D points A and B. Which is the length of the vector with start and end points A and B If one input is an array and the other is a single point, the scaler will be broadcast to the size of the array
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"A (*inputs:a*)", "``['pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]']``", "Vector A", "None"
"B (*inputs:b*)", "``['pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]']``", "Vector B", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:distance", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]']``", "The distance between the input vectors", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Distance3D"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Distance3D"
"Categories", "math:operator"
"Generated Class Name", "OgnDistance3DDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetLocationAtDistanceOnCurve.rst | .. _omni_graph_nodes_GetLocationAtDistanceOnCurve_1:
.. _omni_graph_nodes_GetLocationAtDistanceOnCurve:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Locations At Distances On Curve
:keywords: lang-en omnigraph node internal threadsafe nodes get-location-at-distance-on-curve
Get Locations At Distances On Curve
===================================
.. <description>
DEPRECATED: Use GetLocationAtDistanceOnCurve2
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Curve (*inputs:curve*)", "``pointd[3][]``", "The curve to be examined", "[]"
"Distances (*inputs:distance*)", "``double[]``", "The distances along the curve, wrapped to the range 0-1.0", "[]"
"Forward (*inputs:forwardAxis*)", "``token``", "The direction vector from which the returned rotation is relative, one of X, Y, Z", "X"
"Up (*inputs:upAxis*)", "``token``", "The world Up vector, the curve should be in a plane perpendicular with this - one of X, Y, Z", "Y"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Locations on curve at the given distances in world space (*outputs:location*)", "``pointd[3][]``", "Locations", "None"
"World space orientations of the curve at the given distances, may not be smooth for some curves (*outputs:orientation*)", "``quatf[4][]``", "Orientations", "None"
"World space rotations of the curve at the given distances, may not be smooth for some curves (*outputs:rotateXYZ*)", "``vectord[3][]``", "Rotations", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetLocationAtDistanceOnCurve"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Get Locations At Distances On Curve"
"__tokens", "[""x"", ""y"", ""z"", ""X"", ""Y"", ""Z""]"
"Categories", "internal"
"Generated Class Name", "OgnGetLocationAtDistanceOnCurveDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnSourceIndices.rst | .. _omni_graph_nodes_SourceIndices_1:
.. _omni_graph_nodes_SourceIndices:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Extract Source Index Array
:keywords: lang-en omnigraph node math:operator threadsafe nodes source-indices
Extract Source Index Array
==========================
.. <description>
Takes an input array of index values in 'sourceStartsInTarget' encoded as the list of index values at which the output array value will be incremented, starting at the second entry, and with the last entry into the array being the desired sized of the output array 'sourceIndices'. For example the input [1,2,3,5,6,6] would generate an output array of size 5 (last index) consisting of the values [0,0,2,3,3,3]:
- the first two 0s to fill the output array up to index input[1]=2
- the first two 0s to fill the output array up to index input[1]=2
- the 2 to fill the output array up to index input[2]=3
- the three 3s to fill the output array up to index input[3]=6
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:sourceStartsInTarget", "``int[]``", "List of index values encoding the increments for the output array values", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:sourceIndices", "``int[]``", "Decoded list of index values as described by the node algorithm", "[]"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SourceIndices"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Extract Source Index Array"
"Categories", "math:operator"
"Generated Class Name", "OgnSourceIndicesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantUChar.rst | .. _omni_graph_nodes_ConstantUChar_1:
.. _omni_graph_nodes_ConstantUChar:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant UChar
:keywords: lang-en omnigraph node constants nodes constant-u-char
Constant UChar
==============
.. <description>
Holds an 8-bit unsigned character value
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``uchar``", "The constant value", "0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantUChar"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Constant UChar"
"Categories", "constants"
"Generated Class Name", "OgnConstantUCharDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadKeyboardState.rst | .. _omni_graph_nodes_ReadKeyboardState_1:
.. _omni_graph_nodes_ReadKeyboardState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Keyboard State
:keywords: lang-en omnigraph node input:keyboard threadsafe nodes read-keyboard-state
Read Keyboard State
===================
.. <description>
Reads the current state of the keyboard
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Key (*inputs:key*)", "``token``", "The key to check the state of", "A"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,Apostrophe,Backslash,Backspace,CapsLock,Comma,Del,Down,End,Enter,Equal,Escape,F1,F10,F11,F12,F2,F3,F4,F5,F6,F7,F8,F9,GraveAccent,Home,Insert,Key0,Key1,Key2,Key3,Key4,Key5,Key6,Key7,Key8,Key9,Left,LeftAlt,LeftBracket,LeftControl,LeftShift,LeftSuper,Menu,Minus,NumLock,Numpad0,Numpad1,Numpad2,Numpad3,Numpad4,Numpad5,Numpad6,Numpad7,Numpad8,Numpad9,NumpadAdd,NumpadDel,NumpadDivide,NumpadEnter,NumpadEqual,NumpadMultiply,NumpadSubtract,PageDown,PageUp,Pause,Period,PrintScreen,Right,RightAlt,RightBracket,RightControl,RightShift,RightSuper,ScrollLock,Semicolon,Slash,Space,Tab,Up", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Alt (*outputs:altOut*)", "``bool``", "True if Alt is held", "None"
"Ctrl (*outputs:ctrlOut*)", "``bool``", "True if Ctrl is held", "None"
"outputs:isPressed", "``bool``", "True if the key is currently pressed, false otherwise", "None"
"Shift (*outputs:shiftOut*)", "``bool``", "True if Shift is held", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadKeyboardState"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Keyboard State"
"Categories", "input:keyboard"
"Generated Class Name", "OgnReadKeyboardStateDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToFloat.rst | .. _omni_graph_nodes_ToFloat_1:
.. _omni_graph_nodes_ToFloat:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Float
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-float
To Float
========
.. <description>
Converts the given input to 32 bit float. The node will attempt to convert array and tuple inputs to floats of the same shape
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"value (*inputs:value*)", "``['bool', 'bool[]', 'colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numeric value to convert to float", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Float (*outputs:converted*)", "``['float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]']``", "Output float scaler or array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToFloat"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Float"
"Categories", "math:conversion"
"Generated Class Name", "OgnToFloatDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantInt4.rst | .. _omni_graph_nodes_ConstantInt4_1:
.. _omni_graph_nodes_ConstantInt4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Int4
:keywords: lang-en omnigraph node constants nodes constant-int4
Constant Int4
=============
.. <description>
Holds a 4-component int constant.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``int[4]``", "The constant value", "[0, 0, 0, 0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantInt4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantInt4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToDouble.rst | .. _omni_graph_nodes_ToDouble_1:
.. _omni_graph_nodes_ToDouble:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To Double
:keywords: lang-en omnigraph node math:conversion threadsafe nodes to-double
To Double
=========
.. <description>
Converts the given input to 64 bit double. The node will attempt to convert array and tuple inputs to doubles of the same shape
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"value (*inputs:value*)", "``['bool', 'bool[]', 'colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numeric value to convert to double", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Double (*outputs:converted*)", "``['double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]']``", "Output double-based value", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToDouble"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To Double"
"Categories", "math:conversion"
"Generated Class Name", "OgnToDoubleDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTranslateToTarget.rst | .. _omni_graph_nodes_TranslateToTarget_2:
.. _omni_graph_nodes_TranslateToTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Translate To Target
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes translate-to-target
Translate To Target
===================
.. <description>
This node smoothly translates a prim object to a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the same translation as the target prim
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:sourcePrim", "``target``", "The source prim to be transformed", "None"
"inputs:sourcePrimPath", "``path``", "The source prim to be transformed, used when 'useSourcePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"inputs:targetPrim", "``bundle``", "The destination prim. The target's translation will be matched by the sourcePrim", "None"
"inputs:targetPrimPath", "``path``", "The destination prim. The target's translation will be matched by the sourcePrim, used when 'useTargetPath' is true", "None"
"inputs:useSourcePath", "``bool``", "When true, the 'sourcePrimPath' attribute is used, otherwise it will read the connection at the 'sourcePrim' attribute", "False"
"inputs:useTargetPath", "``bool``", "When true, the 'targetPrimPath' attribute is used, otherwise it will read the connection at the 'targetPrim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.TranslateToTarget"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Translate To Target"
"Categories", "sceneGraph"
"Generated Class Name", "OgnTranslateToTargetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetLocationAtDistanceOnCurve2.rst | .. _omni_graph_nodes_GetLocationAtDistanceOnCurve2_1:
.. _omni_graph_nodes_GetLocationAtDistanceOnCurve2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Locations At Distances On Curve
:keywords: lang-en omnigraph node internal threadsafe nodes get-location-at-distance-on-curve2
Get Locations At Distances On Curve
===================================
.. <description>
Given a set of curve points and a normalized distance between 0-1.0, return the location on a closed curve. 0 is the first point on the curve, 1.0 is also the first point because the is an implicit segment connecting the first and last points. Values outside the range 0-1.0 will be wrapped to that range, for example -0.4 is equivalent to 0.6 and 1.3 is equivalent to 0.3 This is a simplistic curve-following node, intended for curves in a plane, for prototyping purposes.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Curve (*inputs:curve*)", "``pointd[3][]``", "The curve to be examined", "[]"
"Distance (*inputs:distance*)", "``double``", "The distance along the curve, wrapped to the range 0-1.0", "0.0"
"Forward (*inputs:forwardAxis*)", "``token``", "The direction vector from which the returned rotation is relative, one of X, Y, Z", "X"
"Up (*inputs:upAxis*)", "``token``", "The world Up vector, the curve should be in a plane perpendicular with this - one of X, Y, Z", "Y"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Location on curve at the given distance in world space (*outputs:location*)", "``pointd[3]``", "Location", "None"
"World space orientation of the curve at the given distance, may not be smooth for some curves (*outputs:orientation*)", "``quatf[4]``", "Orientation", "None"
"World space rotation of the curve at the given distance, may not be smooth for some curves (*outputs:rotateXYZ*)", "``vectord[3]``", "Rotations", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetLocationAtDistanceOnCurve2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Get Locations At Distances On Curve"
"__tokens", "[""x"", ""y"", ""z"", ""X"", ""Y"", ""Z""]"
"Categories", "internal"
"Generated Class Name", "OgnGetLocationAtDistanceOnCurve2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnToString.rst | .. _omni_graph_nodes_ToString_1:
.. _omni_graph_nodes_ToString:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: To String
:keywords: lang-en omnigraph node function threadsafe nodes to-string
To String
=========
.. <description>
Converts the given input to a string equivalent.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"value (*inputs:value*)", "``any``", "The value to be converted to a string. Numeric values are converted using C++'s std::ostringstream << operator. This can result in the values being converted to exponential form. E.g: 1.234e+06 Arrays of numeric values are converted to Python list syntax. E.g: [1.5, -0.03] A uchar value is converted to a single, unquoted character. An array of uchar values is converted to an unquoted string. Avoid zero values (i.e. null chars) in the array as the behavior is undefined and may vary over time. A single token is converted to its unquoted string equivalent. An array of tokens is converted to Python list syntax with each token enclosed in double quotes. E.g. [""first"", ""second""]", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"String (*outputs:converted*)", "``string``", "Output string", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ToString"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "To String"
"Categories", "function"
"Generated Class Name", "OgnToStringDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnHasVariantSet.rst | .. _omni_graph_nodes_HasVariantSet_2:
.. _omni_graph_nodes_HasVariantSet:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Has Variant Set
:keywords: lang-en omnigraph node graph:action,sceneGraph,variants ReadOnly nodes has-variant-set
Has Variant Set
===============
.. <description>
Query the existence of a variantSet on a prim
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:prim", "``target``", "The prim with the variantSet", "None"
"inputs:variantSetName", "``token``", "The variantSet name", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:exists", "``bool``", "Variant exists", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.HasVariantSet"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.HasVariantSet.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Has Variant Set"
"Categories", "graph:action,sceneGraph,variants"
"Generated Class Name", "OgnHasVariantSetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTimelineSet.rst | .. _omni_graph_nodes_SetTimeline_1:
.. _omni_graph_nodes_SetTimeline:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set main timeline
:keywords: lang-en omnigraph node time compute-on-request nodes set-timeline
Set main timeline
=================
.. <description>
Set properties of the main timeline
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Execute In (*inputs:execIn*)", "``execution``", "The input that triggers the execution of this node.", "None"
"Property Name (*inputs:propName*)", "``token``", "The name of the property to set.", "Frame"
"", "*displayGroup*", "parameters", ""
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "Frame,Time,StartFrame,StartTime,EndFrame,EndTime,FramesPerSecond", ""
"Property Value (*inputs:propValue*)", "``double``", "The value of the property to set.", "0.0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Clamp to range (*outputs:clamped*)", "``bool``", "Was the input frame or time clamped to the playback range?", "None"
"Execute Out (*outputs:execOut*)", "``execution``", "The output that is triggered when this node executed.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SetTimeline"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Set main timeline"
"Categories", "time"
"Generated Class Name", "OgnTimelineSetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimsV2.rst | .. _omni_graph_nodes_ReadPrimsV2_1:
.. _omni_graph_nodes_ReadPrimsV2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prims
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prims-v2
Read Prims
==========
.. <description>
Reads primitives and outputs multiple primitive in a bundle.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:_debugStamp", "``int``", "For internal testing only, and subject to change. Please do not depend on this attribute! When not zero, this _debugStamp attribute will be copied to root and child bundles that change When a full update is performed, the negative _debugStamp is written. When only derived attributes (like bounding boxes and world matrices) are updated, _debugStamp + 1000000 is written", "0"
"", "*literalOnly*", "1", ""
"", "*hidden*", "true", ""
"Apply Skel Binding (*inputs:applySkelBinding*)", "``bool``", "If an input USD prim is skinnable and has the SkelBindingAPI schema applied, read skeletal data and apply SkelBinding to deform the prim. The output bundle will have additional child bundles created to hold data for the skeleton and skel animation prims if present. After evaluation, deformed points and normals will be written to the `points` and `normals` attributes, while non-deformed points and normals will be copied to the `points:default` and `normals:default` attributes.", "False"
"Attribute Name Pattern (*inputs:attrNamesToImport*)", "``string``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"Compute Bounding Box (*inputs:computeBoundingBox*)", "``bool``", "For each primitive compute local bounding box and store them as 'bboxMinCorner', 'bboxMaxCorner' and 'bboxTransform' attributes.", "False"
"Bundle change tracking (*inputs:enableBundleChangeTracking*)", "``bool``", "Enable change tracking for output bundle, its children and attributes. The change tracking system for bundles has some overhead, but enables users to inspect the changes that occurred in a bundle. Through inspecting the type of changes user can mitigate excessive computations.", "False"
"USD change tracking (*inputs:enableChangeTracking*)", "``bool``", "Should the output bundles only be updated when the associated USD prims change? This uses a USD notice handler, and has a small overhead, so if you know that the imported USD prims will change frequently, you might want to disable this.", "True"
"Prim Path Pattern (*inputs:pathPattern*)", "``string``", "A list of wildcard patterns used to match the prim paths that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['/Cube0', '/Cube1', '/Box'] '*' - match any '* ^/Box' - match any, but exclude '/Box' '* ^/Cube*' - match any, but exclude '/Cube0' and '/Cube1'", ""
"Prims (*inputs:prims*)", "``target``", "The root prim(s) that pattern matching uses to search from. If 'pathPattern' input is empty, the directly connected prims will be read. Otherwise, all the subtree (including root) will be tested against pattern matcher inputs, and the matched prims will be read into the output bundle. If no prims are connected, and 'pathPattern' is none empty, absolute root ""/"" will be searched as root prim.", "None"
"", "*allowMultiInputs*", "1", ""
"Prim Type Pattern (*inputs:typePattern*)", "``string``", "A list of wildcard patterns used to match the prim types that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['Mesh', 'Cone', 'Cube'] '*' - match any '* ^Mesh' - match any, but exclude 'Mesh' '* ^Cone ^Cube' - match any, but exclude 'Cone' and 'Cube'", "*"
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primsBundle", "``bundle``", "An output bundle containing multiple prims as children. Each child contains data attributes and two additional token attributes named sourcePrimPath and sourcePrimType which contains the path of the Prim being read", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:applySkelBinding", "``bool``", "State from previous evaluation", "False"
"state:attrNamesToImport", "``string``", "State from previous evaluation", "None"
"state:computeBoundingBox", "``bool``", "State from previous evaluation", "False"
"state:enableBundleChangeTracking", "``bool``", "State from previous evaluation", "False"
"state:enableChangeTracking", "``bool``", "State from previous evaluation", "False"
"state:pathPattern", "``string``", "State from previous evaluation", "None"
"state:typePattern", "``string``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "-1"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimsV2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Prims"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimsV2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWriteVariable.rst | .. _omni_graph_core_WriteVariable_2:
.. _omni_graph_core_WriteVariable:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Variable
:keywords: lang-en omnigraph node internal WriteOnly core write-variable
Write Variable
==============
.. <description>
Node that writes a value to a variable
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:execIn", "``execution``", "Input execution state", "None"
"inputs:graph", "``target``", "Ignored. Do not use", "None"
"", "*hidden*", "true", ""
"inputs:targetPath", "``token``", "Ignored. Do not use.", "None"
"", "*hidden*", "true", ""
"inputs:value", "``any``", "The new value to be written", "None"
"inputs:variableName", "``token``", "The name of the graph variable to use.", ""
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "Output execution", "None"
"outputs:value", "``any``", "The written variable value", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.core.WriteVariable"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Write Variable"
"Categories", "internal"
"Generated Class Name", "OgnWriteVariableDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnSelectIf.rst | .. _omni_graph_nodes_SelectIf_1:
.. _omni_graph_nodes_SelectIf:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Select If
:keywords: lang-en omnigraph node flowControl threadsafe nodes select-if
Select If
=========
.. <description>
Selects an output from the given inputs based on a boolean condition. If the condition is an array, and the inputs are arrays of equal length, and values will be selected from ifTrue, ifFalse depending on the bool at the same index. If one input is an array and the other is a scaler of the same base type, the scaler will be extended to the length of the other input.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:condition", "``['bool', 'bool[]']``", "The selection variable", "None"
"If False (*inputs:ifFalse*)", "``any``", "Value if condition is False", "None"
"If True (*inputs:ifTrue*)", "``any``", "Value if condition is True", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``any``", "The selected value from ifTrue and ifFalse", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.SelectIf"
"Version", "1"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.SelectIf.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Select If"
"Categories", "flowControl"
"Generated Class Name", "OgnSelectIfDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCopyAttr.rst | .. _omni_graph_nodes_CopyAttribute_1:
.. _omni_graph_nodes_CopyAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Copy Attributes From Bundles
:keywords: lang-en omnigraph node bundle nodes copy-attribute
Copy Attributes From Bundles
============================
.. <description>
Copies all attributes from one input bundle and specified attributes from a second input bundle to the output bundle.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Full Bundle To Copy (*inputs:fullData*)", "``bundle``", "Collection of attributes to fully copy to the output", "None"
"Extracted Names For Partial Copy (*inputs:inputAttrNames*)", "``token``", "Comma or space separated text, listing the names of attributes to copy from partialData", ""
"New Names For Partial Copy (*inputs:outputAttrNames*)", "``token``", "Comma or space separated text, listing the new names of attributes copied from partialData", ""
"Partial Bundle To Copy (*inputs:partialData*)", "``bundle``", "Collection of attributes from which to select named attributes", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Bundle Of Copied Attributes (*outputs:data*)", "``bundle``", "Collection of attributes consisting of all attributes from input 'fullData' and selected inputs from input 'partialData'", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CopyAttribute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Copy Attributes From Bundles"
"Categories", "bundle"
"Generated Class Name", "OgnCopyAttrDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrim.rst | .. _omni_graph_nodes_ReadPrim_9:
.. _omni_graph_nodes_ReadPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prim
Read Prim
=========
.. <description>
DEPRECATED - use ReadPrimAttributes!
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attributes To Import (*inputs:attrNamesToImport*)", "``token``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"Compute Bounding Box (*inputs:computeBoundingBox*)", "``bool``", "For each primitive compute local bounding box and store them as 'bboxMinCorner', 'bboxMaxCorner' and 'bboxTransform' attributes.", "False"
"inputs:prim", "``bundle``", "The prims to be read from when 'usePathPattern' is false", "None"
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primBundle", "``bundle``", "A bundle of the target Prim attributes. In addition to the data attributes, there is a token attribute named sourcePrimPath which contains the path of the Prim being read", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:attrNamesToImport", "``uint64``", "State from previous evaluation", "None"
"state:computeBoundingBox", "``bool``", "State from previous evaluation", "False"
"state:primPath", "``uint64``", "State from previous evaluation", "None"
"state:primTypes", "``uint64``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "NaN"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrim"
"Version", "9"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Read Prim"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnIncrement.rst | .. _omni_graph_nodes_Increment_1:
.. _omni_graph_nodes_Increment:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Increment
:keywords: lang-en omnigraph node math:operator threadsafe nodes increment
Increment
=========
.. <description>
Add a double argument to any type (element-wise). This includes simple values, tuples, arrays, and arrays of tuples. The output type is always the same as the type of input:value. For example: tuple + double results a tuple. Chopping is used for approximation. For example: 4 + 3.2 will result 7. The default increment value is 1.0.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Increment amount (*inputs:increment*)", "``double``", "The number added to the first operand", "1.0"
"Value (*inputs:value*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The operand that to be increased", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Result of the increment", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Increment"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Increment"
"Categories", "math:operator"
"Generated Class Name", "OgnIncrementDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnClearVariantSelection.rst | .. _omni_graph_nodes_ClearVariantSelection_2:
.. _omni_graph_nodes_ClearVariantSelection:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Clear Variant Selection
:keywords: lang-en omnigraph node graph:action,sceneGraph,variants WriteOnly nodes clear-variant-selection
Clear Variant Selection
=======================
.. <description>
This node will clear the variant selection of the prim on the active layer. Final variant selection will be determined by layer composition below your active layer. In a single layer stage, this will be the fallback variant defined in your variantSet.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:execIn", "``execution``", "The input execution", "None"
"inputs:prim", "``target``", "The prim with the variantSet", "None"
"inputs:setVariant", "``bool``", "Sets the variant selection when finished rather than writing to the attribute values", "False"
"inputs:variantSetName", "``token``", "The variantSet name", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ClearVariantSelection"
"Version", "2"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.ClearVariantSelection.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Clear Variant Selection"
"Categories", "graph:action,sceneGraph,variants"
"Generated Class Name", "OgnClearVariantSelectionDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantQuatf.rst | .. _omni_graph_nodes_ConstantQuatf_1:
.. _omni_graph_nodes_ConstantQuatf:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Quatf
:keywords: lang-en omnigraph node constants nodes constant-quatf
Constant Quatf
==============
.. <description>
Holds a single-precision quaternion constant: A real coefficient and three imaginary coefficients.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``quatf[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantQuatf"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantQuatfDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnDivide.rst | .. _omni_graph_nodes_Divide_1:
.. _omni_graph_nodes_Divide:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Divide
:keywords: lang-en omnigraph node math:operator threadsafe nodes divide
Divide
======
.. <description>
Computes the division of two values: A / B. The result is the same type as the numerator if the numerator is a decimal type. Otherwise the result is a double. Vectors can be divided only by a scaler, the result being a vector in the same direction with a scaled length. Note that there are combinations of inputs that can result in a loss of precision due to different value ranges. Division by zero is an error.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"A (*inputs:a*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The numerator A", "None"
"B (*inputs:b*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The denominator B", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Result of division", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Divide"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Divide"
"Categories", "math:operator"
"Generated Class Name", "OgnDivideDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnIsPrimActive.rst | .. _omni_graph_nodes_IsPrimActive_1:
.. _omni_graph_nodes_IsPrimActive:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Is Prim Active
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes is-prim-active
Is Prim Active
==============
.. <description>
Query if a Prim is active or not in the stage.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Prim Path (*inputs:prim*)", "``path``", "The prim path to be queried", ""
"Prim (*inputs:primTarget*)", "``target``", "The prim to be queried", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:active", "``bool``", "Whether the prim is active or not", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.IsPrimActive"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Is Prim Active"
"Categories", "sceneGraph"
"Generated Class Name", "OgnIsPrimActiveDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantDouble4.rst | .. _omni_graph_nodes_ConstantDouble4_1:
.. _omni_graph_nodes_ConstantDouble4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Double4
:keywords: lang-en omnigraph node constants nodes constant-double4
Constant Double4
================
.. <description>
Holds a 4-component double constant.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``double[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantDouble4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantDouble4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnNoOp.rst | .. _omni_graph_nodes_Noop_1:
.. _omni_graph_nodes_Noop:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: No-Op
:keywords: lang-en omnigraph node debug threadsafe nodes noop
No-Op
=====
.. <description>
Empty node used only as a placeholder
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Noop"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "No-Op"
"Categories", "debug"
"Generated Class Name", "OgnNoOpDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMakeVector2.rst | .. _omni_graph_nodes_MakeVector2_1:
.. _omni_graph_nodes_MakeVector2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Make 2-Vector
:keywords: lang-en omnigraph node math:conversion threadsafe nodes make-vector2
Make 2-Vector
=============
.. <description>
Merge 2 input values into a single output vector. If the inputs are arrays, the output will be an array of vectors.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"X (*inputs:x*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The first component of the vector", "None"
"Y (*inputs:y*)", "``['double', 'double[]', 'float', 'float[]', 'half', 'half[]', 'int', 'int[]']``", "The second component of the vector", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Vector (*outputs:tuple*)", "``['double[2]', 'double[2][]', 'float[2]', 'float[2][]', 'half[2]', 'half[2][]', 'int[2]', 'int[2][]']``", "Output vector(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MakeVector2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "compose,combine,join"
"uiName", "Make 2-Vector"
"Categories", "math:conversion"
"Generated Class Name", "OgnMakeVector2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrims.rst | .. _omni_graph_nodes_WritePrims_1:
.. _omni_graph_nodes_WritePrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prims (Legacy)
:keywords: lang-en omnigraph node sceneGraph,bundle WriteOnly nodes write-prims
Write Prims (Legacy)
====================
.. <description>
DEPRECATED - use WritePrimsV2!
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attribute Name Pattern (*inputs:attrNamesToExport*)", "``string``", "A list of wildcard patterns used to match primitive attributes by name. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['xFormOp:translate', 'xformOp:scale','radius'] '*' - match any 'xformOp:*' - matches 'xFormOp:translate' and 'xformOp:scale' '* ^radius' - match any, but exclude 'radius' '* ^xformOp*' - match any, but exclude 'xFormOp:translate', 'xformOp:scale'", "*"
"inputs:execIn", "``execution``", "The input execution (for action graphs only)", "None"
"Prim Path Pattern (*inputs:pathPattern*)", "``string``", "A list of wildcard patterns used to match primitives by path. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['/Cube0', '/Cube1', '/Box'] '*' - match any '* ^/Box' - match any, but exclude '/Box' '* ^/Cube*' - match any, but exclude '/Cube0' and '/Cube1'", "*"
"Prims Bundle (*inputs:primsBundle*)", "``bundle``", "The bundle(s) of multiple prims to be written back. The sourcePrimPath attribute is used to find the destination prim.", "None"
"", "*allowMultiInputs*", "1", ""
"Prim Type Pattern (*inputs:typePattern*)", "``string``", "A list of wildcard patterns used to match primitives by type. Supported syntax of wildcard pattern: `*` - match an arbitrary number of any characters `?` - match any single character `^` - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['Mesh', 'Cone', 'Cube'] '*' - match any '* ^Mesh' - match any, but exclude 'Mesh' '* ^Cone ^Cube' - match any, but exclude 'Cone' and 'Cube'", "*"
"Persist To USD (*inputs:usdWriteBack*)", "``bool``", "Whether or not the value should be written back to USD, or kept a Fabric only value", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port (for action graphs only)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrims"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Write Prims (Legacy)"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnWritePrimsDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAppendPath.rst | .. _omni_graph_nodes_AppendPath_1:
.. _omni_graph_nodes_AppendPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Append Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes append-path
Append Path
===========
.. <description>
Generates a path token by appending the given relative path token to the given root or prim path token
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:path", "``['token', 'token[]']``", "The path token(s) to be appended to. Must be a base or prim path (ex. /World)", "None"
"inputs:suffix", "``token``", "The prim or prim-property path to append (ex. Cube or Cube.attr)", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:path", "``['token', 'token[]']``", "The new path token(s) (ex. /World/Cube or /World/Cube.attr)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:path", "``token``", "Snapshot of previously seen path", "None"
"state:suffix", "``token``", "Snapshot of previously seen suffix", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AppendPath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "paths"
"uiName", "Append Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnAppendPathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnArrayResize.rst | .. _omni_graph_nodes_ArrayResize_1:
.. _omni_graph_nodes_ArrayResize:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Array Resize
:keywords: lang-en omnigraph node math:array threadsafe nodes array-resize
Array Resize
============
.. <description>
Resizes an array. If the new size is larger, zeroed values will be added to the end.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Array (*inputs:array*)", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The array to be modified", "None"
"inputs:newSize", "``int``", "The new size of the array, negative values are treated as size of 0", "0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Array (*outputs:array*)", "``['bool[]', 'colord[3][]', 'colord[4][]', 'colorf[3][]', 'colorf[4][]', 'colorh[3][]', 'colorh[4][]', 'double[2][]', 'double[3][]', 'double[4][]', 'double[]', 'float[2][]', 'float[3][]', 'float[4][]', 'float[]', 'frame[4][]', 'half[2][]', 'half[3][]', 'half[4][]', 'half[]', 'int64[]', 'int[2][]', 'int[3][]', 'int[4][]', 'int[]', 'matrixd[3][]', 'matrixd[4][]', 'normald[3][]', 'normalf[3][]', 'normalh[3][]', 'pointd[3][]', 'pointf[3][]', 'pointh[3][]', 'quatd[4][]', 'quatf[4][]', 'quath[4][]', 'texcoordd[2][]', 'texcoordd[3][]', 'texcoordf[2][]', 'texcoordf[3][]', 'texcoordh[2][]', 'texcoordh[3][]', 'timecode[]', 'token[]', 'transform[4][]', 'uchar[]', 'uint64[]', 'uint[]', 'vectord[3][]', 'vectorf[3][]', 'vectorh[3][]']``", "The modified array", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ArrayResize"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Array Resize"
"Categories", "math:array"
"Generated Class Name", "OgnArrayResizeDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnWritePrim.rst | .. _omni_graph_nodes_WritePrim_3:
.. _omni_graph_nodes_WritePrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Prim Attributes
:keywords: lang-en omnigraph node sceneGraph WriteOnly nodes write-prim
Write Prim Attributes
=====================
.. <description>
Exposes attributes for a single Prim on the USD stage as inputs to this node. When this node computes it writes any of these connected inputs to the target Prim. Any inputs which are not connected will not be written.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:execIn", "``execution``", "The input execution port", "None"
"Prim (*inputs:prim*)", "``target``", "The prim to be written to", "None"
"Persist To USD (*inputs:usdWriteBack*)", "``bool``", "Whether or not the value should be written back to USD, or kept a Fabric only value", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.WritePrim"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Write Prim Attributes"
"Categories", "sceneGraph"
"Generated Class Name", "OgnWritePrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCurveFrame.rst | .. _omni_graph_nodes_CurveToFrame_1:
.. _omni_graph_nodes_CurveToFrame:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Crate Curve From Frame
:keywords: lang-en omnigraph node geometry:generator threadsafe nodes curve-to-frame
Crate Curve From Frame
======================
.. <description>
Create a frame object based on a curve description
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Curve Points (*inputs:curvePoints*)", "``float[3][]``", "Points on the curve to be framed", "[]"
"Curve Vertex Counts (*inputs:curveVertexCounts*)", "``int[]``", "Vertex counts for the curve points", "[]"
"Curve Vertex Starts (*inputs:curveVertexStarts*)", "``int[]``", "Vertex starting points", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Out Vectors (*outputs:out*)", "``float[3][]``", "Out vector directions on the curve frame", "None"
"Tangents (*outputs:tangent*)", "``float[3][]``", "Tangents on the curve frame", "None"
"Up Vectors (*outputs:up*)", "``float[3][]``", "Up vectors on the curve frame", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CurveToFrame"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Crate Curve From Frame"
"Categories", "geometry:generator"
"Generated Class Name", "OgnCurveFrameDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRandomUnitVector.rst | .. _omni_graph_nodes_RandomUnitVector_1:
.. _omni_graph_nodes_RandomUnitVector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Random Unit Vector
:keywords: lang-en omnigraph node math:operator threadsafe nodes random-unit-vector
Random Unit Vector
==================
.. <description>
Generates a random vector with uniform distribution on the unit sphere.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:execIn", "``execution``", "The input execution port to output a new random value", "None"
"Is noise function (*inputs:isNoise*)", "``bool``", "Turn this node into a noise generator function For a given seed, it will then always output the same number(s)", "False"
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
"Seed (*inputs:seed*)", "``uint64``", "The seed of the random generator.", "None"
"Use seed (*inputs:useSeed*)", "``bool``", "Use the custom seed instead of a random one", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port", "None"
"Random Unit Vector (*outputs:random*)", "``vectorf[3]``", "The random unit vector that was generated", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:gen", "``matrixd[3]``", "Random number generator internal state (abusing matrix3d because it is large enough)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RandomUnitVector"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Random Unit Vector"
"Categories", "math:operator"
"Generated Class Name", "OgnRandomUnitVectorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimAttribute.rst | .. _omni_graph_nodes_ReadPrimAttribute_3:
.. _omni_graph_nodes_ReadPrimAttribute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim Attribute
:keywords: lang-en omnigraph node sceneGraph threadsafe ReadOnly nodes read-prim-attribute
Read Prim Attribute
===================
.. <description>
Given a path to a prim on the current USD stage and the name of an attribute on that prim, gets the value of that attribute, at the global timeline value.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attribute Name (*inputs:name*)", "``token``", "The name of the attribute to get on the specified prim", ""
"inputs:prim", "``target``", "The prim to be read from when 'usePath' is false", "None"
"inputs:primPath", "``token``", "The path of the prim to be modified when 'usePath' is true", "None"
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim attribute. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``any``", "The attribute value", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:correctlySetup", "``bool``", "Wheter or not the instance is properly setup", "False"
"state:importPath", "``uint64``", "Path at which data has been imported", "None"
"state:srcAttrib", "``uint64``", "A TokenC to the source attribute", "None"
"state:srcPath", "``uint64``", "A PathC to the source prim", "None"
"state:srcPathAsToken", "``uint64``", "A TokenC to the source prim", "None"
"state:time", "``double``", "The timecode at which we have imported the value", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimAttribute"
"Version", "3"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.ReadPrimAttribute.svg"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "usd"
"uiName", "Read Prim Attribute"
"Categories", "sceneGraph"
"Generated Class Name", "OgnReadPrimAttributeDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetAttrNames.rst | .. _omni_graph_nodes_GetAttributeNames_1:
.. _omni_graph_nodes_GetAttributeNames:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Attribute Names From Bundle
:keywords: lang-en omnigraph node bundle threadsafe nodes get-attribute-names
Get Attribute Names From Bundle
===============================
.. <description>
Retrieves the names of all of the attributes contained in the input bundle, optionally sorted.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Bundle To Examine (*inputs:data*)", "``bundle``", "Collection of attributes from which to extract names", "None"
"Sort Output (*inputs:sort*)", "``bool``", "If true, the names will be output in sorted order (default, for consistency). If false, the order is not be guaranteed to be consistent between systems or over time, so do not rely on the order downstream in this case.", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attribute Names (*outputs:output*)", "``token[]``", "Names of all of the attributes contained in the input bundle", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetAttributeNames"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Attribute Names From Bundle"
"Categories", "bundle"
"Generated Class Name", "OgnGetAttrNamesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetParentPrims.rst | .. _omni_graph_nodes_GetParentPrims_1:
.. _omni_graph_nodes_GetParentPrims:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Parent Prims
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-parent-prims
Get Parent Prims
================
.. <description>
Generates parent paths from one or more targeted paths (ex. /World/Cube -> /World)
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:prims", "``target``", "Input prim paths (ex. /World/Cube)", "None"
"", "*allowMultiInputs*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:parentPrims", "``target``", "Computed parent paths (ex. /World)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetParentPrims"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Parent Prims"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetParentPrimsDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnCreateTubeTopology.rst | .. _omni_graph_nodes_CreateTubeTopology_1:
.. _omni_graph_nodes_CreateTubeTopology:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Create Tube Topology
:keywords: lang-en omnigraph node geometry:generator threadsafe nodes create-tube-topology
Create Tube Topology
====================
.. <description>
Creates the face vertex counts and indices describing a tube topology with the given number of rows and columns.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Column Array (*inputs:cols*)", "``int[]``", "Array of columns in the topology to be generated", "[]"
"Row Array (*inputs:rows*)", "``int[]``", "Array of rows in the topology to be generated", "[]"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Face Vertex Counts (*outputs:faceVertexCounts*)", "``int[]``", "Array of vertex counts for each face in the tube topology", "None"
"Face Vertex Indices (*outputs:faceVertexIndices*)", "``int[]``", "Array of vertex indices for each face in the tube topology", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.CreateTubeTopology"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Create Tube Topology"
"Categories", "geometry:generator"
"Generated Class Name", "OgnCreateTubeTopologyDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnEachZero.rst | .. _omni_graph_nodes_EachZero_1:
.. _omni_graph_nodes_EachZero:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Each Zero
:keywords: lang-en omnigraph node math:condition threadsafe nodes each-zero
Each Zero
=========
.. <description>
Outputs a boolean, or array of booleans, indicating which input values are zero within a specified tolerance.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Tolerance (*inputs:tolerance*)", "``double``", "How close the value must be to 0 to be considered ""zero"".", "0.0"
"Value (*inputs:value*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Value(s) to check for zero.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "If 'value' is a scalar then 'result' will be a boolean set to true if 'value' is zero. If 'value' is non-scalar (array, tuple, matrix, etc) then 'result' will be an array of booleans, one for each element/component of the input. If those elements are themselves non-scalar (e.g. an array of vectors) they will be considered zero only if all of the sub-elements are zero. For example, if 'value' is [3, 0, 1] then 'result' will be [true, false, true] because the second element is zero. But if 'value' is [[3, 0, 1], [-5, 4, 17]] then 'result' will be [false, false] because neither of the two vectors is fully zero.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.EachZero"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Each Zero"
"Categories", "math:condition"
"Generated Class Name", "OgnEachZeroDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnLengthAlongCurve.rst | .. _omni_graph_nodes_LengthAlongCurve_1:
.. _omni_graph_nodes_LengthAlongCurve:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Length Along Curve
:keywords: lang-en omnigraph node geometry:analysis threadsafe nodes length-along-curve
Length Along Curve
==================
.. <description>
Find the length along the curve of a set of points
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Curve Points (*inputs:curvePoints*)", "``float[3][]``", "Points on the curve to be framed", "[]"
"Curve Vertex Counts (*inputs:curveVertexCounts*)", "``int[]``", "Vertex counts for the curve points", "[]"
"Curve Vertex Starts (*inputs:curveVertexStarts*)", "``int[]``", "Vertex starting points", "[]"
"Normalize (*inputs:normalize*)", "``bool``", "If true then normalize the curve length to a 0, 1 range", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:length", "``float[]``", "List of lengths along the curve corresponding to the input points", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.LengthAlongCurve"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Length Along Curve"
"Categories", "geometry:analysis"
"Generated Class Name", "OgnLengthAlongCurveDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTransformVector.rst | .. _omni_graph_nodes_TransformVector_1:
.. _omni_graph_nodes_TransformVector:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Transform Vector
:keywords: lang-en omnigraph node math:operator threadsafe nodes transform-vector
Transform Vector
================
.. <description>
Applies a transformation matrix to a row vector, returning the result. returns vector * matrix If the vector is one dimension smaller than the matrix (eg a 4x4 matrix and a 3d vector), The last component of the vector will be treated as a 1. The result is then projected back to a 3-vector. Supports mixed array inputs, eg a single matrix and an array of vectors.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Matrix (*inputs:matrix*)", "``['matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]']``", "The transformation matrix to be applied", "None"
"Vector (*inputs:vector*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The row vector(s) to be translated", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The transformed row vector(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.TransformVector"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Transform Vector"
"Categories", "math:operator"
"Generated Class Name", "OgnTransformVectorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAbsolute.rst | .. _omni_graph_nodes_Absolute_1:
.. _omni_graph_nodes_Absolute:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Absolute
:keywords: lang-en omnigraph node math:operator threadsafe nodes absolute
Absolute
========
.. <description>
Compute the absolute value of a vector, array of vectors, scalar or array of scalars If an array of vectors are passed in, the output will be an array of corresponding absolute values
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:input", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The vector(s) or scalar(s) to take the absolute value of", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:absolute", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The resulting absolute(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Absolute"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "absolute"
"uiName", "Absolute"
"Categories", "math:operator"
"Generated Class Name", "OgnAbsoluteDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadPrimAttributes.rst | .. _omni_graph_nodes_ReadPrimAttributes_3:
.. _omni_graph_nodes_ReadPrimAttributes:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Prim Attributes
:keywords: lang-en omnigraph node sceneGraph,bundle ReadOnly nodes read-prim-attributes
Read Prim Attributes
====================
.. <description>
Read Prim attributes and exposes them as dynamic attributes Does not produce output bundle.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Attribute Name Pattern (*inputs:attrNamesToImport*)", "``string``", "A list of wildcard patterns used to match the attribute names that are to be imported Supported syntax of wildcard pattern: '*' - match an arbitrary number of any characters '?' - match any single character '^' - (caret) is used to define a pattern that is to be excluded Example of wildcard patterns, input: ['points', 'faceVertexCount', 'faceVertexIndices', 'size'] '*' - match any '* ^points' - match any, but exclude 'points' '* ^face*' - match any, but exclude 'faceVertexCount' and 'faceVertexIndices'", "*"
"inputs:prim", "``target``", "The prim to be read from when 'usePath' is false", "None"
"Prim Path (*inputs:primPath*)", "``path``", "The path of the prim to be read from when 'usePath' is true", ""
"Time (*inputs:usdTimecode*)", "``timecode``", "The time at which to evaluate the transform of the USD prim. A value of ""NaN"" indicates that the default USD time stamp should be used", "NaN"
"Use Path (*inputs:usePath*)", "``bool``", "When true, the 'primPath' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:primBundle", "``bundle``", "A bundle of the target Prim attributes. In addition to the data attributes, there are token attributes named sourcePrimPath and sourcePrimType which contains the path of the Prim being read", "None"
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:attrNamesToImport", "``string``", "State from previous evaluation", "None"
"state:primPath", "``uint64``", "State from previous evaluation", "None"
"state:usdTimecode", "``timecode``", "State from previous evaluation", "NaN"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ReadPrimAttributes"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Read Prim Attributes"
"Categories", "sceneGraph,bundle"
"Generated Class Name", "OgnReadPrimAttributesDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnReadVariable.rst | .. _omni_graph_core_ReadVariable_2:
.. _omni_graph_core_ReadVariable:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Variable
:keywords: lang-en omnigraph node internal threadsafe core read-variable
Read Variable
=============
.. <description>
Node that reads a value from a variable
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:graph", "``target``", "Ignored. Do not use", "None"
"", "*hidden*", "true", ""
"inputs:targetPath", "``token``", "Ignored. Do not use.", "None"
"", "*hidden*", "true", ""
"inputs:variableName", "``token``", "The name of the graph variable to use.", ""
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``any``", "The variable value that we returned.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.core.ReadVariable"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Read Variable"
"Categories", "internal"
"Generated Class Name", "OgnReadVariableDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnMoveToTarget.rst | .. _omni_graph_nodes_MoveToTarget_2:
.. _omni_graph_nodes_MoveToTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Move To Target
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes move-to-target
Move To Target
==============
.. <description>
This node smoothly translates, rotates, and scales a prim object to a target prim object given a speed and easing factor. At the end of the maneuver, the source prim will have the translation, rotation, and scale of the target prim.
Note: The Prim must have xform:orient in transform stack in order to interpolate rotations
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:sourcePrim", "``target``", "The source prim to be transformed", "None"
"inputs:sourcePrimPath", "``path``", "The source prim to be transformed, used when 'useSourcePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"inputs:targetPrim", "``target``", "The destination prim. The target's translation, rotation, and scale will be matched by the sourcePrim", "None"
"inputs:targetPrimPath", "``path``", "The destination prim. The target's translation, rotation, and scale will be matched by the sourcePrim, used when 'useTargetPath' is true", "None"
"inputs:useSourcePath", "``bool``", "When true, the 'sourcePrimPath' attribute is used, otherwise it will read the connection at the 'sourcePrim' attribute", "False"
"inputs:useTargetPath", "``bool``", "When true, the 'targetPrimPath' attribute is used, otherwise it will read the connection at the 'targetPrim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.MoveToTarget"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Move To Target"
"Categories", "sceneGraph"
"Generated Class Name", "OgnMoveToTargetDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantUInt.rst | .. _omni_graph_nodes_ConstantUInt_1:
.. _omni_graph_nodes_ConstantUInt:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant UInt
:keywords: lang-en omnigraph node constants nodes constant-u-int
Constant UInt
=============
.. <description>
Holds a 32 bit unsigned integer value
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``uint``", "The constant value", "0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantUInt"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Constant UInt"
"Categories", "constants"
"Generated Class Name", "OgnConstantUIntDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetPrimPath.rst | .. _omni_graph_nodes_GetPrimPath_3:
.. _omni_graph_nodes_GetPrimPath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Prim Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-prim-path
Get Prim Path
=============
.. <description>
Generates a path from the specified relationship. This is useful when an absolute prim path may change.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:prim", "``target``", "The prim to determine the path of", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:path", "``path``", "The absolute path of the given prim as a string", "None"
"outputs:primPath", "``token``", "The absolute path of the given prim as a token", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetPrimPath"
"Version", "3"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Prim Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetPrimPathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetGraphTargetPrim.rst | .. _omni_graph_nodes_GetGraphTargetPrim_1:
.. _omni_graph_nodes_GetGraphTargetPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Graph Target Prim
:keywords: lang-en omnigraph node sceneGraph nodes get-graph-target-prim
Get Graph Target Prim
=====================
.. <description>
Access the target prim the graph is being executed on. If the graph is executing itself, this will output the prim of the graph. Otherwise the graph is being executed via instancing, then this will output the prim of the target instance.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:prim", "``target``", "The graph target as a prim", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetGraphTargetPrim"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Graph Target Prim"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetGraphTargetPrimDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnTrig.rst | .. _omni_graph_nodes_Trig_1:
.. _omni_graph_nodes_Trig:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Trigonometric Operation
:keywords: lang-en omnigraph node math:operator,math:conversion threadsafe nodes trig
Trigonometric Operation
=======================
.. <description>
Trigonometric operation of one input in degrees. Supported operations are:
SIN, COS, TAN, ARCSIN, ARCCOS, ARCTAN, DEGREES, RADIANS
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:a", "``['double', 'float', 'half', 'timecode']``", "Input to the function", "None"
"Operation (*inputs:operation*)", "``token``", "The operation to perform", "SIN"
"", "*allowedTokens*", "SIN,COS,TAN,ARCSIN,ARCCOS,ARCTAN,DEGREES,RADIANS", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['double', 'float', 'half', 'timecode']``", "The result of the function", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Trig"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Trigonometric Operation"
"Categories", "math:operator,math:conversion"
"Generated Class Name", "OgnTrigDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantBool.rst | .. _omni_graph_nodes_ConstantBool_1:
.. _omni_graph_nodes_ConstantBool:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Bool
:keywords: lang-en omnigraph node constants nodes constant-bool
Constant Bool
=============
.. <description>
Holds a boolean value
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``bool``", "The constant value", "False"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantBool"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantBoolDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRandomBoolean.rst | .. _omni_graph_nodes_RandomBoolean_1:
.. _omni_graph_nodes_RandomBoolean:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Random Boolean
:keywords: lang-en omnigraph node math:operator threadsafe nodes random-boolean
Random Boolean
==============
.. <description>
Generates a random boolean value.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:execIn", "``execution``", "The input execution port to output a new random value", "None"
"Is noise function (*inputs:isNoise*)", "``bool``", "Turn this node into a noise generator function For a given seed, it will then always output the same number(s)", "False"
"", "*hidden*", "true", ""
"", "*literalOnly*", "1", ""
"Seed (*inputs:seed*)", "``uint64``", "The seed of the random generator.", "None"
"Use seed (*inputs:useSeed*)", "``bool``", "Use the custom seed instead of a random one", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution port", "None"
"Random Boolean (*outputs:random*)", "``bool``", "The random boolean value that was generated", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:gen", "``matrixd[3]``", "Random number generator internal state (abusing matrix3d because it is large enough)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RandomBoolean"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Random Boolean"
"Categories", "math:operator"
"Generated Class Name", "OgnRandomBooleanDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAppendString.rst | .. _omni_graph_nodes_AppendString_1:
.. _omni_graph_nodes_AppendString:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Append String (Deprecated)
:keywords: lang-en omnigraph node function threadsafe nodes append-string
Append String (Deprecated)
==========================
.. <description>
Creates a new token or string by appending the given token or string. token[] inputs will be appended element-wise.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:suffix", "``['string', 'token', 'token[]']``", "The string to be appended", "None"
"inputs:value", "``['string', 'token', 'token[]']``", "The string(s) to be appended to", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:value", "``['string', 'token', 'token[]']``", "The new string(s)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AppendString"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"hidden", "true"
"uiName", "Append String (Deprecated)"
"Categories", "function"
"Generated Class Name", "OgnAppendStringDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAnd.rst | .. _omni_graph_nodes_BooleanAnd_2:
.. _omni_graph_nodes_BooleanAnd:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Boolean AND
:keywords: lang-en omnigraph node math:condition threadsafe nodes boolean-and
Boolean AND
===========
.. <description>
Boolean AND on two or more inputs. If the inputs are arrays, AND operations will be performed pair-wise. The input sizes must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:a", "``['bool', 'bool[]']``", "Input A: bool or bool array.", "None"
"inputs:b", "``['bool', 'bool[]']``", "Input B: bool or bool array.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "The result of the boolean AND - an array of booleans if either input is an array, otherwise a boolean.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BooleanAnd"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Boolean AND"
"Categories", "math:condition"
"Generated Class Name", "OgnAndDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRound.rst | .. _omni_graph_nodes_Round_1:
.. _omni_graph_nodes_Round:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Round
:keywords: lang-en omnigraph node math:operator threadsafe nodes round
Round
=====
.. <description>
Round a decimal input to the given number of decimals. Accepts float, double, half, or arrays / tuples of the aformentioned types
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Decimals (*inputs:decimals*)", "``int``", "The number of decimal places to round to. Negative numbers specify the number of positions left of the decimal", "0"
"Input (*inputs:input*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The input data to round", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Output (*outputs:output*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "The resultant rounded numbers", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Round"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Round"
"Categories", "math:operator"
"Generated Class Name", "OgnRoundDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnRotateToOrientation.rst | .. _omni_graph_nodes_RotateToOrientation_2:
.. _omni_graph_nodes_RotateToOrientation:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Rotate To Orientation
:keywords: lang-en omnigraph node sceneGraph threadsafe WriteOnly nodes rotate-to-orientation
Rotate To Orientation
=====================
.. <description>
Perform a smooth rotation maneuver, rotating a prim to a desired orientation given a speed and easing factor
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Execute In (*inputs:execIn*)", "``execution``", "The input execution", "None"
"inputs:exponent", "``float``", "The blend exponent, which is the degree of the ease curve (1 = linear, 2 = quadratic, 3 = cubic, etc). ", "2.0"
"inputs:prim", "``target``", "The prim to be rotated", "None"
"inputs:primPath", "``path``", "The source prim to be transformed, used when 'usePath' is true", "None"
"inputs:speed", "``double``", "The peak speed of approach (Units / Second)", "1.0"
"Stop (*inputs:stop*)", "``execution``", "Stops the maneuver", "None"
"Target Orientation (*inputs:target*)", "``vectord[3]``", "The desired orientation as euler angles (XYZ) in local space", "[0.0, 0.0, 0.0]"
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used, otherwise it will read the connection at the 'prim' attribute", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Finished (*outputs:finished*)", "``execution``", "The output execution, sent one the maneuver is completed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.RotateToOrientation"
"Version", "2"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Rotate To Orientation"
"Categories", "sceneGraph"
"Generated Class Name", "OgnRotateToOrientationDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnXor.rst | .. _omni_graph_nodes_BooleanXor_1:
.. _omni_graph_nodes_BooleanXor:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Boolean XOR
:keywords: lang-en omnigraph node math:condition threadsafe nodes boolean-xor
Boolean XOR
===========
.. <description>
Boolean XOR on two inputs. If a and b are arrays, XOR operations will be performed pair-wise. Sizes of a and b must match. If only one input is an array, the other input will be broadcast to the size of the array. Returns an array of booleans if either input is an array, otherwise returning a boolean.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:a", "``['bool', 'bool[]']``", "Input A: bool or bool array.", "None"
"inputs:b", "``['bool', 'bool[]']``", "Input B: bool or bool array.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['bool', 'bool[]']``", "The result of the boolean XOR - an array of booleans if either input is an array, otherwise a boolean.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BooleanXor"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Boolean XOR"
"Categories", "math:condition"
"Generated Class Name", "OgnXorDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnBreakVector2.rst | .. _omni_graph_nodes_BreakVector2_1:
.. _omni_graph_nodes_BreakVector2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Break 2-Vector
:keywords: lang-en omnigraph node math:conversion threadsafe nodes break-vector2
Break 2-Vector
==============
.. <description>
Split vector into 2 component values.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Vector (*inputs:tuple*)", "``['double[2]', 'float[2]', 'half[2]', 'int[2]']``", "2-vector to be broken", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"X (*outputs:x*)", "``['double', 'float', 'half', 'int']``", "The first component of the vector", "None"
"Y (*outputs:y*)", "``['double', 'float', 'half', 'int']``", "The second component of the vector", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.BreakVector2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"tags", "decompose,separate,isolate"
"uiName", "Break 2-Vector"
"Categories", "math:conversion"
"Generated Class Name", "OgnBreakVector2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnNormalize.rst | .. _omni_graph_nodes_Normalize_1:
.. _omni_graph_nodes_Normalize:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Normalize
:keywords: lang-en omnigraph node math:operator threadsafe nodes normalize
Normalize
=========
.. <description>
Normalize the input vector. If the input vector has a magnitude of zero, the null vector is returned.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Vector (*inputs:vector*)", "``['double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]']``", "Vector to normalize", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``['double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]']``", "Normalized vector", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.Normalize"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Normalize"
"Categories", "math:operator"
"Generated Class Name", "OgnNormalizeDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantColor4f.rst | .. _omni_graph_nodes_ConstantColor4f_1:
.. _omni_graph_nodes_ConstantColor4f:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Color4F
:keywords: lang-en omnigraph node constants nodes constant-color4f
Constant Color4F
================
.. <description>
Holds a 4-component color constant, which is energy-linear RGBA, not pre-alpha multiplied
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``colorf[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantColor4f"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantColor4fDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantFloat.rst | .. _omni_graph_nodes_ConstantFloat_1:
.. _omni_graph_nodes_ConstantFloat:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Float
:keywords: lang-en omnigraph node constants nodes constant-float
Constant Float
==============
.. <description>
Holds a 32 bit floating point value
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``float``", "The constant value", "0.0"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantFloat"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantFloatDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnStopAllSound.rst | .. _omni_graph_nodes_StopAllSound_1:
.. _omni_graph_nodes_StopAllSound:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Stop All Sound
:keywords: lang-en omnigraph node sound nodes stop-all-sound
Stop All Sound
==============
.. <description>
Stop playing all sounds
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:execIn", "``execution``", "The input execution", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "The output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.StopAllSound"
"Version", "1"
"Extension", "omni.graph.nodes"
"Icon", "ogn/icons/omni.graph.nodes.StopAllSound.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Stop All Sound"
"Categories", "sound"
"Generated Class Name", "OgnStopAllSoundDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantFloat4.rst | .. _omni_graph_nodes_ConstantFloat4_1:
.. _omni_graph_nodes_ConstantFloat4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Float4
:keywords: lang-en omnigraph node constants nodes constant-float4
Constant Float4
===============
.. <description>
Holds a 4-component float constant.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``float[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantFloat4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantFloat4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantDouble2.rst | .. _omni_graph_nodes_ConstantDouble2_1:
.. _omni_graph_nodes_ConstantDouble2:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Double2
:keywords: lang-en omnigraph node constants nodes constant-double2
Constant Double2
================
.. <description>
Holds a 2-component double constant.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``double[2]``", "The constant value", "[0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantDouble2"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantDouble2Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantHalf4.rst | .. _omni_graph_nodes_ConstantHalf4_1:
.. _omni_graph_nodes_ConstantHalf4:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Half4
:keywords: lang-en omnigraph node constants nodes constant-half4
Constant Half4
==============
.. <description>
Holds a 4-component half constant.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``half[4]``", "The constant value", "[0.0, 0.0, 0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantHalf4"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantHalf4Database"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnGetRelativePath.rst | .. _omni_graph_nodes_GetRelativePath_1:
.. _omni_graph_nodes_GetRelativePath:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Relative Path
:keywords: lang-en omnigraph node sceneGraph threadsafe nodes get-relative-path
Get Relative Path
=================
.. <description>
Generates a path token relative to anchor from path.(ex. (/World, /World/Cube) -> /Cube)
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:anchor", "``token``", "Path token to compute relative to (ex. /World)", ""
"inputs:path", "``['token', 'token[]']``", "Path token to convert to a relative path (ex. /World/Cube)", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:relativePath", "``['token', 'token[]']``", "Relative path token (ex. /Cube)", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:anchor", "``token``", "Snapshot of previously seen rootPath", "None"
"state:path", "``token``", "Snapshot of previously seen path", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.GetRelativePath"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Get Relative Path"
"Categories", "sceneGraph"
"Generated Class Name", "OgnGetRelativePathDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnConstantTexCoord2f.rst | .. _omni_graph_nodes_ConstantTexCoord2f_1:
.. _omni_graph_nodes_ConstantTexCoord2f:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Constant Tex Coord2F
:keywords: lang-en omnigraph node constants nodes constant-tex-coord2f
Constant Tex Coord2F
====================
.. <description>
Holds a 2D uv texture coordinate.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*inputs:value*)", "``texcoordf[2]``", "The constant value", "[0.0, 0.0]"
"", "*outputOnly*", "1", ""
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.ConstantTexCoord2f"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"Categories", "constants"
"Generated Class Name", "OgnConstantTexCoord2fDatabase"
"Python Module", "omni.graph.nodes"
|
omniverse-code/kit/exts/omni.graph.nodes/ogn/docs/OgnAnyZero.rst | .. _omni_graph_nodes_AnyZero_1:
.. _omni_graph_nodes_AnyZero:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Any Zero
:keywords: lang-en omnigraph node math:condition threadsafe nodes any-zero
Any Zero
========
.. <description>
Outputs a boolean indicating if any of the input values are zero within a specified tolerance.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.nodes<ext_omni_graph_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Tolerance (*inputs:tolerance*)", "``double``", "How close the value must be to 0 to be considered ""zero"".", "0.0"
"Value (*inputs:value*)", "``['colord[3]', 'colord[3][]', 'colord[4]', 'colord[4][]', 'colorf[3]', 'colorf[3][]', 'colorf[4]', 'colorf[4][]', 'colorh[3]', 'colorh[3][]', 'colorh[4]', 'colorh[4][]', 'double', 'double[2]', 'double[2][]', 'double[3]', 'double[3][]', 'double[4]', 'double[4][]', 'double[]', 'float', 'float[2]', 'float[2][]', 'float[3]', 'float[3][]', 'float[4]', 'float[4][]', 'float[]', 'frame[4]', 'frame[4][]', 'half', 'half[2]', 'half[2][]', 'half[3]', 'half[3][]', 'half[4]', 'half[4][]', 'half[]', 'int', 'int64', 'int64[]', 'int[2]', 'int[2][]', 'int[3]', 'int[3][]', 'int[4]', 'int[4][]', 'int[]', 'matrixd[3]', 'matrixd[3][]', 'matrixd[4]', 'matrixd[4][]', 'normald[3]', 'normald[3][]', 'normalf[3]', 'normalf[3][]', 'normalh[3]', 'normalh[3][]', 'pointd[3]', 'pointd[3][]', 'pointf[3]', 'pointf[3][]', 'pointh[3]', 'pointh[3][]', 'quatd[4]', 'quatd[4][]', 'quatf[4]', 'quatf[4][]', 'quath[4]', 'quath[4][]', 'texcoordd[2]', 'texcoordd[2][]', 'texcoordd[3]', 'texcoordd[3][]', 'texcoordf[2]', 'texcoordf[2][]', 'texcoordf[3]', 'texcoordf[3][]', 'texcoordh[2]', 'texcoordh[2][]', 'texcoordh[3]', 'texcoordh[3][]', 'timecode', 'timecode[]', 'transform[4]', 'transform[4][]', 'uchar', 'uchar[]', 'uint', 'uint64', 'uint64[]', 'uint[]', 'vectord[3]', 'vectord[3][]', 'vectorf[3]', 'vectorf[3][]', 'vectorh[3]', 'vectorh[3][]']``", "Value(s) to check for zero.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Result (*outputs:result*)", "``bool``", "If 'value' is a scalar then 'result' will be true if 'value' is zero. If 'value' is non-scalar (array, tuple, matrix, etc) then 'result' will be true if any of its elements are zero. If those elements are themselves non-scalar (e.g. an array of vectors) they will be considered zero only if all of the sub-elements are zero. For example, if 'value' is [3, 0, 1] then 'result' will be true because the second element is zero. But if 'value' is [[3, 0, 1], [-5, 4, 17]] then 'result' will be false because neither of the two vectors is fully zero.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.nodes.AnyZero"
"Version", "1"
"Extension", "omni.graph.nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Any Zero"
"Categories", "math:condition"
"Generated Class Name", "OgnAnyZeroDatabase"
"Python Module", "omni.graph.nodes"
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.