file_path
stringlengths 21
202
| content
stringlengths 12
1.02M
| size
int64 12
1.02M
| lang
stringclasses 9
values | avg_line_length
float64 3.33
100
| max_line_length
int64 10
993
| alphanum_fraction
float64 0.27
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/exts/omni.graph.io/ogn/docs/OgnImportUSDPrim.rst | .. _omni_graph_ImportUSDPrim_1:
.. _omni_graph_ImportUSDPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: import USD prim data
:keywords: lang-en omnigraph node graph import-u-s-d-prim
import USD prim data
====================
.. <description>
Imports data from a USD prim into attributes in an output bundle
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.io<ext_omni_graph_io>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:applySkelBinding", "``bool``", "If the input USD prim is a Mesh, and has SkelBindingAPI schema applied, compute skinned points and normals.", "True"
"", "*displayGroup*", "parameters", ""
"inputs:applyTransform", "``bool``", "If importAttributes is true, apply the transform necessary to transform any transforming attributes into the space of this node.", "False"
"", "*displayGroup*", "parameters", ""
"Attributes To Import (*inputs:attrNamesToImport*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be imported or empty to import all attributes.", ""
"", "*displayGroup*", "parameters", ""
"inputs:computeBoundingBox", "``bool``", "Compute and store local bounding box of a prim and its children.", "False"
"", "*displayGroup*", "parameters", ""
"inputs:importAttributes", "``bool``", "Import attribute data from the USD prim.", "True"
"", "*displayGroup*", "parameters", ""
"inputs:importPath", "``bool``", "Record the input USD prim's path into the output bundle in an attribute named ""primPath"".", "True"
"", "*displayGroup*", "parameters", ""
"inputs:importPrimvarMetadata", "``bool``", "Import metadata like the interpolation type for primvars, and store it as attributes in the output bundle.", "True"
"", "*displayGroup*", "parameters", ""
"inputs:importTime", "``bool``", "Record the usdTimecode above into the output bundle in an attribute named ""primTime"".", "True"
"", "*displayGroup*", "parameters", ""
"inputs:importTransform", "``bool``", "Record the transform required to take any attributes of the input USD prim into the space of this node, i.e. the world transform of the input prim times the inverse world transform of this node, into the output bundle in an attribute named ""transform"".", "True"
"", "*displayGroup*", "parameters", ""
"inputs:importType", "``bool``", "Deprecated, prim type is always imported", "True"
"", "*hidden*", "true", ""
"", "*displayGroup*", "parameters", ""
"Attributes To Rename (*inputs:inputAttrNames*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be renamed", ""
"inputs:keepPrimsSeparate", "``bool``", "Prefix output attribute names with ""prim"" followed by a unique number and a colon, to keep the attributes for separate input prims separate. The prim paths will be in the ""primPaths"" token array attribute.", "True"
"", "*displayGroup*", "parameters", ""
"New Attribute Names (*inputs:outputAttrNames*)", "``token``", "Comma or space separated text, listing the new names for the attributes listed in inputAttrNames", ""
"inputs:prim", "``bundle``", "The USD prim from which to import data.", "None"
"inputs:renameAttributes", "``bool``", "If true, attributes listed in ""inputAttrNames"" will be imported to attributes with the names specified in ""outputAttrNames"".", "False"
"", "*displayGroup*", "parameters", ""
"inputs:timeVaryingAttributes", "``bool``", "Check whether the USD attributes are time-varying and if so, import their data at the time ""usdTimecode"".", "True"
"", "*displayGroup*", "parameters", ""
"inputs:usdTimecode", "``double``", "The time at which to evaluate the transform of the USD prim.", "0"
"", "*displayGroup*", "parameters", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:output", "``bundle``", "Output bundle containing all of the imported data.", "None"
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:prevApplySkelBinding", "``bool``", "Value of ""applySkelBinding"" input from previous run", "None"
"state:prevApplyTransform", "``bool``", "Value of ""applyTransform"" input from previous run", "None"
"state:prevAttrNamesToImport", "``token``", "Value of ""attrNamesToImport"" input from previous run", "None"
"state:prevComputeBoundingBox", "``bool``", "Value of ""computeBoundingBox"" input from previous run", "None"
"state:prevImportAttributes", "``bool``", "Value of ""importAttributes"" input from previous run", "None"
"state:prevImportPath", "``bool``", "Value of ""importPath"" input from previous run", "None"
"state:prevImportPrimvarMetadata", "``bool``", "Value of ""importPrimvarMetadata"" input from previous run", "None"
"state:prevImportTime", "``bool``", "Value of ""importTime"" input from previous run", "None"
"state:prevImportTransform", "``bool``", "Value of ""importTransform"" input from previous run", "None"
"state:prevImportType", "``bool``", "Value of ""importType"" input from previous run", "None"
"state:prevInputAttrNames", "``token``", "Value of ""inputAttrNames"" input from previous run", "None"
"state:prevInvNodeTransform", "``matrixd[4]``", "Inverse transform of the node prim from the previous run.", "None"
"state:prevKeepPrimsSeparate", "``bool``", "Value of ""keepPrimsSeparate"" input from previous run", "None"
"state:prevOnlyImportSpecified", "``bool``", "Value of ""onlyImportSpecified"" input from previous run", "None"
"state:prevOutputAttrNames", "``token``", "Value of ""outputAttrNames"" input from previous run", "None"
"state:prevPaths", "``token[]``", "Array of paths from the previous run.", "None"
"state:prevRenameAttributes", "``bool``", "Value of ""renameAttributes"" input from previous run", "None"
"state:prevTimeVaryingAttributes", "``bool``", "Value of ""timeVaryingAttributes"" input from previous run", "None"
"state:prevTransforms", "``matrixd[4][]``", "Array of transforms from the previous run.", "None"
"state:prevUsdTimecode", "``double``", "Value of ""usdTimecode"" input from previous run", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ImportUSDPrim"
"Version", "1"
"Extension", "omni.graph.io"
"Icon", "ogn/icons/omni.graph.ImportUSDPrim.svg"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "import USD prim data"
"Generated Class Name", "OgnImportUSDPrimDatabase"
"Python Module", "omni.graph.io"
| 7,139 | reStructuredText | 55.220472 | 308 | 0.650791 |
omniverse-code/kit/exts/omni.graph.io/ogn/docs/OgnTransformBundle.rst | .. _omni_graph_TransformBundle_1:
.. _omni_graph_TransformBundle:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: transform bundle
:keywords: lang-en omnigraph node graph transform-bundle
transform bundle
================
.. <description>
Applies a transform to an input bundle, storing the result in an output bundle
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.io<ext_omni_graph_io>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:input", "``bundle``", "Input bundle containing the attributes to be transformed.", "None"
"inputs:transform", "``matrixd[4]``", "The transform to apply to the bundle", "[[1.0, 0.0, 0.0, 0.0], [0.0, 1.0, 0.0, 0.0], [0.0, 0.0, 1.0, 0.0], [0.0, 0.0, 0.0, 1.0]]"
"", "*displayGroup*", "parameters", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:output", "``bundle``", "Output bundle containing all of the transformed attributes", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.TransformBundle"
"Version", "1"
"Extension", "omni.graph.io"
"Icon", "ogn/icons/omni.graph.TransformBundle.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "transform bundle"
"Generated Class Name", "OgnTransformBundleDatabase"
"Python Module", "omni.graph.io"
| 1,825 | reStructuredText | 25.085714 | 172 | 0.563288 |
omniverse-code/kit/exts/omni.graph.io/ogn/docs/OgnBundleToUSDA.rst | .. _omni_graph_BundleToUSDA_1:
.. _omni_graph_BundleToUSDA:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Bundle to usda text
:keywords: lang-en omnigraph node threadsafe graph bundle-to-u-s-d-a
Bundle to usda text
===================
.. <description>
Outputs a represention of the content of a bundle as usda text
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.io<ext_omni_graph_io>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:bundle", "``bundle``", "The bundle to convert to usda text.", "None"
"inputs:outputAncestors", "``bool``", "If usePath is true and this is also true, ancestor ""primPath"" entries will be output.", "False"
"", "*displayGroup*", "parameters", ""
"inputs:outputValues", "``bool``", "If true, the values of attributes will be output, else values will be omitted.", "True"
"", "*displayGroup*", "parameters", ""
"inputs:usePrimPath", "``bool``", "Use the attribute named ""primPath"" for the usda prim path.", "True"
"", "*displayGroup*", "parameters", ""
"inputs:usePrimType", "``bool``", "Use the attribute named ""primType"" for the usda prim type name.", "True"
"", "*displayGroup*", "parameters", ""
"inputs:usePrimvarMetadata", "``bool``", "Identify attributes representing metadata like the interpolation type for primvars, and include them as usda metadata in the output text.", "True"
"", "*displayGroup*", "parameters", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:text", "``token``", "Output usda text representing the bundle contents.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.BundleToUSDA"
"Version", "1"
"Extension", "omni.graph.io"
"Icon", "ogn/icons/omni.graph.BundleToUSDA.svg"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "Bundle to usda text"
"Generated Class Name", "OgnBundleToUSDADatabase"
"Python Module", "omni.graph.io"
| 2,470 | reStructuredText | 30.679487 | 192 | 0.591498 |
omniverse-code/kit/exts/omni.graph.io/ogn/docs/OgnExportUSDPrim.rst | .. _omni_graph_ExportUSDPrim_1:
.. _omni_graph_ExportUSDPrim:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: export USD prim data
:keywords: lang-en omnigraph node WriteOnly graph export-u-s-d-prim
export USD prim data
====================
.. <description>
Exports data from an input bundle into a USD prim
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.io<ext_omni_graph_io>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:applyTransform", "``bool``", "If true, apply the transform necessary to transform any transforming attributes from the space of the node into the space of the specified prim.", "False"
"", "*displayGroup*", "parameters", ""
"Attributes To Export (*inputs:attrNamesToExport*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be exported or empty to import all attributes.", ""
"", "*displayGroup*", "parameters", ""
"inputs:bundle", "``bundle``", "The bundle from which data should be exported.", "None"
"Attributes To Exclude (*inputs:excludedAttrNames*)", "``token``", "Attributes to be excluded from being exported", ""
"Export to Root Layer (*inputs:exportToRootLayer*)", "``bool``", "If true, prims are exported in the root layer, otherwise the layer specified by ""layerName"" is used.", "True"
"Attributes To Rename (*inputs:inputAttrNames*)", "``token``", "Comma or space separated text, listing the names of attributes in the input data to be renamed", ""
"Layer Name (*inputs:layerName*)", "``token``", "Identifier of the layer to export to if ""exportToRootLayer"" is false, or leave this blank to export to the session layer", ""
"inputs:onlyExportToExisting", "``bool``", "If true, only attributes that already exist in the specified output prim will have data transferred to them from the input bundle.", "False"
"", "*displayGroup*", "parameters", ""
"New Attribute Names (*inputs:outputAttrNames*)", "``token``", "Comma or space separated text, listing the new names for the attributes listed in inputAttrNames", ""
"inputs:primPathFromBundle", "``bool``", "When true, if there is a ""primPath"" token attribute inside the bundle, that will be the path of the USD prim to write to, else the ""outputs:prim"" attribute below will be used for the USD prim path.", "False"
"", "*displayGroup*", "parameters", ""
"Export to Root Layer (*inputs:removeMissingAttrs*)", "``bool``", "If true, any attributes on the USD prim(s) being written to, that aren't in the input data, will be removed from the USD prim(s).", "False"
"inputs:renameAttributes", "``bool``", "If true, attributes listed in ""inputAttrNames"" will be exported to attributes with the names specified in ""outputAttrNames"". Note: to avoid potential issues with redundant attributes being created while typing, keep this off until after specifying all input and output attribute names.", "False"
"", "*displayGroup*", "parameters", ""
"inputs:timeVaryingAttributes", "``bool``", "Check whether the USD attributes should be time-varying and if so, export their data to a time sample at the time ""usdTimecode"".", "False"
"", "*displayGroup*", "parameters", ""
"inputs:usdTimecode", "``double``", "The time at which to evaluate the transform of the USD prim for applyTransform.", "0"
"", "*displayGroup*", "parameters", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:prim", "``bundle``", "The USD prim(s) to which data should be exported if primPathFromBundle is false or if the bundle doesn't have a ""primPath"" token attribute. Note: this is really an input, since the node just receives the path to the prim. The node does not contain the prim.", "None"
"", "*hidden*", "true", ""
State
-----
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"state:prevApplyTransform", "``bool``", "Value of ""applyTransform"" input from previous run", "None"
"state:prevAttrNamesToExport", "``token``", "Value of ""attrNamesToExport"" input from previous run", "None"
"state:prevBundleDirtyID", "``uint64``", "Dirty ID of input bundle from previous run", "None"
"state:prevExcludedAttrNames", "``token``", "Value of ""excludedAttrNames"" input from previous run", "None"
"state:prevExportToRootLayer", "``bool``", "Value of ""exportToRootLayer"" input from previous run", "None"
"state:prevInputAttrNames", "``token``", "Value of ""inputAttrNames"" input from previous run", "None"
"state:prevLayerName", "``token``", "Value of ""layerName"" input from previous run", "None"
"state:prevOnlyExportToExisting", "``bool``", "Value of ""onlyExportToExisting"" input from previous run", "None"
"state:prevOutputAttrNames", "``token``", "Value of ""outputAttrNames"" input from previous run", "None"
"state:prevPrimDirtyIDs", "``uint64[]``", "Dirty IDs of input prims from previous run", "None"
"state:prevPrimPathFromBundle", "``bool``", "Value of ""primPathFromBundle"" input from previous run", "None"
"state:prevRemoveMissingAttrs", "``bool``", "Value of ""removeMissingAttrs"" input from previous run", "None"
"state:prevRenameAttributes", "``bool``", "Value of ""renameAttributes"" input from previous run", "None"
"state:prevTimeVaryingAttributes", "``bool``", "Value of ""timeVaryingAttributes"" input from previous run", "None"
"state:prevUsdTimecode", "``double``", "Value of ""usdTimecode"" input from previous run", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ExportUSDPrim"
"Version", "1"
"Extension", "omni.graph.io"
"Icon", "ogn/icons/omni.graph.ExportUSDPrim.svg"
"Has State?", "True"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "None"
"uiName", "export USD prim data"
"__tokens", "{""primPath"": ""primPath"", ""primType"": ""primType"", ""primTime"": ""primTime"", ""primCount"": ""primCount"", ""transform"": ""transform""}"
"Generated Class Name", "OgnExportUSDPrimDatabase"
"Python Module", "omni.graph.io"
| 6,578 | reStructuredText | 57.221238 | 345 | 0.657799 |
omniverse-code/kit/exts/omni.graph.io/config/extension.toml | [package]
# Semantic Versioning is used: https://semver.org/
version = "1.2.5"
# 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 = "OmniGraph IO"
description="Input/output node types for OmniGraph"
# Path (relative to the root) or content of readme markdown file for UI.
readme = "docs/README.md"
# URL of the extension source repository.
repository = ""
# One of categories for UI.
category = "Graph"
# Keywords for the extension
keywords = ["graph, input, output, io"]
# Location of change log file in target (final) folder of extension, relative to the root. Can also be just a content
# of it instead of file path. More info on writing changelog: https://keepachangelog.com/en/1.0.0/
changelog="docs/CHANGELOG.md"
# Preview image and icon. Folder named "data" automatically goes in git lfs (see .gitattributes file).
# Preview image is shown in "Overview" of Extensions window. Screenshot of an extension might be a good preview image.
preview_image = "data/preview.png"
# Icon is shown in Extensions window, it is recommended to be square, of size 256x256.
icon = "data/icon.png"
# Main module for the Python interface
[[python.module]]
name = "omni.graph.io"
# Additional module used to make .ogn test files auto-discoverable
[[python.module]]
name = "omni.graph.io.ogn.tests"
# Watch the .ogn files for hot reloading (only works for Python files)
[fswatcher.patterns]
include = ["*.ogn", "*.py"]
exclude = ["Ogn*Database.py"]
# Extensions required to load before this one
[dependencies]
"omni.graph" = {}
"omni.graph.ui" = {optional = true}
"omni.usd" = {}
[[native.plugin]]
path = "bin/*.plugin"
recursive = false
[[test]]
# RTX regression OM-51983
timeout = 600
dependencies = [
"omni.graph.ui" #force load dependency to test the functionality
]
[documentation]
pages = [
"docs/Overview.md",
"docs/CHANGELOG.md",
]
| 1,994 | TOML | 26.708333 | 118 | 0.728185 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/__init__.py | """There is no public API to this module."""
__all__ = []
| 58 | Python | 18.66666 | 44 | 0.568966 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/ogn/OgnBundleToUSDADatabase.py | """Support for simplified access to data on nodes of type omni.graph.BundleToUSDA
Outputs a represention of the content of a bundle as usda text
"""
import carb
import carb
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnBundleToUSDADatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.BundleToUSDA
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.bundle
inputs.outputAncestors
inputs.outputValues
inputs.usePrimPath
inputs.usePrimType
inputs.usePrimvarMetadata
Outputs:
outputs.text
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:bundle', 'bundle', 0, None, 'The bundle to convert to usda text.', {}, True, None, False, ''),
('inputs:outputAncestors', 'bool', 0, None, 'If usePath is true and this is also true, ancestor "primPath" entries will be output.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:outputValues', 'bool', 0, None, 'If true, the values of attributes will be output, else values will be omitted.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:usePrimPath', 'bool', 0, None, 'Use the attribute named "primPath" for the usda prim path.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:usePrimType', 'bool', 0, None, 'Use the attribute named "primType" for the usda prim type name.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:usePrimvarMetadata', 'bool', 0, None, 'Identify attributes representing metadata like the interpolation type for primvars, and include them as usda metadata in the output text.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('outputs:text', 'token', 0, None, 'Output usda text representing the bundle contents.', {}, True, None, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.bundle = og.AttributeRole.BUNDLE
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=True, gpu_ptr_kinds={})
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def bundle(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute inputs.bundle"""
return self.__bundles.bundle
@property
def outputAncestors(self):
data_view = og.AttributeValueHelper(self._attributes.outputAncestors)
return data_view.get()
@outputAncestors.setter
def outputAncestors(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.outputAncestors)
data_view = og.AttributeValueHelper(self._attributes.outputAncestors)
data_view.set(value)
@property
def outputValues(self):
data_view = og.AttributeValueHelper(self._attributes.outputValues)
return data_view.get()
@outputValues.setter
def outputValues(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.outputValues)
data_view = og.AttributeValueHelper(self._attributes.outputValues)
data_view.set(value)
@property
def usePrimPath(self):
data_view = og.AttributeValueHelper(self._attributes.usePrimPath)
return data_view.get()
@usePrimPath.setter
def usePrimPath(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usePrimPath)
data_view = og.AttributeValueHelper(self._attributes.usePrimPath)
data_view.set(value)
@property
def usePrimType(self):
data_view = og.AttributeValueHelper(self._attributes.usePrimType)
return data_view.get()
@usePrimType.setter
def usePrimType(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usePrimType)
data_view = og.AttributeValueHelper(self._attributes.usePrimType)
data_view.set(value)
@property
def usePrimvarMetadata(self):
data_view = og.AttributeValueHelper(self._attributes.usePrimvarMetadata)
return data_view.get()
@usePrimvarMetadata.setter
def usePrimvarMetadata(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usePrimvarMetadata)
data_view = og.AttributeValueHelper(self._attributes.usePrimvarMetadata)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def text(self):
data_view = og.AttributeValueHelper(self._attributes.text)
return data_view.get()
@text.setter
def text(self, value):
data_view = og.AttributeValueHelper(self._attributes.text)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnBundleToUSDADatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnBundleToUSDADatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnBundleToUSDADatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 8,803 | Python | 47.373626 | 285 | 0.659889 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/ogn/OgnTransformBundleDatabase.py | """Support for simplified access to data on nodes of type omni.graph.TransformBundle
Applies a transform to an input bundle, storing the result in an output bundle
"""
import carb
import numpy
import carb
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnTransformBundleDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.TransformBundle
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.input
inputs.transform
Outputs:
outputs.output
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:input', 'bundle', 0, None, 'Input bundle containing the attributes to be transformed.', {}, True, None, False, ''),
('inputs:transform', 'matrix4d', 0, None, 'The transform to apply to the bundle', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: '[[1.0, 0.0, 0.0, 0.0], [0.0, 1.0, 0.0, 0.0], [0.0, 0.0, 1.0, 0.0], [0.0, 0.0, 0.0, 1.0]]'}, True, [[1.0, 0.0, 0.0, 0.0], [0.0, 1.0, 0.0, 0.0], [0.0, 0.0, 1.0, 0.0], [0.0, 0.0, 0.0, 1.0]], False, ''),
('outputs:output', 'bundle', 0, None, 'Output bundle containing all of the transformed attributes', {}, True, None, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.input = og.AttributeRole.BUNDLE
role_data.inputs.transform = og.AttributeRole.MATRIX
role_data.outputs.output = og.AttributeRole.BUNDLE
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=True, gpu_ptr_kinds={})
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def input(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute inputs.input"""
return self.__bundles.input
@property
def transform(self):
data_view = og.AttributeValueHelper(self._attributes.transform)
return data_view.get()
@transform.setter
def transform(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.transform)
data_view = og.AttributeValueHelper(self._attributes.transform)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=False, gpu_ptr_kinds={})
self._batchedWriteValues = { }
@property
def output(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute outputs.output"""
return self.__bundles.output
@output.setter
def output(self, bundle: og.BundleContents):
"""Overwrite the bundle attribute outputs.output with a new bundle"""
if not isinstance(bundle, og.BundleContents):
carb.log_error("Only bundle attributes can be assigned to another bundle attribute")
self.__bundles.output.bundle = bundle
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnTransformBundleDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnTransformBundleDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnTransformBundleDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 6,555 | Python | 48.666666 | 347 | 0.661937 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/ogn/OgnImportUSDPrimDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ImportUSDPrim
Imports data from a USD prim into attributes in an output bundle
"""
import carb
import numpy
import carb
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnImportUSDPrimDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ImportUSDPrim
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.applySkelBinding
inputs.applyTransform
inputs.attrNamesToImport
inputs.computeBoundingBox
inputs.importAttributes
inputs.importPath
inputs.importPrimvarMetadata
inputs.importTime
inputs.importTransform
inputs.importType
inputs.inputAttrNames
inputs.keepPrimsSeparate
inputs.outputAttrNames
inputs.prim
inputs.renameAttributes
inputs.timeVaryingAttributes
inputs.usdTimecode
Outputs:
outputs.output
State:
state.prevApplySkelBinding
state.prevApplyTransform
state.prevAttrNamesToImport
state.prevComputeBoundingBox
state.prevImportAttributes
state.prevImportPath
state.prevImportPrimvarMetadata
state.prevImportTime
state.prevImportTransform
state.prevImportType
state.prevInputAttrNames
state.prevInvNodeTransform
state.prevKeepPrimsSeparate
state.prevOnlyImportSpecified
state.prevOutputAttrNames
state.prevPaths
state.prevRenameAttributes
state.prevTimeVaryingAttributes
state.prevTransforms
state.prevUsdTimecode
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:applySkelBinding', 'bool', 0, None, 'If the input USD prim is a Mesh, and has SkelBindingAPI schema applied, compute skinned points and normals.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:applyTransform', 'bool', 0, None, 'If importAttributes is true, apply the transform necessary to transform any transforming attributes into the space of this node.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:attrNamesToImport', 'token', 0, 'Attributes To Import', 'Comma or space separated text, listing the names of attributes in the input data to be imported \nor empty to import all attributes.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:computeBoundingBox', 'bool', 0, None, 'Compute and store local bounding box of a prim and its children.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:importAttributes', 'bool', 0, None, 'Import attribute data from the USD prim.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:importPath', 'bool', 0, None, 'Record the input USD prim\'s path into the output bundle in an attribute named "primPath".', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:importPrimvarMetadata', 'bool', 0, None, 'Import metadata like the interpolation type for primvars, and store it as attributes in the output bundle.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:importTime', 'bool', 0, None, 'Record the usdTimecode above into the output bundle in an attribute named "primTime".', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:importTransform', 'bool', 0, None, 'Record the transform required to take any attributes of the input USD prim \ninto the space of this node, i.e. the world transform of the input prim times the \ninverse world transform of this node, into the output bundle in an attribute named "transform".', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:importType', 'bool', 0, None, 'Deprecated, prim type is always imported', {ogn.MetadataKeys.HIDDEN: 'true', 'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:inputAttrNames', 'token', 0, 'Attributes To Rename', 'Comma or space separated text, listing the names of attributes in the input data to be renamed', {ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:keepPrimsSeparate', 'bool', 0, None, 'Prefix output attribute names with "prim" followed by a unique number and a colon, \nto keep the attributes for separate input prims separate. The prim paths will \nbe in the "primPaths" token array attribute.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:outputAttrNames', 'token', 0, 'New Attribute Names', 'Comma or space separated text, listing the new names for the attributes listed in inputAttrNames', {ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:prim', 'bundle', 0, None, 'The USD prim from which to import data.', {}, False, None, False, ''),
('inputs:renameAttributes', 'bool', 0, None, 'If true, attributes listed in "inputAttrNames" will be imported to attributes with the names specified in "outputAttrNames".', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:timeVaryingAttributes', 'bool', 0, None, 'Check whether the USD attributes are time-varying and if so, import their data at the time "usdTimecode".', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:usdTimecode', 'double', 0, None, 'The time at which to evaluate the transform of the USD prim.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: '0'}, True, 0, False, ''),
('outputs:output', 'bundle', 0, None, 'Output bundle containing all of the imported data.', {}, True, None, False, ''),
('state:prevApplySkelBinding', 'bool', 0, None, 'Value of "applySkelBinding" input from previous run', {}, True, None, False, ''),
('state:prevApplyTransform', 'bool', 0, None, 'Value of "applyTransform" input from previous run', {}, True, None, False, ''),
('state:prevAttrNamesToImport', 'token', 0, None, 'Value of "attrNamesToImport" input from previous run', {}, True, None, False, ''),
('state:prevComputeBoundingBox', 'bool', 0, None, 'Value of "computeBoundingBox" input from previous run', {}, True, None, False, ''),
('state:prevImportAttributes', 'bool', 0, None, 'Value of "importAttributes" input from previous run', {}, True, None, False, ''),
('state:prevImportPath', 'bool', 0, None, 'Value of "importPath" input from previous run', {}, True, None, False, ''),
('state:prevImportPrimvarMetadata', 'bool', 0, None, 'Value of "importPrimvarMetadata" input from previous run', {}, True, None, False, ''),
('state:prevImportTime', 'bool', 0, None, 'Value of "importTime" input from previous run', {}, True, None, False, ''),
('state:prevImportTransform', 'bool', 0, None, 'Value of "importTransform" input from previous run', {}, True, None, False, ''),
('state:prevImportType', 'bool', 0, None, 'Value of "importType" input from previous run', {}, True, None, False, ''),
('state:prevInputAttrNames', 'token', 0, None, 'Value of "inputAttrNames" input from previous run', {}, True, None, False, ''),
('state:prevInvNodeTransform', 'matrix4d', 0, None, 'Inverse transform of the node prim from the previous run.', {}, True, None, False, ''),
('state:prevKeepPrimsSeparate', 'bool', 0, None, 'Value of "keepPrimsSeparate" input from previous run', {}, True, None, False, ''),
('state:prevOnlyImportSpecified', 'bool', 0, None, 'Value of "onlyImportSpecified" input from previous run', {}, True, None, False, ''),
('state:prevOutputAttrNames', 'token', 0, None, 'Value of "outputAttrNames" input from previous run', {}, True, None, False, ''),
('state:prevPaths', 'token[]', 0, None, 'Array of paths from the previous run.', {}, True, None, False, ''),
('state:prevRenameAttributes', 'bool', 0, None, 'Value of "renameAttributes" input from previous run', {}, True, None, False, ''),
('state:prevTimeVaryingAttributes', 'bool', 0, None, 'Value of "timeVaryingAttributes" input from previous run', {}, True, None, False, ''),
('state:prevTransforms', 'matrix4d[]', 0, None, 'Array of transforms from the previous run.', {}, True, None, False, ''),
('state:prevUsdTimecode', 'double', 0, None, 'Value of "usdTimecode" input from previous run', {}, True, None, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.prim = og.AttributeRole.BUNDLE
role_data.outputs.output = og.AttributeRole.BUNDLE
role_data.state.prevInvNodeTransform = og.AttributeRole.MATRIX
role_data.state.prevTransforms = og.AttributeRole.MATRIX
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=True, gpu_ptr_kinds={})
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def applySkelBinding(self):
data_view = og.AttributeValueHelper(self._attributes.applySkelBinding)
return data_view.get()
@applySkelBinding.setter
def applySkelBinding(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.applySkelBinding)
data_view = og.AttributeValueHelper(self._attributes.applySkelBinding)
data_view.set(value)
@property
def applyTransform(self):
data_view = og.AttributeValueHelper(self._attributes.applyTransform)
return data_view.get()
@applyTransform.setter
def applyTransform(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.applyTransform)
data_view = og.AttributeValueHelper(self._attributes.applyTransform)
data_view.set(value)
@property
def attrNamesToImport(self):
data_view = og.AttributeValueHelper(self._attributes.attrNamesToImport)
return data_view.get()
@attrNamesToImport.setter
def attrNamesToImport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.attrNamesToImport)
data_view = og.AttributeValueHelper(self._attributes.attrNamesToImport)
data_view.set(value)
@property
def computeBoundingBox(self):
data_view = og.AttributeValueHelper(self._attributes.computeBoundingBox)
return data_view.get()
@computeBoundingBox.setter
def computeBoundingBox(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.computeBoundingBox)
data_view = og.AttributeValueHelper(self._attributes.computeBoundingBox)
data_view.set(value)
@property
def importAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.importAttributes)
return data_view.get()
@importAttributes.setter
def importAttributes(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.importAttributes)
data_view = og.AttributeValueHelper(self._attributes.importAttributes)
data_view.set(value)
@property
def importPath(self):
data_view = og.AttributeValueHelper(self._attributes.importPath)
return data_view.get()
@importPath.setter
def importPath(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.importPath)
data_view = og.AttributeValueHelper(self._attributes.importPath)
data_view.set(value)
@property
def importPrimvarMetadata(self):
data_view = og.AttributeValueHelper(self._attributes.importPrimvarMetadata)
return data_view.get()
@importPrimvarMetadata.setter
def importPrimvarMetadata(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.importPrimvarMetadata)
data_view = og.AttributeValueHelper(self._attributes.importPrimvarMetadata)
data_view.set(value)
@property
def importTime(self):
data_view = og.AttributeValueHelper(self._attributes.importTime)
return data_view.get()
@importTime.setter
def importTime(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.importTime)
data_view = og.AttributeValueHelper(self._attributes.importTime)
data_view.set(value)
@property
def importTransform(self):
data_view = og.AttributeValueHelper(self._attributes.importTransform)
return data_view.get()
@importTransform.setter
def importTransform(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.importTransform)
data_view = og.AttributeValueHelper(self._attributes.importTransform)
data_view.set(value)
@property
def importType(self):
data_view = og.AttributeValueHelper(self._attributes.importType)
return data_view.get()
@importType.setter
def importType(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.importType)
data_view = og.AttributeValueHelper(self._attributes.importType)
data_view.set(value)
@property
def inputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.inputAttrNames)
return data_view.get()
@inputAttrNames.setter
def inputAttrNames(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.inputAttrNames)
data_view = og.AttributeValueHelper(self._attributes.inputAttrNames)
data_view.set(value)
@property
def keepPrimsSeparate(self):
data_view = og.AttributeValueHelper(self._attributes.keepPrimsSeparate)
return data_view.get()
@keepPrimsSeparate.setter
def keepPrimsSeparate(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.keepPrimsSeparate)
data_view = og.AttributeValueHelper(self._attributes.keepPrimsSeparate)
data_view.set(value)
@property
def outputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.outputAttrNames)
return data_view.get()
@outputAttrNames.setter
def outputAttrNames(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.outputAttrNames)
data_view = og.AttributeValueHelper(self._attributes.outputAttrNames)
data_view.set(value)
@property
def prim(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute inputs.prim"""
return self.__bundles.prim
@property
def renameAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.renameAttributes)
return data_view.get()
@renameAttributes.setter
def renameAttributes(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.renameAttributes)
data_view = og.AttributeValueHelper(self._attributes.renameAttributes)
data_view.set(value)
@property
def timeVaryingAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.timeVaryingAttributes)
return data_view.get()
@timeVaryingAttributes.setter
def timeVaryingAttributes(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.timeVaryingAttributes)
data_view = og.AttributeValueHelper(self._attributes.timeVaryingAttributes)
data_view.set(value)
@property
def usdTimecode(self):
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
return data_view.get()
@usdTimecode.setter
def usdTimecode(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usdTimecode)
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=False, gpu_ptr_kinds={})
self._batchedWriteValues = { }
@property
def output(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute outputs.output"""
return self.__bundles.output
@output.setter
def output(self, bundle: og.BundleContents):
"""Overwrite the bundle attribute outputs.output with a new bundle"""
if not isinstance(bundle, og.BundleContents):
carb.log_error("Only bundle attributes can be assigned to another bundle attribute")
self.__bundles.output.bundle = bundle
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.prevPaths_size = None
self.prevTransforms_size = None
@property
def prevApplySkelBinding(self):
data_view = og.AttributeValueHelper(self._attributes.prevApplySkelBinding)
return data_view.get()
@prevApplySkelBinding.setter
def prevApplySkelBinding(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevApplySkelBinding)
data_view.set(value)
@property
def prevApplyTransform(self):
data_view = og.AttributeValueHelper(self._attributes.prevApplyTransform)
return data_view.get()
@prevApplyTransform.setter
def prevApplyTransform(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevApplyTransform)
data_view.set(value)
@property
def prevAttrNamesToImport(self):
data_view = og.AttributeValueHelper(self._attributes.prevAttrNamesToImport)
return data_view.get()
@prevAttrNamesToImport.setter
def prevAttrNamesToImport(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevAttrNamesToImport)
data_view.set(value)
@property
def prevComputeBoundingBox(self):
data_view = og.AttributeValueHelper(self._attributes.prevComputeBoundingBox)
return data_view.get()
@prevComputeBoundingBox.setter
def prevComputeBoundingBox(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevComputeBoundingBox)
data_view.set(value)
@property
def prevImportAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.prevImportAttributes)
return data_view.get()
@prevImportAttributes.setter
def prevImportAttributes(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevImportAttributes)
data_view.set(value)
@property
def prevImportPath(self):
data_view = og.AttributeValueHelper(self._attributes.prevImportPath)
return data_view.get()
@prevImportPath.setter
def prevImportPath(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevImportPath)
data_view.set(value)
@property
def prevImportPrimvarMetadata(self):
data_view = og.AttributeValueHelper(self._attributes.prevImportPrimvarMetadata)
return data_view.get()
@prevImportPrimvarMetadata.setter
def prevImportPrimvarMetadata(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevImportPrimvarMetadata)
data_view.set(value)
@property
def prevImportTime(self):
data_view = og.AttributeValueHelper(self._attributes.prevImportTime)
return data_view.get()
@prevImportTime.setter
def prevImportTime(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevImportTime)
data_view.set(value)
@property
def prevImportTransform(self):
data_view = og.AttributeValueHelper(self._attributes.prevImportTransform)
return data_view.get()
@prevImportTransform.setter
def prevImportTransform(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevImportTransform)
data_view.set(value)
@property
def prevImportType(self):
data_view = og.AttributeValueHelper(self._attributes.prevImportType)
return data_view.get()
@prevImportType.setter
def prevImportType(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevImportType)
data_view.set(value)
@property
def prevInputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.prevInputAttrNames)
return data_view.get()
@prevInputAttrNames.setter
def prevInputAttrNames(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevInputAttrNames)
data_view.set(value)
@property
def prevInvNodeTransform(self):
data_view = og.AttributeValueHelper(self._attributes.prevInvNodeTransform)
return data_view.get()
@prevInvNodeTransform.setter
def prevInvNodeTransform(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevInvNodeTransform)
data_view.set(value)
@property
def prevKeepPrimsSeparate(self):
data_view = og.AttributeValueHelper(self._attributes.prevKeepPrimsSeparate)
return data_view.get()
@prevKeepPrimsSeparate.setter
def prevKeepPrimsSeparate(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevKeepPrimsSeparate)
data_view.set(value)
@property
def prevOnlyImportSpecified(self):
data_view = og.AttributeValueHelper(self._attributes.prevOnlyImportSpecified)
return data_view.get()
@prevOnlyImportSpecified.setter
def prevOnlyImportSpecified(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevOnlyImportSpecified)
data_view.set(value)
@property
def prevOutputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.prevOutputAttrNames)
return data_view.get()
@prevOutputAttrNames.setter
def prevOutputAttrNames(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevOutputAttrNames)
data_view.set(value)
@property
def prevPaths(self):
data_view = og.AttributeValueHelper(self._attributes.prevPaths)
self.prevPaths_size = data_view.get_array_size()
return data_view.get()
@prevPaths.setter
def prevPaths(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevPaths)
data_view.set(value)
self.prevPaths_size = data_view.get_array_size()
@property
def prevRenameAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.prevRenameAttributes)
return data_view.get()
@prevRenameAttributes.setter
def prevRenameAttributes(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevRenameAttributes)
data_view.set(value)
@property
def prevTimeVaryingAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.prevTimeVaryingAttributes)
return data_view.get()
@prevTimeVaryingAttributes.setter
def prevTimeVaryingAttributes(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevTimeVaryingAttributes)
data_view.set(value)
@property
def prevTransforms(self):
data_view = og.AttributeValueHelper(self._attributes.prevTransforms)
self.prevTransforms_size = data_view.get_array_size()
return data_view.get()
@prevTransforms.setter
def prevTransforms(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevTransforms)
data_view.set(value)
self.prevTransforms_size = data_view.get_array_size()
@property
def prevUsdTimecode(self):
data_view = og.AttributeValueHelper(self._attributes.prevUsdTimecode)
return data_view.get()
@prevUsdTimecode.setter
def prevUsdTimecode(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevUsdTimecode)
data_view.set(value)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnImportUSDPrimDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnImportUSDPrimDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnImportUSDPrimDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 29,375 | Python | 48.78983 | 401 | 0.654672 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/ogn/OgnExportUSDPrimDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ExportUSDPrim
Exports data from an input bundle into a USD prim
"""
import carb
import numpy
import carb
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnExportUSDPrimDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ExportUSDPrim
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.applyTransform
inputs.attrNamesToExport
inputs.bundle
inputs.excludedAttrNames
inputs.exportToRootLayer
inputs.inputAttrNames
inputs.layerName
inputs.onlyExportToExisting
inputs.outputAttrNames
inputs.primPathFromBundle
inputs.removeMissingAttrs
inputs.renameAttributes
inputs.timeVaryingAttributes
inputs.usdTimecode
Outputs:
outputs.prim
State:
state.prevApplyTransform
state.prevAttrNamesToExport
state.prevBundleDirtyID
state.prevExcludedAttrNames
state.prevExportToRootLayer
state.prevInputAttrNames
state.prevLayerName
state.prevOnlyExportToExisting
state.prevOutputAttrNames
state.prevPrimDirtyIDs
state.prevPrimPathFromBundle
state.prevRemoveMissingAttrs
state.prevRenameAttributes
state.prevTimeVaryingAttributes
state.prevUsdTimecode
Predefined Tokens:
tokens.primPath
tokens.primType
tokens.primTime
tokens.primCount
tokens.transform
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:applyTransform', 'bool', 0, None, 'If true, apply the transform necessary to transform any transforming attributes from the space of the node into the space of the specified prim.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:attrNamesToExport', 'token', 0, 'Attributes To Export', 'Comma or space separated text, listing the names of attributes in the input data to be exported \nor empty to import all attributes.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:bundle', 'bundle', 0, None, 'The bundle from which data should be exported.', {}, True, None, False, ''),
('inputs:excludedAttrNames', 'token', 0, 'Attributes To Exclude', 'Attributes to be excluded from being exported', {ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:exportToRootLayer', 'bool', 0, 'Export to Root Layer', 'If true, prims are exported in the root layer, otherwise the layer specified by "layerName" is used.', {ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:inputAttrNames', 'token', 0, 'Attributes To Rename', 'Comma or space separated text, listing the names of attributes in the input data to be renamed', {ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:layerName', 'token', 0, 'Layer Name', 'Identifier of the layer to export to if "exportToRootLayer" is false, or leave this blank to export to the session layer', {ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:onlyExportToExisting', 'bool', 0, None, 'If true, only attributes that already exist in the specified output prim will have data transferred to them from the input bundle.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:outputAttrNames', 'token', 0, 'New Attribute Names', 'Comma or space separated text, listing the new names for the attributes listed in inputAttrNames', {ogn.MetadataKeys.DEFAULT: '""'}, True, "", False, ''),
('inputs:primPathFromBundle', 'bool', 0, None, 'When true, if there is a "primPath" token attribute inside the bundle, that will be the path of the USD prim to write to, \nelse the "outputs:prim" attribute below will be used for the USD prim path.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:removeMissingAttrs', 'bool', 0, 'Export to Root Layer', "If true, any attributes on the USD prim(s) being written to, that aren't in the input data, \nwill be removed from the USD prim(s).", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:renameAttributes', 'bool', 0, None, 'If true, attributes listed in "inputAttrNames" will be exported to attributes with the names specified in "outputAttrNames". \nNote: to avoid potential issues with redundant attributes being created while typing, keep this off until after \nspecifying all input and output attribute names.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:timeVaryingAttributes', 'bool', 0, None, 'Check whether the USD attributes should be time-varying and if so, export their data to a time sample at the time "usdTimecode".', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:usdTimecode', 'double', 0, None, 'The time at which to evaluate the transform of the USD prim for applyTransform.', {'displayGroup': 'parameters', ogn.MetadataKeys.DEFAULT: '0'}, True, 0, False, ''),
('outputs:prim', 'bundle', 0, None, 'The USD prim(s) to which data should be exported if primPathFromBundle is false or if the bundle doesn\'t have a "primPath" token attribute. \nNote: this is really an input, since the node just receives the path to the prim. The node does not contain the prim.', {ogn.MetadataKeys.HIDDEN: 'true'}, False, None, False, ''),
('state:prevApplyTransform', 'bool', 0, None, 'Value of "applyTransform" input from previous run', {}, True, None, False, ''),
('state:prevAttrNamesToExport', 'token', 0, None, 'Value of "attrNamesToExport" input from previous run', {}, True, None, False, ''),
('state:prevBundleDirtyID', 'uint64', 0, None, 'Dirty ID of input bundle from previous run', {}, True, None, False, ''),
('state:prevExcludedAttrNames', 'token', 0, None, 'Value of "excludedAttrNames" input from previous run', {}, True, None, False, ''),
('state:prevExportToRootLayer', 'bool', 0, None, 'Value of "exportToRootLayer" input from previous run', {}, True, None, False, ''),
('state:prevInputAttrNames', 'token', 0, None, 'Value of "inputAttrNames" input from previous run', {}, True, None, False, ''),
('state:prevLayerName', 'token', 0, None, 'Value of "layerName" input from previous run', {}, True, None, False, ''),
('state:prevOnlyExportToExisting', 'bool', 0, None, 'Value of "onlyExportToExisting" input from previous run', {}, True, None, False, ''),
('state:prevOutputAttrNames', 'token', 0, None, 'Value of "outputAttrNames" input from previous run', {}, True, None, False, ''),
('state:prevPrimDirtyIDs', 'uint64[]', 0, None, 'Dirty IDs of input prims from previous run', {}, True, None, False, ''),
('state:prevPrimPathFromBundle', 'bool', 0, None, 'Value of "primPathFromBundle" input from previous run', {}, True, None, False, ''),
('state:prevRemoveMissingAttrs', 'bool', 0, None, 'Value of "removeMissingAttrs" input from previous run', {}, True, None, False, ''),
('state:prevRenameAttributes', 'bool', 0, None, 'Value of "renameAttributes" input from previous run', {}, True, None, False, ''),
('state:prevTimeVaryingAttributes', 'bool', 0, None, 'Value of "timeVaryingAttributes" input from previous run', {}, True, None, False, ''),
('state:prevUsdTimecode', 'double', 0, None, 'Value of "usdTimecode" input from previous run', {}, True, None, False, ''),
])
class tokens:
primPath = "primPath"
primType = "primType"
primTime = "primTime"
primCount = "primCount"
transform = "transform"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.bundle = og.AttributeRole.BUNDLE
role_data.outputs.prim = og.AttributeRole.BUNDLE
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=True, gpu_ptr_kinds={})
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def applyTransform(self):
data_view = og.AttributeValueHelper(self._attributes.applyTransform)
return data_view.get()
@applyTransform.setter
def applyTransform(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.applyTransform)
data_view = og.AttributeValueHelper(self._attributes.applyTransform)
data_view.set(value)
@property
def attrNamesToExport(self):
data_view = og.AttributeValueHelper(self._attributes.attrNamesToExport)
return data_view.get()
@attrNamesToExport.setter
def attrNamesToExport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.attrNamesToExport)
data_view = og.AttributeValueHelper(self._attributes.attrNamesToExport)
data_view.set(value)
@property
def bundle(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute inputs.bundle"""
return self.__bundles.bundle
@property
def excludedAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.excludedAttrNames)
return data_view.get()
@excludedAttrNames.setter
def excludedAttrNames(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.excludedAttrNames)
data_view = og.AttributeValueHelper(self._attributes.excludedAttrNames)
data_view.set(value)
@property
def exportToRootLayer(self):
data_view = og.AttributeValueHelper(self._attributes.exportToRootLayer)
return data_view.get()
@exportToRootLayer.setter
def exportToRootLayer(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.exportToRootLayer)
data_view = og.AttributeValueHelper(self._attributes.exportToRootLayer)
data_view.set(value)
@property
def inputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.inputAttrNames)
return data_view.get()
@inputAttrNames.setter
def inputAttrNames(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.inputAttrNames)
data_view = og.AttributeValueHelper(self._attributes.inputAttrNames)
data_view.set(value)
@property
def layerName(self):
data_view = og.AttributeValueHelper(self._attributes.layerName)
return data_view.get()
@layerName.setter
def layerName(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.layerName)
data_view = og.AttributeValueHelper(self._attributes.layerName)
data_view.set(value)
@property
def onlyExportToExisting(self):
data_view = og.AttributeValueHelper(self._attributes.onlyExportToExisting)
return data_view.get()
@onlyExportToExisting.setter
def onlyExportToExisting(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.onlyExportToExisting)
data_view = og.AttributeValueHelper(self._attributes.onlyExportToExisting)
data_view.set(value)
@property
def outputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.outputAttrNames)
return data_view.get()
@outputAttrNames.setter
def outputAttrNames(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.outputAttrNames)
data_view = og.AttributeValueHelper(self._attributes.outputAttrNames)
data_view.set(value)
@property
def primPathFromBundle(self):
data_view = og.AttributeValueHelper(self._attributes.primPathFromBundle)
return data_view.get()
@primPathFromBundle.setter
def primPathFromBundle(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.primPathFromBundle)
data_view = og.AttributeValueHelper(self._attributes.primPathFromBundle)
data_view.set(value)
@property
def removeMissingAttrs(self):
data_view = og.AttributeValueHelper(self._attributes.removeMissingAttrs)
return data_view.get()
@removeMissingAttrs.setter
def removeMissingAttrs(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.removeMissingAttrs)
data_view = og.AttributeValueHelper(self._attributes.removeMissingAttrs)
data_view.set(value)
@property
def renameAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.renameAttributes)
return data_view.get()
@renameAttributes.setter
def renameAttributes(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.renameAttributes)
data_view = og.AttributeValueHelper(self._attributes.renameAttributes)
data_view.set(value)
@property
def timeVaryingAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.timeVaryingAttributes)
return data_view.get()
@timeVaryingAttributes.setter
def timeVaryingAttributes(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.timeVaryingAttributes)
data_view = og.AttributeValueHelper(self._attributes.timeVaryingAttributes)
data_view.set(value)
@property
def usdTimecode(self):
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
return data_view.get()
@usdTimecode.setter
def usdTimecode(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usdTimecode)
data_view = og.AttributeValueHelper(self._attributes.usdTimecode)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.__bundles = og.BundleContainer(context, node, attributes, [], read_only=False, gpu_ptr_kinds={})
self._batchedWriteValues = { }
@property
def prim(self) -> og.BundleContents:
"""Get the bundle wrapper class for the attribute outputs.prim"""
return self.__bundles.prim
@prim.setter
def prim(self, bundle: og.BundleContents):
"""Overwrite the bundle attribute outputs.prim with a new bundle"""
if not isinstance(bundle, og.BundleContents):
carb.log_error("Only bundle attributes can be assigned to another bundle attribute")
self.__bundles.prim.bundle = bundle
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.prevPrimDirtyIDs_size = None
@property
def prevApplyTransform(self):
data_view = og.AttributeValueHelper(self._attributes.prevApplyTransform)
return data_view.get()
@prevApplyTransform.setter
def prevApplyTransform(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevApplyTransform)
data_view.set(value)
@property
def prevAttrNamesToExport(self):
data_view = og.AttributeValueHelper(self._attributes.prevAttrNamesToExport)
return data_view.get()
@prevAttrNamesToExport.setter
def prevAttrNamesToExport(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevAttrNamesToExport)
data_view.set(value)
@property
def prevBundleDirtyID(self):
data_view = og.AttributeValueHelper(self._attributes.prevBundleDirtyID)
return data_view.get()
@prevBundleDirtyID.setter
def prevBundleDirtyID(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevBundleDirtyID)
data_view.set(value)
@property
def prevExcludedAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.prevExcludedAttrNames)
return data_view.get()
@prevExcludedAttrNames.setter
def prevExcludedAttrNames(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevExcludedAttrNames)
data_view.set(value)
@property
def prevExportToRootLayer(self):
data_view = og.AttributeValueHelper(self._attributes.prevExportToRootLayer)
return data_view.get()
@prevExportToRootLayer.setter
def prevExportToRootLayer(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevExportToRootLayer)
data_view.set(value)
@property
def prevInputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.prevInputAttrNames)
return data_view.get()
@prevInputAttrNames.setter
def prevInputAttrNames(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevInputAttrNames)
data_view.set(value)
@property
def prevLayerName(self):
data_view = og.AttributeValueHelper(self._attributes.prevLayerName)
return data_view.get()
@prevLayerName.setter
def prevLayerName(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevLayerName)
data_view.set(value)
@property
def prevOnlyExportToExisting(self):
data_view = og.AttributeValueHelper(self._attributes.prevOnlyExportToExisting)
return data_view.get()
@prevOnlyExportToExisting.setter
def prevOnlyExportToExisting(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevOnlyExportToExisting)
data_view.set(value)
@property
def prevOutputAttrNames(self):
data_view = og.AttributeValueHelper(self._attributes.prevOutputAttrNames)
return data_view.get()
@prevOutputAttrNames.setter
def prevOutputAttrNames(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevOutputAttrNames)
data_view.set(value)
@property
def prevPrimDirtyIDs(self):
data_view = og.AttributeValueHelper(self._attributes.prevPrimDirtyIDs)
self.prevPrimDirtyIDs_size = data_view.get_array_size()
return data_view.get()
@prevPrimDirtyIDs.setter
def prevPrimDirtyIDs(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevPrimDirtyIDs)
data_view.set(value)
self.prevPrimDirtyIDs_size = data_view.get_array_size()
@property
def prevPrimPathFromBundle(self):
data_view = og.AttributeValueHelper(self._attributes.prevPrimPathFromBundle)
return data_view.get()
@prevPrimPathFromBundle.setter
def prevPrimPathFromBundle(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevPrimPathFromBundle)
data_view.set(value)
@property
def prevRemoveMissingAttrs(self):
data_view = og.AttributeValueHelper(self._attributes.prevRemoveMissingAttrs)
return data_view.get()
@prevRemoveMissingAttrs.setter
def prevRemoveMissingAttrs(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevRemoveMissingAttrs)
data_view.set(value)
@property
def prevRenameAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.prevRenameAttributes)
return data_view.get()
@prevRenameAttributes.setter
def prevRenameAttributes(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevRenameAttributes)
data_view.set(value)
@property
def prevTimeVaryingAttributes(self):
data_view = og.AttributeValueHelper(self._attributes.prevTimeVaryingAttributes)
return data_view.get()
@prevTimeVaryingAttributes.setter
def prevTimeVaryingAttributes(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevTimeVaryingAttributes)
data_view.set(value)
@property
def prevUsdTimecode(self):
data_view = og.AttributeValueHelper(self._attributes.prevUsdTimecode)
return data_view.get()
@prevUsdTimecode.setter
def prevUsdTimecode(self, value):
data_view = og.AttributeValueHelper(self._attributes.prevUsdTimecode)
data_view.set(value)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnExportUSDPrimDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnExportUSDPrimDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnExportUSDPrimDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 24,954 | Python | 49.211268 | 437 | 0.658852 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/ogn/tests/TestOgnImportUSDPrim.py | import os
import omni.kit.test
import omni.graph.core as og
import omni.graph.core.tests as ogts
from omni.graph.core.tests.omnigraph_test_utils import _TestGraphAndNode
from omni.graph.core.tests.omnigraph_test_utils import _test_clear_scene
from omni.graph.core.tests.omnigraph_test_utils import _test_setup_scene
from omni.graph.core.tests.omnigraph_test_utils import _test_verify_scene
class TestOgn(ogts.OmniGraphTestCase):
async def test_data_access(self):
from omni.graph.io.ogn.OgnImportUSDPrimDatabase import OgnImportUSDPrimDatabase
test_file_name = "OgnImportUSDPrimTemplate.usda"
usd_path = os.path.join(os.path.dirname(__file__), "usd", test_file_name)
if not os.path.exists(usd_path):
self.assertTrue(False, f"{usd_path} not found for loading test")
(result, error) = await ogts.load_test_file(usd_path)
self.assertTrue(result, f'{error} on {usd_path}')
test_node = og.Controller.node("/TestGraph/Template_omni_graph_ImportUSDPrim")
database = OgnImportUSDPrimDatabase(test_node)
self.assertTrue(test_node.is_valid())
node_type_name = test_node.get_type_name()
self.assertEqual(og.GraphRegistry().get_node_type_version(node_type_name), 1)
def _attr_error(attribute: og.Attribute, usd_test: bool) -> str:
test_type = "USD Load" if usd_test else "Database Access"
return f"{node_type_name} {test_type} Test - {attribute.get_name()} value error"
self.assertTrue(test_node.get_attribute_exists("inputs:applySkelBinding"))
attribute = test_node.get_attribute("inputs:applySkelBinding")
db_value = database.inputs.applySkelBinding
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:applyTransform"))
attribute = test_node.get_attribute("inputs:applyTransform")
db_value = database.inputs.applyTransform
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:attrNamesToImport"))
attribute = test_node.get_attribute("inputs:attrNamesToImport")
db_value = database.inputs.attrNamesToImport
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:computeBoundingBox"))
attribute = test_node.get_attribute("inputs:computeBoundingBox")
db_value = database.inputs.computeBoundingBox
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:importAttributes"))
attribute = test_node.get_attribute("inputs:importAttributes")
db_value = database.inputs.importAttributes
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:importPath"))
attribute = test_node.get_attribute("inputs:importPath")
db_value = database.inputs.importPath
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:importPrimvarMetadata"))
attribute = test_node.get_attribute("inputs:importPrimvarMetadata")
db_value = database.inputs.importPrimvarMetadata
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:importTime"))
attribute = test_node.get_attribute("inputs:importTime")
db_value = database.inputs.importTime
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:importTransform"))
attribute = test_node.get_attribute("inputs:importTransform")
db_value = database.inputs.importTransform
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:importType"))
attribute = test_node.get_attribute("inputs:importType")
db_value = database.inputs.importType
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:inputAttrNames"))
attribute = test_node.get_attribute("inputs:inputAttrNames")
db_value = database.inputs.inputAttrNames
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:keepPrimsSeparate"))
attribute = test_node.get_attribute("inputs:keepPrimsSeparate")
db_value = database.inputs.keepPrimsSeparate
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:outputAttrNames"))
attribute = test_node.get_attribute("inputs:outputAttrNames")
db_value = database.inputs.outputAttrNames
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:renameAttributes"))
attribute = test_node.get_attribute("inputs:renameAttributes")
db_value = database.inputs.renameAttributes
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:timeVaryingAttributes"))
attribute = test_node.get_attribute("inputs:timeVaryingAttributes")
db_value = database.inputs.timeVaryingAttributes
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:usdTimecode"))
attribute = test_node.get_attribute("inputs:usdTimecode")
db_value = database.inputs.usdTimecode
expected_value = 0
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("outputs_output"))
attribute = test_node.get_attribute("outputs_output")
db_value = database.outputs.output
self.assertTrue(test_node.get_attribute_exists("state:prevApplySkelBinding"))
attribute = test_node.get_attribute("state:prevApplySkelBinding")
db_value = database.state.prevApplySkelBinding
self.assertTrue(test_node.get_attribute_exists("state:prevApplyTransform"))
attribute = test_node.get_attribute("state:prevApplyTransform")
db_value = database.state.prevApplyTransform
self.assertTrue(test_node.get_attribute_exists("state:prevAttrNamesToImport"))
attribute = test_node.get_attribute("state:prevAttrNamesToImport")
db_value = database.state.prevAttrNamesToImport
self.assertTrue(test_node.get_attribute_exists("state:prevComputeBoundingBox"))
attribute = test_node.get_attribute("state:prevComputeBoundingBox")
db_value = database.state.prevComputeBoundingBox
self.assertTrue(test_node.get_attribute_exists("state:prevImportAttributes"))
attribute = test_node.get_attribute("state:prevImportAttributes")
db_value = database.state.prevImportAttributes
self.assertTrue(test_node.get_attribute_exists("state:prevImportPath"))
attribute = test_node.get_attribute("state:prevImportPath")
db_value = database.state.prevImportPath
self.assertTrue(test_node.get_attribute_exists("state:prevImportPrimvarMetadata"))
attribute = test_node.get_attribute("state:prevImportPrimvarMetadata")
db_value = database.state.prevImportPrimvarMetadata
self.assertTrue(test_node.get_attribute_exists("state:prevImportTime"))
attribute = test_node.get_attribute("state:prevImportTime")
db_value = database.state.prevImportTime
self.assertTrue(test_node.get_attribute_exists("state:prevImportTransform"))
attribute = test_node.get_attribute("state:prevImportTransform")
db_value = database.state.prevImportTransform
self.assertTrue(test_node.get_attribute_exists("state:prevImportType"))
attribute = test_node.get_attribute("state:prevImportType")
db_value = database.state.prevImportType
self.assertTrue(test_node.get_attribute_exists("state:prevInputAttrNames"))
attribute = test_node.get_attribute("state:prevInputAttrNames")
db_value = database.state.prevInputAttrNames
self.assertTrue(test_node.get_attribute_exists("state:prevInvNodeTransform"))
attribute = test_node.get_attribute("state:prevInvNodeTransform")
db_value = database.state.prevInvNodeTransform
self.assertTrue(test_node.get_attribute_exists("state:prevKeepPrimsSeparate"))
attribute = test_node.get_attribute("state:prevKeepPrimsSeparate")
db_value = database.state.prevKeepPrimsSeparate
self.assertTrue(test_node.get_attribute_exists("state:prevOnlyImportSpecified"))
attribute = test_node.get_attribute("state:prevOnlyImportSpecified")
db_value = database.state.prevOnlyImportSpecified
self.assertTrue(test_node.get_attribute_exists("state:prevOutputAttrNames"))
attribute = test_node.get_attribute("state:prevOutputAttrNames")
db_value = database.state.prevOutputAttrNames
self.assertTrue(test_node.get_attribute_exists("state:prevPaths"))
attribute = test_node.get_attribute("state:prevPaths")
db_value = database.state.prevPaths
self.assertTrue(test_node.get_attribute_exists("state:prevRenameAttributes"))
attribute = test_node.get_attribute("state:prevRenameAttributes")
db_value = database.state.prevRenameAttributes
self.assertTrue(test_node.get_attribute_exists("state:prevTimeVaryingAttributes"))
attribute = test_node.get_attribute("state:prevTimeVaryingAttributes")
db_value = database.state.prevTimeVaryingAttributes
self.assertTrue(test_node.get_attribute_exists("state:prevTransforms"))
attribute = test_node.get_attribute("state:prevTransforms")
db_value = database.state.prevTransforms
self.assertTrue(test_node.get_attribute_exists("state:prevUsdTimecode"))
attribute = test_node.get_attribute("state:prevUsdTimecode")
db_value = database.state.prevUsdTimecode
| 13,220 | Python | 53.407407 | 92 | 0.709834 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/ogn/tests/TestOgnExportUSDPrim.py | import os
import omni.kit.test
import omni.graph.core as og
import omni.graph.core.tests as ogts
from omni.graph.core.tests.omnigraph_test_utils import _TestGraphAndNode
from omni.graph.core.tests.omnigraph_test_utils import _test_clear_scene
from omni.graph.core.tests.omnigraph_test_utils import _test_setup_scene
from omni.graph.core.tests.omnigraph_test_utils import _test_verify_scene
class TestOgn(ogts.OmniGraphTestCase):
async def test_data_access(self):
from omni.graph.io.ogn.OgnExportUSDPrimDatabase import OgnExportUSDPrimDatabase
test_file_name = "OgnExportUSDPrimTemplate.usda"
usd_path = os.path.join(os.path.dirname(__file__), "usd", test_file_name)
if not os.path.exists(usd_path):
self.assertTrue(False, f"{usd_path} not found for loading test")
(result, error) = await ogts.load_test_file(usd_path)
self.assertTrue(result, f'{error} on {usd_path}')
test_node = og.Controller.node("/TestGraph/Template_omni_graph_ExportUSDPrim")
database = OgnExportUSDPrimDatabase(test_node)
self.assertTrue(test_node.is_valid())
node_type_name = test_node.get_type_name()
self.assertEqual(og.GraphRegistry().get_node_type_version(node_type_name), 1)
def _attr_error(attribute: og.Attribute, usd_test: bool) -> str:
test_type = "USD Load" if usd_test else "Database Access"
return f"{node_type_name} {test_type} Test - {attribute.get_name()} value error"
self.assertTrue(test_node.get_attribute_exists("inputs:applyTransform"))
attribute = test_node.get_attribute("inputs:applyTransform")
db_value = database.inputs.applyTransform
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:attrNamesToExport"))
attribute = test_node.get_attribute("inputs:attrNamesToExport")
db_value = database.inputs.attrNamesToExport
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:bundle"))
attribute = test_node.get_attribute("inputs:bundle")
db_value = database.inputs.bundle
self.assertTrue(test_node.get_attribute_exists("inputs:excludedAttrNames"))
attribute = test_node.get_attribute("inputs:excludedAttrNames")
db_value = database.inputs.excludedAttrNames
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:exportToRootLayer"))
attribute = test_node.get_attribute("inputs:exportToRootLayer")
db_value = database.inputs.exportToRootLayer
expected_value = True
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:inputAttrNames"))
attribute = test_node.get_attribute("inputs:inputAttrNames")
db_value = database.inputs.inputAttrNames
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:layerName"))
attribute = test_node.get_attribute("inputs:layerName")
db_value = database.inputs.layerName
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:onlyExportToExisting"))
attribute = test_node.get_attribute("inputs:onlyExportToExisting")
db_value = database.inputs.onlyExportToExisting
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:outputAttrNames"))
attribute = test_node.get_attribute("inputs:outputAttrNames")
db_value = database.inputs.outputAttrNames
expected_value = ""
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:primPathFromBundle"))
attribute = test_node.get_attribute("inputs:primPathFromBundle")
db_value = database.inputs.primPathFromBundle
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:removeMissingAttrs"))
attribute = test_node.get_attribute("inputs:removeMissingAttrs")
db_value = database.inputs.removeMissingAttrs
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:renameAttributes"))
attribute = test_node.get_attribute("inputs:renameAttributes")
db_value = database.inputs.renameAttributes
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:timeVaryingAttributes"))
attribute = test_node.get_attribute("inputs:timeVaryingAttributes")
db_value = database.inputs.timeVaryingAttributes
expected_value = False
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("inputs:usdTimecode"))
attribute = test_node.get_attribute("inputs:usdTimecode")
db_value = database.inputs.usdTimecode
expected_value = 0
actual_value = og.Controller.get(attribute)
ogts.verify_values(expected_value, actual_value, _attr_error(attribute, True))
ogts.verify_values(expected_value, db_value, _attr_error(attribute, False))
self.assertTrue(test_node.get_attribute_exists("state:prevApplyTransform"))
attribute = test_node.get_attribute("state:prevApplyTransform")
db_value = database.state.prevApplyTransform
self.assertTrue(test_node.get_attribute_exists("state:prevAttrNamesToExport"))
attribute = test_node.get_attribute("state:prevAttrNamesToExport")
db_value = database.state.prevAttrNamesToExport
self.assertTrue(test_node.get_attribute_exists("state:prevBundleDirtyID"))
attribute = test_node.get_attribute("state:prevBundleDirtyID")
db_value = database.state.prevBundleDirtyID
self.assertTrue(test_node.get_attribute_exists("state:prevExcludedAttrNames"))
attribute = test_node.get_attribute("state:prevExcludedAttrNames")
db_value = database.state.prevExcludedAttrNames
self.assertTrue(test_node.get_attribute_exists("state:prevExportToRootLayer"))
attribute = test_node.get_attribute("state:prevExportToRootLayer")
db_value = database.state.prevExportToRootLayer
self.assertTrue(test_node.get_attribute_exists("state:prevInputAttrNames"))
attribute = test_node.get_attribute("state:prevInputAttrNames")
db_value = database.state.prevInputAttrNames
self.assertTrue(test_node.get_attribute_exists("state:prevLayerName"))
attribute = test_node.get_attribute("state:prevLayerName")
db_value = database.state.prevLayerName
self.assertTrue(test_node.get_attribute_exists("state:prevOnlyExportToExisting"))
attribute = test_node.get_attribute("state:prevOnlyExportToExisting")
db_value = database.state.prevOnlyExportToExisting
self.assertTrue(test_node.get_attribute_exists("state:prevOutputAttrNames"))
attribute = test_node.get_attribute("state:prevOutputAttrNames")
db_value = database.state.prevOutputAttrNames
self.assertTrue(test_node.get_attribute_exists("state:prevPrimDirtyIDs"))
attribute = test_node.get_attribute("state:prevPrimDirtyIDs")
db_value = database.state.prevPrimDirtyIDs
self.assertTrue(test_node.get_attribute_exists("state:prevPrimPathFromBundle"))
attribute = test_node.get_attribute("state:prevPrimPathFromBundle")
db_value = database.state.prevPrimPathFromBundle
self.assertTrue(test_node.get_attribute_exists("state:prevRemoveMissingAttrs"))
attribute = test_node.get_attribute("state:prevRemoveMissingAttrs")
db_value = database.state.prevRemoveMissingAttrs
self.assertTrue(test_node.get_attribute_exists("state:prevRenameAttributes"))
attribute = test_node.get_attribute("state:prevRenameAttributes")
db_value = database.state.prevRenameAttributes
self.assertTrue(test_node.get_attribute_exists("state:prevTimeVaryingAttributes"))
attribute = test_node.get_attribute("state:prevTimeVaryingAttributes")
db_value = database.state.prevTimeVaryingAttributes
self.assertTrue(test_node.get_attribute_exists("state:prevUsdTimecode"))
attribute = test_node.get_attribute("state:prevUsdTimecode")
db_value = database.state.prevUsdTimecode
| 10,861 | Python | 53.582914 | 92 | 0.710524 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/_impl/extension.py | """Support required by the Carbonite extension loader"""
import omni.ext
from ..bindings._omni_graph_io import acquire_interface as _acquire_interface # noqa: PLE0402
from ..bindings._omni_graph_io import release_interface as _release_interface # noqa: PLE0402
class _PublicExtension(omni.ext.IExt):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.__interface = None
try:
import omni.graph.ui as ogu
ogu.ComputeNodeWidget.get_instance().add_template_path(__file__)
except ImportError:
pass
def on_startup(self, ext_id):
self.__interface = _acquire_interface()
def on_shutdown(self):
if self.__interface is not None:
_release_interface(self.__interface)
self.__interface = None
| 833 | Python | 31.076922 | 94 | 0.631453 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/_impl/templates/template_omni.graph.ImportUSDPrim.py | from omni.kit.property.usd.custom_layout_helper import CustomLayoutFrame, CustomLayoutGroup, CustomLayoutProperty
class CustomLayout:
def __init__(self, compute_node_widget):
# print("\nInside template_omni.genproc.ImportUSDPrim.py, CustomLayout:__init__\n");
# Enable template
self.enable = True
self.compute_node_widget = compute_node_widget
self.compute_node_widget.get_bundles()
bundle_items_iter = iter(self.compute_node_widget.bundles.items())
_ = next(bundle_items_iter)[1][0].get_attribute_names_and_types()
def apply(self, props):
frame = CustomLayoutFrame(hide_extra=True)
with frame:
with CustomLayoutGroup("Import Parameters"):
CustomLayoutProperty("inputs:prim", "Prim(s) to Import")
CustomLayoutProperty("inputs:usdTimecode", "Timecode")
CustomLayoutProperty("inputs:keepPrimsSeparate", "Allow Multiple Prims")
CustomLayoutProperty("inputs:importTransform", "Import Transforms")
CustomLayoutProperty("inputs:computeBoundingBox", "Compute Bounding Boxes")
CustomLayoutProperty("inputs:importType", "Import Types")
CustomLayoutProperty("inputs:importPath", "Import Paths")
CustomLayoutProperty("inputs:importTime", "Import Time")
with CustomLayoutGroup("Attributes"):
CustomLayoutProperty("inputs:importAttributes", "Import Attributes")
CustomLayoutProperty("inputs:attrNamesToImport", "Attributes to Import")
CustomLayoutProperty("inputs:renameAttributes", "Rename Attributes")
CustomLayoutProperty("inputs:inputAttrNames", "Attributes to Rename")
CustomLayoutProperty("inputs:outputAttrNames", "New Attribute Names")
CustomLayoutProperty("inputs:applyTransform", "Transform Attributes")
CustomLayoutProperty("inputs:timeVaryingAttributes", "Time Varying Attributes")
CustomLayoutProperty("inputs:importPrimvarMetadata", "Import Metadata")
CustomLayoutProperty("inputs:applySkelBinding", "Apply SkelBinding")
return frame.apply(props)
# print("\nIn template_omni.graph.ImportUSDPrim.py\n")
| 2,295 | Python | 52.395348 | 113 | 0.672331 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/_impl/templates/template_omni.graph.ExportUSDPrim.py | from omni.kit.property.usd.custom_layout_helper import CustomLayoutFrame, CustomLayoutGroup, CustomLayoutProperty
class CustomLayout:
def __init__(self, compute_node_widget):
# print("\nInside template_omni.genproc.ExportUSDPrim.py, CustomLayout:__init__\n");
# Enable template
self.enable = True
self.compute_node_widget = compute_node_widget
self.compute_node_widget.get_bundles()
bundle_items_iter = iter(self.compute_node_widget.bundles.items())
_ = next(bundle_items_iter)[1][0].get_attribute_names_and_types()
def apply(self, props):
frame = CustomLayoutFrame(hide_extra=True)
with frame:
with CustomLayoutGroup("Export Parameters"):
CustomLayoutProperty("outputs:prim", "Prim(s) to Export to")
CustomLayoutProperty("inputs:bundle", "Source Data")
CustomLayoutProperty("inputs:primPathFromBundle", "Export to primPath from Source")
CustomLayoutProperty("inputs:exportToRootLayer", "Export to Root Layer")
CustomLayoutProperty("inputs:layerName", "Layer Name")
with CustomLayoutGroup("Attributes"):
CustomLayoutProperty("inputs:attrNamesToExport", "Attributes to Export")
CustomLayoutProperty("inputs:onlyExportToExisting", "Only Export Existing")
CustomLayoutProperty("inputs:removeMissingAttrs", "Remove Missing")
CustomLayoutProperty("inputs:renameAttributes", "Rename Attributes")
CustomLayoutProperty("inputs:inputAttrNames", "Attributes to Rename")
CustomLayoutProperty("inputs:outputAttrNames", "New Attribute Names")
CustomLayoutProperty("inputs:excludedAttrNames", "Attributes to Exclude")
CustomLayoutProperty("inputs:applyTransform", "Transform Attributes")
CustomLayoutProperty("inputs:timeVaryingAttributes", "Time-varying Attributes")
CustomLayoutProperty("inputs:usdTimecode", "USD Time")
return frame.apply(props)
# print("\nIn template_omni.graph.ExportUSDPrim.py\n")
| 2,150 | Python | 51.463413 | 113 | 0.672093 |
omniverse-code/kit/exts/omni.graph.io/omni/graph/io/tests/test_prim_data_import_export.py | import omni.graph.core as ogc
import omni.kit.test
class TestPrimDataImportExport(ogc.tests.OmniGraphTestCase):
"""Run a unit test to validate data flow through bundles."""
TEST_GRAPH_PATH = "/TestGraph"
TRANSLATE = (10.0, 20.0, 30.0)
ROTATE = (90.0, 180.0, 270.0)
SCALE = (400.0, 500.0, 600.0)
async def setUp(self):
"""Set up test environment, to be torn down when done"""
await super().setUp()
self.controller = ogc.Controller()
self.graph = self.controller.create_graph(self.TEST_GRAPH_PATH)
self.context = self.graph.get_default_graph_context()
# Create ImportUSDPrim and ExportUSDPrim and connect them together.
(self.graph, (self.importNode, self.exportNode), _, _,) = self.controller.edit(
self.TEST_GRAPH_PATH,
{
ogc.Controller.Keys.CREATE_NODES: [
("import_usd_prim_data", "omni.graph.ImportUSDPrim"),
("export_usd_prim_data", "omni.graph.ExportUSDPrim"),
],
ogc.Controller.Keys.CONNECT: [
(
"import_usd_prim_data.outputs_output",
"export_usd_prim_data.inputs:bundle",
)
],
},
)
stage = omni.usd.get_context().get_stage()
# Create two Xform nodes, one as input, the other as output.
self.input_prim = ogc.Controller.create_prim("/input_prim", {}, "Xform")
self.output_prim = ogc.Controller.create_prim("/output_prim", {}, "Xform")
omni.kit.commands.execute(
"AddRelationshipTarget",
relationship=stage.GetPropertyAtPath(self.TEST_GRAPH_PATH + "/import_usd_prim_data.inputs:prim"),
target=self.input_prim.GetPath(),
)
omni.kit.commands.execute(
"AddRelationshipTarget",
relationship=stage.GetPropertyAtPath(self.TEST_GRAPH_PATH + "/export_usd_prim_data.outputs:prim"),
target=self.output_prim.GetPath(),
)
async def test_set_attributes(self):
"""Test whether attribute value changes of the input prim will be synced to the output prim."""
# Assign new TRS values to the input prim.
self.input_prim.GetAttribute("xformOp:translate").Set(self.TRANSLATE)
self.input_prim.GetAttribute("xformOp:rotateXYZ").Set(self.ROTATE)
self.input_prim.GetAttribute("xformOp:scale").Set(self.SCALE)
# Before graph evaluation, the output prim is still with its default attribute values.
self.assertFalse(self.output_prim.GetAttribute("xformOp:translate").Get() == self.TRANSLATE)
self.assertFalse(self.output_prim.GetAttribute("xformOp:rotateXYZ").Get() == self.ROTATE)
self.assertFalse(self.output_prim.GetAttribute("xformOp:scale").Get() == self.SCALE)
# Trigger graph evaluation and wait for completion.
await ogc.Controller.evaluate(self.graph)
# After graph evaluation, the output prim has been fed with data from the input prim.
self.assertTrue(self.output_prim.GetAttribute("xformOp:translate").Get() == self.TRANSLATE)
self.assertTrue(self.output_prim.GetAttribute("xformOp:rotateXYZ").Get() == self.ROTATE)
self.assertTrue(self.output_prim.GetAttribute("xformOp:scale").Get() == self.SCALE)
async def test_bundle_attributes_and_metadata(self):
"""Test bundle attributes and metadata"""
# Get the bundle from the import node.
bundle = self.context.get_output_bundle(self.importNode, "outputs_output")
self.assertTrue(bundle.is_valid())
# Attribute names and types before evaluation.
attr_names, attr_types = bundle.get_attribute_names_and_types()
self.assertTrue(len(attr_names) == 0)
self.assertTrue(len(attr_types) == 0)
# Assign new TRS values to the input prim.
self.input_prim.GetAttribute("xformOp:translate").Set(self.TRANSLATE)
self.input_prim.GetAttribute("xformOp:rotateXYZ").Set(self.ROTATE)
self.input_prim.GetAttribute("xformOp:scale").Set(self.SCALE)
# Trigger graph evaluation and wait for completion.
await ogc.Controller.evaluate(self.graph)
# Attribute names and types after evaluation.
attr_names, attr_types = bundle.get_attribute_names_and_types()
self.assertTrue(len(attr_names) != 0)
self.assertTrue(len(attr_types) != 0)
# Internal attributes shouldn't be exposed.
metadata_names = {
"interpolation",
"source",
"bundlePrimIndexOffset",
}
self.assertTrue(metadata_names.isdisjoint(set(attr_names)))
# Convert bundle to IBundle2 for metadata access.
factory = ogc.IBundleFactory.create()
bundle = factory.get_bundle(self.context, bundle)
# Test metadata names.
self.assertEqual(
set(bundle.get_bundle_metadata_names()),
{"bundlePrimIndexOffset"},
)
async def test_bundle_dirty_id(self):
"""Test whether bundleDirtyID bumps after graph evaluation."""
factory = ogc.IBundleFactory.create()
# Get the output bundle from the importer and convert to IBundle2.
output_bundle = self.context.get_output_bundle(self.importNode, "outputs_output")
output_bundle = factory.get_bundle(self.context, output_bundle)
# Get the input bundle from the exporter and convert to IBundle2.
input_bundle = self.context.get_input_bundle(self.exportNode, "inputs:bundle")
input_bundle = factory.get_bundle(self.context, input_bundle)
# Trigger graph evaluation and wait for completion.
await ogc.Controller.evaluate(self.graph)
dirty_id = ogc._og_unstable.IDirtyID2.create(self.context) # noqa: PLW0212
# Get dirty id.
output_dirty_id = dirty_id.get([output_bundle])[0]
input_dirty_id = dirty_id.get([input_bundle])[0]
# Trigger graph evaluation and wait for completion.
await ogc.Controller.evaluate(self.graph)
# The dirty id doesn't bump because nothing gets changed.
self.assertEqual(output_dirty_id, dirty_id.get([output_bundle])[0])
self.assertEqual(input_dirty_id, dirty_id.get([input_bundle])[0])
# Assign new TRS values to the input prim.
self.input_prim.GetAttribute("xformOp:translate").Set(self.TRANSLATE)
self.input_prim.GetAttribute("xformOp:rotateXYZ").Set(self.ROTATE)
self.input_prim.GetAttribute("xformOp:scale").Set(self.SCALE)
# Trigger graph evaluation and wait for completion.
await ogc.Controller.evaluate(self.graph)
# The dirty id bumps because of TRS value changes.
self.assertNotEqual(output_dirty_id, dirty_id.get([output_bundle])[0])
self.assertNotEqual(input_dirty_id, dirty_id.get([input_bundle])[0])
async def test_child_bundle_order(self):
"""Test whether the order of child bundles extracted from the output bundle is consistent with that of target prims."""
graph_path = "/TestGraph2"
cubes = [("/cube_1", 1.0), ("/cube_2", 2.0), ("/cube_3", 3.0), ("/cube_4", 4.0)]
attr_name = "size"
controller = ogc.Controller()
keys = ogc.Controller.Keys
(graph, (_, output_node), _, _,) = controller.edit(
graph_path,
{
keys.CREATE_NODES: [
("import_usd_prim_data", "omni.graph.ImportUSDPrim"),
("bundle_to_usda_text", "omni.graph.BundleToUSDA"),
],
keys.CONNECT: [
("import_usd_prim_data.outputs_output", "bundle_to_usda_text.inputs:bundle"),
],
keys.SET_VALUES: ("import_usd_prim_data.inputs:attrNamesToImport", attr_name),
},
)
# Create target prims and assign the size attribute with different values.
for cube_path, cube_size in cubes:
prim = ogc.Controller.create_prim(cube_path, {}, "Cube")
prim.GetAttribute(attr_name).Set(cube_size)
# Assign the target prims to the import node.
stage = omni.usd.get_context().get_stage()
omni.kit.commands.execute(
"SetRelationshipTargets",
relationship=stage.GetPropertyAtPath(graph_path + "/import_usd_prim_data.inputs:prim"),
targets=[cube_path for cube_path, _ in cubes],
)
await ogc.Controller.evaluate(graph)
expected_result = (
'def Cube "cube_1"\n'
"{\n"
" double size = 1.00000000000000000e+00\n"
' token sourcePrimPath = "/cube_1"\n'
' token sourcePrimType = "Cube"\n'
"}\n"
'def Cube "cube_2"\n'
"{\n"
" double size = 2.00000000000000000e+00\n"
' token sourcePrimPath = "/cube_2"\n'
' token sourcePrimType = "Cube"\n'
"}\n"
'def Cube "cube_3"\n'
"{\n"
" double size = 3.00000000000000000e+00\n"
' token sourcePrimPath = "/cube_3"\n'
' token sourcePrimType = "Cube"\n'
"}\n"
'def Cube "cube_4"\n'
"{\n"
" double size = 4.00000000000000000e+00\n"
' token sourcePrimPath = "/cube_4"\n'
' token sourcePrimType = "Cube"\n'
"}\n"
)
# Change timecode to trigger recompute. Run 60 times to eliminate random factor.
for timecode in range(60):
self.controller.edit(
self.TEST_GRAPH_PATH,
{ogc.Controller.Keys.SET_VALUES: ("import_usd_prim_data.inputs:usdTimecode", timecode)},
)
await ogc.Controller.evaluate(self.graph)
output_attr = output_node.get_attribute("outputs:text")
self.assertTrue(output_attr is not None and output_attr.is_valid())
self.assertEqual(output_attr.get(), expected_result)
| 10,119 | Python | 41.521008 | 127 | 0.605989 |
omniverse-code/kit/exts/omni.graph.io/docs/CHANGELOG.md | # CHANGELOG
This document records all notable changes to ``omni.graph.io`` extension.
This project adheres to `Semantic Versioning <https://semver.org/>`_.
<<<<<<< HEAD
=======
## [1.2.5] - 2022-11-18
### Changed
- Allow to be used in headless mode
## [1.2.3] - 2022-08-09
### Fixed
- Applied formatting to all of the Python files
## [1.2.2] - 2022-08-09
### Fixed
- Fixed backward compatibility break for the deprecated `IDirtyID` interface.
## [1.2.1] - 2022-08-03
### Fixed
- Compilation errors related to deprecation of methods in ogn bundle.
## [1.2.0] - 2022-07-28
### Deprecated
- Deprecated `IDirtyID` interface
- Deprecated `BundleAttrib` class and `BundleAttribSource` enumeration
- Deprecated `BundlePrim`, `BundlePrims`, `BundlePrimIterator` and `BundlePrimAttrIterator`
- Deprecated `ConstBundlePrim`, `ConstBundlePrims`, `ConstBundlePrimIterator` and `ConstBundlePrimAttrIterator`
## [1.1.0] - 2022-07-07
### Added
- Test for public API consistency
- Added build handling for tests module
## [1.0.10] - 2021-11-19
- Added option on ImportUsdPrim to include local bounding box of imported prims as a common attribute.
- Fixed case where Import is not re-computed when a transform is needed and an ancestor prim's transform has changed.
## [1.0.9] - 2021-11-10
- Added option on ExportUSDPrim node type to remove, from output prims, any authored attributes that aren't being exported
## [1.0.8] - 2021-10-22
- Should be identical to 1.0.7, but incrementing the version number just in case, for logistical reasons
## [1.0.7] - 2021-10-14
- Added option to export time sampled data to specified time in ExportUSDPrim node type
## [1.0.6] - 2021-10-05
- Fixed re-importing of transforming attributes in ImportUSDPrim node type when transforms change
## [1.0.5] - 2021-09-24
- Added attribute-level change tracking to ImportUSDPrim node type
## [1.0.4] - 2021-09-16
- Added "Attributes to Import" and "Attributes to Export" to corresponding nodes to reduce confusion about how to import/export a subset of attributes
- Added support for importing/exporting "widths" interpolation from USD
## [1.0.3] - 2021-08-18
- Updated for an ABI break in Kit
## [1.0.2] - 2021-08-17
- Fixed crash related to ImportUSDPrim node type and breaking change in Kit from eTransform being deprecated in favour of eMatrix
## [1.0.1] - 2021-08-13
- Fixed crash related to ImportUSDPrim node type
## [1.0.0] - 2021-07-27
### Added
- Initial version. Added ImportUSDPrim, ExportUSDPrim, TransformBundle, and BundleToUSDA node types.
| 2,536 | Markdown | 34.236111 | 150 | 0.734227 |
omniverse-code/kit/exts/omni.graph.io/docs/index.rst | OmniGraph I/O
#############
.. tabularcolumns:: |L|R|
.. csv-table::
:width: 100%
**Extension**: omni.graph.io,**Documentation Generated**: |today|
.. toctree::
:maxdepth: 1
CHANGELOG
| 203 | reStructuredText | 10.999999 | 68 | 0.566502 |
omniverse-code/kit/exts/omni.graph.io/docs/Overview.md | # OmniGraph I/O
```{csv-table}
**Extension**: omni.graph.io,**Documentation Generated**: {sub-ref}`today`
```
| 112 | Markdown | 15.142855 | 74 | 0.642857 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnGetCameraTarget.rst | .. _omni_graph_ui_nodes_GetCameraTarget_2:
.. _omni_graph_ui_nodes_GetCameraTarget:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Camera Target
:keywords: lang-en omnigraph node sceneGraph:camera threadsafe ui_nodes get-camera-target
Get Camera Target
=================
.. <description>
Gets a viewport camera's target point.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:prim", "``target``", "The camera prim, when 'usePath' is false", "None"
"Camera Path (*inputs:primPath*)", "``token``", "Path of the camera, used when 'usePath' is true", ""
"inputs:usePath", "``bool``", "When true, the 'primPath' attribute is used as the path to the prim being read, otherwise it will read the connection at the 'prim' attribute", "True"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Target (*outputs:target*)", "``pointd[3]``", "The target point", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.GetCameraTarget"
"Version", "2"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Get Camera Target"
"Categories", "sceneGraph:camera"
"Generated Class Name", "OgnGetCameraTargetDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,887 | reStructuredText | 25.971428 | 185 | 0.579226 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadWindowSize.rst | .. _omni_graph_ui_nodes_ReadWindowSize_1:
.. _omni_graph_ui_nodes_ReadWindowSize:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Window Size (BETA)
:keywords: lang-en omnigraph node ui ReadOnly ui_nodes read-window-size
Read Window Size (BETA)
=======================
.. <description>
Outputs the size of a UI window.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Viewport? (*inputs:isViewport*)", "``bool``", "If true then only viewport windows will be considered.", "False"
"Name (*inputs:name*)", "``token``", "Name of the window. If there are multiple windows with the same name the first one found will be used.", "None"
"Widget Path (*inputs:widgetPath*)", "``token``", "Full path to a widget in the window. If specified then 'name' will be ignored and the window containing the widget will be used.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Height (*outputs:height*)", "``float``", "Height of the window in pixels.", "None"
"Width (*outputs:width*)", "``float``", "Width of the window in pixels.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadWindowSize"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Window Size (BETA)"
"Categories", "ui"
"Generated Class Name", "OgnReadWindowSizeDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,058 | reStructuredText | 28 | 192 | 0.581633 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnNewFrame.rst | .. _omni_graph_ui_nodes_OnNewFrame_1:
.. _omni_graph_ui_nodes_OnNewFrame:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On New Frame
:keywords: lang-en omnigraph node graph:action,event compute-on-request ui_nodes on-new-frame
On New Frame
============
.. <description>
Triggers when there is a new frame available for the given viewport. Note that the graph will run asynchronously to the new frame event
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:viewport", "``token``", "Name of the viewport, or empty for the default viewport", ""
"", "*displayGroup*", "parameters", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:execOut", "``execution``", "Output Execution", "None"
"outputs:frameNumber", "``int``", "The number of the frame which is available", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnNewFrame"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "True"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On New Frame"
"Categories", "graph:action,event"
"Generated Class Name", "OgnOnNewFrameDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,797 | reStructuredText | 24.685714 | 135 | 0.578186 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnWidgetValueChanged.rst | .. _omni_graph_ui_nodes_OnWidgetValueChanged_1:
.. _omni_graph_ui_nodes_OnWidgetValueChanged:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Widget Value Changed (BETA)
:keywords: lang-en omnigraph node graph:action,ui compute-on-request ui_nodes on-widget-value-changed
On Widget Value Changed (BETA)
==============================
.. <description>
Event node which fires when a UI widget with the specified identifier has its value changed. This node should be used in combination with UI creation nodes such as OgnSlider.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "A unique identifier identifying the widget. This should be specified in the UI creation node such as OgnSlider.", ""
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"New Value (*outputs:newValue*)", "``['bool', 'float', 'int', 'string']``", "The new value of the widget", "None"
"Value Changed (*outputs:valueChanged*)", "``execution``", "Executed when the value of the widget is changed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnWidgetValueChanged"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "True"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Widget Value Changed (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnWidgetValueChangedDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,111 | reStructuredText | 29.171428 | 183 | 0.600189 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnViewportDragged.rst | .. _omni_graph_ui_nodes_OnViewportDragged_1:
.. _omni_graph_ui_nodes_OnViewportDragged:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Viewport Dragged (BETA)
:keywords: lang-en omnigraph node graph:action,ui threadsafe compute-on-request ui_nodes on-viewport-dragged
On Viewport Dragged (BETA)
==========================
.. <description>
Event node which fires when a viewport drag event occurs in the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger viewport drag events", "Left Mouse Drag"
"", "*displayGroup*", "parameters", ""
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "Left Mouse Drag,Right Mouse Drag,Middle Mouse Drag", ""
"Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played", "True"
"", "*literalOnly*", "1", ""
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of 2D position outputs are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"", "*literalOnly*", "1", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for drag events", "Viewport"
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Began (*outputs:began*)", "``execution``", "Enabled when the drag begins, populating 'Initial Position' with the current mouse position", "None"
"Ended (*outputs:ended*)", "``execution``", "Enabled when the drag ends, populating 'Final Position' with the current mouse position", "None"
"Final Position (*outputs:finalPosition*)", "``double[2]``", "The mouse position at which the drag ended (valid when 'Ended' is enabled)", "None"
"Initial Position (*outputs:initialPosition*)", "``double[2]``", "The mouse position at which the drag began (valid when either 'Began' or 'Ended' is enabled)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnViewportDragged"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Viewport Dragged (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnViewportDraggedDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,166 | reStructuredText | 38.5875 | 270 | 0.6235 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnPlacer.rst | .. _omni_graph_ui_nodes_Placer_1:
.. _omni_graph_ui_nodes_Placer:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Placer (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes placer
Placer (BETA)
=============
.. <description>
Contruct a Placer widget. The Placer takes a single child and places it at a given position within it.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
"Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget.", ""
"Position (*inputs:position*)", "``double[2]``", "Where to position the child widget within the Placer.", "[0.0, 0.0]"
"inputs:style", "``string``", "Style to be applied to the Placer and its child. This can later be changed with the WriteWidgetStyle node.", "None"
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
"Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created Placer widget", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.Placer"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Placer (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnPlacerDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,333 | reStructuredText | 30.972602 | 207 | 0.600943 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnSetActiveViewportCamera.rst | .. _omni_graph_ui_nodes_SetActiveViewportCamera_1:
.. _omni_graph_ui_nodes_SetActiveViewportCamera:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set Active Camera
:keywords: lang-en omnigraph node sceneGraph:camera ReadOnly ui_nodes set-active-viewport-camera
Set Active Camera
=================
.. <description>
Sets Viewport's actively bound camera to given camera at give path
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"In (*inputs:execIn*)", "``execution``", "Execution input", "None"
"Camera Path (*inputs:primPath*)", "``token``", "Path of the camera to bind", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport, or empty for the default viewport", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Out (*outputs:execOut*)", "``execution``", "Execution Output", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.SetActiveViewportCamera"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Set Active Camera"
"Categories", "sceneGraph:camera"
"Generated Class Name", "OgnSetActiveViewportCameraDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,846 | reStructuredText | 25.385714 | 110 | 0.582882 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnPicked.rst | .. _omni_graph_ui_nodes_OnPicked_3:
.. _omni_graph_ui_nodes_OnPicked:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Picked (BETA)
:keywords: lang-en omnigraph node graph:action,ui threadsafe compute-on-request ui_nodes on-picked
On Picked (BETA)
================
.. <description>
Event node which fires when a picking event occurs in the specified viewport. Note that picking events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger a picking event", "Left Mouse Click"
"", "*displayGroup*", "parameters", ""
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "Left Mouse Click,Right Mouse Click,Middle Mouse Click,Left Mouse Press,Right Mouse Press,Middle Mouse Press", ""
"Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played.", "True"
"", "*literalOnly*", "1", ""
"Tracked Prims (*inputs:trackedPrims*)", "``target``", "Optionally specify a set of tracked prims that will cause 'Picked' to fire when picked", "None"
"", "*literalOnly*", "1", ""
"", "*allowMultiInputs*", "1", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for picking events", "Viewport"
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Tracked Prim Picked (*outputs:isTrackedPrimPicked*)", "``bool``", "True if a tracked prim got picked, or if any prim got picked if no tracked prims are specified (will always be true when 'Picked' fires, and false when 'Missed' fires)", "None"
"Missed (*outputs:missed*)", "``execution``", "Enabled when an attempted picking did not pick a tracked prim, or when nothing gets picked if no tracked prims are specified", "None"
"Picked (*outputs:picked*)", "``execution``", "Enabled when a tracked prim is picked, or when any prim is picked if no tracked prims are specified", "None"
"Picked Prim (*outputs:pickedPrim*)", "``target``", "The picked prim, or an empty target if nothing got picked", "None"
"Picked Prim Path (*outputs:pickedPrimPath*)", "``token``", "The path of the picked prim, or an empty string if nothing got picked", "None"
"Picked World Position (*outputs:pickedWorldPos*)", "``pointd[3]``", "The XYZ-coordinates of the point in world space at which the prim got picked, or (0,0,0) if nothing got picked", "None"
"Tracked Prim Paths (*outputs:trackedPrimPaths*)", "``token[]``", "A list of the paths of the prims specified in 'Tracked Prims'", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnPicked"
"Version", "3"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Picked (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnPickedDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,630 | reStructuredText | 42.22619 | 251 | 0.626997 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnDrawDebugCurve.rst | .. _omni_graph_ui_nodes_DrawDebugCurve_1:
.. _omni_graph_ui_nodes_DrawDebugCurve:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Draw Debug Curve
:keywords: lang-en omnigraph node debug ui_nodes draw-debug-curve
Draw Debug Curve
================
.. <description>
Given a set of curve points, draw a curve in the viewport
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Closed (*inputs:closed*)", "``bool``", "When true, connect the last point to the first", "False"
"Color (*inputs:color*)", "``colorf[3]``", "The color of the curve", "[0.0, 0.0, 0.0]"
"Curve Points (*inputs:curvepoints*)", "``double[3][]``", "The curve to be drawn", "[]"
"In (*inputs:execIn*)", "``execution``", "Execution input", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Out (*outputs:execOut*)", "``execution``", "Execution Output", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.DrawDebugCurve"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Draw Debug Curve"
"Categories", "debug"
"Generated Class Name", "OgnDrawDebugCurveDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,843 | reStructuredText | 24.971831 | 101 | 0.558329 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnViewportClicked.rst | .. _omni_graph_ui_nodes_OnViewportClicked_1:
.. _omni_graph_ui_nodes_OnViewportClicked:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Viewport Clicked (BETA)
:keywords: lang-en omnigraph node graph:action,ui threadsafe compute-on-request ui_nodes on-viewport-clicked
On Viewport Clicked (BETA)
==========================
.. <description>
Event node which fires when a viewport click event occurs in the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger viewport click events", "Left Mouse Click"
"", "*displayGroup*", "parameters", ""
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "Left Mouse Click,Right Mouse Click,Middle Mouse Click", ""
"Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played", "True"
"", "*literalOnly*", "1", ""
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of the 2D position output are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"", "*literalOnly*", "1", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for click events", "Viewport"
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Clicked (*outputs:clicked*)", "``execution``", "Enabled when the specified input gesture triggers a viewport click event in the specified viewport", "None"
"Position (*outputs:position*)", "``double[2]``", "The position at which the viewport click event occurred", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnViewportClicked"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Viewport Clicked (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnViewportClickedDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,839 | reStructuredText | 35.410256 | 273 | 0.617471 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadViewportPressState.rst | .. _omni_graph_ui_nodes_ReadViewportPressState_1:
.. _omni_graph_ui_nodes_ReadViewportPressState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Viewport Press State (BETA)
:keywords: lang-en omnigraph node ui threadsafe ui_nodes read-viewport-press-state
Read Viewport Press State (BETA)
================================
.. <description>
Read the state of the last viewport press event from the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger viewport press events", "Left Mouse Press"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "Left Mouse Press,Right Mouse Press,Middle Mouse Press", ""
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of 2D position outputs are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for press events", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Pressed (*outputs:isPressed*)", "``bool``", "True if the specified viewport is currently pressed", "None"
"Is Release Position Valid (*outputs:isReleasePositionValid*)", "``bool``", "True if the press was released inside of the viewport, and false otherwise", "None"
"Is Valid (*outputs:isValid*)", "``bool``", "True if a valid event state was detected and the outputs of this node are valid, and false otherwise", "None"
"Press Position (*outputs:pressPosition*)", "``double[2]``", "The position at which the specified viewport was last pressed", "None"
"Release Position (*outputs:releasePosition*)", "``double[2]``", "The position at which the last press on the specified viewport was released, or (0,0) if the press was released outside of the viewport or the viewport is currently pressed", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadViewportPressState"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Viewport Press State (BETA)"
"Categories", "ui"
"Generated Class Name", "OgnReadViewportPressStateDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,107 | reStructuredText | 39.894736 | 270 | 0.641455 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnGetViewportResolution.rst | .. _omni_graph_ui_nodes_GetViewportResolution_1:
.. _omni_graph_ui_nodes_GetViewportResolution:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Viewport Resolution
:keywords: lang-en omnigraph node viewport ui_nodes get-viewport-resolution
Get Viewport Resolution
=======================
.. <description>
Gets the resolution of the target viewport.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport, or empty for the default viewport", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Resolution (*outputs:resolution*)", "``int[2]``", "The resolution of the target viewport", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.GetViewportResolution"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Get Viewport Resolution"
"Categories", "viewport"
"Generated Class Name", "OgnGetViewportResolutionDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,689 | reStructuredText | 23.852941 | 118 | 0.580225 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnSetViewportFullscreen.rst | .. _omni_graph_ui_nodes_SetViewportFullscreen_1:
.. _omni_graph_ui_nodes_SetViewportFullscreen:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set Viewport Fullscreen
:keywords: lang-en omnigraph node graph:action,viewport WriteOnly ui_nodes set-viewport-fullscreen
Set Viewport Fullscreen
=======================
.. <description>
Toggles fullscreen on/off for viewport(s) and visibility on/off for all other panes.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:exec", "``execution``", "The input execution", "None"
"Mode (*inputs:mode*)", "``token``", "The mode to toggle fullscreen on/off for viewport(s) and visibility on/off for all other panes: ""Default"" - Windowed viewport(s) with all other panes shown. ""Fullscreen"" - Fullscreen viewport(s) with all other panes hidden. ""Hide UI"" - Windowed viewport(s) with all other panes hidden.", "Default"
"", "*allowedTokens*", "Default,Fullscreen,Hide UI", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:exec", "``execution``", "The output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.SetViewportFullscreen"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Set Viewport Fullscreen"
"Categories", "graph:action,viewport"
"Generated Class Name", "OgnSetViewportFullscreenDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,082 | reStructuredText | 28.757142 | 346 | 0.602786 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnSlider.rst | .. _omni_graph_ui_nodes_Slider_1:
.. _omni_graph_ui_nodes_Slider:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Slider (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes slider
Slider (BETA)
=============
.. <description>
Create a slider widget on the Viewport
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
"Disable (*inputs:disable*)", "``execution``", "Disable this button so that it cannot be pressed", "None"
"Enable (*inputs:enable*)", "``execution``", "Enable this button after it has been disabled", "None"
"Hide (*inputs:hide*)", "``execution``", "Input execution to hide the widget and all its child widgets", "None"
"Max (*inputs:max*)", "``float``", "The maximum value of the slider", "0.0"
"Min (*inputs:min*)", "``float``", "The minimum value of the slider", "0.0"
"Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget. If empty, this widget will be created as a direct child of Viewport.", "None"
"Show (*inputs:show*)", "``execution``", "Input execution to show the widget and all its child widgets after they become hidden", "None"
"Step (*inputs:step*)", "``float``", "The step size of the slider", "0.01"
"Tear Down (*inputs:tearDown*)", "``execution``", "Input execution to tear down the widget and all its child widgets", "None"
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"
"Width (*inputs:width*)", "``double``", "The width of the created slider", "100.0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
"Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created widget", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.Slider"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"hidden", "True"
"uiName", "Slider (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnSliderDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,010 | reStructuredText | 36.172839 | 207 | 0.605316 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadMouseState.rst | .. _omni_graph_ui_nodes_ReadMouseState_1:
.. _omni_graph_ui_nodes_ReadMouseState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Mouse State
:keywords: lang-en omnigraph node input:mouse threadsafe ui_nodes read-mouse-state
Read Mouse State
================
.. <description>
Reads the current state of the mouse. You can choose which mouse element this node is associated with. When mouse element is chosen to be a button, only outputs:isPressed is meaningful. When coordinates are chosen, only outputs:coords and outputs:window are meaningful.
Pixel coordinates are the position of the mouse cursor in screen pixel units with (0,0) top left. Normalized coordinates are values between 0-1 where 0 is top/left and 1 is bottom/right. By default, coordinates are relative to the application window, but if 'Use Relative Coords' is set to true, then coordinates are relative to the workspace window containing the mouse pointer.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Mouse Element (*inputs:mouseElement*)", "``token``", "The mouse input to check the state of", "Left Button"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "Left Button,Right Button,Middle Button,Forward Button,Back Button,Normalized Mouse Coordinates,Pixel Mouse Coordinates", ""
"Use Relative Coords (*inputs:useRelativeCoords*)", "``bool``", "When true, the output 'coords' is made relative to the workspace window containing the mouse pointer instead of the entire application window", "False"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:coords", "``float[2]``", "The coordinates of the mouse. If the mouse element selected is a button, this will output a zero vector.", "None"
"outputs:isPressed", "``bool``", "True if the button is currently pressed, false otherwise. If the mouse element selected is a coordinate, this will output false.", "None"
"outputs:window", "``token``", "The name of the workspace window containing the mouse pointer if 'Use Relative Coords' is true and the mouse element selected is a coordinate", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadMouseState"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Mouse State"
"Categories", "input:mouse"
"Generated Class Name", "OgnReadMouseStateDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,070 | reStructuredText | 40.499999 | 380 | 0.659935 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnSetViewportMode.rst | .. _omni_graph_ui_nodes_SetViewportMode_1:
.. _omni_graph_ui_nodes_SetViewportMode:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set Viewport Mode (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes set-viewport-mode
Set Viewport Mode (BETA)
========================
.. <description>
Sets the mode of a specified viewport window to 'Scripted' mode or 'Default' mode when executed.
'Scripted' mode disables default viewport interaction and enables placing UI elements over the viewport. 'Default' mode is the default state of the viewport, and entering it will destroy any UI elements on the viewport.
Executing with 'Enable Viewport Mouse Events' set to true in 'Scripted' mode is required to allow the specified viewport to be targeted by viewport mouse event nodes, including 'On Viewport Dragged' and 'Read Viewport Drag State'.
Executing with 'Enable Picking' set to true in 'Scripted' mode is required to allow the specified viewport to be targeted by the 'On Picked' and 'Read Pick State' nodes.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Enable Picking (*inputs:enablePicking*)", "``bool``", "Enable/Disable picking prims in the specified viewport when in 'Scripted' mode", "False"
"Enable Viewport Mouse Events (*inputs:enableViewportMouseEvents*)", "``bool``", "Enable/Disable viewport mouse events on the specified viewport when in 'Scripted' mode", "False"
"inputs:execIn", "``execution``", "Input execution", "None"
"Mode (*inputs:mode*)", "``int``", "The mode to set the specified viewport to when this node is executed (0: 'Default', 1: 'Scripted')", "0"
"Pass Clicks Thru (*inputs:passClicksThru*)", "``bool``", "Allow mouse clicks to affect the viewport while in 'Scripted' mode. In 'Scripted' mode mouse clicks are prevented from reaching the viewport to avoid accidentally selecting prims or interacting with the viewport's own UI. Setting this attribute true will allow clicks to reach the viewport. This is in addition to interacting with the widgets created by UI nodes so if a button widget appears on top of some geometry in the viewport, clicking on the button will not only trigger the button but could also select the geometry. To avoid this, put the button inside a Stack widget and use a WriteWidgetProperty node to set the Stack's 'content_clipping' property to 1.", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to set the mode of", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Default Mode (*outputs:defaultMode*)", "``execution``", "Fires when this node is successfully executed with 'Mode' set to 'Default'", "None"
"Scripted Mode (*outputs:scriptedMode*)", "``execution``", "Fires when this node is successfully executed with 'Mode' set to 'Scripted'", "None"
"Widget Path (*outputs:widgetPath*)", "``token``", "When the viewport enters 'Scripted' mode, a container widget is created under which other UI may be parented. This attribute provides the absolute path to that widget, which can be used as the 'parentWidgetPath' input to various UI nodes, such as Button. When the viewport exits 'Scripted' mode, the container widget and all the UI within it will be destroyed.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.SetViewportMode"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Set Viewport Mode (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnSetViewportModeDatabase"
"Python Module", "omni.graph.ui_nodes"
| 4,244 | reStructuredText | 53.423076 | 739 | 0.683082 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadViewportDragState.rst | .. _omni_graph_ui_nodes_ReadViewportDragState_1:
.. _omni_graph_ui_nodes_ReadViewportDragState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Viewport Drag State (BETA)
:keywords: lang-en omnigraph node ui threadsafe ui_nodes read-viewport-drag-state
Read Viewport Drag State (BETA)
===============================
.. <description>
Read the state of the last viewport drag event from the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger viewport drag events", "Left Mouse Drag"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "Left Mouse Drag,Right Mouse Drag,Middle Mouse Drag", ""
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of 2D position and velocity outputs are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for drag events", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Current Position (*outputs:currentPosition*)", "``double[2]``", "The current mouse position if a drag is in progress, or the final mouse position of the most recent drag if a drag is not in progress", "None"
"Initial Position (*outputs:initialPosition*)", "``double[2]``", "The mouse position at which the most recent drag began", "None"
"Is Drag In Progress (*outputs:isDragInProgress*)", "``bool``", "True if a viewport drag event is currently in progress in the specified viewport", "None"
"Is Valid (*outputs:isValid*)", "``bool``", "True if a valid event state was detected and the outputs of this node are valid, and false otherwise", "None"
"Velocity (*outputs:velocity*)", "``double[2]``", "A vector representing the change in position of the mouse since the previous frame if a drag is in progress, otherwise (0,0)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadViewportDragState"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Viewport Drag State (BETA)"
"Categories", "ui"
"Generated Class Name", "OgnReadViewportDragStateDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,131 | reStructuredText | 40.210526 | 283 | 0.639732 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnSetViewportRenderer.rst | .. _omni_graph_ui_nodes_SetViewportRenderer_1:
.. _omni_graph_ui_nodes_SetViewportRenderer:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Set Viewport Renderer
:keywords: lang-en omnigraph node graph:action,viewport ui_nodes set-viewport-renderer
Set Viewport Renderer
=====================
.. <description>
Sets renderer for the target viewport.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:exec", "``execution``", "The input execution", "None"
"Renderer (*inputs:renderer*)", "``token``", "Renderer to be assigned to the target viewport", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport, or empty for the default viewport", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:exec", "``execution``", "The output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.SetViewportRenderer"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Set Viewport Renderer"
"Categories", "graph:action,viewport"
"Generated Class Name", "OgnSetViewportRendererDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,825 | reStructuredText | 25.085714 | 118 | 0.582466 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnGetActiveViewportCamera.rst | .. _omni_graph_ui_nodes_GetActiveViewportCamera_2:
.. _omni_graph_ui_nodes_GetActiveViewportCamera:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Active Camera
:keywords: lang-en omnigraph node sceneGraph:camera ui_nodes get-active-viewport-camera
Get Active Camera
=================
.. <description>
Gets the path of the camera bound to a viewport
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport, or empty for the default viewport", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Camera (*outputs:camera*)", "``token``", "Path of the active camera", "None"
"Camera Prim (*outputs:cameraPrim*)", "``target``", "The prim of the active camera", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.GetActiveViewportCamera"
"Version", "2"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Get Active Camera"
"Categories", "sceneGraph:camera"
"Generated Class Name", "OgnGetActiveViewportCameraDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,765 | reStructuredText | 24.594203 | 110 | 0.580737 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnSpacer.rst | .. _omni_graph_ui_nodes_Spacer_1:
.. _omni_graph_ui_nodes_Spacer:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Spacer (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes spacer
Spacer (BETA)
=============
.. <description>
A widget that leaves empty space.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
"Height (*inputs:height*)", "``int``", "The amount of vertical space to leave, in pixels.", "0"
"Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget.", ""
"inputs:style", "``string``", "Style to be applied to the spacer. This can later be changed with the WriteWidgetStyle node.", "None"
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"
"Width (*inputs:width*)", "``int``", "The amount of horizontal space to leave, in pixels.", "0"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
"Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created widget", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.Spacer"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Spacer (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnSpacerDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,320 | reStructuredText | 30.364864 | 207 | 0.592672 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadPickState.rst | .. _omni_graph_ui_nodes_ReadPickState_2:
.. _omni_graph_ui_nodes_ReadPickState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Pick State (BETA)
:keywords: lang-en omnigraph node ui threadsafe ui_nodes read-pick-state
Read Pick State (BETA)
======================
.. <description>
Read the state of the last picking event from the specified viewport. Note that picking events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger a picking event", "Left Mouse Click"
"", "*displayGroup*", "parameters", ""
"", "*allowedTokens*", "Left Mouse Click,Right Mouse Click,Middle Mouse Click,Left Mouse Press,Right Mouse Press,Middle Mouse Press", ""
"Tracked Prim Paths (*inputs:trackedPrimPaths*)", "``token[]``", "Optionally specify a set of prims (by paths) to track whether or not they got picked (only affects the value of 'Is Tracked Prim Picked')", "None"
"Tracked Prims (*inputs:trackedPrims*)", "``target``", "Optionally specify a set of prims to track whether or not they got picked (only affects the value of 'Is Tracked Prim Picked')", "None"
"", "*allowMultiInputs*", "1", ""
"Use Paths (*inputs:usePaths*)", "``bool``", "When true, 'Tracked Prim Paths' is used, otherwise 'Tracked Prims' is used", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for picking events", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Tracked Prim Picked (*outputs:isTrackedPrimPicked*)", "``bool``", "True if a tracked prim got picked in the last picking event, or if any prim got picked if no tracked prims are specified", "None"
"Is Valid (*outputs:isValid*)", "``bool``", "True if a valid event state was detected and the outputs of this node are valid, and false otherwise", "None"
"Picked Prim (*outputs:pickedPrim*)", "``target``", "The picked prim, or an empty target if nothing got picked", "None"
"Picked Prim Path (*outputs:pickedPrimPath*)", "``token``", "The path of the prim picked in the last picking event, or an empty string if nothing got picked", "None"
"Picked World Position (*outputs:pickedWorldPos*)", "``pointd[3]``", "The XYZ-coordinates of the point in world space at which the prim got picked, or (0,0,0) if nothing got picked", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadPickState"
"Version", "2"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Pick State (BETA)"
"Categories", "ui"
"Generated Class Name", "OgnReadPickStateDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,397 | reStructuredText | 42.012658 | 216 | 0.634383 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnButton.rst | .. _omni_graph_ui_nodes_Button_1:
.. _omni_graph_ui_nodes_Button:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Button (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes button
Button (BETA)
=============
.. <description>
Create a button widget on the Viewport
.. </description>
Here is an example of a button that was created using the text ``Press Me``:
.. image:: ../../../../../source/extensions/omni.graph.ui_nodes/docs/PressMe.png
:alt: "Press Me" Button
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
"Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget.", ""
"Size (*inputs:size*)", "``double[2]``", "The width and height of the created widget. Value of 0 means the created widget will be just large enough to fit everything.", "[0.0, 0.0]"
"Start Hidden (*inputs:startHidden*)", "``bool``", "Determines whether the button will initially be visible (False) or not (True).", "False"
"inputs:style", "``string``", "Style to be applied to the button. This can later be changed with the WriteWidgetStyle node.", "None"
"Text (*inputs:text*)", "``string``", "The text that is displayed on the button", "None"
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
"Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created widget", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.Button"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Button (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnButtonDatabase"
"Python Module", "omni.graph.ui_nodes"
Further information on the button operation can be found in the documentation of :py:class:`omni.ui.Button`.
| 2,847 | reStructuredText | 33.731707 | 207 | 0.614682 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnWriteWidgetProperty.rst | .. _omni_graph_ui_nodes_WriteWidgetProperty_1:
.. _omni_graph_ui_nodes_WriteWidgetProperty:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Widget Property (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes write-widget-property
Write Widget Property (BETA)
============================
.. <description>
Set the value of a widget's property (height, tooltip, etc).
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Property Name (*inputs:propertyName*)", "``token``", "Name of the property to write to.", ""
"Value (*inputs:value*)", "``any``", "The value to write to the property.", "None"
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "Unique identifier for the widget. This is only valid within the current graph.", ""
"Widget Path (*inputs:widgetPath*)", "``token``", "Full path to the widget. If present this will be used insted of 'widgetIdentifier'. Unlike 'widgetIdentifier' this is valid across all graphs.", ""
"Write (*inputs:write*)", "``execution``", "Input execution to write the value to the widget's property.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:written", "``execution``", "Executed when the value has been successfully written.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.WriteWidgetProperty"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Write Widget Property (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnWriteWidgetPropertyDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,270 | reStructuredText | 30.541666 | 202 | 0.600441 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnPrintText.rst | .. _omni_graph_ui_nodes_PrintText_1:
.. _omni_graph_ui_nodes_PrintText:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Print Text
:keywords: lang-en omnigraph node debug ui_nodes print-text
Print Text
==========
.. <description>
Prints some text to the system log or to the screen
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"In (*inputs:execIn*)", "``execution``", "Execution input", "None"
"Log Level (*inputs:logLevel*)", "``token``", "The logging level for the message [Info, Warning, Error]", "Info"
"", "*allowedTokens*", "Info,Warning,Error", ""
"Text (*inputs:text*)", "``string``", "The text to print", ""
"To Screen (*inputs:toScreen*)", "``bool``", "When true, displays the text on the viewport for a few seconds, as well as the log", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport if printing to screen, or empty for the default viewport", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Out (*outputs:execOut*)", "``execution``", "Execution Output", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.PrintText"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"tags", "logging,toast,debug"
"uiName", "Print Text"
"Categories", "debug"
"Generated Class Name", "OgnPrintTextDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,047 | reStructuredText | 26.675675 | 142 | 0.569614 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnWidgetClicked.rst | .. _omni_graph_ui_nodes_OnWidgetClicked_1:
.. _omni_graph_ui_nodes_OnWidgetClicked:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Widget Clicked (BETA)
:keywords: lang-en omnigraph node graph:action,ui compute-on-request ui_nodes on-widget-clicked
On Widget Clicked (BETA)
========================
.. <description>
Event node which fires when a UI widget with the specified identifier is clicked. This node should be used in combination with UI creation nodes such as OgnButton.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "A unique identifier identifying the widget. This should be specified in the UI creation node such as OgnButton.", ""
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Clicked (*outputs:clicked*)", "``execution``", "Executed when the widget is clicked", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnWidgetClicked"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "True"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Widget Clicked (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnWidgetClickedDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,908 | reStructuredText | 26.666666 | 183 | 0.592767 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnVStack.rst | .. _omni_graph_ui_nodes_VStack_1:
.. _omni_graph_ui_nodes_VStack:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Stack (BETA)
:keywords: lang-en omnigraph node graph:action,ui ui_nodes v-stack
Stack (BETA)
============
.. <description>
Contruct a Stack on the Viewport. All child widgets of Stack will be placed in a row, column or layer based on the direction input.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
"Direction (*inputs:direction*)", "``token``", "The direction the widgets will be stacked.", "TOP_TO_BOTTOM"
"", "*allowedTokens*", "BACK_TO_FRONT,BOTTOM_TO_TOP,FRONT_TO_BACK,LEFT_TO_RIGHT,RIGHT_TO_LEFT,TOP_TO_BOTTOM", ""
"Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget.", ""
"inputs:style", "``string``", "Style to be applied to the stack and its children. This can later be changed with the WriteWidgetStyle node.", "None"
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
"Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created widget", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.VStack"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Stack (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnVStackDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,461 | reStructuredText | 32.27027 | 207 | 0.60707 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadViewportHoverState.rst | .. _omni_graph_ui_nodes_ReadViewportHoverState_1:
.. _omni_graph_ui_nodes_ReadViewportHoverState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Viewport Hover State (BETA)
:keywords: lang-en omnigraph node ui threadsafe ui_nodes read-viewport-hover-state
Read Viewport Hover State (BETA)
================================
.. <description>
Read the state of the last viewport hover event from the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of 2D position and velocity outputs are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for hover events", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Hovered (*outputs:isHovered*)", "``bool``", "True if the specified viewport is currently hovered", "None"
"Is Valid (*outputs:isValid*)", "``bool``", "True if a valid event state was detected and the outputs of this node are valid, and false otherwise", "None"
"Position (*outputs:position*)", "``double[2]``", "The current mouse position if the specified viewport is currently hovered, otherwise (0,0)", "None"
"Velocity (*outputs:velocity*)", "``double[2]``", "A vector representing the change in position of the mouse since the previous frame if the specified viewport is currently hovered, otherwise (0,0)", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadViewportHoverState"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Viewport Hover State (BETA)"
"Categories", "ui"
"Generated Class Name", "OgnReadViewportHoverStateDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,682 | reStructuredText | 36.263888 | 283 | 0.634228 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnGetViewportRenderer.rst | .. _omni_graph_ui_nodes_GetViewportRenderer_1:
.. _omni_graph_ui_nodes_GetViewportRenderer:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Get Viewport Renderer
:keywords: lang-en omnigraph node viewport ui_nodes get-viewport-renderer
Get Viewport Renderer
=====================
.. <description>
Gets the renderer being used by the target viewport.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport, or empty for the default viewport", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Renderer (*outputs:renderer*)", "``token``", "The renderer being used by the target viewport", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.GetViewportRenderer"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Get Viewport Renderer"
"Categories", "viewport"
"Generated Class Name", "OgnGetViewportRendererDatabase"
"Python Module", "omni.graph.ui_nodes"
| 1,684 | reStructuredText | 23.779411 | 118 | 0.578979 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnWriteWidgetStyle.rst | .. _omni_graph_ui_nodes_WriteWidgetStyle_1:
.. _omni_graph_ui_nodes_WriteWidgetStyle:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Write Widget Style (BETA)
:keywords: lang-en omnigraph node graph:action,ui ReadOnly ui_nodes write-widget-style
Write Widget Style (BETA)
=========================
.. <description>
Sets a widget's style properties. This node should be used in combination with UI creation nodes such as Button.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"inputs:style", "``string``", "The style to set the widget to.", ""
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "A unique identifier identifying the widget. This is only valid within the current graph. This should be specified in the UI creation node such as OgnButton.", ""
"Widget Path (*inputs:widgetPath*)", "``token``", "Full path to the widget. If present this will be used insted of 'widgetIdentifier'. Unlike 'widgetIdentifier' this is valid across all graphs.", ""
"inputs:write", "``execution``", "Input execution", "None"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:written", "``execution``", "Output execution", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.WriteWidgetStyle"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Write Widget Style (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnWriteWidgetStyleDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,176 | reStructuredText | 29.661971 | 228 | 0.60432 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnViewportHovered.rst | .. _omni_graph_ui_nodes_OnViewportHovered_1:
.. _omni_graph_ui_nodes_OnViewportHovered:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Viewport Hovered (BETA)
:keywords: lang-en omnigraph node graph:action,ui threadsafe compute-on-request ui_nodes on-viewport-hovered
On Viewport Hovered (BETA)
==========================
.. <description>
Event node which fires when the specified viewport is hovered over. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played", "True"
"", "*literalOnly*", "1", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for hover events", "Viewport"
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Began (*outputs:began*)", "``execution``", "Enabled when the hover begins", "None"
"Ended (*outputs:ended*)", "``execution``", "Enabled when the hover ends", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnViewportHovered"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Viewport Hovered (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnViewportHoveredDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,125 | reStructuredText | 28.527777 | 171 | 0.592 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnViewportScrolled.rst | .. _omni_graph_ui_nodes_OnViewportScrolled_1:
.. _omni_graph_ui_nodes_OnViewportScrolled:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Viewport Scrolled (BETA)
:keywords: lang-en omnigraph node graph:action,ui threadsafe compute-on-request ui_nodes on-viewport-scrolled
On Viewport Scrolled (BETA)
===========================
.. <description>
Event node which fires when a viewport scroll event occurs in the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played", "True"
"", "*literalOnly*", "1", ""
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of the 2D position output are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"", "*literalOnly*", "1", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for scroll events", "Viewport"
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Position (*outputs:position*)", "``double[2]``", "The position at which the viewport scroll event occurred", "None"
"Scroll Value (*outputs:scrollValue*)", "``float``", "The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative", "None"
"Scrolled (*outputs:scrolled*)", "``execution``", "Enabled when a viewport scroll event occurs in the specified viewport", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnViewportScrolled"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Viewport Scrolled (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnViewportScrolledDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,695 | reStructuredText | 34.946666 | 273 | 0.621892 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnOnViewportPressed.rst | .. _omni_graph_ui_nodes_OnViewportPressed_1:
.. _omni_graph_ui_nodes_OnViewportPressed:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: On Viewport Pressed (BETA)
:keywords: lang-en omnigraph node graph:action,ui threadsafe compute-on-request ui_nodes on-viewport-pressed
On Viewport Pressed (BETA)
==========================
.. <description>
Event node which fires when the specified viewport is pressed, and when that press is released. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Gesture (*inputs:gesture*)", "``token``", "The input gesture to trigger viewport press events", "Left Mouse Press"
"", "*displayGroup*", "parameters", ""
"", "*literalOnly*", "1", ""
"", "*allowedTokens*", "Left Mouse Press,Right Mouse Press,Middle Mouse Press", ""
"Only Simulate On Play (*inputs:onlyPlayback*)", "``bool``", "When true, the node is only computed while Stage is being played", "True"
"", "*literalOnly*", "1", ""
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of 2D position outputs are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"", "*literalOnly*", "1", ""
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for press events", "Viewport"
"", "*literalOnly*", "1", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Release Position Valid (*outputs:isReleasePositionValid*)", "``bool``", "True if the press was released inside of the viewport, and false otherwise", "None"
"Press Position (*outputs:pressPosition*)", "``double[2]``", "The position at which the viewport was pressed (valid when either 'Pressed' or 'Released' is enabled)", "None"
"Pressed (*outputs:pressed*)", "``execution``", "Enabled when the specified viewport is pressed, populating 'Press Position' with the current mouse position", "None"
"Release Position (*outputs:releasePosition*)", "``double[2]``", "The position at which the press was released, or (0,0) if the press was released outside of the viewport or the viewport is currently pressed (valid when 'Ended' is enabled and 'Is Release Position Valid' is true)", "None"
"Released (*outputs:released*)", "``execution``", "Enabled when the press is released, populating 'Release Position' with the current mouse position and setting 'Is Release Position Valid' to true if the press is released inside of the viewport. If the press is released outside of the viewport, 'Is Release Position Valid' is set to false and 'Release Position' is set to (0,0).", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.OnViewportPressed"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "On Viewport Pressed (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnOnViewportPressedDatabase"
"Python Module", "omni.graph.ui_nodes"
| 3,764 | reStructuredText | 45.481481 | 392 | 0.647715 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadViewportScrollState.rst | .. _omni_graph_ui_nodes_ReadViewportScrollState_1:
.. _omni_graph_ui_nodes_ReadViewportScrollState:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Viewport Scroll State (BETA)
:keywords: lang-en omnigraph node ui threadsafe ui_nodes read-viewport-scroll-state
Read Viewport Scroll State (BETA)
=================================
.. <description>
Read the state of the last viewport scroll event from the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Use Normalized Coords (*inputs:useNormalizedCoords*)", "``bool``", "When true, the components of the 2D position output are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.", "False"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport window to watch for scroll events", "Viewport"
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Is Valid (*outputs:isValid*)", "``bool``", "True if a valid event state was detected and the outputs of this node are valid, and false otherwise", "None"
"Position (*outputs:position*)", "``double[2]``", "The last position at which a viewport scroll event occurred in the specified viewport", "None"
"Scroll Value (*outputs:scrollValue*)", "``float``", "The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadViewportScrollState"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "C++"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Viewport Scroll State (BETA)"
"Categories", "ui"
"Generated Class Name", "OgnReadViewportScrollStateDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,507 | reStructuredText | 34.323943 | 273 | 0.629438 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnLockViewportRender.rst | .. _omni_graph_ui_nodes_LockViewportRender_1:
.. _omni_graph_ui_nodes_LockViewportRender:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Lock Viewport Render
:keywords: lang-en omnigraph node graph:action,viewport ui_nodes lock-viewport-render
Lock Viewport Render
====================
.. <description>
Locks and unlocks viewport render. Viewport render is frozen at the frame when it is locked, while computation and UI update are still executed as normal. It fades out back to the current frame when it is unlocked, two output execution attributes - fadeStarted and fadeComplete - will be triggered separately during the fading progress. The node manages the lock state for its target viewport and takes action according to the lock state when an input execution attribute is triggered. A node is able to unlock the target viewort only if it has locked the target viewport.
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Fade Time (*inputs:fadeTime*)", "``double``", "The duration of fading in time (seconds) when being unlocked", "1.0"
"inputs:lock", "``execution``", "The input execution attribute for locking viewport render", "None"
"inputs:unlock", "``execution``", "The input execution attribute for unlocking viewport render", "None"
"Viewport (*inputs:viewport*)", "``token``", "Name of the viewport, or empty for the default viewport", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"outputs:fadeComplete", "``execution``", "Triggered when fading is complete", "None"
"outputs:fadeStarted", "``execution``", "Triggered when fading is started", "None"
"outputs:locked", "``execution``", "Triggered when viewport render is locked", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.LockViewportRender"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Lock Viewport Render"
"Categories", "graph:action,viewport"
"Generated Class Name", "OgnLockViewportRenderDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,705 | reStructuredText | 36.068493 | 572 | 0.644732 |
omniverse-code/kit/exts/omni.graph.ui_nodes/ogn/docs/OgnReadWidgetProperty.rst | .. _omni_graph_ui_nodes_ReadWidgetProperty_1:
.. _omni_graph_ui_nodes_ReadWidgetProperty:
.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================
:orphan:
.. meta::
:title: Read Widget Property (BETA)
:keywords: lang-en omnigraph node graph:action,ui WriteOnly ui_nodes read-widget-property
Read Widget Property (BETA)
===========================
.. <description>
Read the value of a widget's property (height, tooltip, etc).
.. </description>
Installation
------------
To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.
Inputs
------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Property Name (*inputs:propertyName*)", "``token``", "Name of the property to read.", ""
"Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "Unique identifier for the widget. This is only valid within the current graph.", ""
"Widget Path (*inputs:widgetPath*)", "``token``", "Full path to the widget. If present this will be used insted of 'widgetIdentifier'. Unlike 'widgetIdentifier' this is valid across all graphs.", ""
Outputs
-------
.. csv-table::
:header: "Name", "Type", "Descripton", "Default"
:widths: 20, 20, 50, 10
"Value (*outputs:value*)", "``['bool', 'double', 'int', 'string']``", "The value of the property.", "None"
Metadata
--------
.. csv-table::
:header: "Name", "Value"
:widths: 30,70
"Unique ID", "omni.graph.ui_nodes.ReadWidgetProperty"
"Version", "1"
"Extension", "omni.graph.ui_nodes"
"Has State?", "False"
"Implementation Language", "Python"
"Default Memory Type", "cpu"
"Generated Code Exclusions", "tests"
"uiName", "Read Widget Property (BETA)"
"Categories", "graph:action,ui"
"Generated Class Name", "OgnReadWidgetPropertyDatabase"
"Python Module", "omni.graph.ui_nodes"
| 2,069 | reStructuredText | 28.571428 | 202 | 0.59014 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnReadViewportPressStateDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.ReadViewportPressState
Read the state of the last viewport press event from the specified viewport. Note that viewport mouse events must be enabled
on the specified viewport using a SetViewportMode node.
"""
import numpy
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnReadViewportPressStateDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.ReadViewportPressState
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.gesture
inputs.useNormalizedCoords
inputs.viewport
Outputs:
outputs.isPressed
outputs.isReleasePositionValid
outputs.isValid
outputs.pressPosition
outputs.releasePosition
Predefined Tokens:
tokens.LeftMouseDrag
tokens.RightMouseDrag
tokens.MiddleMouseDrag
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:gesture', 'token', 0, 'Gesture', 'The input gesture to trigger viewport press events', {'displayGroup': 'parameters', ogn.MetadataKeys.ALLOWED_TOKENS: 'Left Mouse Press,Right Mouse Press,Middle Mouse Press', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"LeftMouseDrag": "Left Mouse Press", "RightMouseDrag": "Right Mouse Press", "MiddleMouseDrag": "Middle Mouse Press"}', ogn.MetadataKeys.DEFAULT: '"Left Mouse Press"'}, True, "Left Mouse Press", False, ''),
('inputs:useNormalizedCoords', 'bool', 0, 'Use Normalized Coords', 'When true, the components of 2D position outputs are scaled to between 0 and 1,\nwhere 0 is top/left and 1 is bottom/right.\nWhen false, components are in viewport render resolution pixels.', {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to watch for press events', {ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:isPressed', 'bool', 0, 'Is Pressed', 'True if the specified viewport is currently pressed', {}, True, None, False, ''),
('outputs:isReleasePositionValid', 'bool', 0, 'Is Release Position Valid', 'True if the press was released inside of the viewport, and false otherwise', {}, True, None, False, ''),
('outputs:isValid', 'bool', 0, 'Is Valid', 'True if a valid event state was detected and the outputs of this node are valid, and false otherwise', {}, True, None, False, ''),
('outputs:pressPosition', 'double2', 0, 'Press Position', 'The position at which the specified viewport was last pressed', {}, True, None, False, ''),
('outputs:releasePosition', 'double2', 0, 'Release Position', 'The position at which the last press on the specified viewport was released,\nor (0,0) if the press was released outside of the viewport or the viewport is currently pressed', {}, True, None, False, ''),
])
class tokens:
LeftMouseDrag = "Left Mouse Press"
RightMouseDrag = "Right Mouse Press"
MiddleMouseDrag = "Middle Mouse Press"
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def gesture(self):
data_view = og.AttributeValueHelper(self._attributes.gesture)
return data_view.get()
@gesture.setter
def gesture(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.gesture)
data_view = og.AttributeValueHelper(self._attributes.gesture)
data_view.set(value)
@property
def useNormalizedCoords(self):
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
return data_view.get()
@useNormalizedCoords.setter
def useNormalizedCoords(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.useNormalizedCoords)
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
data_view.set(value)
@property
def viewport(self):
data_view = og.AttributeValueHelper(self._attributes.viewport)
return data_view.get()
@viewport.setter
def viewport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.viewport)
data_view = og.AttributeValueHelper(self._attributes.viewport)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def isPressed(self):
data_view = og.AttributeValueHelper(self._attributes.isPressed)
return data_view.get()
@isPressed.setter
def isPressed(self, value):
data_view = og.AttributeValueHelper(self._attributes.isPressed)
data_view.set(value)
@property
def isReleasePositionValid(self):
data_view = og.AttributeValueHelper(self._attributes.isReleasePositionValid)
return data_view.get()
@isReleasePositionValid.setter
def isReleasePositionValid(self, value):
data_view = og.AttributeValueHelper(self._attributes.isReleasePositionValid)
data_view.set(value)
@property
def isValid(self):
data_view = og.AttributeValueHelper(self._attributes.isValid)
return data_view.get()
@isValid.setter
def isValid(self, value):
data_view = og.AttributeValueHelper(self._attributes.isValid)
data_view.set(value)
@property
def pressPosition(self):
data_view = og.AttributeValueHelper(self._attributes.pressPosition)
return data_view.get()
@pressPosition.setter
def pressPosition(self, value):
data_view = og.AttributeValueHelper(self._attributes.pressPosition)
data_view.set(value)
@property
def releasePosition(self):
data_view = og.AttributeValueHelper(self._attributes.releasePosition)
return data_view.get()
@releasePosition.setter
def releasePosition(self, value):
data_view = og.AttributeValueHelper(self._attributes.releasePosition)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnReadViewportPressStateDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnReadViewportPressStateDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnReadViewportPressStateDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 9,771 | Python | 48.604061 | 469 | 0.670044 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnOnViewportPressedDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.OnViewportPressed
Event node which fires when the specified viewport is pressed, and when that press is released. Note that viewport mouse
events must be enabled on the specified viewport using a SetViewportMode node.
"""
import numpy
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnOnViewportPressedDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.OnViewportPressed
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.gesture
inputs.onlyPlayback
inputs.useNormalizedCoords
inputs.viewport
Outputs:
outputs.isReleasePositionValid
outputs.pressPosition
outputs.pressed
outputs.releasePosition
outputs.released
Predefined Tokens:
tokens.LeftMouseDrag
tokens.RightMouseDrag
tokens.MiddleMouseDrag
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:gesture', 'token', 0, 'Gesture', 'The input gesture to trigger viewport press events', {'displayGroup': 'parameters', ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.ALLOWED_TOKENS: 'Left Mouse Press,Right Mouse Press,Middle Mouse Press', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"LeftMouseDrag": "Left Mouse Press", "RightMouseDrag": "Right Mouse Press", "MiddleMouseDrag": "Middle Mouse Press"}', ogn.MetadataKeys.DEFAULT: '"Left Mouse Press"'}, True, "Left Mouse Press", False, ''),
('inputs:onlyPlayback', 'bool', 0, 'Only Simulate On Play', 'When true, the node is only computed while Stage is being played', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:useNormalizedCoords', 'bool', 0, 'Use Normalized Coords', 'When true, the components of 2D position outputs are scaled to between 0 and 1,\nwhere 0 is top/left and 1 is bottom/right.\nWhen false, components are in viewport render resolution pixels.', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to watch for press events', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:isReleasePositionValid', 'bool', 0, 'Is Release Position Valid', 'True if the press was released inside of the viewport, and false otherwise', {}, True, None, False, ''),
('outputs:pressPosition', 'double2', 0, 'Press Position', "The position at which the viewport was pressed (valid when either 'Pressed' or 'Released' is enabled)", {}, True, None, False, ''),
('outputs:pressed', 'execution', 0, 'Pressed', "Enabled when the specified viewport is pressed, populating 'Press Position' with the current mouse position", {}, True, None, False, ''),
('outputs:releasePosition', 'double2', 0, 'Release Position', "The position at which the press was released, or (0,0) if the press was released outside of the viewport\nor the viewport is currently pressed (valid when 'Ended' is enabled and 'Is Release Position Valid' is true)", {}, True, None, False, ''),
('outputs:released', 'execution', 0, 'Released', "Enabled when the press is released, populating 'Release Position' with the current mouse position\nand setting 'Is Release Position Valid' to true if the press is released inside of the viewport.\nIf the press is released outside of the viewport, 'Is Release Position Valid' is set to false\nand 'Release Position' is set to (0,0).", {}, True, None, False, ''),
])
class tokens:
LeftMouseDrag = "Left Mouse Press"
RightMouseDrag = "Right Mouse Press"
MiddleMouseDrag = "Middle Mouse Press"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.outputs.pressed = og.AttributeRole.EXECUTION
role_data.outputs.released = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def gesture(self):
data_view = og.AttributeValueHelper(self._attributes.gesture)
return data_view.get()
@gesture.setter
def gesture(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.gesture)
data_view = og.AttributeValueHelper(self._attributes.gesture)
data_view.set(value)
@property
def onlyPlayback(self):
data_view = og.AttributeValueHelper(self._attributes.onlyPlayback)
return data_view.get()
@onlyPlayback.setter
def onlyPlayback(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.onlyPlayback)
data_view = og.AttributeValueHelper(self._attributes.onlyPlayback)
data_view.set(value)
@property
def useNormalizedCoords(self):
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
return data_view.get()
@useNormalizedCoords.setter
def useNormalizedCoords(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.useNormalizedCoords)
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
data_view.set(value)
@property
def viewport(self):
data_view = og.AttributeValueHelper(self._attributes.viewport)
return data_view.get()
@viewport.setter
def viewport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.viewport)
data_view = og.AttributeValueHelper(self._attributes.viewport)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def isReleasePositionValid(self):
data_view = og.AttributeValueHelper(self._attributes.isReleasePositionValid)
return data_view.get()
@isReleasePositionValid.setter
def isReleasePositionValid(self, value):
data_view = og.AttributeValueHelper(self._attributes.isReleasePositionValid)
data_view.set(value)
@property
def pressPosition(self):
data_view = og.AttributeValueHelper(self._attributes.pressPosition)
return data_view.get()
@pressPosition.setter
def pressPosition(self, value):
data_view = og.AttributeValueHelper(self._attributes.pressPosition)
data_view.set(value)
@property
def pressed(self):
data_view = og.AttributeValueHelper(self._attributes.pressed)
return data_view.get()
@pressed.setter
def pressed(self, value):
data_view = og.AttributeValueHelper(self._attributes.pressed)
data_view.set(value)
@property
def releasePosition(self):
data_view = og.AttributeValueHelper(self._attributes.releasePosition)
return data_view.get()
@releasePosition.setter
def releasePosition(self, value):
data_view = og.AttributeValueHelper(self._attributes.releasePosition)
data_view.set(value)
@property
def released(self):
data_view = og.AttributeValueHelper(self._attributes.released)
return data_view.get()
@released.setter
def released(self, value):
data_view = og.AttributeValueHelper(self._attributes.released)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnOnViewportPressedDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnOnViewportPressedDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnOnViewportPressedDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 11,292 | Python | 50.56621 | 505 | 0.67136 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnReadPickStateDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.ReadPickState
Read the state of the last picking event from the specified viewport. Note that picking events must be enabled on the specified
viewport using a SetViewportMode node.
"""
import numpy
import usdrt
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnReadPickStateDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.ReadPickState
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.gesture
inputs.trackedPrimPaths
inputs.trackedPrims
inputs.usePaths
inputs.viewport
Outputs:
outputs.isTrackedPrimPicked
outputs.isValid
outputs.pickedPrim
outputs.pickedPrimPath
outputs.pickedWorldPos
Predefined Tokens:
tokens.LeftMouseClick
tokens.RightMouseClick
tokens.MiddleMouseClick
tokens.LeftMousePress
tokens.RightMousePress
tokens.MiddleMousePress
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:gesture', 'token', 0, 'Gesture', 'The input gesture to trigger a picking event', {'displayGroup': 'parameters', ogn.MetadataKeys.ALLOWED_TOKENS: 'Left Mouse Click,Right Mouse Click,Middle Mouse Click,Left Mouse Press,Right Mouse Press,Middle Mouse Press', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"LeftMouseClick": "Left Mouse Click", "RightMouseClick": "Right Mouse Click", "MiddleMouseClick": "Middle Mouse Click", "LeftMousePress": "Left Mouse Press", "RightMousePress": "Right Mouse Press", "MiddleMousePress": "Middle Mouse Press"}', ogn.MetadataKeys.DEFAULT: '"Left Mouse Click"'}, True, "Left Mouse Click", False, ''),
('inputs:trackedPrimPaths', 'token[]', 0, 'Tracked Prim Paths', "Optionally specify a set of prims (by paths) to track whether or not they got picked\n(only affects the value of 'Is Tracked Prim Picked')", {}, False, None, True, 'Use the trackedPrims input instead'),
('inputs:trackedPrims', 'target', 0, 'Tracked Prims', "Optionally specify a set of prims to track whether or not they got picked\n(only affects the value of 'Is Tracked Prim Picked')", {ogn.MetadataKeys.ALLOW_MULTI_INPUTS: '1'}, False, [], False, ''),
('inputs:usePaths', 'bool', 0, 'Use Paths', "When true, 'Tracked Prim Paths' is used, otherwise 'Tracked Prims' is used", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to watch for picking events', {ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:isTrackedPrimPicked', 'bool', 0, 'Is Tracked Prim Picked', 'True if a tracked prim got picked in the last picking event,\nor if any prim got picked if no tracked prims are specified', {}, True, None, False, ''),
('outputs:isValid', 'bool', 0, 'Is Valid', 'True if a valid event state was detected and the outputs of this node are valid, and false otherwise', {}, True, None, False, ''),
('outputs:pickedPrim', 'target', 0, 'Picked Prim', 'The picked prim, or an empty target if nothing got picked', {}, True, [], False, ''),
('outputs:pickedPrimPath', 'token', 0, 'Picked Prim Path', 'The path of the prim picked in the last picking event, or an empty string if nothing got picked', {}, True, None, True, 'Use the pickedPrim output instead'),
('outputs:pickedWorldPos', 'point3d', 0, 'Picked World Position', 'The XYZ-coordinates of the point in world space at which the prim got picked,\nor (0,0,0) if nothing got picked', {}, True, None, False, ''),
])
class tokens:
LeftMouseClick = "Left Mouse Click"
RightMouseClick = "Right Mouse Click"
MiddleMouseClick = "Middle Mouse Click"
LeftMousePress = "Left Mouse Press"
RightMousePress = "Right Mouse Press"
MiddleMousePress = "Middle Mouse Press"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.trackedPrims = og.AttributeRole.TARGET
role_data.outputs.pickedPrim = og.AttributeRole.TARGET
role_data.outputs.pickedWorldPos = og.AttributeRole.POSITION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def gesture(self):
data_view = og.AttributeValueHelper(self._attributes.gesture)
return data_view.get()
@gesture.setter
def gesture(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.gesture)
data_view = og.AttributeValueHelper(self._attributes.gesture)
data_view.set(value)
@property
def trackedPrimPaths(self):
data_view = og.AttributeValueHelper(self._attributes.trackedPrimPaths)
return data_view.get()
@trackedPrimPaths.setter
def trackedPrimPaths(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.trackedPrimPaths)
data_view = og.AttributeValueHelper(self._attributes.trackedPrimPaths)
data_view.set(value)
self.trackedPrimPaths_size = data_view.get_array_size()
@property
def trackedPrims(self):
data_view = og.AttributeValueHelper(self._attributes.trackedPrims)
return data_view.get()
@trackedPrims.setter
def trackedPrims(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.trackedPrims)
data_view = og.AttributeValueHelper(self._attributes.trackedPrims)
data_view.set(value)
self.trackedPrims_size = data_view.get_array_size()
@property
def usePaths(self):
data_view = og.AttributeValueHelper(self._attributes.usePaths)
return data_view.get()
@usePaths.setter
def usePaths(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.usePaths)
data_view = og.AttributeValueHelper(self._attributes.usePaths)
data_view.set(value)
@property
def viewport(self):
data_view = og.AttributeValueHelper(self._attributes.viewport)
return data_view.get()
@viewport.setter
def viewport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.viewport)
data_view = og.AttributeValueHelper(self._attributes.viewport)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.pickedPrim_size = None
self._batchedWriteValues = { }
@property
def isTrackedPrimPicked(self):
data_view = og.AttributeValueHelper(self._attributes.isTrackedPrimPicked)
return data_view.get()
@isTrackedPrimPicked.setter
def isTrackedPrimPicked(self, value):
data_view = og.AttributeValueHelper(self._attributes.isTrackedPrimPicked)
data_view.set(value)
@property
def isValid(self):
data_view = og.AttributeValueHelper(self._attributes.isValid)
return data_view.get()
@isValid.setter
def isValid(self, value):
data_view = og.AttributeValueHelper(self._attributes.isValid)
data_view.set(value)
@property
def pickedPrim(self):
data_view = og.AttributeValueHelper(self._attributes.pickedPrim)
return data_view.get(reserved_element_count=self.pickedPrim_size)
@pickedPrim.setter
def pickedPrim(self, value):
data_view = og.AttributeValueHelper(self._attributes.pickedPrim)
data_view.set(value)
self.pickedPrim_size = data_view.get_array_size()
@property
def pickedPrimPath(self):
data_view = og.AttributeValueHelper(self._attributes.pickedPrimPath)
return data_view.get()
@pickedPrimPath.setter
def pickedPrimPath(self, value):
data_view = og.AttributeValueHelper(self._attributes.pickedPrimPath)
data_view.set(value)
@property
def pickedWorldPos(self):
data_view = og.AttributeValueHelper(self._attributes.pickedWorldPos)
return data_view.get()
@pickedWorldPos.setter
def pickedWorldPos(self, value):
data_view = og.AttributeValueHelper(self._attributes.pickedWorldPos)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnReadPickStateDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnReadPickStateDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnReadPickStateDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 12,176 | Python | 48.702041 | 640 | 0.662861 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnSetViewportFullscreenDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.SetViewportFullscreen
Toggles fullscreen on/off for viewport(s) and visibility on/off for all other panes.
"""
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnSetViewportFullscreenDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.SetViewportFullscreen
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.exec
inputs.mode
Outputs:
outputs.exec
Predefined Tokens:
tokens.Default
tokens.Fullscreen
tokens.HideUI
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:exec', 'execution', 0, None, 'The input execution', {}, True, None, False, ''),
('inputs:mode', 'token', 0, 'Mode', 'The mode to toggle fullscreen on/off for viewport(s) and visibility on/off for all other panes:\n\n"Default" - Windowed viewport(s) with all other panes shown.\n"Fullscreen" - Fullscreen viewport(s) with all other panes hidden.\n"Hide UI" - Windowed viewport(s) with all other panes hidden.', {ogn.MetadataKeys.ALLOWED_TOKENS: 'Default,Fullscreen,Hide UI', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"Default": "Default", "Fullscreen": "Fullscreen", "HideUI": "Hide UI"}', ogn.MetadataKeys.DEFAULT: '"Default"'}, True, "Default", False, ''),
('outputs:exec', 'execution', 0, None, 'The output execution', {}, True, None, False, ''),
])
class tokens:
Default = "Default"
Fullscreen = "Fullscreen"
HideUI = "Hide UI"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.exec = og.AttributeRole.EXECUTION
role_data.outputs.exec = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def exec(self):
data_view = og.AttributeValueHelper(self._attributes.exec)
return data_view.get()
@exec.setter
def exec(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.exec)
data_view = og.AttributeValueHelper(self._attributes.exec)
data_view.set(value)
@property
def mode(self):
data_view = og.AttributeValueHelper(self._attributes.mode)
return data_view.get()
@mode.setter
def mode(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.mode)
data_view = og.AttributeValueHelper(self._attributes.mode)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def exec(self):
data_view = og.AttributeValueHelper(self._attributes.exec)
return data_view.get()
@exec.setter
def exec(self, value):
data_view = og.AttributeValueHelper(self._attributes.exec)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnSetViewportFullscreenDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnSetViewportFullscreenDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnSetViewportFullscreenDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 6,593 | Python | 45.765957 | 582 | 0.664493 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnPrintTextDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.PrintText
Prints some text to the system log or to the screen
"""
import sys
import traceback
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnPrintTextDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.PrintText
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.execIn
inputs.logLevel
inputs.text
inputs.toScreen
inputs.viewport
Outputs:
outputs.execOut
Predefined Tokens:
tokens.Info
tokens.Warning
tokens.Error
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:execIn', 'execution', 0, 'In', 'Execution input', {}, True, None, False, ''),
('inputs:logLevel', 'token', 0, 'Log Level', 'The logging level for the message [Info, Warning, Error]', {ogn.MetadataKeys.ALLOWED_TOKENS: 'Info,Warning,Error', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '["Info", "Warning", "Error"]', ogn.MetadataKeys.DEFAULT: '"Info"'}, True, "Info", False, ''),
('inputs:text', 'string', 0, 'Text', 'The text to print', {}, True, "", False, ''),
('inputs:toScreen', 'bool', 0, 'To Screen', 'When true, displays the text on the viewport for a few seconds, as well as the log', {}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport if printing to screen, or empty for the default viewport', {}, True, "", False, ''),
('outputs:execOut', 'execution', 0, 'Out', 'Execution Output', {}, True, None, False, ''),
])
class tokens:
Info = "Info"
Warning = "Warning"
Error = "Error"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.execIn = og.AttributeRole.EXECUTION
role_data.inputs.text = og.AttributeRole.TEXT
role_data.outputs.execOut = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = {"execIn", "logLevel", "text", "toScreen", "viewport", "_setting_locked", "_batchedReadAttributes", "_batchedReadValues"}
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = [self._attributes.execIn, self._attributes.logLevel, self._attributes.text, self._attributes.toScreen, self._attributes.viewport]
self._batchedReadValues = [None, "Info", "", False, ""]
@property
def execIn(self):
return self._batchedReadValues[0]
@execIn.setter
def execIn(self, value):
self._batchedReadValues[0] = value
@property
def logLevel(self):
return self._batchedReadValues[1]
@logLevel.setter
def logLevel(self, value):
self._batchedReadValues[1] = value
@property
def text(self):
return self._batchedReadValues[2]
@text.setter
def text(self, value):
self._batchedReadValues[2] = value
@property
def toScreen(self):
return self._batchedReadValues[3]
@toScreen.setter
def toScreen(self, value):
self._batchedReadValues[3] = value
@property
def viewport(self):
return self._batchedReadValues[4]
@viewport.setter
def viewport(self, value):
self._batchedReadValues[4] = value
def __getattr__(self, item: str):
if item in self.LOCAL_PROPERTY_NAMES:
return object.__getattribute__(self, item)
else:
return super().__getattr__(item)
def __setattr__(self, item: str, new_value):
if item in self.LOCAL_PROPERTY_NAMES:
object.__setattr__(self, item, new_value)
else:
super().__setattr__(item, new_value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = {"execOut", "_batchedWriteValues"}
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def execOut(self):
value = self._batchedWriteValues.get(self._attributes.execOut)
if value:
return value
else:
data_view = og.AttributeValueHelper(self._attributes.execOut)
return data_view.get()
@execOut.setter
def execOut(self, value):
self._batchedWriteValues[self._attributes.execOut] = value
def __getattr__(self, item: str):
if item in self.LOCAL_PROPERTY_NAMES:
return object.__getattribute__(self, item)
else:
return super().__getattr__(item)
def __setattr__(self, item: str, new_value):
if item in self.LOCAL_PROPERTY_NAMES:
object.__setattr__(self, item, new_value)
else:
super().__setattr__(item, new_value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnPrintTextDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnPrintTextDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnPrintTextDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
class abi:
"""Class defining the ABI interface for the node type"""
@staticmethod
def get_node_type():
get_node_type_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'get_node_type', None)
if callable(get_node_type_function):
return get_node_type_function()
return 'omni.graph.ui_nodes.PrintText'
@staticmethod
def compute(context, node):
def database_valid():
return True
try:
per_node_data = OgnPrintTextDatabase.PER_NODE_DATA[node.node_id()]
db = per_node_data.get('_db')
if db is None:
db = OgnPrintTextDatabase(node)
per_node_data['_db'] = db
if not database_valid():
per_node_data['_db'] = None
return False
except:
db = OgnPrintTextDatabase(node)
try:
compute_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'compute', None)
if callable(compute_function) and compute_function.__code__.co_argcount > 1:
return compute_function(context, node)
db.inputs._prefetch()
db.inputs._setting_locked = True
with og.in_compute():
return OgnPrintTextDatabase.NODE_TYPE_CLASS.compute(db)
except Exception as error:
stack_trace = "".join(traceback.format_tb(sys.exc_info()[2].tb_next))
db.log_error(f'Assertion raised in compute - {error}\n{stack_trace}', add_context=False)
finally:
db.inputs._setting_locked = False
db.outputs._commit()
return False
@staticmethod
def initialize(context, node):
OgnPrintTextDatabase._initialize_per_node_data(node)
initialize_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'initialize', None)
if callable(initialize_function):
initialize_function(context, node)
per_node_data = OgnPrintTextDatabase.PER_NODE_DATA[node.node_id()]
def on_connection_or_disconnection(*args):
per_node_data['_db'] = None
node.register_on_connected_callback(on_connection_or_disconnection)
node.register_on_disconnected_callback(on_connection_or_disconnection)
@staticmethod
def release(node):
release_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'release', None)
if callable(release_function):
release_function(node)
OgnPrintTextDatabase._release_per_node_data(node)
@staticmethod
def release_instance(node, target):
OgnPrintTextDatabase._release_per_node_instance_data(node, target)
@staticmethod
def update_node_version(context, node, old_version, new_version):
update_node_version_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'update_node_version', None)
if callable(update_node_version_function):
return update_node_version_function(context, node, old_version, new_version)
return False
@staticmethod
def initialize_type(node_type):
initialize_type_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'initialize_type', None)
needs_initializing = True
if callable(initialize_type_function):
needs_initializing = initialize_type_function(node_type)
if needs_initializing:
node_type.set_metadata(ogn.MetadataKeys.EXTENSION, "omni.graph.ui_nodes")
node_type.set_metadata(ogn.MetadataKeys.TAGS, "logging,toast,debug")
node_type.set_metadata(ogn.MetadataKeys.UI_NAME, "Print Text")
node_type.set_metadata(ogn.MetadataKeys.CATEGORIES, "debug")
node_type.set_metadata(ogn.MetadataKeys.DESCRIPTION, "Prints some text to the system log or to the screen")
node_type.set_metadata(ogn.MetadataKeys.EXCLUSIONS, "tests")
node_type.set_metadata(ogn.MetadataKeys.LANGUAGE, "Python")
OgnPrintTextDatabase.INTERFACE.add_to_node_type(node_type)
@staticmethod
def on_connection_type_resolve(node):
on_connection_type_resolve_function = getattr(OgnPrintTextDatabase.NODE_TYPE_CLASS, 'on_connection_type_resolve', None)
if callable(on_connection_type_resolve_function):
on_connection_type_resolve_function(node)
NODE_TYPE_CLASS = None
@staticmethod
def register(node_type_class):
OgnPrintTextDatabase.NODE_TYPE_CLASS = node_type_class
og.register_node_type(OgnPrintTextDatabase.abi, 1)
@staticmethod
def deregister():
og.deregister_node_type("omni.graph.ui_nodes.PrintText")
| 13,270 | Python | 43.089701 | 300 | 0.62208 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnOnPickedDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.OnPicked
Event node which fires when a picking event occurs in the specified viewport. Note that picking events must be enabled on
the specified viewport using a SetViewportMode node.
"""
import numpy
import usdrt
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnOnPickedDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.OnPicked
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.gesture
inputs.onlyPlayback
inputs.trackedPrims
inputs.viewport
Outputs:
outputs.isTrackedPrimPicked
outputs.missed
outputs.picked
outputs.pickedPrim
outputs.pickedPrimPath
outputs.pickedWorldPos
outputs.trackedPrimPaths
Predefined Tokens:
tokens.LeftMouseClick
tokens.RightMouseClick
tokens.MiddleMouseClick
tokens.LeftMousePress
tokens.RightMousePress
tokens.MiddleMousePress
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:gesture', 'token', 0, 'Gesture', 'The input gesture to trigger a picking event', {'displayGroup': 'parameters', ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.ALLOWED_TOKENS: 'Left Mouse Click,Right Mouse Click,Middle Mouse Click,Left Mouse Press,Right Mouse Press,Middle Mouse Press', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"LeftMouseClick": "Left Mouse Click", "RightMouseClick": "Right Mouse Click", "MiddleMouseClick": "Middle Mouse Click", "LeftMousePress": "Left Mouse Press", "RightMousePress": "Right Mouse Press", "MiddleMousePress": "Middle Mouse Press"}', ogn.MetadataKeys.DEFAULT: '"Left Mouse Click"'}, True, "Left Mouse Click", False, ''),
('inputs:onlyPlayback', 'bool', 0, 'Only Simulate On Play', 'When true, the node is only computed while Stage is being played.', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:trackedPrims', 'target', 0, 'Tracked Prims', "Optionally specify a set of tracked prims that will cause 'Picked' to fire when picked", {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.ALLOW_MULTI_INPUTS: '1'}, False, [], False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to watch for picking events', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:isTrackedPrimPicked', 'bool', 0, 'Is Tracked Prim Picked', "True if a tracked prim got picked, or if any prim got picked if no tracked prims are specified\n(will always be true when 'Picked' fires, and false when 'Missed' fires)", {}, True, None, False, ''),
('outputs:missed', 'execution', 0, 'Missed', 'Enabled when an attempted picking did not pick a tracked prim,\nor when nothing gets picked if no tracked prims are specified', {}, True, None, False, ''),
('outputs:picked', 'execution', 0, 'Picked', 'Enabled when a tracked prim is picked,\nor when any prim is picked if no tracked prims are specified', {}, True, None, False, ''),
('outputs:pickedPrim', 'target', 0, 'Picked Prim', 'The picked prim, or an empty target if nothing got picked', {}, True, [], False, ''),
('outputs:pickedPrimPath', 'token', 0, 'Picked Prim Path', 'The path of the picked prim, or an empty string if nothing got picked', {}, True, None, True, 'Use the pickedPrim output instead'),
('outputs:pickedWorldPos', 'point3d', 0, 'Picked World Position', 'The XYZ-coordinates of the point in world space at which the prim got picked,\nor (0,0,0) if nothing got picked', {}, True, None, False, ''),
('outputs:trackedPrimPaths', 'token[]', 0, 'Tracked Prim Paths', "A list of the paths of the prims specified in 'Tracked Prims'", {}, True, None, False, ''),
])
class tokens:
LeftMouseClick = "Left Mouse Click"
RightMouseClick = "Right Mouse Click"
MiddleMouseClick = "Middle Mouse Click"
LeftMousePress = "Left Mouse Press"
RightMousePress = "Right Mouse Press"
MiddleMousePress = "Middle Mouse Press"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.trackedPrims = og.AttributeRole.TARGET
role_data.outputs.missed = og.AttributeRole.EXECUTION
role_data.outputs.picked = og.AttributeRole.EXECUTION
role_data.outputs.pickedPrim = og.AttributeRole.TARGET
role_data.outputs.pickedWorldPos = og.AttributeRole.POSITION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def gesture(self):
data_view = og.AttributeValueHelper(self._attributes.gesture)
return data_view.get()
@gesture.setter
def gesture(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.gesture)
data_view = og.AttributeValueHelper(self._attributes.gesture)
data_view.set(value)
@property
def onlyPlayback(self):
data_view = og.AttributeValueHelper(self._attributes.onlyPlayback)
return data_view.get()
@onlyPlayback.setter
def onlyPlayback(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.onlyPlayback)
data_view = og.AttributeValueHelper(self._attributes.onlyPlayback)
data_view.set(value)
@property
def trackedPrims(self):
data_view = og.AttributeValueHelper(self._attributes.trackedPrims)
return data_view.get()
@trackedPrims.setter
def trackedPrims(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.trackedPrims)
data_view = og.AttributeValueHelper(self._attributes.trackedPrims)
data_view.set(value)
self.trackedPrims_size = data_view.get_array_size()
@property
def viewport(self):
data_view = og.AttributeValueHelper(self._attributes.viewport)
return data_view.get()
@viewport.setter
def viewport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.viewport)
data_view = og.AttributeValueHelper(self._attributes.viewport)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self.pickedPrim_size = None
self.trackedPrimPaths_size = None
self._batchedWriteValues = { }
@property
def isTrackedPrimPicked(self):
data_view = og.AttributeValueHelper(self._attributes.isTrackedPrimPicked)
return data_view.get()
@isTrackedPrimPicked.setter
def isTrackedPrimPicked(self, value):
data_view = og.AttributeValueHelper(self._attributes.isTrackedPrimPicked)
data_view.set(value)
@property
def missed(self):
data_view = og.AttributeValueHelper(self._attributes.missed)
return data_view.get()
@missed.setter
def missed(self, value):
data_view = og.AttributeValueHelper(self._attributes.missed)
data_view.set(value)
@property
def picked(self):
data_view = og.AttributeValueHelper(self._attributes.picked)
return data_view.get()
@picked.setter
def picked(self, value):
data_view = og.AttributeValueHelper(self._attributes.picked)
data_view.set(value)
@property
def pickedPrim(self):
data_view = og.AttributeValueHelper(self._attributes.pickedPrim)
return data_view.get(reserved_element_count=self.pickedPrim_size)
@pickedPrim.setter
def pickedPrim(self, value):
data_view = og.AttributeValueHelper(self._attributes.pickedPrim)
data_view.set(value)
self.pickedPrim_size = data_view.get_array_size()
@property
def pickedPrimPath(self):
data_view = og.AttributeValueHelper(self._attributes.pickedPrimPath)
return data_view.get()
@pickedPrimPath.setter
def pickedPrimPath(self, value):
data_view = og.AttributeValueHelper(self._attributes.pickedPrimPath)
data_view.set(value)
@property
def pickedWorldPos(self):
data_view = og.AttributeValueHelper(self._attributes.pickedWorldPos)
return data_view.get()
@pickedWorldPos.setter
def pickedWorldPos(self, value):
data_view = og.AttributeValueHelper(self._attributes.pickedWorldPos)
data_view.set(value)
@property
def trackedPrimPaths(self):
data_view = og.AttributeValueHelper(self._attributes.trackedPrimPaths)
return data_view.get(reserved_element_count=self.trackedPrimPaths_size)
@trackedPrimPaths.setter
def trackedPrimPaths(self, value):
data_view = og.AttributeValueHelper(self._attributes.trackedPrimPaths)
data_view.set(value)
self.trackedPrimPaths_size = data_view.get_array_size()
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnOnPickedDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnOnPickedDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnOnPickedDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 12,859 | Python | 48.844961 | 676 | 0.66226 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnReadMouseStateDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.ReadMouseState
Reads the current state of the mouse. You can choose which mouse element this node is associated with. When mouse element
is chosen to be a button, only outputs:isPressed is meaningful. When coordinates are chosen, only outputs:coords and outputs:window
are meaningful.
Pixel coordinates are the position of the mouse cursor in screen pixel units with (0,0) top left. Normalized
coordinates are values between 0-1 where 0 is top/left and 1 is bottom/right. By default, coordinates are relative to the
application window, but if 'Use Relative Coords' is set to true, then coordinates are relative to the workspace window containing
the mouse pointer.
"""
import numpy
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnReadMouseStateDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.ReadMouseState
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.mouseElement
inputs.useRelativeCoords
Outputs:
outputs.coords
outputs.isPressed
outputs.window
Predefined Tokens:
tokens.LeftButton
tokens.RightButton
tokens.MiddleButton
tokens.ForwardButton
tokens.BackButton
tokens.MouseCoordsNormalized
tokens.MouseCoordsPixel
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:mouseElement', 'token', 0, 'Mouse Element', 'The mouse input to check the state of', {'displayGroup': 'parameters', ogn.MetadataKeys.ALLOWED_TOKENS: 'Left Button,Right Button,Middle Button,Forward Button,Back Button,Normalized Mouse Coordinates,Pixel Mouse Coordinates', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"LeftButton": "Left Button", "RightButton": "Right Button", "MiddleButton": "Middle Button", "ForwardButton": "Forward Button", "BackButton": "Back Button", "MouseCoordsNormalized": "Normalized Mouse Coordinates", "MouseCoordsPixel": "Pixel Mouse Coordinates"}', ogn.MetadataKeys.DEFAULT: '"Left Button"'}, True, "Left Button", False, ''),
('inputs:useRelativeCoords', 'bool', 0, 'Use Relative Coords', "When true, the output 'coords' is made relative to the workspace window containing the\nmouse pointer instead of the entire application window", {}, True, False, False, ''),
('outputs:coords', 'float2', 0, None, 'The coordinates of the mouse. If the mouse element selected is a button, this will output a zero vector.', {}, True, None, False, ''),
('outputs:isPressed', 'bool', 0, None, 'True if the button is currently pressed, false otherwise. If the mouse element selected\nis a coordinate, this will output false.', {}, True, None, False, ''),
('outputs:window', 'token', 0, None, "The name of the workspace window containing the mouse pointer if 'Use Relative Coords' is true\nand the mouse element selected is a coordinate", {}, True, None, False, ''),
])
class tokens:
LeftButton = "Left Button"
RightButton = "Right Button"
MiddleButton = "Middle Button"
ForwardButton = "Forward Button"
BackButton = "Back Button"
MouseCoordsNormalized = "Normalized Mouse Coordinates"
MouseCoordsPixel = "Pixel Mouse Coordinates"
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def mouseElement(self):
data_view = og.AttributeValueHelper(self._attributes.mouseElement)
return data_view.get()
@mouseElement.setter
def mouseElement(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.mouseElement)
data_view = og.AttributeValueHelper(self._attributes.mouseElement)
data_view.set(value)
@property
def useRelativeCoords(self):
data_view = og.AttributeValueHelper(self._attributes.useRelativeCoords)
return data_view.get()
@useRelativeCoords.setter
def useRelativeCoords(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.useRelativeCoords)
data_view = og.AttributeValueHelper(self._attributes.useRelativeCoords)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def coords(self):
data_view = og.AttributeValueHelper(self._attributes.coords)
return data_view.get()
@coords.setter
def coords(self, value):
data_view = og.AttributeValueHelper(self._attributes.coords)
data_view.set(value)
@property
def isPressed(self):
data_view = og.AttributeValueHelper(self._attributes.isPressed)
return data_view.get()
@isPressed.setter
def isPressed(self, value):
data_view = og.AttributeValueHelper(self._attributes.isPressed)
data_view.set(value)
@property
def window(self):
data_view = og.AttributeValueHelper(self._attributes.window)
return data_view.get()
@window.setter
def window(self, value):
data_view = og.AttributeValueHelper(self._attributes.window)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnReadMouseStateDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnReadMouseStateDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnReadMouseStateDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 8,753 | Python | 49.895349 | 666 | 0.681595 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnReadViewportHoverStateDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.ReadViewportHoverState
Read the state of the last viewport hover event from the specified viewport. Note that viewport mouse events must be enabled
on the specified viewport using a SetViewportMode node.
"""
import numpy
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnReadViewportHoverStateDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.ReadViewportHoverState
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.useNormalizedCoords
inputs.viewport
Outputs:
outputs.isHovered
outputs.isValid
outputs.position
outputs.velocity
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:useNormalizedCoords', 'bool', 0, 'Use Normalized Coords', 'When true, the components of 2D position and velocity outputs are scaled to between 0 and 1,\nwhere 0 is top/left and 1 is bottom/right.\nWhen false, components are in viewport render resolution pixels.', {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to watch for hover events', {ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:isHovered', 'bool', 0, 'Is Hovered', 'True if the specified viewport is currently hovered', {}, True, None, False, ''),
('outputs:isValid', 'bool', 0, 'Is Valid', 'True if a valid event state was detected and the outputs of this node are valid, and false otherwise', {}, True, None, False, ''),
('outputs:position', 'double2', 0, 'Position', 'The current mouse position if the specified viewport is currently hovered, otherwise (0,0)', {}, True, None, False, ''),
('outputs:velocity', 'double2', 0, 'Velocity', 'A vector representing the change in position of the mouse since the previous frame\nif the specified viewport is currently hovered, otherwise (0,0)', {}, True, None, False, ''),
])
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def useNormalizedCoords(self):
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
return data_view.get()
@useNormalizedCoords.setter
def useNormalizedCoords(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.useNormalizedCoords)
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
data_view.set(value)
@property
def viewport(self):
data_view = og.AttributeValueHelper(self._attributes.viewport)
return data_view.get()
@viewport.setter
def viewport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.viewport)
data_view = og.AttributeValueHelper(self._attributes.viewport)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def isHovered(self):
data_view = og.AttributeValueHelper(self._attributes.isHovered)
return data_view.get()
@isHovered.setter
def isHovered(self, value):
data_view = og.AttributeValueHelper(self._attributes.isHovered)
data_view.set(value)
@property
def isValid(self):
data_view = og.AttributeValueHelper(self._attributes.isValid)
return data_view.get()
@isValid.setter
def isValid(self, value):
data_view = og.AttributeValueHelper(self._attributes.isValid)
data_view.set(value)
@property
def position(self):
data_view = og.AttributeValueHelper(self._attributes.position)
return data_view.get()
@position.setter
def position(self, value):
data_view = og.AttributeValueHelper(self._attributes.position)
data_view.set(value)
@property
def velocity(self):
data_view = og.AttributeValueHelper(self._attributes.velocity)
return data_view.get()
@velocity.setter
def velocity(self, value):
data_view = og.AttributeValueHelper(self._attributes.velocity)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnReadViewportHoverStateDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnReadViewportHoverStateDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnReadViewportHoverStateDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 7,873 | Python | 47.906832 | 342 | 0.668741 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnDrawDebugCurveDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.DrawDebugCurve
Given a set of curve points, draw a curve in the viewport
"""
import numpy
import sys
import traceback
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnDrawDebugCurveDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.DrawDebugCurve
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.closed
inputs.color
inputs.curvepoints
inputs.execIn
Outputs:
outputs.execOut
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:closed', 'bool', 0, 'Closed', 'When true, connect the last point to the first', {}, True, False, False, ''),
('inputs:color', 'color3f', 0, 'Color', 'The color of the curve', {}, True, [0.0, 0.0, 0.0], False, ''),
('inputs:curvepoints', 'double3[]', 0, 'Curve Points', 'The curve to be drawn', {}, True, [], False, ''),
('inputs:execIn', 'execution', 0, 'In', 'Execution input', {}, True, None, False, ''),
('outputs:execOut', 'execution', 0, 'Out', 'Execution Output', {}, True, None, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.color = og.AttributeRole.COLOR
role_data.inputs.execIn = og.AttributeRole.EXECUTION
role_data.outputs.execOut = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = {"closed", "color", "execIn", "_setting_locked", "_batchedReadAttributes", "_batchedReadValues"}
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = [self._attributes.closed, self._attributes.color, self._attributes.execIn]
self._batchedReadValues = [False, [0.0, 0.0, 0.0], None]
@property
def curvepoints(self):
data_view = og.AttributeValueHelper(self._attributes.curvepoints)
return data_view.get()
@curvepoints.setter
def curvepoints(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.curvepoints)
data_view = og.AttributeValueHelper(self._attributes.curvepoints)
data_view.set(value)
self.curvepoints_size = data_view.get_array_size()
@property
def closed(self):
return self._batchedReadValues[0]
@closed.setter
def closed(self, value):
self._batchedReadValues[0] = value
@property
def color(self):
return self._batchedReadValues[1]
@color.setter
def color(self, value):
self._batchedReadValues[1] = value
@property
def execIn(self):
return self._batchedReadValues[2]
@execIn.setter
def execIn(self, value):
self._batchedReadValues[2] = value
def __getattr__(self, item: str):
if item in self.LOCAL_PROPERTY_NAMES:
return object.__getattribute__(self, item)
else:
return super().__getattr__(item)
def __setattr__(self, item: str, new_value):
if item in self.LOCAL_PROPERTY_NAMES:
object.__setattr__(self, item, new_value)
else:
super().__setattr__(item, new_value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = {"execOut", "_batchedWriteValues"}
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def execOut(self):
value = self._batchedWriteValues.get(self._attributes.execOut)
if value:
return value
else:
data_view = og.AttributeValueHelper(self._attributes.execOut)
return data_view.get()
@execOut.setter
def execOut(self, value):
self._batchedWriteValues[self._attributes.execOut] = value
def __getattr__(self, item: str):
if item in self.LOCAL_PROPERTY_NAMES:
return object.__getattribute__(self, item)
else:
return super().__getattr__(item)
def __setattr__(self, item: str, new_value):
if item in self.LOCAL_PROPERTY_NAMES:
object.__setattr__(self, item, new_value)
else:
super().__setattr__(item, new_value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnDrawDebugCurveDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnDrawDebugCurveDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnDrawDebugCurveDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
class abi:
"""Class defining the ABI interface for the node type"""
@staticmethod
def get_node_type():
get_node_type_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'get_node_type', None)
if callable(get_node_type_function):
return get_node_type_function()
return 'omni.graph.ui_nodes.DrawDebugCurve'
@staticmethod
def compute(context, node):
def database_valid():
return True
try:
per_node_data = OgnDrawDebugCurveDatabase.PER_NODE_DATA[node.node_id()]
db = per_node_data.get('_db')
if db is None:
db = OgnDrawDebugCurveDatabase(node)
per_node_data['_db'] = db
if not database_valid():
per_node_data['_db'] = None
return False
except:
db = OgnDrawDebugCurveDatabase(node)
try:
compute_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'compute', None)
if callable(compute_function) and compute_function.__code__.co_argcount > 1:
return compute_function(context, node)
db.inputs._prefetch()
db.inputs._setting_locked = True
with og.in_compute():
return OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS.compute(db)
except Exception as error:
stack_trace = "".join(traceback.format_tb(sys.exc_info()[2].tb_next))
db.log_error(f'Assertion raised in compute - {error}\n{stack_trace}', add_context=False)
finally:
db.inputs._setting_locked = False
db.outputs._commit()
return False
@staticmethod
def initialize(context, node):
OgnDrawDebugCurveDatabase._initialize_per_node_data(node)
initialize_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'initialize', None)
if callable(initialize_function):
initialize_function(context, node)
per_node_data = OgnDrawDebugCurveDatabase.PER_NODE_DATA[node.node_id()]
def on_connection_or_disconnection(*args):
per_node_data['_db'] = None
node.register_on_connected_callback(on_connection_or_disconnection)
node.register_on_disconnected_callback(on_connection_or_disconnection)
@staticmethod
def release(node):
release_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'release', None)
if callable(release_function):
release_function(node)
OgnDrawDebugCurveDatabase._release_per_node_data(node)
@staticmethod
def release_instance(node, target):
OgnDrawDebugCurveDatabase._release_per_node_instance_data(node, target)
@staticmethod
def update_node_version(context, node, old_version, new_version):
update_node_version_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'update_node_version', None)
if callable(update_node_version_function):
return update_node_version_function(context, node, old_version, new_version)
return False
@staticmethod
def initialize_type(node_type):
initialize_type_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'initialize_type', None)
needs_initializing = True
if callable(initialize_type_function):
needs_initializing = initialize_type_function(node_type)
if needs_initializing:
node_type.set_metadata(ogn.MetadataKeys.EXTENSION, "omni.graph.ui_nodes")
node_type.set_metadata(ogn.MetadataKeys.UI_NAME, "Draw Debug Curve")
node_type.set_metadata(ogn.MetadataKeys.CATEGORIES, "debug")
node_type.set_metadata(ogn.MetadataKeys.DESCRIPTION, "Given a set of curve points, draw a curve in the viewport")
node_type.set_metadata(ogn.MetadataKeys.EXCLUSIONS, "tests")
node_type.set_metadata(ogn.MetadataKeys.LANGUAGE, "Python")
OgnDrawDebugCurveDatabase.INTERFACE.add_to_node_type(node_type)
@staticmethod
def on_connection_type_resolve(node):
on_connection_type_resolve_function = getattr(OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS, 'on_connection_type_resolve', None)
if callable(on_connection_type_resolve_function):
on_connection_type_resolve_function(node)
NODE_TYPE_CLASS = None
@staticmethod
def register(node_type_class):
OgnDrawDebugCurveDatabase.NODE_TYPE_CLASS = node_type_class
og.register_node_type(OgnDrawDebugCurveDatabase.abi, 1)
@staticmethod
def deregister():
og.deregister_node_type("omni.graph.ui_nodes.DrawDebugCurve")
| 12,801 | Python | 43.762238 | 136 | 0.626357 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnSetViewportModeDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.SetViewportMode
Sets the mode of a specified viewport window to 'Scripted' mode or 'Default' mode when executed.
'Scripted' mode disables
default viewport interaction and enables placing UI elements over the viewport. 'Default' mode is the default state of the
viewport, and entering it will destroy any UI elements on the viewport.
Executing with 'Enable Viewport Mouse Events' set
to true in 'Scripted' mode is required to allow the specified viewport to be targeted by viewport mouse event nodes, including
'On Viewport Dragged' and 'Read Viewport Drag State'.
Executing with 'Enable Picking' set to true in 'Scripted' mode is
required to allow the specified viewport to be targeted by the 'On Picked' and 'Read Pick State' nodes.
"""
import sys
import traceback
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnSetViewportModeDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.SetViewportMode
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.enablePicking
inputs.enableViewportMouseEvents
inputs.execIn
inputs.mode
inputs.passClicksThru
inputs.viewport
Outputs:
outputs.defaultMode
outputs.scriptedMode
outputs.widgetPath
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:enablePicking', 'bool', 0, 'Enable Picking', "Enable/Disable picking prims in the specified viewport when in 'Scripted' mode", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:enableViewportMouseEvents', 'bool', 0, 'Enable Viewport Mouse Events', "Enable/Disable viewport mouse events on the specified viewport when in 'Scripted' mode", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:execIn', 'execution', 0, None, 'Input execution', {}, True, None, False, ''),
('inputs:mode', 'int', 0, 'Mode', "The mode to set the specified viewport to when this node is executed (0: 'Default', 1: 'Scripted')", {ogn.MetadataKeys.DEFAULT: '0'}, True, 0, False, ''),
('inputs:passClicksThru', 'bool', 0, 'Pass Clicks Thru', "Allow mouse clicks to affect the viewport while in 'Scripted' mode.\n\nIn 'Scripted' mode mouse clicks are prevented from reaching the viewport to avoid accidentally\nselecting prims or interacting with the viewport's own UI. Setting this attribute true will\nallow clicks to reach the viewport. This is in addition to interacting with the widgets created\nby UI nodes so if a button widget appears on top of some geometry in the viewport, clicking on\nthe button will not only trigger the button but could also select the geometry. To avoid this,\nput the button inside a Stack widget and use a WriteWidgetProperty node to set the Stack's\n'content_clipping' property to 1.", {ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to set the mode of', {ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:defaultMode', 'execution', 0, 'Default Mode', "Fires when this node is successfully executed with 'Mode' set to 'Default'", {}, True, None, False, ''),
('outputs:scriptedMode', 'execution', 0, 'Scripted Mode', "Fires when this node is successfully executed with 'Mode' set to 'Scripted'", {}, True, None, False, ''),
('outputs:widgetPath', 'token', 0, 'Widget Path', "When the viewport enters 'Scripted' mode, a container widget is created under which other UI may be parented.\nThis attribute provides the absolute path to that widget, which can be used as the 'parentWidgetPath'\ninput to various UI nodes, such as Button. When the viewport exits 'Scripted' mode,\nthe container widget and all the UI within it will be destroyed.", {}, True, None, False, ''),
])
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.inputs.execIn = og.AttributeRole.EXECUTION
role_data.outputs.defaultMode = og.AttributeRole.EXECUTION
role_data.outputs.scriptedMode = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = {"enablePicking", "enableViewportMouseEvents", "execIn", "mode", "passClicksThru", "viewport", "_setting_locked", "_batchedReadAttributes", "_batchedReadValues"}
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = [self._attributes.enablePicking, self._attributes.enableViewportMouseEvents, self._attributes.execIn, self._attributes.mode, self._attributes.passClicksThru, self._attributes.viewport]
self._batchedReadValues = [False, False, None, 0, False, "Viewport"]
@property
def enablePicking(self):
return self._batchedReadValues[0]
@enablePicking.setter
def enablePicking(self, value):
self._batchedReadValues[0] = value
@property
def enableViewportMouseEvents(self):
return self._batchedReadValues[1]
@enableViewportMouseEvents.setter
def enableViewportMouseEvents(self, value):
self._batchedReadValues[1] = value
@property
def execIn(self):
return self._batchedReadValues[2]
@execIn.setter
def execIn(self, value):
self._batchedReadValues[2] = value
@property
def mode(self):
return self._batchedReadValues[3]
@mode.setter
def mode(self, value):
self._batchedReadValues[3] = value
@property
def passClicksThru(self):
return self._batchedReadValues[4]
@passClicksThru.setter
def passClicksThru(self, value):
self._batchedReadValues[4] = value
@property
def viewport(self):
return self._batchedReadValues[5]
@viewport.setter
def viewport(self, value):
self._batchedReadValues[5] = value
def __getattr__(self, item: str):
if item in self.LOCAL_PROPERTY_NAMES:
return object.__getattribute__(self, item)
else:
return super().__getattr__(item)
def __setattr__(self, item: str, new_value):
if item in self.LOCAL_PROPERTY_NAMES:
object.__setattr__(self, item, new_value)
else:
super().__setattr__(item, new_value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = {"defaultMode", "scriptedMode", "widgetPath", "_batchedWriteValues"}
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def defaultMode(self):
value = self._batchedWriteValues.get(self._attributes.defaultMode)
if value:
return value
else:
data_view = og.AttributeValueHelper(self._attributes.defaultMode)
return data_view.get()
@defaultMode.setter
def defaultMode(self, value):
self._batchedWriteValues[self._attributes.defaultMode] = value
@property
def scriptedMode(self):
value = self._batchedWriteValues.get(self._attributes.scriptedMode)
if value:
return value
else:
data_view = og.AttributeValueHelper(self._attributes.scriptedMode)
return data_view.get()
@scriptedMode.setter
def scriptedMode(self, value):
self._batchedWriteValues[self._attributes.scriptedMode] = value
@property
def widgetPath(self):
value = self._batchedWriteValues.get(self._attributes.widgetPath)
if value:
return value
else:
data_view = og.AttributeValueHelper(self._attributes.widgetPath)
return data_view.get()
@widgetPath.setter
def widgetPath(self, value):
self._batchedWriteValues[self._attributes.widgetPath] = value
def __getattr__(self, item: str):
if item in self.LOCAL_PROPERTY_NAMES:
return object.__getattribute__(self, item)
else:
return super().__getattr__(item)
def __setattr__(self, item: str, new_value):
if item in self.LOCAL_PROPERTY_NAMES:
object.__setattr__(self, item, new_value)
else:
super().__setattr__(item, new_value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnSetViewportModeDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnSetViewportModeDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnSetViewportModeDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
class abi:
"""Class defining the ABI interface for the node type"""
@staticmethod
def get_node_type():
get_node_type_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'get_node_type', None)
if callable(get_node_type_function):
return get_node_type_function()
return 'omni.graph.ui_nodes.SetViewportMode'
@staticmethod
def compute(context, node):
def database_valid():
return True
try:
per_node_data = OgnSetViewportModeDatabase.PER_NODE_DATA[node.node_id()]
db = per_node_data.get('_db')
if db is None:
db = OgnSetViewportModeDatabase(node)
per_node_data['_db'] = db
if not database_valid():
per_node_data['_db'] = None
return False
except:
db = OgnSetViewportModeDatabase(node)
try:
compute_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'compute', None)
if callable(compute_function) and compute_function.__code__.co_argcount > 1:
return compute_function(context, node)
db.inputs._prefetch()
db.inputs._setting_locked = True
with og.in_compute():
return OgnSetViewportModeDatabase.NODE_TYPE_CLASS.compute(db)
except Exception as error:
stack_trace = "".join(traceback.format_tb(sys.exc_info()[2].tb_next))
db.log_error(f'Assertion raised in compute - {error}\n{stack_trace}', add_context=False)
finally:
db.inputs._setting_locked = False
db.outputs._commit()
return False
@staticmethod
def initialize(context, node):
OgnSetViewportModeDatabase._initialize_per_node_data(node)
initialize_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'initialize', None)
if callable(initialize_function):
initialize_function(context, node)
per_node_data = OgnSetViewportModeDatabase.PER_NODE_DATA[node.node_id()]
def on_connection_or_disconnection(*args):
per_node_data['_db'] = None
node.register_on_connected_callback(on_connection_or_disconnection)
node.register_on_disconnected_callback(on_connection_or_disconnection)
@staticmethod
def release(node):
release_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'release', None)
if callable(release_function):
release_function(node)
OgnSetViewportModeDatabase._release_per_node_data(node)
@staticmethod
def release_instance(node, target):
OgnSetViewportModeDatabase._release_per_node_instance_data(node, target)
@staticmethod
def update_node_version(context, node, old_version, new_version):
update_node_version_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'update_node_version', None)
if callable(update_node_version_function):
return update_node_version_function(context, node, old_version, new_version)
return False
@staticmethod
def initialize_type(node_type):
initialize_type_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'initialize_type', None)
needs_initializing = True
if callable(initialize_type_function):
needs_initializing = initialize_type_function(node_type)
if needs_initializing:
node_type.set_metadata(ogn.MetadataKeys.EXTENSION, "omni.graph.ui_nodes")
node_type.set_metadata(ogn.MetadataKeys.UI_NAME, "Set Viewport Mode (BETA)")
node_type.set_metadata(ogn.MetadataKeys.CATEGORIES, "graph:action,ui")
node_type.set_metadata(ogn.MetadataKeys.DESCRIPTION, "Sets the mode of a specified viewport window to 'Scripted' mode or 'Default' mode when executed.\n 'Scripted' mode disables default viewport interaction and enables placing UI elements over the viewport. 'Default' mode is the default state of the viewport, and entering it will destroy any UI elements on the viewport.\n Executing with 'Enable Viewport Mouse Events' set to true in 'Scripted' mode is required to allow the specified viewport to be targeted by viewport mouse event nodes, including 'On Viewport Dragged' and 'Read Viewport Drag State'.\n Executing with 'Enable Picking' set to true in 'Scripted' mode is required to allow the specified viewport to be targeted by the 'On Picked' and 'Read Pick State' nodes.")
node_type.set_metadata(ogn.MetadataKeys.EXCLUSIONS, "tests")
node_type.set_metadata(ogn.MetadataKeys.LANGUAGE, "Python")
OgnSetViewportModeDatabase.INTERFACE.add_to_node_type(node_type)
@staticmethod
def on_connection_type_resolve(node):
on_connection_type_resolve_function = getattr(OgnSetViewportModeDatabase.NODE_TYPE_CLASS, 'on_connection_type_resolve', None)
if callable(on_connection_type_resolve_function):
on_connection_type_resolve_function(node)
NODE_TYPE_CLASS = None
@staticmethod
def register(node_type_class):
OgnSetViewportModeDatabase.NODE_TYPE_CLASS = node_type_class
og.register_node_type(OgnSetViewportModeDatabase.abi, 1)
@staticmethod
def deregister():
og.deregister_node_type("omni.graph.ui_nodes.SetViewportMode")
| 17,641 | Python | 51.195266 | 804 | 0.655575 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/OgnOnViewportDraggedDatabase.py | """Support for simplified access to data on nodes of type omni.graph.ui_nodes.OnViewportDragged
Event node which fires when a viewport drag event occurs in the specified viewport. Note that viewport mouse events must
be enabled on the specified viewport using a SetViewportMode node.
"""
import numpy
import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn
class OgnOnViewportDraggedDatabase(og.Database):
"""Helper class providing simplified access to data on nodes of type omni.graph.ui_nodes.OnViewportDragged
Class Members:
node: Node being evaluated
Attribute Value Properties:
Inputs:
inputs.gesture
inputs.onlyPlayback
inputs.useNormalizedCoords
inputs.viewport
Outputs:
outputs.began
outputs.ended
outputs.finalPosition
outputs.initialPosition
Predefined Tokens:
tokens.LeftMouseDrag
tokens.RightMouseDrag
tokens.MiddleMouseDrag
"""
# Imprint the generator and target ABI versions in the file for JIT generation
GENERATOR_VERSION = (1, 41, 3)
TARGET_VERSION = (2, 139, 12)
# This is an internal object that provides per-class storage of a per-node data dictionary
PER_NODE_DATA = {}
# This is an internal object that describes unchanging attributes in a generic way
# The values in this list are in no particular order, as a per-attribute tuple
# Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
# Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
# You should not need to access any of this data directly, use the defined database interfaces
INTERFACE = og.Database._get_interface([
('inputs:gesture', 'token', 0, 'Gesture', 'The input gesture to trigger viewport drag events', {'displayGroup': 'parameters', ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.ALLOWED_TOKENS: 'Left Mouse Drag,Right Mouse Drag,Middle Mouse Drag', ogn.MetadataKeys.ALLOWED_TOKENS_RAW: '{"LeftMouseDrag": "Left Mouse Drag", "RightMouseDrag": "Right Mouse Drag", "MiddleMouseDrag": "Middle Mouse Drag"}', ogn.MetadataKeys.DEFAULT: '"Left Mouse Drag"'}, True, "Left Mouse Drag", False, ''),
('inputs:onlyPlayback', 'bool', 0, 'Only Simulate On Play', 'When true, the node is only computed while Stage is being played', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: 'true'}, True, True, False, ''),
('inputs:useNormalizedCoords', 'bool', 0, 'Use Normalized Coords', 'When true, the components of 2D position outputs are scaled to between 0 and 1,\nwhere 0 is top/left and 1 is bottom/right.\nWhen false, components are in viewport render resolution pixels.', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: 'false'}, True, False, False, ''),
('inputs:viewport', 'token', 0, 'Viewport', 'Name of the viewport window to watch for drag events', {ogn.MetadataKeys.LITERAL_ONLY: '1', ogn.MetadataKeys.DEFAULT: '"Viewport"'}, True, "Viewport", False, ''),
('outputs:began', 'execution', 0, 'Began', "Enabled when the drag begins, populating 'Initial Position' with the current mouse position", {}, True, None, False, ''),
('outputs:ended', 'execution', 0, 'Ended', "Enabled when the drag ends, populating 'Final Position' with the current mouse position", {}, True, None, False, ''),
('outputs:finalPosition', 'double2', 0, 'Final Position', "The mouse position at which the drag ended (valid when 'Ended' is enabled)", {}, True, None, False, ''),
('outputs:initialPosition', 'double2', 0, 'Initial Position', "The mouse position at which the drag began (valid when either 'Began' or 'Ended' is enabled)", {}, True, None, False, ''),
])
class tokens:
LeftMouseDrag = "Left Mouse Drag"
RightMouseDrag = "Right Mouse Drag"
MiddleMouseDrag = "Middle Mouse Drag"
@classmethod
def _populate_role_data(cls):
"""Populate a role structure with the non-default roles on this node type"""
role_data = super()._populate_role_data()
role_data.outputs.began = og.AttributeRole.EXECUTION
role_data.outputs.ended = og.AttributeRole.EXECUTION
return role_data
class ValuesForInputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to input attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedReadAttributes = []
self._batchedReadValues = []
@property
def gesture(self):
data_view = og.AttributeValueHelper(self._attributes.gesture)
return data_view.get()
@gesture.setter
def gesture(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.gesture)
data_view = og.AttributeValueHelper(self._attributes.gesture)
data_view.set(value)
@property
def onlyPlayback(self):
data_view = og.AttributeValueHelper(self._attributes.onlyPlayback)
return data_view.get()
@onlyPlayback.setter
def onlyPlayback(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.onlyPlayback)
data_view = og.AttributeValueHelper(self._attributes.onlyPlayback)
data_view.set(value)
@property
def useNormalizedCoords(self):
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
return data_view.get()
@useNormalizedCoords.setter
def useNormalizedCoords(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.useNormalizedCoords)
data_view = og.AttributeValueHelper(self._attributes.useNormalizedCoords)
data_view.set(value)
@property
def viewport(self):
data_view = og.AttributeValueHelper(self._attributes.viewport)
return data_view.get()
@viewport.setter
def viewport(self, value):
if self._setting_locked:
raise og.ReadOnlyError(self._attributes.viewport)
data_view = og.AttributeValueHelper(self._attributes.viewport)
data_view.set(value)
def _prefetch(self):
readAttributes = self._batchedReadAttributes
newValues = _og._prefetch_input_attributes_data(readAttributes)
if len(readAttributes) == len(newValues):
self._batchedReadValues = newValues
class ValuesForOutputs(og.DynamicAttributeAccess):
LOCAL_PROPERTY_NAMES = { }
"""Helper class that creates natural hierarchical access to output attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
self._batchedWriteValues = { }
@property
def began(self):
data_view = og.AttributeValueHelper(self._attributes.began)
return data_view.get()
@began.setter
def began(self, value):
data_view = og.AttributeValueHelper(self._attributes.began)
data_view.set(value)
@property
def ended(self):
data_view = og.AttributeValueHelper(self._attributes.ended)
return data_view.get()
@ended.setter
def ended(self, value):
data_view = og.AttributeValueHelper(self._attributes.ended)
data_view.set(value)
@property
def finalPosition(self):
data_view = og.AttributeValueHelper(self._attributes.finalPosition)
return data_view.get()
@finalPosition.setter
def finalPosition(self, value):
data_view = og.AttributeValueHelper(self._attributes.finalPosition)
data_view.set(value)
@property
def initialPosition(self):
data_view = og.AttributeValueHelper(self._attributes.initialPosition)
return data_view.get()
@initialPosition.setter
def initialPosition(self, value):
data_view = og.AttributeValueHelper(self._attributes.initialPosition)
data_view.set(value)
def _commit(self):
_og._commit_output_attributes_data(self._batchedWriteValues)
self._batchedWriteValues = { }
class ValuesForState(og.DynamicAttributeAccess):
"""Helper class that creates natural hierarchical access to state attributes"""
def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
"""Initialize simplified access for the attribute data"""
context = node.get_graph().get_default_graph_context()
super().__init__(context, node, attributes, dynamic_attributes)
def __init__(self, node):
super().__init__(node)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
self.inputs = OgnOnViewportDraggedDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
self.outputs = OgnOnViewportDraggedDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
self.state = OgnOnViewportDraggedDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
| 10,185 | Python | 48.207729 | 496 | 0.664507 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnOnViewportHovered.cpp | // Copyright (c) 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.
//
#include <OgnOnViewportHoveredDatabase.h>
#include "ViewportHoverNodeCommon.h"
#include <omni/kit/IApp.h>
#include <omni/ui/Workspace.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnOnViewportHovered
{
public:
struct InternalState
{
carb::events::ISubscriptionPtr hoverBeganSub;
carb::events::ISubscriptionPtr hoverEndedSub;
ViewportHoverEventPayloads eventPayloads;
ViewportHoverEventStates eventStates;
} m_internalState;
exec::unstable::Stamp m_setStamp; // stamp set when the event occurs
exec::unstable::SyncStamp m_syncStamp; // stamp set by each instance
static void initialize(GraphContextObj const&, NodeObj const& nodeObj)
{
OgnOnViewportHovered& state = OgnOnViewportHoveredDatabase::sSharedState<OgnOnViewportHovered>(nodeObj);
// Subscribe to hover events
if (omni::kit::IApp* app = carb::getCachedInterface<omni::kit::IApp>())
{
state.m_internalState.hoverBeganSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kHoverBeganEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnOnViewportHovered& state =
OgnOnViewportHoveredDatabase::sSharedState<OgnOnViewportHovered>(nodeObj);
state.m_internalState.eventPayloads.clear();
state.m_internalState.eventPayloads.setHoverBeganPayload(e->payload);
state.m_setStamp.next();
if (nodeObj.iNode->isValid(nodeObj))
nodeObj.iNode->requestCompute(nodeObj);
}
}
);
state.m_internalState.hoverEndedSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kHoverEndedEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnOnViewportHovered& state =
OgnOnViewportHoveredDatabase::sSharedState<OgnOnViewportHovered>(nodeObj);
state.m_internalState.eventPayloads.setHoverEndedPayload(e->payload);
state.m_setStamp.next();
if (nodeObj.iNode->isValid(nodeObj))
nodeObj.iNode->requestCompute(nodeObj);
}
}
);
}
}
static void release(const NodeObj& nodeObj)
{
OgnOnViewportHovered& state = OgnOnViewportHoveredDatabase::sSharedState<OgnOnViewportHovered>(nodeObj);
// Unsubscribe from hover events
if (state.m_internalState.hoverBeganSub.get())
state.m_internalState.hoverBeganSub.detach()->unsubscribe();
if (state.m_internalState.hoverEndedSub.get())
state.m_internalState.hoverEndedSub.detach()->unsubscribe();
}
static bool compute(OgnOnViewportHoveredDatabase& db)
{
if (checkNodeDisabledForOnlyPlay(db))
return true;
OgnOnViewportHovered& sharedState = db.sharedState<OgnOnViewportHovered>();
OgnOnViewportHovered& perInstanceState = db.perInstanceState<OgnOnViewportHovered>();
if(perInstanceState.m_syncStamp.makeSync(sharedState.m_setStamp))
{
if (sharedState.m_internalState.eventPayloads.empty())
return true;
// Get the targeted viewport
char const* const viewportWindowName = db.tokenToString(db.inputs.viewport());
if (!omni::ui::Workspace::getWindow(viewportWindowName))
{
db.logWarning("Viewport window '%s' not found", viewportWindowName);
}
// Process event payloads and update event state
bool hoverBegan = false;
for (auto const& hoverBeganPayload : sharedState.m_internalState.eventPayloads.hoverBeganPayloads())
{
if (!hoverBeganPayload.second.isValid)
continue;
auto& eventStateValue = sharedState.m_internalState.eventStates[hoverBeganPayload.first];
eventStateValue.isHovered = true;
if (std::strcmp(viewportWindowName, hoverBeganPayload.first.viewportWindowName) == 0)
{
hoverBegan = true;
}
}
bool hoverEnded = false;
for (auto const& hoverEndedPayload : sharedState.m_internalState.eventPayloads.hoverEndedPayloads())
{
if (!hoverEndedPayload.second.isValid)
continue;
auto& eventStateValue = sharedState.m_internalState.eventStates[hoverEndedPayload.first];
if (eventStateValue.isHovered)
{
eventStateValue.isHovered = false;
if (std::strcmp(viewportWindowName, hoverEndedPayload.first.viewportWindowName) == 0)
{
hoverEnded = true;
}
}
}
// Get event state and set outputs
auto it = sharedState.m_internalState.eventStates.find({viewportWindowName});
if (it != sharedState.m_internalState.eventStates.end())
{
if (hoverEnded)
{
db.outputs.began() = kExecutionAttributeStateDisabled;
db.outputs.ended() = kExecutionAttributeStateEnabled;
}
else if (hoverBegan)
{
db.outputs.began() = kExecutionAttributeStateEnabled;
db.outputs.ended() = kExecutionAttributeStateDisabled;
}
else
{
db.outputs.began() = kExecutionAttributeStateDisabled;
db.outputs.ended() = kExecutionAttributeStateDisabled;
}
}
}
return true;
}
};
REGISTER_OGN_NODE()
} // ui
} // graph
} // omni
| 6,678 | C++ | 36.948863 | 112 | 0.581761 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnSlider.py | # Copyright (c) 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.
#
import omni.graph.core as og
import omni.kit.app
import omni.ui as ui
from . import UINodeCommon
class OgnSlider:
@staticmethod
def internal_state():
return UINodeCommon.OgnUINodeInternalState()
@staticmethod
def compute(db) -> bool:
# OM-97733: This node hasn't been converted to use the widget registry yet. Let's discourage
# its use.
db.log_warning("The Slider node is unsupported and may not behave as expected.")
if db.inputs.create != og.ExecutionAttributeState.DISABLED:
min_value = db.inputs.min
max_value = db.inputs.max
step = db.inputs.step
if step <= 0:
db.log_error("The step size of the slider must be positive!")
return False
width = db.inputs.width
if width <= 0:
db.log_error("The width of the slider must be positive!")
return False
widget_identifier = UINodeCommon.get_unique_widget_identifier(db)
parent_widget = UINodeCommon.get_parent_widget(db)
if parent_widget is None:
return False
# Tear down previously created widget
if db.internal_state.created_widget is not None:
UINodeCommon.tear_down_widget(db)
def on_slider_finished_dragging(model):
if not db.internal_state.created_widget.enabled:
return
message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
event_name = "value_changed_" + widget_identifier
reg_event_name = UINodeCommon.registered_event_name(event_name)
payload = {"newValue": model.get_value_as_float(), "valueType": "float"}
message_bus.push(reg_event_name, payload=payload)
# Now create the button widget and register callbacks
with parent_widget:
db.internal_state.created_frame = ui.Frame()
with db.internal_state.created_frame:
with ui.HStack(content_clipping=1):
db.internal_state.created_widget = ui.FloatSlider(
identifier=widget_identifier,
width=width,
min=min_value,
max=max_value,
step=step,
)
db.internal_state.created_widget.model.set_value((min_value + max_value) / 2)
db.internal_state.created_widget.model.add_end_edit_fn(on_slider_finished_dragging)
db.outputs.created = og.ExecutionAttributeState.ENABLED
db.outputs.widgetPath = UINodeCommon.find_widget_path(db.internal_state.created_widget)
return True
if db.inputs.tearDown != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.tear_down_widget(db)
if db.inputs.show != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.show_widget(db)
if db.inputs.hide != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.hide_widget(db)
if db.inputs.enable != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.enable_widget(db)
if db.inputs.disable != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.disable_widget(db)
db.log_warning("Unexpected execution with no execution input enabled")
return False
| 3,974 | Python | 39.979381 | 107 | 0.614494 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnLockViewportRender.py | # Copyright (c) 2023, 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 enum import Enum, auto
from omni.graph.core import ExecutionAttributeState
from omni.graph.ui_nodes.ogn.OgnLockViewportRenderDatabase import OgnLockViewportRenderDatabase
from omni.kit.viewport.utility import get_active_viewport_window
class LockState(Enum):
"""Enum for lock state"""
UNLOCKED = auto()
"""The target has been unlocked."""
LOCKED = auto()
"""The target has been locked."""
UNLOCKING = auto()
"""The target is being unlocked."""
class OgnLockViewportRenderInternalState:
"""Convenience class for maintaining per-node state information"""
def __init__(self):
self._lock_state = LockState.UNLOCKED
self._viewport_name = ""
self._viewport_api = None
self._viewport_widget = None
self._previous_freeze_frame = None
self._previous_display_delegate = None
self._elapsed_time = 0.0
self._fading_time = 1.0
@property
def lock_state(self) -> LockState:
return self._lock_state
@lock_state.setter
def lock_state(self, state: LockState):
self._lock_state = state
@property
def viewport_name(self):
return self._viewport_name
@viewport_name.setter
def viewport_name(self, name):
self._viewport_name = name
@property
def viewport_api(self):
return self._viewport_api
@viewport_api.setter
def viewport_api(self, api):
assert api is not None
self._viewport_api = api
@property
def viewport_widget(self):
return self._viewport_widget
@viewport_widget.setter
def viewport_widget(self, widget):
assert widget is not None
self._viewport_widget = widget
@property
def previous_freeze_frame(self):
return self._previous_freeze_frame
@previous_freeze_frame.setter
def previous_freeze_frame(self, freeze_frame):
assert isinstance(freeze_frame, bool)
self._previous_freeze_frame = freeze_frame
@property
def previous_display_delegate(self):
return self._previous_display_delegate
@previous_display_delegate.setter
def previous_display_delegate(self, display_delegate):
assert display_delegate is not None
self._previous_display_delegate = display_delegate
@property
def elapsed_time(self) -> float:
return self._elapsed_time
@elapsed_time.setter
def elapsed_time(self, time: float):
self._elapsed_time = time
@property
def fading_time(self) -> float:
return self._fading_time
@fading_time.setter
def fading_time(self, time: float):
self._fading_time = time
def restore_freeze_frame(self):
if self._viewport_api is not None:
assert isinstance(self._previous_freeze_frame, bool)
self._viewport_api.freeze_frame = self._previous_freeze_frame
self._viewport_api = None
self._previous_freeze_frame = None
def restore_display_delegate(self):
if self._viewport_widget is not None:
self._viewport_widget.display_delegate = self._previous_display_delegate
self._viewport_widget = None
self._previous_display_delegate = None
class OgnLockViewportRender:
"""
Locks and unlocks viewport render.
"""
@staticmethod
def internal_state():
"""Return an object that will contain per-node state information"""
return OgnLockViewportRenderInternalState()
@staticmethod
def unlock_immediately_if_locked(internal_state):
"""Unlock viewport render immediately if locked"""
assert isinstance(internal_state, OgnLockViewportRenderInternalState)
if internal_state.lock_state != LockState.UNLOCKED:
internal_state.restore_display_delegate()
internal_state.restore_freeze_frame()
internal_state.lock_state = LockState.UNLOCKED
@staticmethod
def release(node):
"""When a node is removed it will get a release call for cleanup"""
internal_state = OgnLockViewportRenderDatabase.per_node_internal_state(node)
if internal_state is not None:
OgnLockViewportRender.unlock_immediately_if_locked(internal_state)
@staticmethod
def compute(db) -> bool:
"""Compute the outputs from the current inputs"""
try:
# An extension is generally not allowed to force a specific viewport backend like omni.kit.widget.viewport
# to be loaded; instead it is the application that controls which viewport to be loaded. If the following
# import fails at runtime, it is because omni.kit.widget.viewport is not loaded by the application, then
# the node won't be supported to lock and unlock viewport render.
from omni.kit.widget.viewport.display_delegate import OverlayViewportDisplayDelegate
locked_exec_attr_state = ExecutionAttributeState.DISABLED
fade_started_exec_attr_state = ExecutionAttributeState.DISABLED
fade_complete_exec_attr_state = ExecutionAttributeState.DISABLED
internal_state = db.internal_state
# If target viewport is changed, make sure viewport render is unlocked for the previous viewport
viewport_name = db.inputs.viewport
if internal_state.viewport_name != viewport_name:
OgnLockViewportRender.unlock_immediately_if_locked(internal_state)
internal_state.viewport_name = viewport_name
if db.inputs.lock == ExecutionAttributeState.ENABLED:
if internal_state.lock_state == LockState.UNLOCKED:
# sanity check
assert (
internal_state.viewport_api is None
and internal_state.viewport_widget is None
and internal_state.previous_freeze_frame is None
and internal_state.previous_display_delegate is None
), "Invalid internal state"
viewport_window = get_active_viewport_window(viewport_name)
assert viewport_window, f"Unknown viewport window {viewport_name}"
viewport_api = viewport_window.viewport_api
viewport_widget = viewport_window.viewport_widget
# We need to restore the display delegate to the previous one when unlocking viewport render
internal_state.viewport_api = viewport_api
internal_state.viewport_widget = viewport_widget
internal_state.previous_freeze_frame = viewport_api.freeze_frame
internal_state.previous_display_delegate = viewport_widget.display_delegate
# Signal other viewport elements that the viewport is locked so certain things won't update
viewport_api.freeze_frame = True
# Set to a new display delegate that overlays the locked frame on top of the renderer output
viewport_widget.display_delegate = OverlayViewportDisplayDelegate(viewport_api)
locked_exec_attr_state = ExecutionAttributeState.ENABLED
internal_state.lock_state = LockState.LOCKED
else:
if internal_state.lock_state == LockState.LOCKED:
# Start updating relevant parts of the viewport now that the transition has begun
internal_state.restore_freeze_frame()
internal_state.elapsed_time = 0.0
internal_state.fading_time = max(db.inputs.fadeTime, 0.0)
# Push this node in a latent state. Note the output connection of the `fadeStarted` attribute
# can't be activated at the same tick because only 1 activated output is permited per compute,
# therefore it has to be activated until the next tick.
fade_complete_exec_attr_state = ExecutionAttributeState.LATENT_PUSH
internal_state.lock_state = LockState.UNLOCKING
elif internal_state.lock_state == LockState.UNLOCKING:
elapsed_time = internal_state.elapsed_time
fading_time = internal_state.fading_time
assert elapsed_time >= 0.0 and fading_time >= 0.0
if elapsed_time == 0.0:
fade_started_exec_attr_state = ExecutionAttributeState.ENABLED
elif elapsed_time < fading_time:
display_delegate = internal_state.viewport_widget.display_delegate
assert isinstance(display_delegate, OverlayViewportDisplayDelegate)
display_delegate.set_overlay_alpha(1.0 - elapsed_time / fading_time)
elif elapsed_time >= fading_time:
# Reset the display delegate to the previous one that was used before locking viewport render
internal_state.restore_display_delegate()
# Output attribute connection is activated and the latent state is finished for this node
fade_complete_exec_attr_state = ExecutionAttributeState.LATENT_FINISH
internal_state.lock_state = LockState.UNLOCKED
internal_state.elapsed_time += db.abi_context.get_elapsed_time()
db.outputs.locked = locked_exec_attr_state
db.outputs.fadeStarted = fade_started_exec_attr_state
db.outputs.fadeComplete = fade_complete_exec_attr_state
except Exception as error: # noqa: PLW0703
db.log_error(str(error))
return False
return True
| 10,244 | Python | 38.555984 | 118 | 0.640863 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnComboBox.py | # Copyright (c) 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.
#
import omni.graph.core as og
import omni.kit.app
import omni.ui as ui
from . import UINodeCommon
class ComboBoxItem(ui.AbstractItem):
def __init__(self, text):
super().__init__()
self.model = ui.SimpleStringModel(text)
class ComboBoxModel(ui.AbstractItemModel):
def __init__(self, item_list):
super().__init__()
self._current_index = ui.SimpleIntModel(0)
self._current_index.add_value_changed_fn(lambda index_model: self._item_changed(None))
self._items = [ComboBoxItem(text) for text in item_list]
def get_item_children(self, item=None):
return self._items
def get_item_value_model(self, item=None, column_id=0):
if item is None:
return self._current_index
return item.model
class OgnComboBox:
@staticmethod
def internal_state():
return UINodeCommon.OgnUINodeInternalState()
@staticmethod
def compute(db) -> bool:
# OM-97733: This node hasn't been converted to use the widget registry yet. Let's discourage
# its use.
db.log_warning("The ComboBox node is unsupported and may not behave as expected.")
if db.inputs.create != og.ExecutionAttributeState.DISABLED:
item_list = db.inputs.itemList
if not item_list:
db.log_error("The combo box must have at least one item!")
return False
width = db.inputs.width
if width <= 0:
db.log_error("The width of the combo box must be positive!")
return False
widget_identifier = UINodeCommon.get_unique_widget_identifier(db)
parent_widget = UINodeCommon.get_parent_widget(db)
if parent_widget is None:
return False
# Tear down previously created widget
if db.internal_state.created_widget is not None:
UINodeCommon.tear_down_widget(db)
def on_combox_box_item_changed(model, item):
if not db.internal_state.created_widget.enabled:
return
current_index = model.get_item_value_model().as_int
selected_child = model.get_item_children()[current_index]
selected_value = model.get_item_value_model(selected_child).as_string
message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
event_name = "value_changed_" + widget_identifier
reg_event_name = UINodeCommon.registered_event_name(event_name)
payload = {"newValue": selected_value, "valueType": "string"}
message_bus.push(reg_event_name, payload=payload)
# Now create the button widget and register callbacks
with parent_widget:
db.internal_state.created_frame = ui.Frame()
with db.internal_state.created_frame:
with ui.HStack(content_clipping=1):
db.internal_state.created_widget = ui.ComboBox(
ComboBoxModel(item_list),
identifier=widget_identifier,
width=width,
)
db.internal_state.created_widget.model.add_item_changed_fn(on_combox_box_item_changed)
db.outputs.created = og.ExecutionAttributeState.ENABLED
db.outputs.widgetPath = UINodeCommon.find_widget_path(db.internal_state.created_widget)
return True
if db.inputs.tearDown != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.tear_down_widget(db)
if db.inputs.show != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.show_widget(db)
if db.inputs.hide != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.hide_widget(db)
if db.inputs.enable != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.enable_widget(db)
if db.inputs.disable != og.ExecutionAttributeState.DISABLED:
return UINodeCommon.disable_widget(db)
db.log_warning("Unexpected execution with no execution input enabled")
return False
| 4,651 | Python | 38.092437 | 110 | 0.627607 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnGetCameraPosition.cpp | // Copyright (c) 2021-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.
//
// clang-format off
#include "UsdPCH.h"
// clang-format on
#include <OgnGetCameraPositionDatabase.h>
#include "CameraState.h"
#include "NodeUtils.h"
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnGetCameraPosition
{
public:
static bool compute(OgnGetCameraPositionDatabase& db)
{
PXR_NS::UsdPrim prim = getPrimFromPathOrRelationship(db, OgnGetCameraPositionAttributes::inputs::prim.m_token);
if (!prim)
return false;
auto camera = PXR_NS::UsdGeomCamera(prim);
if (!camera)
return true;
CameraState cameraState(std::move(camera));
carb::Double3 position;
cameraState.getCameraPosition(position);
carb::Double3& positionAttrib = reinterpret_cast<carb::Double3&>(db.outputs.position());
positionAttrib = position;
return true;
}
};
REGISTER_OGN_NODE()
}
}
}
| 1,340 | C++ | 23.381818 | 119 | 0.708209 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/UINodeCommon.h | // Copyright (c) 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.
//
#include <omni/graph/core/ogn/UsdTypes.h>
#include <carb/dictionary/IDictionary.h>
#include <carb/events/EventsUtils.h>
#include <carb/events/IEvents.h>
#include <algorithm>
#include <cstring>
#include <map>
#include <memory>
#include <utility>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
/**
* Checks if the node with `inputs:onlyPlayback` should be disabled, because playback is not happening.
*
* @param[in] db The node OGN Database object
* @return true if the node should be disabled
*/
template<typename NodeDb>
bool checkNodeDisabledForOnlyPlay(NodeDb const& db)
{
return db.inputs.onlyPlayback() && (not db.abi_context().iContext->getIsPlaying(db.abi_context()));
}
/**
* Memoizes constant copies of C-strings to reduce heap allocation calls when passing equivalent C-strings between scopes.
*/
class StringMemo
{
public:
/**
* Finds or creates a constant copy of the input C-string having the same lifetime as this StringMemo object.
*
* @param[in] cstr A null-terminated C-style string
* @return An equivalent constant C-style string
*/
char const* lookup(char const* cstr)
{
if (!cstr)
return nullptr;
auto it = m_map.find(cstr);
if (it == m_map.end())
{
std::unique_ptr<char const, cstr_deleter> cstr_copy {cstrdup(cstr)};
char const* cstr_copy_ptr = cstr_copy.get();
m_map.emplace(cstr_copy_ptr, std::move(cstr_copy));
return cstr_copy_ptr;
}
return it->first;
}
private:
static char* cstrdup(const char *cstr)
{
std::size_t const len = std::strlen(cstr);
char* new_copy = static_cast<char*>(std::malloc(len + 1));
if (!new_copy)
return nullptr;
std::memcpy(new_copy, cstr, len + 1);
return new_copy;
}
struct cstr_cmp
{
bool operator()(char const* a, char const* b) const
{
return std::strcmp(a, b) < 0;
}
};
struct cstr_deleter{
void operator()(char const* p) const
{
std::free(const_cast<char*>(p));
}
};
std::map<char const*, std::unique_ptr<char const, cstr_deleter>, cstr_cmp> m_map;
};
}
}
}
| 2,694 | C | 25.165048 | 122 | 0.641797 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportPressNodeCommon.h | // Copyright (c) 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.
//
#include "UINodeCommon.h"
namespace omni
{
namespace graph
{
namespace ui_nodes
{
constexpr carb::events::EventType kPressBeganEventType = CARB_EVENTS_TYPE_FROM_STR("omni.graph.viewport.press.began");
constexpr carb::events::EventType kPressEndedEventType = CARB_EVENTS_TYPE_FROM_STR("omni.graph.viewport.press.ended");
class ViewportPressEventPayloads
{
public:
struct Key
{
char const* viewportWindowName;
char const* gestureName;
bool operator<(Key const& other) const
{
int const ret = std::strcmp(viewportWindowName, other.viewportWindowName);
if (ret < 0)
return true;
else if (ret <= 0)
return std::strcmp(gestureName, other.gestureName) < 0;
return false;
}
};
struct PressBeganValue
{
pxr::GfVec2d pressPositionNorm;
pxr::GfVec2d pressPositionPixel;
bool isValid;
};
struct PressEndedValue
{
pxr::GfVec2d releasePositionNorm;
pxr::GfVec2d releasePositionPixel;
bool isReleasePositionValid;
bool isValid;
};
// Store a press began event payload
void setPressBeganPayload(carb::dictionary::Item* payload)
{
auto idict = carb::dictionary::getCachedDictionaryInterface();
Key key {
stringMemo.lookup(idict->get<char const*>(payload, "viewport")),
stringMemo.lookup(idict->get<char const*>(payload, "gesture"))
};
pressBeganPayloadMap[key] = PressBeganValue {
pxr::GfVec2d {
idict->get<double>(payload, "pos_norm_x"),
idict->get<double>(payload, "pos_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "pos_pixel_x"),
idict->get<double>(payload, "pos_pixel_y")
},
true
};
}
// Store a press ended event payload
void setPressEndedPayload(carb::dictionary::Item* payload)
{
auto idict = carb::dictionary::getCachedDictionaryInterface();
Key key {
stringMemo.lookup(idict->get<char const*>(payload, "viewport")),
stringMemo.lookup(idict->get<char const*>(payload, "gesture"))
};
pressEndedPayloadMap[key] = PressEndedValue {
pxr::GfVec2d {
idict->get<double>(payload, "pos_norm_x"),
idict->get<double>(payload, "pos_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "pos_pixel_x"),
idict->get<double>(payload, "pos_pixel_y")
},
idict->get<bool>(payload, "pos_valid"),
true
};
}
// Invalidate all stored payloads
void clear()
{
for (auto& p : pressBeganPayloadMap)
{
p.second.isValid = false;
}
for (auto& p : pressEndedPayloadMap)
{
p.second.isValid = false;
}
}
bool empty()
{
if (std::any_of(pressBeganPayloadMap.begin(), pressBeganPayloadMap.end(),
[](auto const& p) {
return p.second.isValid;
}))
{
return false;
}
if (std::any_of(pressEndedPayloadMap.begin(), pressEndedPayloadMap.end(),
[](auto const& p) {
return p.second.isValid;
}))
{
return false;
}
return true;
}
std::map<Key, PressBeganValue> const& pressBeganPayloads()
{
return pressBeganPayloadMap;
}
std::map<Key, PressEndedValue> const& pressEndedPayloads()
{
return pressEndedPayloadMap;
}
private:
std::map<Key, PressBeganValue> pressBeganPayloadMap;
std::map<Key, PressEndedValue> pressEndedPayloadMap;
StringMemo stringMemo;
};
using ViewportPressEventStateKey = ViewportPressEventPayloads::Key;
struct ViewportPressEventStateValue
{
pxr::GfVec2d pressPositionNorm = {0.0, 0.0};
pxr::GfVec2d pressPositionPixel = {0.0, 0.0};
pxr::GfVec2d releasePositionNorm = {0.0, 0.0};
pxr::GfVec2d releasePositionPixel = {0.0, 0.0};
bool isPressed = false;
bool isReleasePositionValid = false;
};
using ViewportPressEventStates = std::map<ViewportPressEventStateKey, ViewportPressEventStateValue>;
}
}
}
| 4,802 | C | 27.589286 | 118 | 0.600583 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnWriteWidgetStyle.py | # Copyright (c) 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.
#
import omni.graph.core as og
from . import UINodeCommon
class OgnWriteWidgetStyle:
@staticmethod
def compute(db) -> bool:
if db.inputs.write != og.ExecutionAttributeState.DISABLED:
widget_path = db.inputs.widgetPath
if not widget_path:
widget_identifier = db.inputs.widgetIdentifier
if not widget_identifier:
db.log_warning("No widgetIdentifier or widgetPath provided.")
return False
widget = UINodeCommon.get_registered_widget(db.abi_context, widget_identifier)
if not widget:
db.log_warning(f"No widget with identifier '{widget_identifier}' found in this graph.")
return False
else:
widget = UINodeCommon.find_widget_among_all_windows(widget_path)
if not widget:
db.log_warning(f"No widget found at path '{widget_path}'.")
return False
# For error messages only.
widget_identifier = widget_path
style_string = db.inputs.style
if not style_string:
db.log_error("No style provided.")
return False
style = {}
try:
style = UINodeCommon.to_ui_style(db.inputs.style)
except SyntaxError as err:
db.log_error(f"'inputs:style': {err.msg}")
return False
widget.set_style(style)
db.outputs.written = og.ExecutionAttributeState.ENABLED
return True
db.log_warning("Unexpected execution with no execution input enabled")
return False
| 2,150 | Python | 37.410714 | 107 | 0.607907 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportDragManipulator.py | # Copyright (c) 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.
#
__all__ = ["ViewportDragManipulatorFactory"]
from typing import Any
import carb
import omni.kit.app
import omni.kit.commands
from omni.ui import scene as sc
EVENT_NAME_BEGAN = "omni.graph.viewport.drag.began"
EVENT_NAME_CHANGED = "omni.graph.viewport.drag.changed"
EVENT_NAME_ENDED = "omni.graph.viewport.drag.ended"
GESTURE_NAMES = ["Left Mouse Drag", "Right Mouse Drag", "Middle Mouse Drag"]
class DoNotPrevent(sc.GestureManager):
def can_be_prevented(self, gesture):
return False
class ViewportDragGesture(sc.DragGesture):
def __init__(self, viewport_api: Any, viewport_window_name: str, mouse_button: int):
super().__init__(mouse_button=mouse_button, manager=DoNotPrevent())
self._viewport_api = viewport_api
self._viewport_window_name = viewport_window_name
self._gesture_name = GESTURE_NAMES[mouse_button]
self._event_type_began = carb.events.type_from_string(EVENT_NAME_BEGAN)
self._event_type_changed = carb.events.type_from_string(EVENT_NAME_CHANGED)
self._event_type_ended = carb.events.type_from_string(EVENT_NAME_ENDED)
self._message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
self._start_pos_valid = False
self._started_moving = False
self._start_pos_norm = None
self._start_pos_pixel = None
def on_began(self):
mouse = self.sender.gesture_payload.mouse
resolution = self._viewport_api.resolution
# Start position in normalized coords
pos_norm = self._viewport_api.map_ndc_to_texture(mouse)[0]
pos_norm = (pos_norm[0], 1.0 - pos_norm[1])
if not all(0.0 <= x <= 1.0 for x in pos_norm):
self._start_pos_valid = False
return
# Start position in viewport resolution pixels
pos_pixel = (pos_norm[0] * resolution[0], pos_norm[1] * resolution[1])
# Store start position and wait for on_changed to send
self._start_pos_valid = True
self._started_moving = False
self._start_pos_norm = pos_norm
self._start_pos_pixel = pos_pixel
def on_changed(self):
if not self._start_pos_valid:
return
mouse = self.sender.gesture_payload.mouse
mouse_moved = self.sender.gesture_payload.mouse_moved
resolution = self._viewport_api.resolution
# Current position in normalized coords
pos_norm = self._viewport_api.map_ndc_to_texture(mouse)[0]
pos_norm = (pos_norm[0], 1.0 - pos_norm[1])
if not all(0.0 <= x <= 1.0 for x in pos_norm):
return
# Current position in viewport resolution pixels
pos_pixel = (pos_norm[0] * resolution[0], pos_norm[1] * resolution[1])
# Velocity in normalized coords
vel_norm = self._viewport_api.map_ndc_to_texture(mouse_moved)[0]
origin_norm = self._viewport_api.map_ndc_to_texture((0, 0))[0]
vel_norm = (vel_norm[0] - origin_norm[0], origin_norm[1] - vel_norm[1])
# Velocity in viewport resolution pixels
vel_pixel = (vel_norm[0] * resolution[0], vel_norm[1] * resolution[1])
if not self._started_moving:
payload = {
"viewport": self._viewport_window_name,
"gesture": self._gesture_name,
"start_pos_norm_x": self._start_pos_norm[0],
"start_pos_norm_y": self._start_pos_norm[1],
"start_pos_pixel_x": self._start_pos_pixel[0],
"start_pos_pixel_y": self._start_pos_pixel[1],
"pos_norm_x": pos_norm[0],
"pos_norm_y": pos_norm[1],
"pos_pixel_x": pos_pixel[0],
"pos_pixel_y": pos_pixel[1],
"vel_norm_x": vel_norm[0],
"vel_norm_y": vel_norm[1],
"vel_pixel_x": vel_pixel[0],
"vel_pixel_y": vel_pixel[1],
}
self._message_bus.push(self._event_type_began, payload=payload)
self._started_moving = True
else:
payload = {
"viewport": self._viewport_window_name,
"gesture": self._gesture_name,
"pos_norm_x": pos_norm[0],
"pos_norm_y": pos_norm[1],
"pos_pixel_x": pos_pixel[0],
"pos_pixel_y": pos_pixel[1],
"vel_norm_x": vel_norm[0],
"vel_norm_y": vel_norm[1],
"vel_pixel_x": vel_pixel[0],
"vel_pixel_y": vel_pixel[1],
}
self._message_bus.push(self._event_type_changed, payload=payload)
def on_ended(self):
if self._start_pos_valid and self._started_moving:
payload = {
"viewport": self._viewport_window_name,
"gesture": self._gesture_name,
}
self._message_bus.push(self._event_type_ended, payload=payload)
self._start_pos_valid = False
# Custom manipulator containing a Screen that contains the gestures
class ViewportDragManipulator(sc.Manipulator):
def __init__(self, viewport_api: Any, viewport_window_name: str, *args, **kwargs):
super().__init__(*args, **kwargs)
self._gestures = [
ViewportDragGesture(viewport_api, viewport_window_name, 0), # left mouse drag
ViewportDragGesture(viewport_api, viewport_window_name, 1), # right mouse drag
ViewportDragGesture(viewport_api, viewport_window_name, 2), # middle mouse drag
]
self._screen = None
self._transform = None
self.name = None
self.categories = ()
def on_build(self):
self._transform = sc.Transform()
with self._transform:
self._screen = sc.Screen(gesture=self._gestures)
def destroy(self):
self._gestures = []
self._screen = None
if self._transform:
self._transform.clear()
self._transform = None
# Factory creator
def ViewportDragManipulatorFactory(desc: dict) -> ViewportDragManipulator: # noqa: N802
manip = ViewportDragManipulator(desc.get("viewport_api"), desc.get("viewport_window_name"))
manip.categories = ()
manip.name = f"ViewportDragManipulator.{desc.get('viewport_window_name')}"
return manip
| 6,711 | Python | 38.482353 | 95 | 0.60453 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnReadViewportPressState.cpp | // Copyright (c) 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.
//
#include <OgnReadViewportPressStateDatabase.h>
#include "ViewportPressNodeCommon.h"
#include <omni/kit/IApp.h>
#include <omni/ui/Workspace.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnReadViewportPressState
{
public:
struct InternalState
{
carb::events::ISubscriptionPtr pressBeganSub;
carb::events::ISubscriptionPtr pressEndedSub;
ViewportPressEventPayloads eventPayloads;
ViewportPressEventStates eventStates;
} m_internalState;
exec::unstable::Stamp m_setStamp; // stamp set when the event occurs
exec::unstable::SyncStamp m_syncStamp; // stamp set by each instance
//
// Process event payloads and update event states immediately after receiving each payload
static void updateEventStates(ViewportPressEventStates& eventStates, ViewportPressEventPayloads& eventPayloads)
{
for (auto const& pressBeganPayload : eventPayloads.pressBeganPayloads())
{
if (!pressBeganPayload.second.isValid)
continue;
auto& eventStateValue = eventStates[pressBeganPayload.first];
eventStateValue.pressPositionNorm = pressBeganPayload.second.pressPositionNorm;
eventStateValue.pressPositionPixel = pressBeganPayload.second.pressPositionPixel;
eventStateValue.releasePositionNorm = {0.0, 0.0};
eventStateValue.releasePositionPixel = {0.0, 0.0};
eventStateValue.isPressed = true;
eventStateValue.isReleasePositionValid = false;
}
for (auto const& pressEndedPayload : eventPayloads.pressEndedPayloads())
{
if (!pressEndedPayload.second.isValid)
continue;
auto& eventStateValue = eventStates[pressEndedPayload.first];
if (eventStateValue.isPressed)
{
eventStateValue.releasePositionNorm = pressEndedPayload.second.releasePositionNorm;
eventStateValue.releasePositionPixel = pressEndedPayload.second.releasePositionPixel;
eventStateValue.isPressed = false;
eventStateValue.isReleasePositionValid = pressEndedPayload.second.isReleasePositionValid;
}
}
eventPayloads.clear();
}
static void initialize(GraphContextObj const&, NodeObj const& nodeObj)
{
OgnReadViewportPressState& state =
OgnReadViewportPressStateDatabase::sSharedState<OgnReadViewportPressState>(nodeObj);
// Subscribe to press events
if (omni::kit::IApp* app = carb::getCachedInterface<omni::kit::IApp>())
{
state.m_internalState.pressBeganSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kPressBeganEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnReadViewportPressState& state =
OgnReadViewportPressStateDatabase::sSharedState<OgnReadViewportPressState>(nodeObj);
state.m_internalState.eventPayloads.setPressBeganPayload(e->payload);
state.m_setStamp.next();
updateEventStates(state.m_internalState.eventStates, state.m_internalState.eventPayloads);
}
}
);
state.m_internalState.pressEndedSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kPressEndedEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnReadViewportPressState& state =
OgnReadViewportPressStateDatabase::sSharedState<OgnReadViewportPressState>(nodeObj);
state.m_internalState.eventPayloads.setPressEndedPayload(e->payload);
state.m_setStamp.next();
updateEventStates(state.m_internalState.eventStates, state.m_internalState.eventPayloads);
}
}
);
}
}
static void release(const NodeObj& nodeObj)
{
OgnReadViewportPressState& state =
OgnReadViewportPressStateDatabase::sSharedState<OgnReadViewportPressState>(nodeObj);
// Unsubscribe from press events
if (state.m_internalState.pressBeganSub.get())
state.m_internalState.pressBeganSub.detach()->unsubscribe();
if (state.m_internalState.pressEndedSub.get())
state.m_internalState.pressEndedSub.detach()->unsubscribe();
}
static bool compute(OgnReadViewportPressStateDatabase& db)
{
OgnReadViewportPressState& sharedState = db.sharedState<OgnReadViewportPressState>();
OgnReadViewportPressState& perInstanceState = db.perInstanceState<OgnReadViewportPressState>();
if(perInstanceState.m_syncStamp.makeSync(sharedState.m_setStamp))
{
// Get the targeted viewport and gesture
char const* const viewportWindowName = db.tokenToString(db.inputs.viewport());
char const* const gestureName = db.tokenToString(db.inputs.gesture());
if (!omni::ui::Workspace::getWindow(viewportWindowName))
{
db.logWarning("Viewport window '%s' not found", viewportWindowName);
}
// Output press state
auto it = sharedState.m_internalState.eventStates.find({viewportWindowName, gestureName});
if (it != sharedState.m_internalState.eventStates.end())
{
if (db.inputs.useNormalizedCoords())
{
db.outputs.pressPosition() = it->second.pressPositionNorm;
db.outputs.releasePosition() = it->second.releasePositionNorm;
}
else
{
db.outputs.pressPosition() = it->second.pressPositionPixel;
db.outputs.releasePosition() = it->second.releasePositionPixel;
}
db.outputs.isReleasePositionValid() = it->second.isReleasePositionValid;
db.outputs.isPressed() = it->second.isPressed;
db.outputs.isValid() = true;
}
else
{
db.outputs.pressPosition() = {0.0, 0.0};
db.outputs.releasePosition() = {0.0, 0.0};
db.outputs.isReleasePositionValid() = false;
db.outputs.isPressed() = false;
db.outputs.isValid() = false;
}
}
return true;
}
};
REGISTER_OGN_NODE()
} // ui
} // graph
} // omni
| 7,263 | C++ | 38.912088 | 115 | 0.61655 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportClickNodeCommon.h | // Copyright (c) 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.
//
#include "UINodeCommon.h"
namespace omni
{
namespace graph
{
namespace ui_nodes
{
constexpr carb::events::EventType kClickEventType = CARB_EVENTS_TYPE_FROM_STR("omni.graph.viewport.click");
class ViewportClickEventPayloads
{
public:
struct Key
{
char const* viewportWindowName;
char const* gestureName;
bool operator<(Key const& other) const
{
int const ret = std::strcmp(viewportWindowName, other.viewportWindowName);
if (ret < 0)
return true;
else if (ret <= 0)
return std::strcmp(gestureName, other.gestureName) < 0;
return false;
}
};
struct Value
{
pxr::GfVec2d positionNorm;
pxr::GfVec2d positionPixel;
bool isValid;
};
// Store an event payload as a key-value pair
void setPayload(carb::dictionary::Item* payload)
{
auto idict = carb::dictionary::getCachedDictionaryInterface();
Key key {
stringMemo.lookup(idict->get<char const*>(payload, "viewport")),
stringMemo.lookup(idict->get<char const*>(payload, "gesture"))
};
payloadMap[key] = Value {
pxr::GfVec2d {
idict->get<double>(payload, "pos_norm_x"),
idict->get<double>(payload, "pos_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "pos_pixel_x"),
idict->get<double>(payload, "pos_pixel_y")
},
true
};
}
// Retrieve a payload value by key
Value const* getPayloadValue(char const* viewportWindowName, char const* gestureName)
{
auto it = payloadMap.find({viewportWindowName, gestureName});
if (it != payloadMap.end() && it->second.isValid)
{
return &(it->second);
}
return nullptr;
}
// Invalidate all stored payloads
void clear()
{
for (auto& p : payloadMap) {
p.second.isValid = false;
}
}
// Check if there exists a valid payload
bool empty()
{
return std::none_of(payloadMap.begin(), payloadMap.end(),
[](auto const& p) {
return p.second.isValid;
});
}
private:
std::map<Key, Value> payloadMap;
StringMemo stringMemo;
};
}
}
}
| 2,803 | C | 25.205607 | 107 | 0.590082 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/PickingManipulator.py | # Copyright (c) 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.
#
__all__ = ["PickingManipulatorFactory"]
from typing import Any, List, Optional
import carb
import omni.kit.app
import omni.kit.commands
from omni.ui import scene as sc
EVENT_NAME = "omni.graph.picking"
CLICK_GESTURE_NAMES = ["Left Mouse Click", "Right Mouse Click", "Middle Mouse Click"]
PRESS_GESTURE_NAMES = ["Left Mouse Press", "Right Mouse Press", "Middle Mouse Press"]
SEQ_LIMIT = 128
class DoNotPrevent(sc.GestureManager):
def can_be_prevented(self, gesture):
return False
# Custom gesture that triggers a picking query on mouse press, and sends the result on both mouse press and end of click
class PickingGesture(sc.DragGesture):
def __init__(self, viewport_api: Any, viewport_window_name: str, mouse_button: int):
super().__init__(mouse_button=mouse_button, manager=DoNotPrevent())
self._viewport_api = viewport_api
self._viewport_window_name = viewport_window_name
self._click_gesture_name = CLICK_GESTURE_NAMES[mouse_button]
self._press_gesture_name = PRESS_GESTURE_NAMES[mouse_button]
self._event_type = carb.events.type_from_string(EVENT_NAME)
self._message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
# Sequence number for associating picking queries with gestures
self._seq = 0
# Bool to track whether the mouse button was initially pressed over the 3D viewport or not
# (does not need to be an array like the rest since _query_completed does not need to check it)
self._began = False
# Sequence number indexed bools to control the following execution order cases for mouse click:
# 1: on_began -> _query_completed -> on_ended
# 2: on_began -> _query_completed -> on_changed (cancelled) -> on_ended
# 3: on_began -> on_ended -> _query_completed
# 4: on_began -> on_changed (cancelled) -> _query_completed -> on_ended
# 5: on_began -> on_changed (cancelled) -> on_ended -> _query_completed
self._ended = [False] * SEQ_LIMIT # True if the mouse button has been released without moving the mouse
self._cancelled = [False] * SEQ_LIMIT # True if the mouse was moved while pressed, cancelling the click
self._result_stored = [False] * SEQ_LIMIT # True if the picking query has completed and stored its result
# Sequence number indexed temporary buffers to hold the picking result
self._picked_prim_path = [None] * SEQ_LIMIT
self._world_space_pos = [None] * SEQ_LIMIT
# Callback to request_query called when the picking query completes
def _query_completed(self, seq: int, picked_prim_path: str, world_space_pos: Optional[List[float]], *args):
# Handle mouse press:
# Send the picked prim path and picked world position in an event payload
# Include the viewport window name and gesture name to filter on the receiving end
press_payload = {
"viewport": self._viewport_window_name,
"gesture": self._press_gesture_name,
"path": picked_prim_path,
"pos_x": world_space_pos[0] if world_space_pos else 0.0,
"pos_y": world_space_pos[1] if world_space_pos else 0.0,
"pos_z": world_space_pos[2] if world_space_pos else 0.0,
}
self._message_bus.push(self._event_type, payload=press_payload)
# Handle cases for mouse click
if self._cancelled[seq]:
return
if self._ended[seq]:
# Case 3: Click has already ended and we were waiting on the query to complete, so send the payload now
click_payload = {
"viewport": self._viewport_window_name,
"gesture": self._click_gesture_name,
"path": picked_prim_path,
"pos_x": world_space_pos[0] if world_space_pos else 0.0,
"pos_y": world_space_pos[1] if world_space_pos else 0.0,
"pos_z": world_space_pos[2] if world_space_pos else 0.0,
}
self._message_bus.push(self._event_type, payload=click_payload)
else:
# Case 1 or 2: Click has not completed yet, so save the picking result and wait until mouse is released
self._picked_prim_path[seq] = picked_prim_path
self._world_space_pos[seq] = world_space_pos
self._result_stored[seq] = True
def _query_completed_seq(self, seq: int):
return lambda *args: self._query_completed(seq, *args)
# Called when the specified mouse button is pressed
def on_began(self):
# Get the next sequence number and reset the control bools
self._seq = (self._seq + 1) % SEQ_LIMIT
self._began = False
self._ended[self._seq] = False
self._cancelled[self._seq] = False
self._result_stored[self._seq] = False
self._picked_prim_path[self._seq] = None
self._world_space_pos[self._seq] = None
# Get the mouse position in normalized coords and check if the mouse is actually over the 3D viewport
mouse = self.sender.gesture_payload.mouse
resolution = self._viewport_api.resolution
pos_norm, _ = self._viewport_api.map_ndc_to_texture(mouse)
if pos_norm is None or not all(0.0 <= x <= 1.0 for x in pos_norm):
return
self._began = True
# Get the mouse position in viewport resolution pixels and request a picking query
pos_pixel = (int(pos_norm[0] * resolution[0]), int((1.0 - pos_norm[1]) * resolution[1]))
self._viewport_api.request_query(
pos_pixel,
self._query_completed_seq(self._seq),
query_name=f"omni.graph.ui_nodes.PickingManipulator.{id(self)}",
)
# Called when the mouse is moved while pressed, cancelling the click
def on_changed(self):
if not self._began:
return
self._cancelled[self._seq] = True
# Called when the specified mouse button is released
def on_ended(self):
if not self._began or self._cancelled[self._seq]:
return
if self._result_stored[self._seq]:
# Case 1: The picking query has already completed and we have the result saved, so send the payload now
picked_prim_path = self._picked_prim_path[self._seq]
world_space_pos = self._world_space_pos[self._seq]
click_payload = {
"viewport": self._viewport_window_name,
"gesture": self._click_gesture_name,
"path": picked_prim_path,
"pos_x": world_space_pos[0] if world_space_pos else 0.0,
"pos_y": world_space_pos[1] if world_space_pos else 0.0,
"pos_z": world_space_pos[2] if world_space_pos else 0.0,
}
self._message_bus.push(self._event_type, payload=click_payload)
else:
# Case 3: The picking query has not completed yet, so wait until it completes to send the payload
self._ended[self._seq] = True
# Custom manipulator containing a screen that contains the gestures
class PickingManipulator(sc.Manipulator):
def __init__(self, viewport_api: Any, viewport_window_name: str, *args, **kwargs):
super().__init__(*args, **kwargs)
self._gestures = [
PickingGesture(viewport_api, viewport_window_name, 0), # left mouse click/press
PickingGesture(viewport_api, viewport_window_name, 1), # right mouse click/press
PickingGesture(viewport_api, viewport_window_name, 2), # middle mouse click/press
]
self._screen = None
self._transform = None
self.name = None
self.categories = ()
def on_build(self):
# Create a transform and put a screen in it (must hold a reference to keep the sc.Screen alive)
self._transform = sc.Transform()
with self._transform:
# sc.Screen is an invisible rectangle that is always in front of and entirely covers the viewport camera
# By attaching the gestures to this screen, the gestures can be triggered by clicking anywhere
self._screen = sc.Screen(gesture=self._gestures)
def destroy(self):
self._gestures = []
self._screen = None
if self._transform:
self._transform.clear()
self._transform = None
# Factory creator
def PickingManipulatorFactory(desc: dict) -> PickingManipulator: # noqa: N802
manip = PickingManipulator(desc.get("viewport_api"), desc.get("viewport_window_name"))
manip.categories = ()
manip.name = f"PickingManipulator.{desc.get('viewport_window_name')}"
return manip
| 9,093 | Python | 45.397959 | 120 | 0.638953 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnSetCameraPosition.cpp | // Copyright (c) 2021-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.
//
// clang-format off
#include "UsdPCH.h"
// clang-format on
#include <OgnSetCameraPositionDatabase.h>
#include "CameraState.h"
#include "NodeUtils.h"
#include <pxr/base/gf/vec3d.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnSetCameraPosition
{
public:
static bool compute(OgnSetCameraPositionDatabase& db)
{
PXR_NS::UsdPrim prim = getPrimFromPathOrRelationship(db, OgnSetCameraPositionAttributes::inputs::prim.m_token);
if (!prim)
return false;
auto position = db.inputs.position();
auto rotate = db.inputs.rotate();
auto camera = PXR_NS::UsdGeomCamera(prim);
if (!camera)
return false;
CameraState cameraState(std::move(camera));
bool ok = cameraState.setCameraPosition({ position[0], position[1], position[2] }, rotate);
if (!ok)
{
db.logError("Could not set position for camera %s", prim.GetPath().GetText());
}
db.outputs.execOut() = kExecutionAttributeStateEnabled;
return true;
}
};
REGISTER_OGN_NODE()
}
}
}
| 1,541 | C++ | 23.870967 | 119 | 0.683971 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnReadViewportScrollState.cpp | // Copyright (c) 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.
//
#include <OgnReadViewportScrollStateDatabase.h>
#include "ViewportScrollNodeCommon.h"
#include <omni/kit/IApp.h>
#include <omni/ui/Workspace.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnReadViewportScrollState
{
public:
struct InternalState
{
carb::events::ISubscriptionPtr scrollSub;
ViewportScrollEventPayloads eventPayloads;
} m_internalState;
exec::unstable::Stamp m_setStamp; // stamp set when the event occurs
exec::unstable::SyncStamp m_syncStamp; // stamp set by each instance
static void initialize(GraphContextObj const& context, NodeObj const& nodeObj)
{
OgnReadViewportScrollState& state =
OgnReadViewportScrollStateDatabase::sSharedState<OgnReadViewportScrollState>(nodeObj);
// Subscribe to scroll events
if (omni::kit::IApp* app = carb::getCachedInterface<omni::kit::IApp>())
{
state.m_internalState.scrollSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kScrollEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnReadViewportScrollState& state =
OgnReadViewportScrollStateDatabase::sSharedState<OgnReadViewportScrollState>(nodeObj);
state.m_internalState.eventPayloads.setPayload(e->payload);
state.m_setStamp.next();
}
}
);
}
}
static void release(const NodeObj& nodeObj)
{
OgnReadViewportScrollState& state =
OgnReadViewportScrollStateDatabase::sSharedState<OgnReadViewportScrollState>(nodeObj);
// Unsubscribe from scroll events
if (state.m_internalState.scrollSub.get())
state.m_internalState.scrollSub.detach()->unsubscribe();
}
static bool compute(OgnReadViewportScrollStateDatabase& db)
{
OgnReadViewportScrollState& sharedState = db.sharedState<OgnReadViewportScrollState>();
OgnReadViewportScrollState& perInstanceState = db.perInstanceState<OgnReadViewportScrollState>();
if(perInstanceState.m_syncStamp.makeSync(sharedState.m_setStamp))
{
// Get the targeted viewport and gesture
char const* const viewportWindowName = db.tokenToString(db.inputs.viewport());
if (!omni::ui::Workspace::getWindow(viewportWindowName))
{
db.logWarning("Viewport window '%s' not found", viewportWindowName);
}
auto const* eventPayloadValuePtr = sharedState.m_internalState.eventPayloads.getPayloadValue(viewportWindowName);
if (eventPayloadValuePtr)
{
db.outputs.scrollValue() = eventPayloadValuePtr->scrollValue;
db.outputs.position() = db.inputs.useNormalizedCoords() ? eventPayloadValuePtr->positionNorm : eventPayloadValuePtr->positionPixel;
db.outputs.isValid() = true;
}
else
{
db.outputs.scrollValue() = 0.0f;
db.outputs.position() = {0.0, 0.0};
db.outputs.isValid() = false;
}
}
return true;
}
};
REGISTER_OGN_NODE()
} // ui
} // graph
} // omni
| 3,820 | C++ | 35.740384 | 147 | 0.638743 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnOnWidgetValueChanged.py | # Copyright (c) 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 contextlib import suppress
import omni.graph.core as og
from omni.graph.ui_nodes.ogn.OgnOnWidgetValueChangedDatabase import OgnOnWidgetValueChangedDatabase
from . import UINodeCommon
class OgnOnWidgetValueChanged:
@staticmethod
def try_resolve_output_attribute(node, attr_name, attr_type):
out_attr = node.get_attribute(attr_name)
attr_type_valid = attr_type.base_type != og.BaseDataType.UNKNOWN
if out_attr.get_resolved_type().base_type != og.BaseDataType.UNKNOWN and (
not attr_type_valid or attr_type != out_attr.get_resolved_type()
):
out_attr.set_resolved_type(og.Type(og.BaseDataType.UNKNOWN))
if attr_type_valid and out_attr.get_resolved_type().base_type == og.BaseDataType.UNKNOWN:
out_attr.set_resolved_type(attr_type)
@staticmethod
def internal_state():
return UINodeCommon.OgnUIEventNodeInternalState()
@staticmethod
def compute(db) -> bool:
widget_identifier = db.inputs.widgetIdentifier
if not widget_identifier:
return True
event_name = "value_changed_" + widget_identifier
if db.internal_state.first_time_subscribe(db.node, event_name):
return True
payload = db.internal_state.try_pop_event()
if payload is None:
return True
if "valueType" in payload.get_keys():
value_type = payload["valueType"]
OgnOnWidgetValueChanged.try_resolve_output_attribute(
db.node, "outputs:newValue", og.AttributeType.type_from_ogn_type_name(value_type)
)
if "newValue" in payload.get_keys():
new_value = payload["newValue"]
db.outputs.newValue = new_value
db.outputs.valueChanged = og.ExecutionAttributeState.ENABLED
return True
# ----------------------------------------------------------------------------
@staticmethod
def release(node):
# Unsubscribe right away instead of waiting for GC cleanup, we don't want our callback firing
# after the node has been released.
with suppress(og.OmniGraphError):
state = OgnOnWidgetValueChangedDatabase.per_node_internal_state(node)
state.release()
| 2,695 | Python | 35.931506 | 101 | 0.66308 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnDrawDebugCurve.py | """
This is the implementation of the OGN node defined in OgnDrawDebugCurve.ogn
"""
import carb
import numpy as np
import omni.debugdraw as dd
import omni.graph.core as og
class OgnDrawDebugCurve:
"""
Draws a curve using omni.debugdraw
"""
@staticmethod
def compute(db) -> bool:
"""Compute the outputs from the current input"""
curvepoints = db.inputs.curvepoints
color = db.inputs.color
closed = db.inputs.closed
try:
ddi = dd._debugDraw.acquire_debug_draw_interface() # noqa: PLW0212
rgb_bytes = (np.clip(color, 0, 1.0) * 255).astype("uint8").tobytes()
argb_bytes = b"\xff" + rgb_bytes
argb = int.from_bytes(argb_bytes, byteorder="big")
carbpoints = [carb.Float3(p.tolist()) for p in curvepoints]
# carb.log_warn(f'{color} = {argb_bytes} = {argb}, {carbpoints[0]}, {carbpoints[1]}')
for i in range(len(carbpoints) - 1):
ddi.draw_line(carbpoints[i], argb, carbpoints[i + 1], argb)
if closed:
ddi.draw_line(carbpoints[-1], argb, carbpoints[0], argb)
except Exception as error: # noqa: PLW0703
import traceback
raise RuntimeError(traceback.format_exc()) from error
db.outputs.execOut = og.ExecutionAttributeState.ENABLED
return True
| 1,376 | Python | 33.424999 | 97 | 0.606105 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnOnNewFrame.py | """
This is the implementation of the OGN node defined in OgnOnNewFrame.ogn
"""
from contextlib import suppress
import omni.graph.core as og
import omni.usd
from omni.graph.ui_nodes.ogn.OgnOnNewFrameDatabase import OgnOnNewFrameDatabase
from omni.kit.viewport.utility import get_viewport_from_window_name
class OgnOnNewFrameInternalState:
"""Convenience class for maintaining per-node state information"""
def __init__(self):
"""Instantiate the per-node state information."""
# This subscription object controls the lifetime of our callback, it will be
# cleaned up automatically when our node is destroyed
self.sub = None
# Set when the callback has triggered
self.is_set = False
# The last payload received
self.payload = None
# The node instance handle
self.node = None
# The viewport we are watching frames for
self.viewport_handle = None
def on_event(self, e):
"""The event callback"""
if e is None:
return
self.is_set = True
viewport_handle = e.payload["viewport_handle"]
if viewport_handle != self.viewport_handle:
return
self.payload = e.payload
# Tell the evaluator we need to be computed
if self.node.is_valid():
self.node.request_compute()
def first_time_subscribe(self, node: og.Node, viewport_handle: int) -> bool:
"""Checked call to set up carb subscription
Args:
node: The node instance
viewport_handle: The handle for the viewport to watch
Returns:
True if we subscribed, False if we are already subscribed
"""
if self.sub is not None and self.viewport_handle != viewport_handle:
# event name changed since we last subscribed, unsubscribe
self.sub.unsubscribe()
self.sub = None
if self.sub is None:
self.sub = (
omni.usd.get_context()
.get_rendering_event_stream()
.create_subscription_to_push_by_type(
int(omni.usd.StageRenderingEventType.NEW_FRAME),
self.on_event,
name=f"omni.graph.action.__on_new_frame.{node.node_id()}",
)
)
self.viewport_handle = viewport_handle
self.node = node
self.payload = None
return True
return False
def try_pop_event(self):
"""Pop the payload of the last event received, or None if there is no event to pop"""
if self.is_set:
self.is_set = False
payload = self.payload
self.payload = None
return payload
return None
# ======================================================================
class OgnOnNewFrame:
@staticmethod
def internal_state():
"""Returns an object that will contain per-node state information"""
return OgnOnNewFrameInternalState()
@staticmethod
def compute(db) -> bool:
viewport_name = db.inputs.viewport
viewport_api = get_viewport_from_window_name(viewport_name)
if not viewport_api:
return True
state = db.internal_state
# XXX: Note this may be incorrect, viewport_handle is not stable (and may be None)
viewport_handle = viewport_api.frame_info.get("viewport_handle")
if state.first_time_subscribe(db.node, viewport_handle):
return True
payload = state.try_pop_event()
if payload is None:
return True
# Copy the event dict contents into the output bundle
db.outputs.frameNumber = payload["frame_number"]
db.outputs.execOut = og.ExecutionAttributeState.ENABLED
return True
# ----------------------------------------------------------------------------
@staticmethod
def release(node):
# Unsubscribe right away instead of waiting for GC cleanup, we don't want our callback firing
# after the node has been released.
with suppress(og.OmniGraphError):
state = OgnOnNewFrameDatabase.per_node_internal_state(node)
if state.sub:
state.sub.unsubscribe()
state.sub = None
| 4,332 | Python | 33.388889 | 101 | 0.587719 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnSetViewportMode.py | # Copyright (c) 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 dataclasses import dataclass
from threading import Lock
from typing import Any, Callable, Dict, Optional
import omni.graph.core as og
import omni.ui as ui
from omni.graph.ui_nodes.ogn.nodes.OgnVStack import OgnVStack
from omni.graph.ui_nodes.ogn.OgnSetViewportModeDatabase import OgnSetViewportModeDatabase
from omni.kit.viewport.utility import get_active_viewport_and_window
from omni.ui import scene as sc
from omni.ui_query import OmniUIQuery
from .PickingManipulator import PickingManipulatorFactory # noqa: PLE0402
from .ViewportClickManipulator import ViewportClickManipulatorFactory # noqa: PLE0402
from .ViewportDragManipulator import ViewportDragManipulatorFactory # noqa: PLE0402
from .ViewportHoverManipulator import ViewportHoverManipulatorFactory # noqa: PLE0402
from .ViewportPressManipulator import ViewportPressManipulatorFactory # noqa: PLE0402
from .ViewportScrollManipulator import ViewportScrollManipulatorFactory # noqa: PLE0402
UI_FRAME_NAME = "omni.graph.SetViewportMode"
VIEWPORT_OVERLAY_NAME = "OG_overlay"
IS_LOCK_REQUIRED = True
class NoLock:
def __init__(self):
pass
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
pass
class OgnSetViewportMode:
@dataclass
class ViewportState:
viewport_click_manipulator: Optional[Any] = None
viewport_press_manipulator: Optional[Any] = None
viewport_drag_manipulator: Optional[Any] = None
viewport_hover_manipulator: Optional[Any] = None
viewport_scroll_manipulator: Optional[Any] = None
picking_manipulator: Optional[Any] = None
__viewport_states: Dict[str, ViewportState] = {}
__do_it_lock: Optional[Any] = Lock() if IS_LOCK_REQUIRED else NoLock()
@staticmethod
def compute(db) -> bool:
if db.inputs.execIn == og.ExecutionAttributeState.DISABLED:
return False
with OgnSetViewportMode.__do_it_lock:
result = OgnSetViewportMode.__do_it(
db.inputs.mode,
db.inputs.viewport,
db.abi_context,
db.outputs,
db.log_error,
db.inputs.enableViewportMouseEvents,
db.inputs.enablePicking,
db.inputs.passClicksThru,
)
if result:
if db.inputs.mode == 0:
db.outputs.defaultMode = og.ExecutionAttributeState.ENABLED
db.outputs.scriptedMode = og.ExecutionAttributeState.DISABLED
elif db.inputs.mode == 1:
db.outputs.defaultMode = og.ExecutionAttributeState.DISABLED
db.outputs.scriptedMode = og.ExecutionAttributeState.ENABLED
return True
db.outputs.defaultMode = og.ExecutionAttributeState.DISABLED
db.outputs.scriptedMode = og.ExecutionAttributeState.DISABLED
return False
@staticmethod
def __do_it(
mode: int,
viewport_window_name: str,
context: og.GraphContext,
outputs: OgnSetViewportModeDatabase.ValuesForOutputs,
log_fn: Optional[Callable],
viewport_mouse_events_enabled: bool,
picking_enabled: bool,
pass_clicks_thru: bool,
) -> bool:
# Validate the viewport window name
if not viewport_window_name:
if log_fn is not None:
log_fn(f"Viewport window '{viewport_window_name}' not found")
return False
viewport_api, viewport_window = get_active_viewport_and_window(window_name=viewport_window_name)
if viewport_window is None:
if log_fn is not None:
log_fn(f"Viewport window '{viewport_window_name}' not found")
return False
if hasattr(viewport_api, "legacy_window"):
if log_fn is not None:
log_fn(f"Legacy viewport window '{viewport_window_name}' not compatible with Set Viewport Mode")
return False
# Default mode
if mode == 0:
# Destroy the manipulators
OgnSetViewportMode.__viewport_states[viewport_window_name] = OgnSetViewportMode.__viewport_states.get(
viewport_window_name, OgnSetViewportMode.ViewportState()
)
viewport_state = OgnSetViewportMode.__viewport_states[viewport_window_name]
if viewport_state.viewport_click_manipulator is not None:
viewport_state.viewport_click_manipulator.destroy()
viewport_state.viewport_click_manipulator = None
if viewport_state.viewport_press_manipulator is not None:
viewport_state.viewport_press_manipulator.destroy()
viewport_state.viewport_press_manipulator = None
if viewport_state.viewport_drag_manipulator is not None:
viewport_state.viewport_drag_manipulator.destroy()
viewport_state.viewport_drag_manipulator = None
if viewport_state.viewport_hover_manipulator is not None:
viewport_state.viewport_hover_manipulator.destroy()
viewport_state.viewport_hover_manipulator = None
if viewport_state.viewport_scroll_manipulator is not None:
viewport_state.viewport_scroll_manipulator.destroy()
viewport_state.viewport_scroll_manipulator = None
if viewport_state.picking_manipulator is not None:
viewport_state.picking_manipulator.destroy()
viewport_state.picking_manipulator = None
# Destroy the ui.ZStack and sc.SceneView if they exist
frame = viewport_window.get_frame(UI_FRAME_NAME)
frame_children = ui.Inspector.get_children(frame)
if frame_children:
widget_container = frame_children[0]
widget_container_children = ui.Inspector.get_children(widget_container)
if widget_container_children:
scene_view = widget_container_children[0]
viewport_api.remove_scene_view(scene_view)
scene_view.scene.clear()
scene_view.destroy()
OgnVStack.deregister_widget(context, VIEWPORT_OVERLAY_NAME)
widget_container.destroy()
frame.clear()
# Clear output widget path
outputs.widgetPath = ""
# Scripted mode
elif mode == 1:
# Create the ui.ZStack and sc.SceneView if they don't exist
frame = viewport_window.get_frame(UI_FRAME_NAME)
frame_children = ui.Inspector.get_children(frame)
if frame_children:
widget_container = frame_children[0]
else:
with frame:
widget_container = ui.ZStack(identifier=VIEWPORT_OVERLAY_NAME)
# Register the container widget so that graphs can access its properties, like size.
OgnVStack.register_widget(context, VIEWPORT_OVERLAY_NAME, widget_container)
widget_container.content_clipping = not pass_clicks_thru
widget_container_children = ui.Inspector.get_children(widget_container)
if widget_container_children:
scene_view = widget_container_children[0]
else:
with widget_container:
scene_view = sc.SceneView(child_windows_input=0)
viewport_api.add_scene_view(scene_view)
# Destroy any existing manipulators and create the enabled manipulators
OgnSetViewportMode.__viewport_states[viewport_window_name] = OgnSetViewportMode.__viewport_states.get(
viewport_window_name, OgnSetViewportMode.ViewportState()
)
viewport_state = OgnSetViewportMode.__viewport_states[viewport_window_name]
if viewport_state.viewport_click_manipulator is not None:
viewport_state.viewport_click_manipulator.destroy()
viewport_state.viewport_click_manipulator = None
if viewport_state.viewport_press_manipulator is not None:
viewport_state.viewport_press_manipulator.destroy()
viewport_state.viewport_press_manipulator = None
if viewport_state.viewport_drag_manipulator is not None:
viewport_state.viewport_drag_manipulator.destroy()
viewport_state.viewport_drag_manipulator = None
if viewport_state.viewport_hover_manipulator is not None:
viewport_state.viewport_hover_manipulator.destroy()
viewport_state.viewport_hover_manipulator = None
if viewport_state.viewport_scroll_manipulator is not None:
viewport_state.viewport_scroll_manipulator.destroy()
viewport_state.viewport_scroll_manipulator = None
if viewport_state.picking_manipulator is not None:
viewport_state.picking_manipulator.destroy()
viewport_state.picking_manipulator = None
with scene_view.scene:
if viewport_mouse_events_enabled:
viewport_state.viewport_click_manipulator = ViewportClickManipulatorFactory(
{"viewport_api": viewport_api, "viewport_window_name": viewport_window_name}
)
viewport_state.viewport_press_manipulator = ViewportPressManipulatorFactory(
{"viewport_api": viewport_api, "viewport_window_name": viewport_window_name}
)
viewport_state.viewport_drag_manipulator = ViewportDragManipulatorFactory(
{"viewport_api": viewport_api, "viewport_window_name": viewport_window_name}
)
viewport_state.viewport_hover_manipulator = ViewportHoverManipulatorFactory(
{"viewport_api": viewport_api, "viewport_window_name": viewport_window_name}
)
viewport_state.viewport_scroll_manipulator = ViewportScrollManipulatorFactory(
{"viewport_api": viewport_api, "viewport_window_name": viewport_window_name}
)
if picking_enabled:
viewport_state.picking_manipulator = PickingManipulatorFactory(
{"viewport_api": viewport_api, "viewport_window_name": viewport_window_name}
)
# Set output widget path
outputs.widgetPath = OmniUIQuery.get_widget_path(viewport_window, widget_container)
return True
| 11,087 | Python | 43 | 114 | 0.638496 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportScrollManipulator.py | # Copyright (c) 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.
#
__all__ = ["ViewportScrollManipulatorFactory"]
from typing import Any
import carb
import omni.kit.app
import omni.kit.commands
from omni.ui import scene as sc
EVENT_NAME = "omni.graph.viewport.scroll"
class DoNotPrevent(sc.GestureManager):
def can_be_prevented(self, gesture):
return False
class ViewportScrollGesture(sc.ScrollGesture):
def __init__(self, viewport_api: Any, viewport_window_name: str):
super().__init__(manager=DoNotPrevent())
self._viewport_api = viewport_api
self._viewport_window_name = viewport_window_name
self._event_type = carb.events.type_from_string(EVENT_NAME)
self._message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
def on_ended(self, *args):
mouse = self.sender.gesture_payload.mouse
resolution = self._viewport_api.resolution
# Position in normalized coords
pos_norm = self._viewport_api.map_ndc_to_texture(mouse)[0]
pos_norm = (pos_norm[0], 1.0 - pos_norm[1])
if not all(0.0 <= x <= 1.0 for x in pos_norm):
return
# Position in viewport resolution pixels
pos_pixel = (pos_norm[0] * resolution[0], pos_norm[1] * resolution[1])
payload = {
"viewport": self._viewport_window_name,
"pos_norm_x": pos_norm[0],
"pos_norm_y": pos_norm[1],
"pos_pixel_x": pos_pixel[0],
"pos_pixel_y": pos_pixel[1],
"scroll": self.scroll[0],
}
self._message_bus.push(self._event_type, payload=payload)
class ViewportScrollManipulator(sc.Manipulator):
def __init__(self, viewport_api: Any, viewport_window_name: str, *args, **kwargs):
super().__init__(*args, **kwargs)
self._gestures = [ViewportScrollGesture(viewport_api, viewport_window_name)]
self._screen = None
self._transform = None
self.name = None
self.categories = ()
def on_build(self):
self._transform = sc.Transform()
with self._transform:
self._screen = sc.Screen(gesture=self._gestures)
def destroy(self):
self._gestures = []
self._screen = None
if self._transform:
self._transform.clear()
self._transform = None
# Factory creator
def ViewportScrollManipulatorFactory(desc: dict) -> ViewportScrollManipulator: # noqa: N802
manip = ViewportScrollManipulator(desc.get("viewport_api"), desc.get("viewport_window_name"))
manip.categories = ()
manip.name = f"ViewportScrollManipulator.{desc.get('viewport_window_name')}"
return manip
| 3,047 | Python | 33.636363 | 97 | 0.65146 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnOnWidgetClicked.py | # Copyright (c) 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 contextlib import suppress
import omni.graph.core as og
from omni.graph.ui_nodes.ogn.OgnOnWidgetClickedDatabase import OgnOnWidgetClickedDatabase
from . import UINodeCommon
class OgnOnWidgetClicked:
@staticmethod
def internal_state():
return UINodeCommon.OgnUIEventNodeInternalState()
@staticmethod
def compute(db) -> bool:
widget_identifier = db.inputs.widgetIdentifier
if not widget_identifier:
return True
event_name = "clicked_" + widget_identifier
if db.internal_state.first_time_subscribe(db.node, event_name):
return True
payload = db.internal_state.try_pop_event()
if payload is None:
return True
# Currently payload is an empty dictionary
db.outputs.clicked = og.ExecutionAttributeState.ENABLED
return True
# ----------------------------------------------------------------------------
@staticmethod
def release(node):
# Unsubscribe right away instead of waiting for GC cleanup, we don't want our callback firing
# after the node has been released.
with suppress(og.OmniGraphError):
state = OgnOnWidgetClickedDatabase.per_node_internal_state(node)
state.release()
| 1,709 | Python | 32.529411 | 101 | 0.679345 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/CameraState.cpp | // Copyright (c) 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.
//
#include "CameraState.h"
#include <carb/settings/ISettings.h>
#include <omni/timeline/ITimeline.h>
#include <omni/usd/UsdUtils.h>
using namespace omni::graph::ui_nodes;
static const PXR_NS::TfToken kCenterOfInterest("omni:kit:centerOfInterest");
static bool checkPositionAndTarget(const PXR_NS::GfVec3d& position, const PXR_NS::GfVec3d& target)
{
// If position and target are coincident, fail
if ((position - target).GetLengthSq() <= std::numeric_limits<double>::epsilon())
{
return false;
}
return true;
}
static PXR_NS::GfVec3d getCameraUp(PXR_NS::UsdStageRefPtr stage)
{
PXR_NS::TfToken upAxis = PXR_NS::UsdGeomGetStageUpAxis(stage);
if (upAxis == PXR_NS::UsdGeomTokens->x)
{
return { 1, 0, 0 };
}
if (upAxis == PXR_NS::UsdGeomTokens->z)
{
return { 0, 0, 1 };
}
return { 0, 1, 0 };
}
CameraState::CameraState(PXR_NS::UsdGeomCamera camera, const PXR_NS::UsdTimeCode* time)
: m_camera(std::move(camera))
, m_timeCode(time ? *time : omni::timeline::getTimeline()->getCurrentTime() * m_camera.GetPrim().GetStage()->GetTimeCodesPerSecond())
{
}
void CameraState::getCameraPosition(carb::Double3& position) const
{
PXR_NS::GfMatrix4d worldXform = m_camera.ComputeLocalToWorldTransform(m_timeCode).RemoveScaleShear();
PXR_NS::GfVec3d worldPos = worldXform.Transform(PXR_NS::GfVec3d(0, 0, 0));
position = { worldPos[0], worldPos[1], worldPos[2] };
}
void CameraState::getCameraTarget(carb::Double3& target) const
{
PXR_NS::GfVec3d localCenterOfInterest;
PXR_NS::UsdAttribute coiAttr = m_camera.GetPrim().GetAttribute(kCenterOfInterest);
if (!coiAttr || !coiAttr.Get(&localCenterOfInterest, m_timeCode))
{
localCenterOfInterest = { 0, 0, -1 };
}
PXR_NS::GfMatrix4d worldXform = m_camera.ComputeLocalToWorldTransform(m_timeCode).RemoveScaleShear();
PXR_NS::GfVec3d worldCenterOfInterest = worldXform.Transform(localCenterOfInterest);
target = { worldCenterOfInterest[0], worldCenterOfInterest[1], worldCenterOfInterest[2] };
}
bool CameraState::setCameraPosition(const carb::Double3& worldPosition, bool rotate)
{
PXR_NS::GfMatrix4d worldXform = m_camera.ComputeLocalToWorldTransform(m_timeCode).RemoveScaleShear();
PXR_NS::GfMatrix4d parentXform = m_camera.ComputeParentToWorldTransform(m_timeCode);
PXR_NS::GfMatrix4d invParentXform = parentXform.GetInverse();
PXR_NS::GfMatrix4d initialLocalXform = worldXform * invParentXform;
PXR_NS::GfVec3d posInParent = invParentXform.Transform(PXR_NS::GfVec3d(worldPosition.x, worldPosition.y, worldPosition.z));
PXR_NS::UsdPrim camPrim = m_camera.GetPrim();
PXR_NS::UsdAttribute coiAttr;
PXR_NS::GfVec3d prevLocalCenterOfInterest;
PXR_NS::GfMatrix4d newLocalXform;
if (rotate)
{
const PXR_NS::GfVec3d camUp = getCameraUp(camPrim.GetStage());
coiAttr = camPrim.GetAttribute(kCenterOfInterest);
if (!coiAttr || !coiAttr.Get(&prevLocalCenterOfInterest, m_timeCode))
{
prevLocalCenterOfInterest = { 0, 0, -1 };
}
PXR_NS::GfVec3d coiInParent = invParentXform.Transform(worldXform.Transform(prevLocalCenterOfInterest));
if (!checkPositionAndTarget(posInParent, coiInParent))
{
return false;
}
newLocalXform = PXR_NS::GfMatrix4d(1).SetLookAt(posInParent, coiInParent, camUp).GetInverse();
}
else
{
newLocalXform = initialLocalXform;
}
newLocalXform.SetTranslateOnly(posInParent);
omni::usd::UsdUtils::setLocalTransformMatrix(camPrim, newLocalXform, m_timeCode);
if (coiAttr)
{
PXR_NS::GfVec3d prevWorldCOI = worldXform.Transform(prevLocalCenterOfInterest);
PXR_NS::GfVec3d newLocalCOI = (newLocalXform * parentXform).GetInverse().Transform(prevWorldCOI);
omni::usd::UsdUtils::setAttribute(coiAttr, newLocalCOI, m_timeCode);
}
return true;
}
bool CameraState::setCameraTarget(const carb::Double3& worldTarget, bool rotate)
{
PXR_NS::UsdPrim camPrim = m_camera.GetPrim();
PXR_NS::GfMatrix4d worldXform = m_camera.ComputeLocalToWorldTransform(m_timeCode).RemoveScaleShear();
PXR_NS::GfMatrix4d parentXform = m_camera.ComputeParentToWorldTransform(m_timeCode);
PXR_NS::GfMatrix4d invParentXform = parentXform.GetInverse();
PXR_NS::GfMatrix4d initialLocalXform = worldXform * invParentXform;
PXR_NS::GfVec3d gfWorldTarget(worldTarget.x, worldTarget.y, worldTarget.z);
PXR_NS::GfVec3d prevLocalCenterOfInterest;
PXR_NS::UsdAttribute coiAttr = camPrim.GetAttribute(kCenterOfInterest);
if (!coiAttr || !coiAttr.Get(&prevLocalCenterOfInterest, m_timeCode))
{
prevLocalCenterOfInterest = { 0, 0, -1 };
}
PXR_NS::GfVec3d posInParent = invParentXform.Transform(initialLocalXform.Transform(PXR_NS::GfVec3d(0, 0, 0)));
PXR_NS::GfMatrix4d newLocalXform;
PXR_NS::GfVec3d newLocalCenterOfInterest;
if (rotate)
{
// Rotate camera to look at new target, leaving it where it is
PXR_NS::GfVec3d camUp = getCameraUp(camPrim.GetStage());
PXR_NS::GfVec3d coiInParent = invParentXform.Transform(gfWorldTarget);
if (!checkPositionAndTarget(posInParent, coiInParent))
{
return false;
}
newLocalXform = PXR_NS::GfMatrix4d(1).SetLookAt(posInParent, coiInParent, camUp).GetInverse();
newLocalCenterOfInterest = (newLocalXform * parentXform).GetInverse().Transform(gfWorldTarget);
}
else
{
// Camera keeps orientation and distance relative to target
// Calculate movement of center-of-interest in parent's space
PXR_NS::GfVec3d targetMove = invParentXform.Transform(gfWorldTarget) - invParentXform.Transform(worldXform.Transform(prevLocalCenterOfInterest));
// Copy the camera's local transform
newLocalXform = initialLocalXform;
// And move it by the delta
newLocalXform.SetTranslateOnly(posInParent + targetMove);
}
if (rotate)
{
omni::usd::UsdUtils::setAttribute(coiAttr, newLocalCenterOfInterest, m_timeCode);
}
omni::usd::UsdUtils::setLocalTransformMatrix(camPrim, newLocalXform, m_timeCode);
return true;
}
| 6,675 | C++ | 38.270588 | 153 | 0.708914 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnGetActiveViewportCamera.py | """
This is the implementation of the OGN node defined in OgnGetActiveViewportCamera.ogn
"""
from omni.kit.viewport.utility import get_viewport_window_camera_string
class OgnGetActiveViewportCamera:
"""
Gets a viewport's actively bound camera
"""
@staticmethod
def compute(db) -> bool:
"""Compute the outputs from the current input"""
try:
viewport_name = db.inputs.viewport
active_camera = get_viewport_window_camera_string(viewport_name)
db.outputs.camera = active_camera
db.outputs.cameraPrim = [active_camera]
except Exception as error: # pylint: disable=broad-except
db.log_error(str(error))
return False
return True
| 752 | Python | 27.961537 | 84 | 0.650266 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/UINodeCommon.py | # Copyright (c) 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.
#
import ast
from typing import Dict, List, Optional, Tuple, Type, Union
import carb.events
import omni.client
import omni.graph.core as og
import omni.kit.app
import omni.ui as ui
import omni.usd
from omni.ui_query import OmniUIQuery
# TODO: Uncomment this when Viewport 2.0 becomes the default Viewport
# import omni.kit.viewport.window as vp
class OgnUINodeInternalState:
# This class is used by old widget nodes which have not yet been converted to use
# OgWidgetNode. It will be removed once they are all converted.
def __init__(self):
self.created_widget = None
self.created_frame = None
class OgWidgetNodeCallbacks:
"""
!!!BETA: DO NOT USE!!!
A base class for callbacks used by nodes which create omni.ui widgets.
"""
@staticmethod
def get_property_names(widget: ui.Widget, writeable: bool) -> Optional[List[str]]:
"""
Returns a dictionary containing those properties which are common to all ui.Widget.
If 'writeable' is True then only those properties whose values can be set will be
returned, otherwise only those whose value can be read will be returned.
If 'widget' is not a valid widget a warning will be issued and None returned.
"""
if not isinstance(widget, ui.Widget):
carb.log_warn(f"Attempt to retrieve property names from non-widget object '{widget}'.")
return None
# Read/write properties
props = [
"enabled", # bool
"height", # ui.Length
"name", # str
"opaque_for_mouse_events", # bool
"selected", # bool
"skip_draw_when_clipped", # bool
"style_type_name_override", # str
"tooltip", # str
"tooltip_offset_x", # float
"tooltip_offset_y", # float
"visible", # bool
"visible_max", # float
"visible_min", # float
"width", # ui.Length
]
if not writeable:
# Read-only properties
props += [
"computed_content_height", # float
"computed_content_width", # float
"computed_height", # float
"computed_width", # float
"dragging", # bool
"identifier", # str
"screen_position_x", # float
"screen_position_y", # float
]
return props
@staticmethod
def resolve_output_property(widget: ui.Widget, property_name: str, attribute: og.Attribute):
"""
Resolves the type of an output property based on a widget attribute.
This assumes the output attribute has the 'unvalidated' metadata set to true
OmniGraphError raised on failure.
"""
if not isinstance(widget, ui.Widget):
raise og.OmniGraphError(f"Attempt to resolve property on non-widget object '{widget}'.")
widget_desc = widget.identifier or repr(widget)
if not hasattr(widget, property_name):
raise og.OmniGraphError(f"Widget '{widget_desc}' has no property '{property_name}'.")
prop_value = getattr(widget, property_name)
if isinstance(prop_value, bool):
out_type = "bool"
elif isinstance(prop_value, int):
out_type = "int"
elif isinstance(prop_value, float):
out_type = "double"
elif isinstance(prop_value, (str, ui.Length, ui.Direction)):
out_type = "string"
else:
raise og.OmniGraphError(f"Cannot resolve output type: {type(prop_value)}")
attr_type = og.AttributeType.type_from_ogn_type_name(out_type)
attr_type_valid = attr_type.base_type != og.BaseDataType.UNKNOWN
if attribute.get_resolved_type().base_type != og.BaseDataType.UNKNOWN and (
not attr_type_valid or attr_type != attribute.get_resolved_type()
):
attribute.set_resolved_type(og.Type(og.BaseDataType.UNKNOWN))
if attr_type_valid and attribute.get_resolved_type().base_type == og.BaseDataType.UNKNOWN:
attribute.set_resolved_type(attr_type)
@staticmethod
def get_property_value(widget: ui.Widget, property_name: str, attribute: og.RuntimeAttribute):
"""
Retrieves the value of a property from a widget and writes it to the given node attribute.
OmniGraphError raised on failure.
"""
if not isinstance(widget, ui.Widget):
raise og.OmniGraphError(f"Attempt to get property value from non-widget object '{widget}'.")
widget_desc = widget.identifier or repr(widget)
if not hasattr(widget, property_name):
raise og.OmniGraphError(f"Widget '{widget_desc}' has no property '{property_name}'.")
prop_value = getattr(widget, property_name)
prop_type = type(prop_value)
if prop_type in (bool, int, float, str):
try:
attribute.value = prop_value
return # Property value is retrieved
except ValueError:
pass
# XXX: To preserve the 'units' (px, fr, %) we may want to split the output of these into a (value, unit) pair
elif prop_type in (ui.Length, ui.Direction):
try:
attribute.value = str(prop_value)
return
except ValueError:
pass
else:
raise og.OmniGraphError(f"Unsupported property type: {prop_type}")
raise og.OmniGraphError(f"Attempt to get property '{property_name}' from widget '{widget_desc}' failed.")
@staticmethod
def set_property_value(widget: ui.Widget, property_name: str, attribute: og.RuntimeAttribute):
"""
Retrieves the value of a node attribute and writes it to the given widget property.
OmniGraphError raised on failure.
"""
if not isinstance(widget, ui.Widget):
raise og.OmniGraphError(f"Attempt to set property value on non-widget object '{widget}'.")
widget_desc = widget.identifier or repr(widget)
if not hasattr(widget, property_name):
raise og.OmniGraphError(f"Widget '{widget_desc}' has no property '{property_name}'.")
value = attribute.value
prop_type = type(getattr(widget, property_name))
if prop_type == str and property_name == "image_url":
try:
setattr(widget, property_name, resolve_image_url(prop_type(value)))
return
except ValueError:
pass
elif prop_type in (bool, int, float, str):
try:
setattr(widget, property_name, prop_type(value))
return
except ValueError:
pass
elif prop_type == ui.Length:
length = to_ui_length(value)
if length is not None:
try:
setattr(widget, property_name, length)
return
except ValueError:
pass
return
elif prop_type == ui.Direction:
direction = to_ui_direction(value)
if direction is not None:
try:
setattr(widget, property_name, direction)
return
except ValueError:
pass
return
else:
raise og.OmniGraphError(f"Unsupported property type: {prop_type}")
if prop_type == ui.Length:
carb.log_warn(
f"{prop_type} properties may be set from int or float values, or from string values containing "
"an int or float optionally followed by 'px' for pixels (e.g. '5px'), 'fr' for fractional amounts "
"('0.3fr') or '%' for percentages ('30%'). If no suffix is given then 'px' is assumed."
)
if isinstance(value, str) and prop_type != str:
raise og.OmniGraphError(
f"Cannot set value onto widget '{widget_desc}' property '{property_name}': "
f"string value '{value}' cannot be converted to {prop_type}."
)
raise og.OmniGraphError(
f"Cannot set value of type {type(value)} onto widget '{widget_desc}' "
f"property '{property_name}' (type {prop_type})"
)
@staticmethod
def get_style_element_names(widget: ui.Widget, writeable: bool) -> List[str]:
"""
Returns the names of those style elements which are common to all ui.Widget.
If 'writeable' is True then only those elements whose values can be set will be
returned, otherwise only those whose value can be read will be returned.
If 'widget' is not a valid widget a warning will be issued and None returned.
"""
if not isinstance(widget, ui.Widget):
carb.log_warn(f"Attempt to retrieve style element names from non-widget object '{widget}'.")
return None
# There are currently no style elements common to all widgets.
return []
@staticmethod
def get_style_value(widget: ui.Widget, element_name: str, attribute: og.RuntimeAttribute) -> bool:
"""
Retrieves the value of a style element from a widget and writes it to the given node attribute.
Returns True on success, False on failure.
"""
if not isinstance(widget, ui.Widget):
carb.log_warn(f"Attempt to get style element from non-widget object '{widget}'.")
return None
# TBD
return False
@staticmethod
def set_style_value(widget: ui.Widget, element_name: str, attribute: og.RuntimeAttribute) -> bool:
"""
Retrieves the value of a style element from a node attribute and sets it on the given widget.
Returns True on success, False on failure.
"""
if not isinstance(widget, ui.Widget):
carb.log_warn(f"Attempt to set style element on non-widget object '{widget}'.")
return None
# TBD
return False
class OgWidgetNode(OgWidgetNodeCallbacks):
"""
!!!BETA: DO NOT USE!!!
A base class for nodes which create omni.ui widgets.
"""
@classmethod
def register_widget(cls, context: og.GraphContext, widget_id: str, widget: omni.ui.Widget):
"""
Register a widget by the GraphContext in which it was generated and a unique id within that context.
"""
register_widget(context, widget_id, widget, cls)
@classmethod
def deregister_widget(cls, context: og.GraphContext, widget_id: str):
"""
Deregister a previously registered widget.
"""
if context and widget_id:
remove_registered_widgets(context, widget_id)
######################################################################################################
#
# Widget Registry
#
# The widget registry provides a mapping between a widget identifier and the widget itself. Widget
# identifiers are specific to the graph context in which their widgets were created. This helps to avoid clashing
# identifiers, particularly when graphs are instanced.
#
# TODO: Internally we use the widget's full path string to identify the widget uniquely within the application.
# This is quite inefficient as it requires traversing the entire widget tree of the application each
# time we want to convert a path to a widget or vice-versa.
#
# We cannot store the widget object itself in the registry because that would increment its
# reference count and keep the widget (and its window) alive after they should have been destroyed.
#
# Using a weak reference won't work either because the widget objects we see in Python are just temporary
# wrappers around the actual C++ objects. A weak reference would be invalidated as soon as the wrapper was
# destroyed, even though the widget itself might still be alive.
#
# get_registered_widget() ensures that the widget registry for a given context does not
# grow without bound, but we still need a way to either automatically clear a widget's entry when it is
# destroyed, or completely clear the entries for a given context when that context is destroyed.
# One approach would be to have the SetViewportMode node clear the registry of all widgets in its graph
# context when it destroys its OG overlay, however since its extension doesn't depend on this one, it would
# have to monitor the loading and unloading of the omni.graph.action extension.
def register_widget(
context: og.GraphContext, widget_id: str, widget: ui.Widget, callbacks: Type[OgWidgetNodeCallbacks]
):
"""
!!!BETA: DO NOT USE!!!
Register a widget by the GraphContext in which it was generated and a unique id within that context.
'callbacks' is either a sub-class of OgWidgetNode or some other object which provides the same set of
static methods (the class methods are not necessary).
"""
if context and widget_id and widget:
path = find_widget_path(widget)
if path:
_widget_registry[(context, widget_id)] = path
_widget_callbacks[path] = callbacks
def get_registered_widget(context: og.GraphContext, widget_id: str) -> Optional[ui.Widget]:
"""
!!!BETA: DO NOT USE!!!
Returns a widget given the GraphContext in which it was created and its unique id within that context.
If there is no such widget then None is returned.
"""
path = _widget_registry.get((context, widget_id))
if path:
widget = find_widget_among_all_windows(path)
if not widget:
# This must be a deleted widget. Remove it from the registry.
remove_registered_widgets(context, widget_id)
return widget
return None
def get_registered_widgets(context: og.GraphContext = None, widget_id: str = None) -> List[ui.Widget]:
"""
!!!BETA: DO NOT USE!!!
Returns all the widgets which match the search parameters. If 'context' is None then all contexts
will be searched. If 'id' is None then all widgets within the searched context(s) will be returned.
"""
return [
find_widget_among_all_windows(path)
for (_context, _id), path in _widget_registry.items()
if (context is None or _context == context) and (widget_id is None or _id == widget_id)
]
def remove_registered_widgets(context: og.GraphContext, widget_id: str = None):
"""
!!!BETA: DO NOT USE!!!
Removes the specified widget from the registry. If 'widget_id' is not specified then all widgets
registered under the given context will be removed.
"""
if widget_id:
keys_to_remove = [(context, widget_id)]
else:
keys_to_remove = [(_ctx, _id) for (_ctx, _id) in _widget_registry if _ctx == context]
for key in keys_to_remove:
path = _widget_registry.pop(key)
_widget_callbacks.pop(path, None)
def get_widget_callbacks(widget: ui.Widget) -> Optional[Type[OgWidgetNodeCallbacks]]:
"""
!!!BETA: DO NOT USE!!!
Returns the callbacks object for a registered widget or None if no such widget is registered.
"""
return _widget_callbacks.get(find_widget_path(widget))
def get_unique_widget_identifier(db: og.Database) -> str:
"""
!!!BETA: DO NOT USE!!!
Returns a widget identifier which is unique within the current GraphContext.
The identifier is taken from the 'widgetIdentifier' input attribute, or the name
of the node if 'widgetIdentifier' is not set. If the identifier is already in
use then a suffix will be added to make it unique.
"""
base_id = db.inputs.widgetIdentifier or db.node.get_prim_path().replace("/", ":")
counter = 0
final_id = base_id
while get_registered_widget(db.abi_context, final_id) is not None:
counter += 1
final_id = base_id + "_" + str(counter)
return final_id
# Mapping between widget identifiers and widgets.
#
# Key: (graph context, widget identifier)
# Value: full path to the widget
_widget_registry: Dict[Tuple[og.GraphContext, str], str] = {}
# Callbacks to operate on per-widget data (e.g. properites)
#
# Key: full path to the widget
# Value: class object derived from OgWidgetNodeCallbacks
_widget_callbacks: Dict[str, Type[OgWidgetNodeCallbacks]] = {}
######################################################################################################
def to_ui_direction(value: str) -> ui.Direction:
"""
!!!BETA: DO NOT USE!!!
Convert the input value to a ui.Direction.
"""
if value == "LEFT_TO_RIGHT":
return ui.Direction.LEFT_TO_RIGHT
if value == "RIGHT_TO_LEFT":
return ui.Direction.RIGHT_TO_LEFT
if value == "TOP_TO_BOTTOM":
return ui.Direction.TOP_TO_BOTTOM
if value == "BOTTOM_TO_TOP":
return ui.Direction.BOTTOM_TO_TOP
if value == "BACK_TO_FRONT":
return ui.Direction.BACK_TO_FRONT
if value == "FRONT_TO_BACK":
return ui.Direction.FRONT_TO_BACK
return None
def to_ui_length(value: Union[float, int, str]) -> ui.Length:
"""
!!!BETA: DO NOT USE!!!
Convert the input value to a ui.Length.
"""
if isinstance(value, (float, int)):
return ui.Length(value)
if not isinstance(value, str):
return None
unit_type = ui.UnitType.PIXEL
if value.endswith("fr"):
unit_type = ui.UnitType.FRACTION
value = value[:-2]
elif value.endswith("%"):
unit_type = ui.UnitType.PERCENT
value = value[:-1]
elif value.endswith("px"):
value = value[:-2]
try:
return ui.Length(int(value), unit_type)
except ValueError:
try:
return ui.Length(float(value), unit_type)
except ValueError:
return None
def resolve_image_url(url: str) -> str:
if not url:
return url
edit_layer = omni.usd.get_context().get_stage().GetEditTarget().GetLayer()
if edit_layer.anonymous:
return url
return omni.client.combine_urls(edit_layer.realPath, url).replace("\\", "/")
def resolve_style_image_urls(style_dict: Optional[Dict]) -> Optional[Dict]:
if not style_dict:
return style_dict
edit_layer = omni.usd.get_context().get_stage().GetEditTarget().GetLayer()
if edit_layer.anonymous:
return style_dict
for value in style_dict.values():
if isinstance(value, dict):
url = value.get("image_url")
if url:
value["image_url"] = omni.client.combine_urls(edit_layer.realPath, url).replace("\\", "/")
return style_dict
def to_ui_style(style_string: str) -> Optional[Dict]:
"""
!!!BETA: DO NOT USE!!!
Converts a string containing a style description into a Python dictionary suitable for use with
ui.Widget.set_style().
Returns None if style_string is empty.
Raises SyntaxError if the string contains invalid style syntax.
Raises ValueError if 'style_string' is not a string.
"""
def fmt_syntax_err(err):
# Syntax errors are not very descriptive. Let's do a bit better.
msg = "Invalid style syntax"
# Don't include the message if it's just "invalid syntax".
if err.msg.lower() != "invalid syntax":
msg += " (" + err.msg + ")"
# Include the text of the line where the error was found, with an indicator at the point of the error.
# It would be nice to output this as two lines with the indicator indented beneath the error, but by the
# time the message reached the node's tooltip all such formatting would be lost. So we settle for an
# inline indicator.
text = err.text[: err.offset] + "^^^" + err.text[err.offset :]
# If the line is too long, elide the start and/or end of it.
if len(text) > 50:
right = min(err.offset + 25, len(text))
left = max(right - 50, 0)
if len(text) - right > 5:
text = text[:right] + "..."
if left > 5:
text = "..." + text[left:]
# Include the line number and offset so that the callers don't all have to do it themselves.
return msg + f": line {err.lineno} offset {err.offset}: " + text
def fmt_value_err(err):
# Value errors generally reflect some bad internal state of the parser. They only give us a message with
# no indication of where in input the error occurred.
return f"Invalid style syntax ({err.args[0]})."
if not style_string:
return None
if not isinstance(style_string, str):
raise ValueError(f"Style must be a string, not type {type(style_string)}.")
try:
return resolve_style_image_urls(ast.literal_eval(style_string))
except SyntaxError as err:
err.msg = fmt_syntax_err(err)
raise
except ValueError as err:
syn_err = SyntaxError(fmt_value_err(err))
syn_err.text = style_string
raise syn_err from err
######################################################################################################
# All code in this block deal with Viewport 1.0
# TODO: Remove this block of code when Viewport 2.0 becomes the default Viewport
def _parse_input(query, search_among_all_windows=False):
"""A variation of OmniUIQuery._parse_input that allows you to search among all windows with the same name"""
tokens = query.split("//")
window_name = tokens[0] if len(tokens) > 1 else None
widget_predicate = ""
widget_part = tokens[1] if len(tokens) > 1 else tokens[0]
widget_part_list = widget_part.split(".", maxsplit=1)
widget_path = widget_part_list[0]
if len(widget_part_list) > 1:
widget_predicate = widget_part_list[1]
window = None
if window_name:
windows = ui.Workspace.get_windows()
window_list = []
for window in windows:
if window.title == window_name:
window_list.append(window)
if not window_list:
carb.log_warn(f"Failed to find window: '{window_name}'")
return False, None, [], widget_predicate
if search_among_all_windows:
window = []
for current_window in window_list:
if isinstance(current_window, ui.Window):
window.append(current_window)
if len(window) == 0:
carb.log_warn(f"Failed to find a ui.Window named {window_name}, query only works on ui.Window")
return False, None, [], widget_predicate
else:
if len(window_list) == 1:
window = window_list[0]
else:
carb.log_warn(
f"found {len(window_list)} windows named '{window_name}'. Using first visible window found"
)
window = None
for win in window_list:
if win.visible:
window = win
break
if not window:
carb.log_warn(f"Failed to find visible window: '{window_name}'")
return False, None, [], widget_predicate
if not isinstance(window, ui.Window) and not isinstance(window, ui.ToolBar):
carb.log_warn(f"window: {window_name} is not a ui.Window, query only works on ui.Window")
return False, None, [], widget_predicate
widget_tokens = widget_path.split("/")
if window and not (widget_tokens[0] == "Frame" or widget_tokens[0] == "Frame[0]"):
carb.log_warn("Query with a window currently only supports '<WindowName>//Frame/*' type query")
return False, None, [], widget_predicate
if widget_tokens[-1] == "":
widget_tokens = widget_tokens[:-1]
return True, window, widget_tokens, widget_predicate
def __search_for_widget_in_window(window: ui.Window, widget_tokens: List[str]) -> Optional[ui.Widget]:
current_child = window.frame
for token in widget_tokens[1:]:
child = OmniUIQuery._child_widget(current_child, token, show_warnings=False) # noqa: PLW0212
if not child: # Unable to find the widget in the current window
return None
current_child = child
return current_child
def find_widget_among_all_windows(query):
"""Find a single widget given a full widget path.
If there are multiple windows with the same name, search among all of them."""
validate_status, windows, widget_tokens, _ = _parse_input(query, search_among_all_windows=True)
if not validate_status:
return None
if len(widget_tokens) == 1:
return windows[0].frame
for window in windows:
search_result = __search_for_widget_in_window(window, widget_tokens)
if search_result is not None:
return search_result
return None
def get_widget_window(widget_or_path: Union[ui.Widget, str]) -> Optional[ui.Window]:
if isinstance(widget_or_path, ui.Widget):
for window in ui.Workspace.get_windows():
if isinstance(window, ui.Window) and OmniUIQuery.get_widget_path(window, widget_or_path) is not None:
return window
elif isinstance(widget_or_path, str):
found_it, windows, widget_tokens, _ = _parse_input(widget_or_path, search_among_all_windows=True)
if not found_it:
return None
if len(widget_tokens) == 1:
return windows[0]
for window in windows:
search_result = __search_for_widget_in_window(window, widget_tokens)
if search_result is not None:
return window
return None
def get_parent_widget(db: og.Database):
"""Given the path to the parent widget db.inputs.parentWidgetPath, find the parent widget at that path.
If the path is empty, then the parent widget will be the viewport frame."""
parent_widget_path = db.inputs.parentWidgetPath
if not parent_widget_path:
# This widget is a direct child of the viewport frame
if not hasattr(db.internal_state, "window"):
db.internal_state.window = ui.Window("Viewport")
db.internal_state.window.visible = True
parent_widget = db.internal_state.window.frame
return parent_widget
# This widget is nested under some other widget
parent_widget = find_widget_among_all_windows(parent_widget_path)
if not parent_widget:
db.log_error("Cannot find the parent widget at the specified path!")
return None
return parent_widget
def find_widget_path(widget: ui.Widget):
"""Find the path to the widget. Search among all windows."""
for window in ui.Workspace.get_windows():
if isinstance(window, ui.Window):
query_result = OmniUIQuery.get_widget_path(window, widget)
if query_result is not None:
return query_result
return None
######################################################################################################
# All code in this block deal with Viewport 2.0
# TODO: Uncomment this block of code when Viewport 2.0 becomes the default Viewport
# def get_unique_frame_identifier(db):
# """Return a unique identifier for the created viewport frame"""
# unique_widget_identifier = get_unique_widget_identifier(db)
# return "omni.graph.action.ui_node." + unique_widget_identifier
#
#
# def get_default_viewport_window():
# default_viewport_name = vp.ViewportWindowExtension.WINDOW_NAME
# for window in vp.get_viewport_window_instances():
# if window.name == default_viewport_name:
# return window
# return None
#
#
# def get_parent_widget(db):
# """Given the path to the parent widget db.inputs.parentWidgetPath, find the parent widget at that path.
# If the path is empty, then the parent widget will be the viewport frame."""
# parent_widget_path = db.inputs.parentWidgetPath
#
# if not parent_widget_path:
# # This widget is a direct child of the viewport frame
# viewport_window = get_default_viewport_window()
# if not viewport_window:
# db.log_error("Cannot find the default viewport window!")
# return None
# frame_identifier = get_unique_frame_identifier(db)
# viewport_frame = viewport_window.get_frame(frame_identifier)
# return viewport_frame
#
# else:
# # This widget is nested under some other widget
# parent_widget = OmniUIQuery.find_widget(parent_widget_path)
# if not parent_widget:
# db.log_error("Cannot find the parent widget at the specified path!")
# return None
# return parent_widget
#
#
# def find_widget_path(widget: ui.Widget):
# """Given a widget in the default viewport window, find the path to the widget"""
# viewport_window = get_default_viewport_window()
# if not viewport_window:
# return None
# return OmniUIQuery.get_widget_path(viewport_window, widget)
######################################################################################################
def tear_down_widget(db: og.Database) -> bool:
if db.internal_state.created_widget is None:
db.log_error("Cannot tear down a widget that has not been created")
return False
# Since ui.Frame can only have one child, this code effectively replaces the previous child of ui.Frame
# with an empty ui.Placer, and the previous child will be automatically garbage collected.
# Due to the limitations of omni.ui, we cannot remove child widgets from the parent, so this is the best we can do.
db.internal_state.created_widget = None
with db.internal_state.created_frame:
ui.Placer()
db.internal_state.created_frame = None
db.outputs.created = og.ExecutionAttributeState.DISABLED
db.outputs.widgetPath = ""
return True
def show_widget(db: og.Database) -> bool:
if db.internal_state.created_widget is None:
db.log_error("Cannot show a widget that has not been created")
return False
db.internal_state.created_widget.visible = True
db.outputs.created = og.ExecutionAttributeState.DISABLED
# Keep db.outputs.widgetPath unchanged
return True
def hide_widget(db: og.Database) -> bool:
if db.internal_state.created_widget is None:
db.log_error("Cannot hide a widget that has not been created")
return False
db.internal_state.created_widget.visible = False
db.outputs.created = og.ExecutionAttributeState.DISABLED
# Keep db.outputs.widgetPath unchanged
return True
def enable_widget(db: og.Database) -> bool:
if db.internal_state.created_widget is None:
db.log_error("Cannot enable a widget that has not been created")
return False
db.internal_state.created_widget.enabled = True
db.outputs.created = og.ExecutionAttributeState.DISABLED
# Keep db.outputs.widgetPath unchanged
return True
def disable_widget(db: og.Database) -> bool:
if db.internal_state.created_widget is None:
db.log_error("Cannot disable a widget that has not been created")
return False
db.internal_state.created_widget.enabled = False
db.outputs.created = og.ExecutionAttributeState.DISABLED
# Keep db.outputs.widgetPath unchanged
return True
def registered_event_name(event_name):
"""Returns the internal name used for the given custom event name"""
n = "omni.graph.action." + event_name
return carb.events.type_from_string(n)
class OgnUIEventNodeInternalState:
def __init__(self):
"""Instantiate the per-node state information."""
# This subscription object controls the lifetime of our callback,
# it will be cleaned up automatically when our node is destroyed
self.sub = None
# Set when the callback has triggered
self.is_set = False
# The last payload received
self.payload = None
# The event name we used to subscribe
self.sub_event_name = ""
# The node instance handle
self.node = None
def on_event(self, custom_event):
"""The event callback"""
if custom_event is None:
return
self.is_set = True
self.payload = custom_event.payload
# Tell the evaluator we need to be computed
if self.node.is_valid():
self.node.request_compute()
def first_time_subscribe(self, node: og.Node, event_name: str) -> bool:
"""Checked call to set up carb subscription
Args:
node: The node instance
event_name: The name of the carb event
Returns:
True if we subscribed, False if we are already subscribed
"""
if self.sub is not None and self.sub_event_name != event_name:
# event name changed since we last subscribed, unsubscribe
self.sub.unsubscribe()
self.sub = None
if self.sub is None:
# Add a subscription for the given event name. This is a pop subscription,
# so we expect a 1-frame lag between send and receive
reg_event_name = registered_event_name(event_name)
message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
self.sub = message_bus.create_subscription_to_pop_by_type(reg_event_name, self.on_event)
self.sub_event_name = event_name
self.node = node
return True
return False
def try_pop_event(self):
"""Pop the payload of the last event received, or None if there is no event to pop"""
if self.is_set:
self.is_set = False
payload = self.payload
self.payload = None
return payload
return None
def release(self):
# Unsubscribe right away instead of waiting for GC cleanup, we don't want our callback firing
# after the node has been released.
if self.sub:
self.sub.unsubscribe()
self.sub = None
| 34,571 | Python | 38.064407 | 119 | 0.622458 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnReadPickState.cpp | // Copyright (c) 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.
//
#include <OgnReadPickStateDatabase.h>
#include "PickingNodeCommon.h"
#include <omni/kit/IApp.h>
#include <omni/ui/Workspace.h>
#include <omni/graph/core/PreUsdInclude.h>
#include <pxr/usd/sdf/path.h>
#include <pxr/usd/usd/common.h>
#include <pxr/usd/usd/prim.h>
#include <pxr/usd/usd/relationship.h>
#include <pxr/usd/usdUtils/stageCache.h>
#include <omni/graph/core/PostUsdInclude.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnReadPickState
{
public:
struct InternalState
{
carb::events::ISubscriptionPtr pickingSub;
PickingEventPayloads eventPayloads;
} m_internalState;
exec::unstable::Stamp m_setStamp; // stamp set when the event occurs
exec::unstable::SyncStamp m_syncStamp; // stamp set by each instance
static void initialize(GraphContextObj const& context, NodeObj const& nodeObj)
{
OgnReadPickState& state = OgnReadPickStateDatabase::sSharedState<OgnReadPickState>(nodeObj);
// Subscribe to picking events
if (omni::kit::IApp* app = carb::getCachedInterface<omni::kit::IApp>())
{
state.m_internalState.pickingSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kPickingEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnReadPickState& state = OgnReadPickStateDatabase::sSharedState<OgnReadPickState>(nodeObj);
state.m_internalState.eventPayloads.setPayload(e->payload);
state.m_setStamp.next();
}
}
);
}
}
static void release(const NodeObj& nodeObj)
{
OgnReadPickState& state = OgnReadPickStateDatabase::sSharedState<OgnReadPickState>(nodeObj);
// Unsubscribe from picking events
if (state.m_internalState.pickingSub.get())
state.m_internalState.pickingSub.detach()->unsubscribe();
}
static bool compute(OgnReadPickStateDatabase& db)
{
OgnReadPickState& sharedState = db.sharedState<OgnReadPickState>();
OgnReadPickState& perInstanceState = db.perInstanceState<OgnReadPickState>();
if(perInstanceState.m_syncStamp.makeSync(sharedState.m_setStamp))
{
// Get the targeted viewport and gesture
char const* const viewportWindowName = db.tokenToString(db.inputs.viewport());
char const* const gestureName = db.tokenToString(db.inputs.gesture());
if (!omni::ui::Workspace::getWindow(viewportWindowName))
{
db.logWarning("Viewport window '%s' not found", viewportWindowName);
}
auto const* eventPayloadValuePtr = sharedState.m_internalState.eventPayloads.getPayloadValue(viewportWindowName, gestureName);
if (eventPayloadValuePtr)
{
// Get the picked path and pos for the targeted viewport and gesture
char const* const pickedPrimPath = eventPayloadValuePtr->pickedPrimPath;
pxr::GfVec3d const& pickedWorldPos = eventPayloadValuePtr->pickedWorldPos;
// Determine if a tracked prim is picked
bool isTrackedPrimPicked;
// First determine if any prim is picked
bool const isAnyPrimPicked = pickedPrimPath && pickedPrimPath[0] != '\0';
if (isAnyPrimPicked)
{
TargetPath pickedPrim = db.stringToPath(pickedPrimPath);
// If any prim is picked, determine if the picked prim is tracked
if (db.inputs.usePaths())
{
// Get the list of tracked prims from the path[] input
auto& trackedPrimPaths = db.inputs.trackedPrimPaths();
// If no tracked prims are specified then we consider all prims to be tracked
// Else search the list of tracked prims for the picked prim
if (trackedPrimPaths.empty())
isTrackedPrimPicked = true;
else
isTrackedPrimPicked = std::any_of(trackedPrimPaths.begin(), trackedPrimPaths.end(),
[&db, pickedPrimPath](NameToken const& path) {
return (std::strcmp(db.tokenToString(path), pickedPrimPath) == 0);
});
}
else
{
// Get the list of tracked prims
const auto& trackedPrims = db.inputs.trackedPrims();
// If no tracked prims are specified then we consider all prims to be tracked
// Else search the list of tracked prims for the picked prim
if (trackedPrims.empty())
isTrackedPrimPicked = true;
else
isTrackedPrimPicked = std::any_of(trackedPrims.begin(), trackedPrims.end(),
[pickedPrim](TargetPath const& trackedPrim) {
return (trackedPrim == pickedPrim);
});
}
db.outputs.pickedPrim().resize(1);
db.outputs.pickedPrim()[0] = pickedPrim;
db.outputs.pickedPrimPath() = db.stringToToken(pickedPrimPath);
}
else
{
// No prim is picked at all, so a tracked prim certainly isn't picked
isTrackedPrimPicked = false;
db.outputs.pickedPrim().resize(0);
db.outputs.pickedPrimPath() = Token();
}
// Set outputs
db.outputs.pickedWorldPos() = pickedWorldPos;
db.outputs.isTrackedPrimPicked() = isTrackedPrimPicked;
db.outputs.isValid() = true;
}
else
{
db.outputs.pickedPrim().resize(0);
db.outputs.pickedPrimPath() = Token();
db.outputs.pickedWorldPos() = {0, 0, 0};
db.outputs.isTrackedPrimPicked() = false;
db.outputs.isValid() = false;
}
}
return true;
}
};
REGISTER_OGN_NODE()
} // ui
} // graph
} // omni
| 7,001 | C++ | 39.473988 | 138 | 0.566633 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnPlacer.py | # Copyright (c) 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 List, Optional
import carb
import omni.graph.core as og
import omni.ui as ui
from . import UINodeCommon
class OgnPlacer(UINodeCommon.OgWidgetNode):
@staticmethod
def compute(db) -> bool:
if db.inputs.create != og.ExecutionAttributeState.DISABLED:
(position_x, position_y) = db.inputs.position
parent_widget_path = db.inputs.parentWidgetPath
if not parent_widget_path:
db.log_error("No parentWidgetPath supplied.")
return False
parent_widget = UINodeCommon.find_widget_among_all_windows(parent_widget_path)
if parent_widget is None:
db.log_error("Could not find parent widget.")
return False
style = {}
try:
style = UINodeCommon.to_ui_style(db.inputs.style)
except SyntaxError as err:
db.log_error(f"'inputs:style': {err.msg}")
return False
widget_identifier = UINodeCommon.get_unique_widget_identifier(db)
with parent_widget:
placer = ui.Placer(offset_x=position_x, offset_y=position_y)
if style:
placer.set_style(style)
OgnPlacer.register_widget(db.abi_context, widget_identifier, placer)
db.outputs.created = og.ExecutionAttributeState.ENABLED
db.outputs.widgetPath = UINodeCommon.find_widget_path(placer)
return True
db.log_warning("Unexpected execution with no execution input enabled")
return False
@staticmethod
def get_property_names(placer: ui.Placer, writeable: bool) -> Optional[List[str]]:
props = super(OgnPlacer, OgnPlacer).get_property_names(placer, writeable)
if props is not None:
if not isinstance(placer, ui.Placer):
carb.log_warn(f"Attempt to retrieve property names from non-placer object '{placer}'.")
return None
props += [
"drag_axis", # ui.Axis
"draggable", # bool
"frames_to_start_drag", # int
"offset_x", # ui.Length
"offset_y", # ui.Length
"stable_size", # bool
]
return props
@staticmethod
def get_property_value(placer: ui.Placer, property_name: str, attribute: og.RuntimeAttribute):
if not isinstance(placer, ui.Placer):
raise og.OmniGraphError(
f"Attempt to get value of property {property_name} on non-placer object '{placer}'."
)
if property_name not in OgnPlacer.get_property_names(placer, False):
raise og.OmniGraphError(f"'{property_name}' is not a readable property of placer '{placer.identifier}'")
super(OgnPlacer, OgnPlacer).get_property_value(placer, property_name, attribute)
@staticmethod
def set_property_value(placer: ui.Placer, property_name: str, attribute: og.RuntimeAttribute):
if not isinstance(placer, ui.Placer):
raise og.OmniGraphError(
f"Attempt to set value of property {property_name} on non-placer object '{placer}'."
)
if property_name not in OgnPlacer.get_property_names(placer, True):
raise og.OmniGraphError(f"'{property_name}' is not a writeable property of placer '{placer.identifier}'")
super(OgnPlacer, OgnPlacer).set_property_value(placer, property_name, attribute)
@staticmethod
def get_style_element_names(placer: ui.Placer, writeable: bool) -> List[str]:
element_names = super(OgnPlacer, OgnPlacer).get_style_element_names(placer, writeable)
if element_names is not None: # noqa: SIM102
if not isinstance(placer, ui.Placer):
carb.log_warn(f"Attempt to retrieve style element names from non-placer widget '{placer}'.")
return None
# TBD
return element_names
@staticmethod
def get_style_value(placer: ui.Placer, element_name: str, attribute: og.RuntimeAttribute) -> bool:
if not isinstance(placer, ui.Placer):
carb.log_warn(f"Attempt to get style element from non-placer object '{placer}'.")
return False
return super(OgnPlacer, OgnPlacer).get_style_value(placer, element_name, attribute)
@staticmethod
def set_style_value(placer: ui.Placer, element_name: str, attribute: og.RuntimeAttribute) -> bool:
if not isinstance(placer, ui.Placer):
carb.log_warn(f"Attempt to set style element on non-placer object '{placer}'.")
return False
return super(OgnPlacer, OgnPlacer).set_style_value(placer, element_name, attribute)
| 5,171 | Python | 41.743801 | 117 | 0.637014 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnVStack.py | # Copyright (c) 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 List, Optional
import carb
import omni.graph.core as og
import omni.ui as ui
from . import UINodeCommon
class OgnVStack(UINodeCommon.OgWidgetNode):
@staticmethod
def compute(db) -> bool:
if db.inputs.create != og.ExecutionAttributeState.DISABLED:
direction = UINodeCommon.to_ui_direction(db.inputs.direction)
if not direction:
db.log_warning("Unexpected direction input")
return False
parent_widget_path = db.inputs.parentWidgetPath
if not parent_widget_path:
db.log_error("No parentWidgetPath supplied.")
return False
parent_widget = UINodeCommon.find_widget_among_all_windows(parent_widget_path)
if parent_widget is None:
db.log_error("Could not find parent widget.")
return False
style = {}
try:
style = UINodeCommon.to_ui_style(db.inputs.style)
except SyntaxError as err:
db.log_error(f"'inputs:style': {err.msg}")
return False
widget_identifier = UINodeCommon.get_unique_widget_identifier(db)
with parent_widget:
stack = ui.Stack(direction, identifier=widget_identifier)
if style:
stack.set_style(style)
OgnVStack.register_widget(db.abi_context, widget_identifier, stack)
db.outputs.created = og.ExecutionAttributeState.ENABLED
db.outputs.widgetPath = UINodeCommon.find_widget_path(stack)
return True
db.log_warning("Unexpected execution with no execution input enabled")
return False
@staticmethod
def get_property_names(stack: ui.Stack, writeable: bool) -> Optional[List[str]]:
props = super(OgnVStack, OgnVStack).get_property_names(stack, writeable)
if props is not None:
if not isinstance(stack, ui.Stack):
carb.log_warn(f"Attempt to retrieve property names from non-stack object '{stack}'.")
return None
props += ["content_clipping", "direction", "spacing"] # bool # str # float
return props
@staticmethod
def resolve_output_property(stack: ui.Stack, property_name: str, attribute: og.Attribute):
if not isinstance(stack, ui.Stack):
raise og.OmniGraphError(f"Attempt to resolve property on non-stack object '{stack}'.")
if property_name not in OgnVStack.get_property_names(stack, False):
raise og.OmniGraphError(f"'{property_name}' is not a readable property of stack '{stack.identifier}'")
super(OgnVStack, OgnVStack).resolve_output_property(stack, property_name, attribute)
@staticmethod
def get_property_value(stack: ui.Stack, property_name: str, attribute: og.RuntimeAttribute):
if not isinstance(stack, ui.Stack):
raise og.OmniGraphError(f"Attempt to get value of property {property_name} on non-stack object '{stack}'.")
if property_name not in OgnVStack.get_property_names(stack, False):
raise og.OmniGraphError(f"'{property_name}' is not a readable property of stack '{stack.identifier}'")
super(OgnVStack, OgnVStack).get_property_value(stack, property_name, attribute)
@staticmethod
def set_property_value(stack: ui.Stack, property_name: str, attribute: og.RuntimeAttribute):
if not isinstance(stack, ui.Stack):
raise og.OmniGraphError(f"Attempt to set value of property {property_name} on non-stack object '{stack}'.")
if property_name not in OgnVStack.get_property_names(stack, True):
raise og.OmniGraphError(f"'{property_name}' is not a writeable property of stack '{stack.identifier}'")
super(OgnVStack, OgnVStack).set_property_value(stack, property_name, attribute)
@staticmethod
def get_style_element_names(stack: ui.Stack, writeable: bool) -> List[str]:
element_names = super(OgnVStack, OgnVStack).get_style_element_names(stack, writeable)
if element_names is not None: # noqa: SIM102
if not isinstance(stack, ui.Stack):
carb.log_warn(f"Attempt to retrieve style element names from non-stack widget '{stack}'.")
return None
# TBD
return element_names
@staticmethod
def get_style_value(stack: ui.Stack, element_name: str, attribute: og.RuntimeAttribute) -> bool:
if not isinstance(stack, ui.Stack):
carb.log_warn(f"Attempt to get style element from non-stack object '{stack}'.")
return False
return super(OgnVStack, OgnVStack).get_style_value(stack, element_name, attribute)
@staticmethod
def set_style_value(stack: ui.Stack, element_name: str, attribute: og.RuntimeAttribute) -> bool:
if not isinstance(stack, ui.Stack):
carb.log_warn(f"Attempt to set style element on non-stack object '{stack}'.")
return False
return super(OgnVStack, OgnVStack).set_style_value(stack, element_name, attribute)
| 5,542 | Python | 44.809917 | 119 | 0.659148 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnButton.py | # Copyright (c) 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 List, Optional
import carb
import omni.graph.core as og
import omni.kit.app
import omni.ui as ui
from . import UINodeCommon
class OgnButton(UINodeCommon.OgWidgetNode):
@staticmethod
def compute(db) -> bool:
if db.inputs.create != og.ExecutionAttributeState.DISABLED:
start_hidden = db.inputs.startHidden
text = db.inputs.text
(size_x, size_y) = db.inputs.size
if size_x < 0 or size_y < 0:
db.log_error("The size of the widget cannot be negative!")
return False
parent_widget_path = db.inputs.parentWidgetPath
if not parent_widget_path:
db.log_error("No parentWidgetPath supplied.")
return False
parent_widget = UINodeCommon.find_widget_among_all_windows(parent_widget_path)
if parent_widget is None:
db.log_error("Could not find parent widget.")
return False
style = {}
try:
style = UINodeCommon.to_ui_style(db.inputs.style)
except SyntaxError as err:
db.log_error(f"'inputs:style': {err.msg}")
return False
widget_identifier = UINodeCommon.get_unique_widget_identifier(db)
def on_button_clicked():
widget = UINodeCommon.get_registered_widget(db.abi_context, widget_identifier)
if not widget or not widget.enabled:
return
message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
event_name = "clicked_" + widget_identifier
reg_event_name = UINodeCommon.registered_event_name(event_name)
message_bus.push(reg_event_name)
# Now create the button widget and register callbacks
with parent_widget:
button = ui.Button(
text, identifier=widget_identifier, width=size_x, height=size_y, visible=not start_hidden
)
button.set_clicked_fn(on_button_clicked)
if style:
button.set_style(style)
OgnButton.register_widget(db.abi_context, widget_identifier, button)
db.outputs.created = og.ExecutionAttributeState.ENABLED
db.outputs.widgetPath = UINodeCommon.find_widget_path(button)
return True
db.log_warning("Unexpected execution with no execution input enabled")
return False
@staticmethod
def get_property_names(button: ui.Button, writeable: bool) -> Optional[List[str]]:
props = super(OgnButton, OgnButton).get_property_names(button, writeable)
if props is not None:
if not isinstance(button, ui.Button):
carb.log_warn(f"Attempt to retrieve property names from non-button object '{button}'.")
return None
props += [
"image_height", # ui.Length
"image_url", # str
"image_width", # ui.Length
"spacing", # float
"text", # str
]
return props
@staticmethod
def resolve_output_property(button: ui.Button, property_name: str, attribute: og.Attribute):
if not isinstance(button, ui.Button):
raise og.OmniGraphError(f"Attempt to resolve property on non-button object '{button}'.")
if property_name not in OgnButton.get_property_names(button, False):
raise og.OmniGraphError(f"'{property_name}' is not a readable property of button '{button.identifier}'")
super(OgnButton, OgnButton).resolve_output_property(button, property_name, attribute)
@staticmethod
def get_property_value(button: ui.Button, property_name: str, attribute: og.RuntimeAttribute):
if not isinstance(button, ui.Button):
raise og.OmniGraphError(
f"Attempt to get value of property {property_name} on non-button object '{button}'."
)
if property_name not in OgnButton.get_property_names(button, False):
raise og.OmniGraphError(f"'{property_name}' is not a readable property of button '{button.identifier}'")
super(OgnButton, OgnButton).get_property_value(button, property_name, attribute)
@staticmethod
def set_property_value(button: ui.Button, property_name: str, attribute: og.RuntimeAttribute):
if not isinstance(button, ui.Button):
raise og.OmniGraphError(
f"Attempt to set value of property {property_name} on non-button object '{button}'."
)
if property_name not in OgnButton.get_property_names(button, True):
raise og.OmniGraphError(f"'{property_name}' is not a writeable property of button '{button.identifier}'")
super(OgnButton, OgnButton).set_property_value(button, property_name, attribute)
@staticmethod
def get_style_element_names(button: ui.Button, writeable: bool) -> List[str]:
element_names = super(OgnButton, OgnButton).get_style_element_names(button, writeable)
if element_names is not None: # noqa: SIM102
if not isinstance(button, ui.Button):
carb.log_warn(f"Attempt to retrieve style element names from non-button widget '{button}'.")
return None
# TBD
return element_names
@staticmethod
def get_style_value(button: ui.Button, element_name: str, attribute: og.RuntimeAttribute) -> bool:
if not isinstance(button, ui.Button):
carb.log_warn(f"Attempt to get style element from non-button object '{button}'.")
return False
return super(OgnButton, OgnButton).get_style_value(button, element_name, attribute)
@staticmethod
def set_style_value(button: ui.Button, element_name: str, attribute: og.RuntimeAttribute) -> bool:
if not isinstance(button, ui.Button):
carb.log_warn(f"Attempt to set style element on non-button object '{button}'.")
return False
return super(OgnButton, OgnButton).set_style_value(button, element_name, attribute)
| 6,600 | Python | 44.212328 | 117 | 0.632576 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/CameraState.h | // Copyright (c) 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.
//
// clang-format off
#include "UsdPCH.h"
// clang-format on
#include <carb/Types.h>
#include <pxr/usd/usdGeom/camera.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class CameraState
{
PXR_NS::UsdGeomCamera m_camera;
const PXR_NS::UsdTimeCode m_timeCode;
public:
CameraState(PXR_NS::UsdGeomCamera camera, const PXR_NS::UsdTimeCode* time = nullptr);
~CameraState() = default;
void getCameraPosition(carb::Double3& position) const;
void getCameraTarget(carb::Double3& target) const;
bool setCameraPosition(const carb::Double3& position, bool rotate);
bool setCameraTarget(const carb::Double3& target, bool rotate);
};
}
}
}
| 1,106 | C | 25.357142 | 89 | 0.748644 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnGetCameraTarget.cpp | // Copyright (c) 2021-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.
//
// clang-format off
#include "UsdPCH.h"
// clang-format on
#include <OgnGetCameraTargetDatabase.h>
#include "CameraState.h"
#include "NodeUtils.h"
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnGetCameraTarget
{
public:
static bool compute(OgnGetCameraTargetDatabase& db)
{
PXR_NS::UsdPrim prim = getPrimFromPathOrRelationship(db, OgnGetCameraTargetAttributes::inputs::prim.m_token);
if (!prim)
return false;
auto camera = PXR_NS::UsdGeomCamera(prim);
if (!camera)
return true;
CameraState cameraState(std::move(camera));
carb::Double3 target;
cameraState.getCameraTarget(target);
carb::Double3& targetAttrib = reinterpret_cast<carb::Double3&>(db.outputs.target());
targetAttrib = target;
return true;
}
};
REGISTER_OGN_NODE()
}
}
}
| 1,318 | C++ | 22.981818 | 117 | 0.703338 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnGetViewportRenderer.py | # Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
from omni.kit.viewport.utility import get_viewport_from_window_name
class OgnGetViewportRenderer:
"""
Gets the renderer being used by the specified viewport.
"""
@staticmethod
def compute(db) -> bool:
"""Compute the outputs from the current input"""
try:
viewport = db.inputs.viewport
viewport_api = get_viewport_from_window_name(viewport)
renderer = ""
if viewport_api is not None:
engine_name = viewport_api.hydra_engine
render_mode = viewport_api.render_mode
if engine_name == "rtx":
if render_mode == "RaytracedLighting":
renderer = "RTX: Realtime"
elif render_mode == "PathTracing":
renderer = "RTX: Path Tracing"
elif engine_name == "iray":
if render_mode == "iray":
renderer = "RTX: Iray"
elif engine_name == "pxr":
renderer = "Pixar Storm"
if renderer == "":
db.log_error(f"Unknown Hydra engine '{engine_name}' and render mode '{render_mode}'")
else:
db.log_error(f"Unknown viewport window '{viewport}'")
db.outputs.renderer = renderer
except Exception as error: # noqa: PLW0703
db.log_error(str(error))
return False
return True
| 1,910 | Python | 33.745454 | 105 | 0.581675 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportClickManipulator.py | # Copyright (c) 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.
#
__all__ = ["ViewportClickManipulatorFactory"]
from typing import Any
import carb
import omni.kit.app
import omni.kit.commands
from omni.ui import scene as sc
EVENT_NAME = "omni.graph.viewport.click"
GESTURE_NAMES = ["Left Mouse Click", "Right Mouse Click", "Middle Mouse Click"]
class DoNotPrevent(sc.GestureManager):
def can_be_prevented(self, gesture):
return False
class ViewportClickGesture(sc.ClickGesture):
def __init__(self, viewport_api: Any, viewport_window_name: str, mouse_button: int):
super().__init__(mouse_button=mouse_button, manager=DoNotPrevent())
self._viewport_api = viewport_api
self._viewport_window_name = viewport_window_name
self._gesture_name = GESTURE_NAMES[mouse_button]
self._event_type = carb.events.type_from_string(EVENT_NAME)
self._message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
def on_ended(self, *args):
if self.state == sc.GestureState.CANCELED:
return
mouse = self.sender.gesture_payload.mouse
resolution = self._viewport_api.resolution
# Position in normalized coords
pos_norm = self._viewport_api.map_ndc_to_texture(mouse)[0]
pos_norm = (pos_norm[0], 1.0 - pos_norm[1])
if not all(0.0 <= x <= 1.0 for x in pos_norm):
return
# Position in viewport resolution pixels
pos_pixel = (pos_norm[0] * resolution[0], pos_norm[1] * resolution[1])
payload = {
"viewport": self._viewport_window_name,
"gesture": self._gesture_name,
"pos_norm_x": pos_norm[0],
"pos_norm_y": pos_norm[1],
"pos_pixel_x": pos_pixel[0],
"pos_pixel_y": pos_pixel[1],
}
self._message_bus.push(self._event_type, payload=payload)
class ViewportClickManipulator(sc.Manipulator):
def __init__(self, viewport_api: Any, viewport_window_name: str, *args, **kwargs):
super().__init__(*args, **kwargs)
self._gestures = [
ViewportClickGesture(viewport_api, viewport_window_name, 0), # left mouse click
ViewportClickGesture(viewport_api, viewport_window_name, 1), # right mouse click
ViewportClickGesture(viewport_api, viewport_window_name, 2), # middle mouse click
]
self._screen = None
self._transform = None
self.name = None
self.categories = ()
def on_build(self):
self._transform = sc.Transform()
with self._transform:
self._screen = sc.Screen(gesture=self._gestures)
def destroy(self):
self._gestures = []
self._screen = None
if self._transform:
self._transform.clear()
self._transform = None
# Factory creator
def ViewportClickManipulatorFactory(desc: dict) -> ViewportClickManipulator: # noqa: N802
manip = ViewportClickManipulator(desc.get("viewport_api"), desc.get("viewport_window_name"))
manip.categories = ()
manip.name = f"ViewportClickManipulator.{desc.get('viewport_window_name')}"
return manip
| 3,531 | Python | 35.412371 | 96 | 0.650241 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnOnViewportDragged.cpp | // Copyright (c) 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.
//
#include <OgnOnViewportDraggedDatabase.h>
#include "ViewportDragNodeCommon.h"
#include <omni/kit/IApp.h>
#include <omni/ui/Workspace.h>
namespace omni
{
namespace graph
{
namespace ui_nodes
{
class OgnOnViewportDragged
{
public:
struct InternalState
{
carb::events::ISubscriptionPtr dragBeganSub;
carb::events::ISubscriptionPtr dragChangedSub;
carb::events::ISubscriptionPtr dragEndedSub;
ViewportDragEventPayloads eventPayloads;
ViewportDragEventStates eventStates;
} m_internalState;
exec::unstable::Stamp m_setStamp; // stamp set when the event occurs
exec::unstable::SyncStamp m_syncStamp; // stamp set by each instance
static void initialize(GraphContextObj const&, NodeObj const& nodeObj)
{
OgnOnViewportDragged& state =
OgnOnViewportDraggedDatabase::sSharedState<OgnOnViewportDragged>(nodeObj);
// Subscribe to drag events
if (omni::kit::IApp* app = carb::getCachedInterface<omni::kit::IApp>())
{
state.m_internalState.dragBeganSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kDragBeganEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnOnViewportDragged& state =
OgnOnViewportDraggedDatabase::sSharedState<OgnOnViewportDragged>(nodeObj);
state.m_internalState.eventPayloads.clear(); // clear prev payloads when we have a new drag
state.m_internalState.eventPayloads.setDragBeganPayload(e->payload);
state.m_setStamp.next();
if (nodeObj.iNode->isValid(nodeObj))
nodeObj.iNode->requestCompute(nodeObj);
}
}
);
state.m_internalState.dragChangedSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kDragChangedEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnOnViewportDragged& state =
OgnOnViewportDraggedDatabase::sSharedState<OgnOnViewportDragged>(nodeObj);
state.m_internalState.eventPayloads.setDragChangedPayload(e->payload);
}
}
);
state.m_internalState.dragEndedSub = carb::events::createSubscriptionToPushByType(
app->getMessageBusEventStream(),
kDragEndedEventType,
[nodeObj](carb::events::IEvent* e)
{
if (e)
{
OgnOnViewportDragged& state =
OgnOnViewportDraggedDatabase::sSharedState<OgnOnViewportDragged>(nodeObj);
state.m_internalState.eventPayloads.setDragEndedPayload(e->payload);
state.m_setStamp.next();
if (nodeObj.iNode->isValid(nodeObj))
nodeObj.iNode->requestCompute(nodeObj);
}
}
);
}
}
static void release(const NodeObj& nodeObj)
{
OgnOnViewportDragged& state =
OgnOnViewportDraggedDatabase::sSharedState<OgnOnViewportDragged>(nodeObj);
// Unsubscribe from drag events
if (state.m_internalState.dragBeganSub.get())
state.m_internalState.dragBeganSub.detach()->unsubscribe();
if (state.m_internalState.dragChangedSub.get())
state.m_internalState.dragChangedSub.detach()->unsubscribe();
if (state.m_internalState.dragEndedSub.get())
state.m_internalState.dragEndedSub.detach()->unsubscribe();
}
static bool compute(OgnOnViewportDraggedDatabase& db)
{
if (checkNodeDisabledForOnlyPlay(db))
return true;
OgnOnViewportDragged& sharedState = db.sharedState<OgnOnViewportDragged>();
OgnOnViewportDragged& perInstanceState = db.perInstanceState<OgnOnViewportDragged>();
if( perInstanceState.m_syncStamp.makeSync(sharedState.m_setStamp))
{
if (sharedState.m_internalState.eventPayloads.empty())
return true;
// Get the targeted viewport and gesture
char const* const viewportWindowName = db.tokenToString(db.inputs.viewport());
char const* const gestureName = db.tokenToString(db.inputs.gesture());
if (!omni::ui::Workspace::getWindow(viewportWindowName))
{
db.logWarning("Viewport window '%s' not found", viewportWindowName);
}
// Process event payloads and update event state
bool dragBegan = false;
for (auto const& dragBeganPayload : sharedState.m_internalState.eventPayloads.dragBeganPayloads())
{
if (!dragBeganPayload.second.isValid)
continue;
auto& eventStateValue = sharedState.m_internalState.eventStates[dragBeganPayload.first];
eventStateValue.isDragInProgress = true;
eventStateValue.initialPositionNorm = dragBeganPayload.second.initialPositionNorm;
eventStateValue.initialPositionPixel = dragBeganPayload.second.initialPositionPixel;
eventStateValue.currentPositionNorm = dragBeganPayload.second.currentPositionNorm;
eventStateValue.currentPositionPixel = dragBeganPayload.second.currentPositionPixel;
if (std::strcmp(viewportWindowName, dragBeganPayload.first.viewportWindowName) == 0
&& std::strcmp(gestureName, dragBeganPayload.first.gestureName) == 0)
{
dragBegan = true;
}
}
for (auto const& dragChangedPayload : sharedState.m_internalState.eventPayloads.dragChangedPayloads())
{
if (!dragChangedPayload.second.isValid)
continue;
auto& eventStateValue = sharedState.m_internalState.eventStates[dragChangedPayload.first];
if (eventStateValue.isDragInProgress)
{
eventStateValue.currentPositionNorm = dragChangedPayload.second.currentPositionNorm;
eventStateValue.currentPositionPixel = dragChangedPayload.second.currentPositionPixel;
}
}
bool dragEnded = false;
for (auto const& dragEndedPayload : sharedState.m_internalState.eventPayloads.dragEndedPayloads())
{
if (!dragEndedPayload.second.isValid)
continue;
auto& eventStateValue = sharedState.m_internalState.eventStates[dragEndedPayload.first];
if (eventStateValue.isDragInProgress)
{
eventStateValue.isDragInProgress = false;
if (std::strcmp(viewportWindowName, dragEndedPayload.first.viewportWindowName) == 0
&& std::strcmp(gestureName, dragEndedPayload.first.gestureName) == 0)
{
dragEnded = true;
}
}
}
// Get event state and set outputs
auto it = sharedState.m_internalState.eventStates.find({viewportWindowName, gestureName});
if (it != sharedState.m_internalState.eventStates.end())
{
if (dragEnded)
{
db.outputs.began() = kExecutionAttributeStateDisabled;
db.outputs.ended() = kExecutionAttributeStateEnabled;
db.outputs.initialPosition() = db.inputs.useNormalizedCoords() ? it->second.initialPositionNorm : it->second.initialPositionPixel;
db.outputs.finalPosition() = db.inputs.useNormalizedCoords() ? it->second.currentPositionNorm : it->second.currentPositionPixel;
}
else if (dragBegan)
{
db.outputs.began() = kExecutionAttributeStateEnabled;
db.outputs.ended() = kExecutionAttributeStateDisabled;
db.outputs.initialPosition() = db.inputs.useNormalizedCoords() ? it->second.initialPositionNorm : it->second.initialPositionPixel;
db.outputs.finalPosition() = {0.0, 0.0};
}
else
{
db.outputs.began() = kExecutionAttributeStateDisabled;
db.outputs.ended() = kExecutionAttributeStateDisabled;
}
}
}
return true;
}
};
REGISTER_OGN_NODE()
} // ui
} // graph
} // omni
| 9,383 | C++ | 41.080717 | 150 | 0.592561 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportHoverManipulator.py | # Copyright (c) 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.
#
__all__ = ["ViewportHoverManipulatorFactory"]
from typing import Any
import carb
import omni.kit.app
import omni.kit.commands
from omni.ui import scene as sc
EVENT_NAME_BEGAN = "omni.graph.viewport.hover.began"
EVENT_NAME_CHANGED = "omni.graph.viewport.hover.changed"
EVENT_NAME_ENDED = "omni.graph.viewport.hover.ended"
class DoNotPrevent(sc.GestureManager):
def can_be_prevented(self, gesture):
return False
class ViewportHoverGesture(sc.HoverGesture):
def __init__(self, viewport_api: Any, viewport_window_name: str):
super().__init__(manager=DoNotPrevent())
self._viewport_api = viewport_api
self._viewport_window_name = viewport_window_name
self._event_type_began = carb.events.type_from_string(EVENT_NAME_BEGAN)
self._event_type_changed = carb.events.type_from_string(EVENT_NAME_CHANGED)
self._event_type_ended = carb.events.type_from_string(EVENT_NAME_ENDED)
self._message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
self._viewport_hovered = False
def on_began(self):
self._viewport_hovered = False
def on_changed(self):
mouse = self.sender.gesture_payload.mouse
pos_norm = self._viewport_api.map_ndc_to_texture(mouse)[0]
pos_norm = (pos_norm[0], 1.0 - pos_norm[1])
viewport_hovered = all(0.0 <= x <= 1.0 for x in pos_norm)
if not self._viewport_hovered and viewport_hovered:
# hover began
resolution = self._viewport_api.resolution
pos_pixel = (pos_norm[0] * resolution[0], pos_norm[1] * resolution[1])
payload = {
"viewport": self._viewport_window_name,
"pos_norm_x": pos_norm[0],
"pos_norm_y": pos_norm[1],
"pos_pixel_x": pos_pixel[0],
"pos_pixel_y": pos_pixel[1],
}
self._message_bus.push(self._event_type_began, payload=payload)
elif self._viewport_hovered and viewport_hovered:
# hover changed
resolution = self._viewport_api.resolution
pos_pixel = (pos_norm[0] * resolution[0], pos_norm[1] * resolution[1])
mouse_moved = self.sender.gesture_payload.mouse_moved
vel_norm = self._viewport_api.map_ndc_to_texture(mouse_moved)[0]
origin_norm = self._viewport_api.map_ndc_to_texture((0, 0))[0]
vel_norm = (vel_norm[0] - origin_norm[0], origin_norm[1] - vel_norm[1])
vel_pixel = (vel_norm[0] * resolution[0], vel_norm[1] * resolution[1])
payload = {
"viewport": self._viewport_window_name,
"pos_norm_x": pos_norm[0],
"pos_norm_y": pos_norm[1],
"pos_pixel_x": pos_pixel[0],
"pos_pixel_y": pos_pixel[1],
"vel_norm_x": vel_norm[0],
"vel_norm_y": vel_norm[1],
"vel_pixel_x": vel_pixel[0],
"vel_pixel_y": vel_pixel[1],
}
self._message_bus.push(self._event_type_changed, payload=payload)
elif self._viewport_hovered and not viewport_hovered:
# hover ended
payload = {
"viewport": self._viewport_window_name,
}
self._message_bus.push(self._event_type_ended, payload=payload)
self._viewport_hovered = viewport_hovered
def on_ended(self):
if self._viewport_hovered:
# hover ended
payload = {
"viewport": self._viewport_window_name,
}
self._message_bus.push(self._event_type_ended, payload=payload)
self._viewport_hovered = False
# Custom manipulator containing a Screen that contains the gestures
class ViewportHoverManipulator(sc.Manipulator):
def __init__(self, viewport_api: Any, viewport_window_name: str, *args, **kwargs):
super().__init__(*args, **kwargs)
self._gestures = [ViewportHoverGesture(viewport_api, viewport_window_name)]
self._screen = None
self._transform = None
self.name = None
self.categories = ()
def on_build(self):
self._transform = sc.Transform()
with self._transform:
self._screen = sc.Screen(gesture=self._gestures)
def destroy(self):
self._gestures = []
self._screen = None
if self._transform:
self._transform.clear()
self._transform = None
# Factory creator
def ViewportHoverManipulatorFactory(desc: dict) -> ViewportHoverManipulator: # noqa: N802
manip = ViewportHoverManipulator(desc.get("viewport_api"), desc.get("viewport_window_name"))
manip.categories = ()
manip.name = f"ViewportHoverManipulator.{desc.get('viewport_window_name')}"
return manip
| 5,243 | Python | 37.277372 | 96 | 0.613008 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/OgnReadWindowSize.py | # Copyright (c) 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.
#
import omni.ui as ui
from . import UINodeCommon
class OgnReadWindowSize:
@staticmethod
def compute(db) -> bool:
db.outputs.height = 0.0
db.outputs.width = 0.0
if db.inputs.isViewport:
try:
from omni.kit.viewport.window import get_viewport_window_instances
vp_wins = [win for win in get_viewport_window_instances(None) if isinstance(win, ui.Window)]
except ImportError:
db.log_error("No non-legacy viewports found.")
return False
widget_path = db.inputs.widgetPath
if not widget_path:
window_name = db.inputs.name
if not window_name:
db.log_warning("No window name or widgetPath provided.")
return True
if db.inputs.isViewport:
for window in vp_wins:
if window.title == window_name:
db.outputs.height = window.height
db.outputs.width = window.width
return True
db.log_error(f"No viewport named '{window_name}' found.")
return False
for window in ui.Workspace.get_windows():
if isinstance(window, ui.Window) and window.title == window_name:
db.outputs.height = window.height
db.outputs.width = window.width
return True
db.log_error(f"No window named '{window_name}' found.")
return False
window = UINodeCommon.get_widget_window(widget_path)
if not window:
db.log_error(f"No widget found at path '{widget_path}'.")
return False
if db.inputs.isViewport and window not in vp_wins:
db.log_error(f"Widget '{widget_path} is not in a viewport window.")
return False
db.outputs.height = window.height
db.outputs.width = window.width
return True
| 2,426 | Python | 35.772727 | 108 | 0.597279 |
omniverse-code/kit/exts/omni.graph.ui_nodes/omni/graph/ui_nodes/ogn/nodes/ViewportDragNodeCommon.h | // Copyright (c) 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.
//
#include "UINodeCommon.h"
namespace omni
{
namespace graph
{
namespace ui_nodes
{
constexpr carb::events::EventType kDragBeganEventType = CARB_EVENTS_TYPE_FROM_STR("omni.graph.viewport.drag.began");
constexpr carb::events::EventType kDragChangedEventType = CARB_EVENTS_TYPE_FROM_STR("omni.graph.viewport.drag.changed");
constexpr carb::events::EventType kDragEndedEventType = CARB_EVENTS_TYPE_FROM_STR("omni.graph.viewport.drag.ended");
class ViewportDragEventPayloads
{
public:
struct Key
{
char const* viewportWindowName;
char const* gestureName;
bool operator<(Key const& other) const
{
int const ret = std::strcmp(viewportWindowName, other.viewportWindowName);
if (ret < 0)
return true;
else if (ret <= 0)
return std::strcmp(gestureName, other.gestureName) < 0;
return false;
}
};
struct DragBeganValue
{
pxr::GfVec2d initialPositionNorm;
pxr::GfVec2d initialPositionPixel;
pxr::GfVec2d currentPositionNorm;
pxr::GfVec2d currentPositionPixel;
pxr::GfVec2d velocityNorm;
pxr::GfVec2d velocityPixel;
bool isValid;
};
struct DragChangedValue
{
pxr::GfVec2d currentPositionNorm;
pxr::GfVec2d currentPositionPixel;
pxr::GfVec2d velocityNorm;
pxr::GfVec2d velocityPixel;
bool isValid;
};
struct DragEndedValue
{
bool isValid;
};
// Store a drag began event payload
void setDragBeganPayload(carb::dictionary::Item* payload)
{
auto idict = carb::dictionary::getCachedDictionaryInterface();
Key key {
stringMemo.lookup(idict->get<char const*>(payload, "viewport")),
stringMemo.lookup(idict->get<char const*>(payload, "gesture"))
};
dragBeganPayloadMap[key] = DragBeganValue {
pxr::GfVec2d {
idict->get<double>(payload, "start_pos_norm_x"),
idict->get<double>(payload, "start_pos_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "start_pos_pixel_x"),
idict->get<double>(payload, "start_pos_pixel_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "pos_norm_x"),
idict->get<double>(payload, "pos_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "pos_pixel_x"),
idict->get<double>(payload, "pos_pixel_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "vel_norm_x"),
idict->get<double>(payload, "vel_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "vel_pixel_x"),
idict->get<double>(payload, "vel_pixel_y")
},
true
};
}
// Store a drag changed event payload
void setDragChangedPayload(carb::dictionary::Item* payload)
{
auto idict = carb::dictionary::getCachedDictionaryInterface();
Key key {
stringMemo.lookup(idict->get<char const*>(payload, "viewport")),
stringMemo.lookup(idict->get<char const*>(payload, "gesture"))
};
dragChangedPayloadMap[key] = DragChangedValue {
pxr::GfVec2d {
idict->get<double>(payload, "pos_norm_x"),
idict->get<double>(payload, "pos_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "pos_pixel_x"),
idict->get<double>(payload, "pos_pixel_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "vel_norm_x"),
idict->get<double>(payload, "vel_norm_y")
},
pxr::GfVec2d {
idict->get<double>(payload, "vel_pixel_x"),
idict->get<double>(payload, "vel_pixel_y")
},
true
};
}
// Store a drag ended event payload
void setDragEndedPayload(carb::dictionary::Item* payload)
{
auto idict = carb::dictionary::getCachedDictionaryInterface();
Key key {
stringMemo.lookup(idict->get<char const*>(payload, "viewport")),
stringMemo.lookup(idict->get<char const*>(payload, "gesture"))
};
dragEndedPayloadMap[key] = DragEndedValue {true};
}
// Invalidate all stored payloads
void clear()
{
for (auto& p : dragBeganPayloadMap)
{
p.second.isValid = false;
}
for (auto& p : dragChangedPayloadMap)
{
p.second.isValid = false;
}
for (auto& p : dragEndedPayloadMap)
{
p.second.isValid = false;
}
}
bool empty()
{
if (std::any_of(dragBeganPayloadMap.begin(), dragBeganPayloadMap.end(),
[](auto const& p) {
return p.second.isValid;
}))
{
return false;
}
if (std::any_of(dragChangedPayloadMap.begin(), dragChangedPayloadMap.end(),
[](auto const& p) {
return p.second.isValid;
}))
{
return false;
}
if (std::any_of(dragEndedPayloadMap.begin(), dragEndedPayloadMap.end(),
[](auto const& p) {
return p.second.isValid;
}))
{
return false;
}
return true;
}
std::map<Key, DragBeganValue> const& dragBeganPayloads()
{
return dragBeganPayloadMap;
}
std::map<Key, DragChangedValue> const& dragChangedPayloads()
{
return dragChangedPayloadMap;
}
std::map<Key, DragEndedValue> const& dragEndedPayloads()
{
return dragEndedPayloadMap;
}
private:
std::map<Key, DragBeganValue> dragBeganPayloadMap;
std::map<Key, DragChangedValue> dragChangedPayloadMap;
std::map<Key, DragEndedValue> dragEndedPayloadMap;
StringMemo stringMemo;
};
using ViewportDragEventStateKey = ViewportDragEventPayloads::Key;
struct ViewportDragEventStateValue
{
bool isDragInProgress = false;
pxr::GfVec2d initialPositionNorm = {0.0, 0.0};
pxr::GfVec2d initialPositionPixel = {0.0, 0.0};
pxr::GfVec2d currentPositionNorm = {0.0, 0.0};
pxr::GfVec2d currentPositionPixel = {0.0, 0.0};
pxr::GfVec2d velocityNorm = {0.0, 0.0};
pxr::GfVec2d velocityPixel = {0.0, 0.0};
};
using ViewportDragEventStates = std::map<ViewportDragEventStateKey, ViewportDragEventStateValue>;
}
}
}
| 7,067 | C | 29.465517 | 120 | 0.578888 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.