REMIX-4798, REMIX-4766: Add more helpful node/port tooltips for Remix Logic Graph Editor

Author: nxkb

CHANGELOG.md

@@ -42,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - REMIX-4715: Make "Edit Graph" dialog a bit easier to use
 - Centralized prim type icon mappings in omni.flux.utils.common for reuse across extensions
 - Update hdremix and omni_core_materials to ext-a9cbe4d-main
+- REMIX-4798: Logic Graph Editor: Improved node + port tooltips and added documentation links
 
 ### Fixed
 - Improved Pyright configuration by generating a list of search paths
@@ -52,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed code formatting and lint errors across multiple extensions
 - REMIX-4593: Fixed logic graph and particle properties panel not preserving expansion state across refreshes
 - Improved a few UX issues with the Logic Properties pane
+- REMIX-4766: Added input validation to ensure a valid graph prim name is provided for new graphs
 
 ### Removed
 - Removed Waypoint support based on deprecated kit sample waypoint extension

docs/howto/learning-logic.md

@@ -0,0 +1,19 @@
+# Creating Remix Logic Graphs
+
+```{warning}
+This documentation is a work in progress.
+```
+
+## Overview
+
+Remix Logic introduces a powerful paradigm to introduce a new layer of control for remix mods.
+
+Once basic asset replacements have been done, Modders often want to make the replacement content react to the state of the game. The Remix Logic system provides a flexible way to sense what's happening in the game, make decisions based on that information, and then apply visual changes accordingly. This unlocks a whole new layer of dynamic visuals.
+
+```{seealso}
+See also the [Remix Logic Component Documentation](https://github.com/NVIDIAGameWorks/dxvk-remix/blob/main/documentation/RemixLogic.md) in the DXVK Remix repository.
+```
+
+***
+
+<sub>Need to leave feedback about the RTX Remix Documentation?  [Click here](https://github.com/NVIDIAGameWorks/rtx-remix/issues/new?assignees=nvdamien&labels=documentation%2Cfeedback%2Ctriage&projects=&template=documentation_feedback.yml&title=%5BDocumentation+feedback%5D%3A+) </sub>

index.md

@@ -46,6 +46,7 @@ docs/howto/learning-assets
 docs/howto/learning-materials
 docs/howto/learning-lighting
 docs/howto/learning-particles
+docs/howto/learning-logic
 docs/howto/learning-packaging
 docs/howto/learning-aitexturetools
 docs/howto/learning-restapi

source/extensions/lightspeed.common/config/extension.toml

@@ -1,6 +1,6 @@
 [package]
 # Semantic Versioning is used: https://semver.org/
-version = "1.13.0"
+version = "1.14.0"
 
 # Lists people or organizations that are considered the "authors" of the package.
 authors = ["Alexander Jaus <[email protected]>"]

source/extensions/lightspeed.common/docs/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.14.0]
+### Added
+- Added documentation URL constants for logic graphs and dxvk-remix
+
 ## [1.13.0]
 ### Added
 - Added constants for logic graph creation and editing

source/extensions/lightspeed.common/lightspeed/common/constants.py

@@ -282,6 +282,7 @@
 DOCUMENTATION_URL = "https://docs.omniverse.nvidia.com/kit/docs/rtx_remix/latest/"
 DOCUMENTATION_ROOT_URL = f"{DOCUMENTATION_URL}docs/"
 QUICK_START_GUIDE_URL = f"{DOCUMENTATION_ROOT_URL}gettingstarted/learning-toolkitsetup.html"
+LOGIC_DOCUMENTATION_URL = f"{DOCUMENTATION_ROOT_URL}howto/learning-logic.html"
 RELEASE_NOTES_URL = f"{DOCUMENTATION_ROOT_URL}remix-releasenotes.html"
 
 TUTORIALS_URL = f"{DOCUMENTATION_ROOT_URL}tutorials/tutorial-videos.html"
@@ -290,6 +291,8 @@
 )
 GITHUB_URL = "https://github.com/NVIDIAGameWorks/rtx-remix/"
 REPORT_ISSUE_URL = "https://github.com/NVIDIAGameWorks/rtx-remix/issues"
+DXVK_REMIX_GITHUB_URL = "https://github.com/NVIDIAGameWorks/dxvk-remix/"
+DXVK_REMIX_DOCUMENTATION_URL = f"{DXVK_REMIX_GITHUB_URL}blob/main/documentation"
 
 REMIX_CATEGORIES = {
     "World UI": {

source/extensions/lightspeed.trex.logic.widget/config/extension.toml

@@ -1,7 +1,7 @@
 [package]
 title = "Remix Logic Graph Editor"
 description = "Component editor window for Remix Component Graphs"
-version = "1.2.0"
+version = "1.3.0"
 authors = ["Chris Grebeldinger <[email protected]>", "Dean Edmonds <[email protected]>", "Nicolas Kendall-Bar <[email protected]>"]
 repository = "https://gitlab-master.nvidia.com/lightspeedrtx/lightspeed-kit/-/tree/main/source/extensions/lightspeed.trex.logic.widget"
 keywords = ["graph", "logic", "component", "remix", "ui"]

source/extensions/lightspeed.trex.logic.widget/docs/CHANGELOG.md

@@ -4,6 +4,16 @@ This document records all notable changes to the **lightspeed.trex.logic.widget*
 
 The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org).
 
+## [1.3.0]
+### Added
+- Added node type descriptions in tooltips when hovering over nodes
+- Added port type info for union/any attributes showing valid connection types
+- Added custom documentation routing for Remix nodes to dxvk-remix docs
+
+### Changed
+- Improved graph name input with validation for valid USD prim identifiers
+- Help button now links to Remix logic documentation
+
 ## [1.2.0]
 ### Added
 - Added missing (select all, select none, and delete selection) actions & hotkeys to the Logic Graph widget

source/extensions/lightspeed.trex.logic.widget/lightspeed/trex/logic/widget/extension.py

@@ -20,6 +20,7 @@
 __all__ = ["RemixLogicGraphExtension"]
 
 import asyncio
+import webbrowser
 from contextlib import suppress
 from functools import lru_cache, partial
 from typing import List
@@ -28,10 +29,12 @@
 import omni.appwindow
 import omni.ext
 import omni.graph.core as og
+import omni.graph.window.core.graph_delegate as graph_delegate
+import omni.graph.window.core.graph_operations as graph_operations
 import omni.kit.app
 import omni.kit.notification_manager as nm
 import omni.ui as ui
-from lightspeed.common.constants import GlobalEventNames, WindowNames
+from lightspeed.common.constants import DXVK_REMIX_DOCUMENTATION_URL, GlobalEventNames, WindowNames
 from lightspeed.events_manager import get_instance as _get_event_manager_instance
 from omni.graph.window.core import OmniGraphCatalogTreeDelegate, graph_config, register_stage_graph_opener
 from pxr import Sdf, Usd
@@ -43,6 +46,7 @@
 from .workspace import RemixLogicGraphWorkspaceWindow
 
 _extension_instance = None
+_original_show_help_for_node_type = None
 
 
 @lru_cache
@@ -56,6 +60,31 @@ def get_instance() -> RemixLogicGraphExtension:
     return _extension_instance
 
 
+def _remix_show_help_for_node_type(node_type: str | og.NodeType):
+    """Custom help function that handles Remix nodes with custom documentation."""
+
+    if isinstance(node_type, str):
+        node_type_name = node_type
+    elif isinstance(node_type, og.NodeType):
+        node_type_name = node_type.get_node_type()
+    else:
+        return
+
+    # Check if it's a Remix/lightspeed node
+    if node_type_name.startswith("lightspeed."):
+        # Construct docs URL based on the node type for Remix nodes
+        if node_type_name.startswith("lightspeed.trex.logic."):
+            component_name = node_type_name.split(".")[-1]
+            doc_url = f"{DXVK_REMIX_DOCUMENTATION_URL}/components/{component_name}.md"
+        else:
+            doc_url = f"{DXVK_REMIX_DOCUMENTATION_URL}/components"
+        webbrowser.open(doc_url)
+    else:
+        # Fall back to original behavior for non-Remix nodes
+        if _original_show_help_for_node_type:
+            _original_show_help_for_node_type(node_type)
+
+
 class RemixLogicGraphExtension(omni.ext.IExt):
     """The entry point for the extension"""
 
@@ -117,6 +146,12 @@ def on_startup(self, ext_id: str):
             self.on_load_existing_graph_action,
         )
 
+        # Monkey patch show_help_for_node_type to handle Remix nodes
+        global _original_show_help_for_node_type
+        _original_show_help_for_node_type = graph_operations.show_help_for_node_type
+        graph_operations.show_help_for_node_type = _remix_show_help_for_node_type
+        graph_delegate.show_help_for_node_type = _remix_show_help_for_node_type
+
     def on_shutdown(self):
         global _extension_instance
         _extension_instance = None
@@ -145,6 +180,13 @@ def on_shutdown(self):
         self._create_graph_sub = None
         self._edit_graph_sub = None
 
+        # Restore original show_help_for_node_type
+        global _original_show_help_for_node_type
+        if _original_show_help_for_node_type is not None:
+            graph_operations.show_help_for_node_type = _original_show_help_for_node_type
+            graph_delegate.show_help_for_node_type = _original_show_help_for_node_type
+            _original_show_help_for_node_type = None
+
     def show_window(self, value: bool):
         """Show/hide the window"""
         if value:

source/extensions/lightspeed.trex.logic.widget/lightspeed/trex/logic/widget/graph_model.py

@@ -16,10 +16,37 @@
 """
 
 import carb.settings
+import omni.graph.core as og
 from omni.graph.window.core import OmniGraphModel
+from pxr import Sdf
 
 
 class RemixLogicGraphModel(OmniGraphModel):
+
     def cull_legacy_prims(self):
         """Return True if the OgnPrim nodes should not be created in the graph"""
         return not carb.settings.get_settings().get("/persistent/omnigraph/createPrimNodes")
+
+    def get_port_type(self, path: Sdf.Path) -> str | None:
+        """Returns the description of the port's attribute type, or None if there is a problem"""
+        # Get the parent's result first
+        result = super().get_port_type(path)
+
+        # If it's an unresolved union, provide more details
+        attr: og.Attribute | None = self.get_attribute_from_path(path)
+        if attr is not None:
+            extended_type = attr.get_extended_type()
+            if extended_type == og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION:
+                union_types: list[str] = attr.get_union_types()  # type: ignore
+                # A little bit sneaky here but we use the opening/closing parenthesis from port_tooltip_text
+                if union_types:
+                    return (
+                        f"Flexible type)\n\t"
+                        f"Connect a port to specify type.\n\t(Valid types: {', '.join(union_types)}"
+                    )
+                return "Flexible type)\n\tConnect a port to specify type. \n\t(Could not determine valid types."
+
+            if extended_type == og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY:
+                return "Flexible type)\n\tConnect a port to specify type.\n\t(Valid types: Any"
+
+        return result