Merge branch 'OGN-schema-fix' into 'main'

MarkEHenderson · MarkEHenderson · commit 37b6daf9a75f · 2025-10-08T12:30:06.000-07:00
Fix component schemas and docs for toolkit usage

See merge request lightspeedrtx/dxvk-remix-nv!1728
diff --git a/src/dxvk/rtx_render/graph/rtx_graph_ogn_writer.cpp b/src/dxvk/rtx_render/graph/rtx_graph_ogn_writer.cpp
@@ -114,29 +114,34 @@ void writePropertyToOGN(std::ofstream& outputFile, const RtComponentPropertySpec
   if (!prop.enumValues.empty()) {
     // For enum documentation, we need to combine everything into the property docstring.
     outputFile << "        \"description\": [\"" << escapeJsonString(prop.docString) << "\\n" << "Allowed values: ";
+    std::string defaultEnumValueString = "";
     for (const auto& enumValue : prop.enumValues) { 
       outputFile << " - " << enumValue.first << ": " << enumValue.second.docString << "\\n ";
+      if (enumValue.second.value == prop.defaultValue) {
+        defaultEnumValueString = enumValue.first;
+      }
     }
     outputFile << "\"]," << std::endl;
+    outputFile << "        \"type\": \"token\"," << std::endl;
+
+    outputFile << "        \"default\": \"" << defaultEnumValueString << "\"," << std::endl;
   } else {
     outputFile << "        \"description\": [\"" << escapeJsonString(prop.docString) << "\"]," << std::endl;
-  }
-  outputFile << "        \"uiName\": \"" << escapeJsonString(prop.uiName) << "\"," << std::endl;
-  outputFile << "        \"type\": \"" << propertyTypeToOgnType(prop.type) << "\"";
+    outputFile << "        \"type\": \"" << propertyTypeToOgnType(prop.type) << "\"," << std::endl;
 
-  // Target relationships don't have default values in OGN
-  if (prop.type != RtComponentPropertyType::Prim) {
-    outputFile << "," << std::endl;
-    outputFile << "        \"default\": " << getDefaultValueAsJson(prop.defaultValue, prop.type);
+    // Target relationships don't have default values in OGN
+    if (prop.type != RtComponentPropertyType::Prim) {
+      outputFile << "        \"default\": " << getDefaultValueAsJson(prop.defaultValue, prop.type) << "," << std::endl;
+    }
   }
 
+
   // Add metadata if available
   bool hasMetadata = false;
   if (!prop.enumValues.empty() || 
       prop.type == RtComponentPropertyType::Color3 ||
       prop.type == RtComponentPropertyType::Color4) {
     
-    outputFile << "," << std::endl;
     outputFile << "        \"metadata\": {" << std::endl;
     
     // Add uiType for color properties
@@ -161,16 +166,17 @@ void writePropertyToOGN(std::ofstream& outputFile, const RtComponentPropertySpec
     }
     
     outputFile << std::endl;
-    outputFile << "        }";
+    outputFile << "        }," << std::endl;
   }
 
   // Optional properties
   if (prop.optional) {
-    outputFile << "," << std::endl;
-    outputFile << "        \"optional\": true";
+    outputFile << "        \"optional\": true," << std::endl;
   }
 
-  outputFile << std::endl;
+  outputFile << "        \"uiName\": \"" << escapeJsonString(prop.uiName) << "\"" << std::endl;
+
+
   outputFile << "      }";
   if (!isLast) {
     outputFile << ",";
@@ -205,6 +211,7 @@ bool writeOGNSchema(const RtComponentSpec* spec, const char* outputFolderPath) {
   outputFile << "    \"version\": " << spec->version << "," << std::endl;
   outputFile << "    \"uiName\": \"" << escapeJsonString(spec->uiName) << "\"," << std::endl;
   outputFile << "    \"language\": \"python\"," << std::endl;
+  outputFile << "    \"categoryDefinitions\": \"config/CategoryDefinition.json\"," << std::endl;
   outputFile << "    \"categories\": \"" << escapeJsonString(spec->categories) << "\"," << std::endl;
 
   // Separate properties by IO type
@@ -236,18 +243,19 @@ bool writeOGNSchema(const RtComponentSpec* spec, const char* outputFolderPath) {
     outputFile << std::endl;
   }
   
+  // Disabled the state section - this shows up as editable properties in the Toolkit UI, and filtering them there is non-trivial.
   // Write state section
-  if (!states.empty()) {
-    outputFile << "    \"state\": {" << std::endl;
-    for (size_t i = 0; i < states.size(); ++i) {
-      writePropertyToOGN(outputFile, *states[i], i == states.size() - 1);
-    }
-    outputFile << "    }";
-    if (!outputs.empty()) {
-      outputFile << ",";
-    }
-    outputFile << std::endl;
-  }
+  // if (!states.empty()) {
+  //   outputFile << "    \"state\": {" << std::endl;
+  //   for (size_t i = 0; i < states.size(); ++i) {
+  //     writePropertyToOGN(outputFile, *states[i], i == states.size() - 1);
+  //   }
+  //   outputFile << "    }";
+  //   if (!outputs.empty()) {
+  //     outputFile << ",";
+  //   }
+  //   outputFile << std::endl;
+  // }
   
   // Write outputs section
   if (!outputs.empty()) {
@@ -282,9 +290,16 @@ bool writePythonStub(const RtComponentSpec* spec, const char* outputFolderPath)
 
   std::ofstream& outputFile = *outputFileHolder;
 
-  outputFile << "from lightspeed.trex.omni.graph.ogn.OgnTemplateNodePyDatabase import OgnTemplateNodePyDatabase" << std::endl;
   outputFile << "# GENERATED FILE - DO NOT EDIT" << std::endl;
   outputFile << "# This file is a stub for OmniGraph editor compatibility, and is not used by the Remix Runtime." << std::endl;
+  outputFile << "from __future__ import annotations" << std::endl;
+  outputFile << std::endl;
+  outputFile << "from typing import TYPE_CHECKING" << std::endl;
+  outputFile << std::endl;
+  outputFile << "if TYPE_CHECKING:" << std::endl;
+  outputFile << "    from lightspeed.trex.components.ogn.ogn.OgnTemplateNodePyDatabase import OgnTemplateNodePyDatabase" << std::endl;
+  outputFile << std::endl;
+  outputFile << std::endl;
   outputFile << "class "<< escapeJsonString(spec->getClassName()) << ":" << std::endl;
   outputFile << "    @staticmethod" << std::endl;
   outputFile << "    def compute(db: OgnTemplateNodePyDatabase):" << std::endl;
diff --git a/src/ogn/lightspeed.trex.components/AnimatedFloat.ogn b/src/ogn/lightspeed.trex.components/AnimatedFloat.ogn
@@ -4,67 +4,60 @@
     "version": 1,
     "uiName": "Animated Float",
     "language": "python",
+    "categoryDefinitions": "config/CategoryDefinition.json",
     "categories": "animation",
     "inputs": {
       "enabled": {
         "description": ["If true, the float will be animated."],
-        "uiName": "Enabled",
         "type": "bool",
         "default": true,
-        "optional": true
+        "optional": true,
+        "uiName": "Enabled"
       },
       "initialValue": {
         "description": ["The value at time t=0."],
-        "uiName": "Initial Value",
         "type": "float",
-        "default": 0.000000
+        "default": 0.000000,
+        "uiName": "Initial Value"
       },
       "finalValue": {
         "description": ["The value at time t=duration."],
-        "uiName": "Final Value",
         "type": "float",
-        "default": 1.000000
+        "default": 1.000000,
+        "uiName": "Final Value"
       },
       "duration": {
         "description": ["How long it takes to animate from initial value to final value, in seconds."],
-        "uiName": "Duration",
         "type": "float",
-        "default": 1.000000
+        "default": 1.000000,
+        "uiName": "Duration"
       },
       "loopingType": {
         "description": ["What happens when the float reaches the final value.\nAllowed values:  - Continue: The value will continue accumulating (a linear animation will preserve the velocity).\n  - Freeze: The value will freeze at the final value.\n  - Loop: The value will return to the initial value.\n  - PingPong: The value will play in reverse until it reaches the initial value, then loop.\n "],
-        "uiName": "Looping Type",
-        "type": "uint",
-        "default": 0,
+        "type": "token",
+        "default": "Loop",
         "metadata": {
           "allowedTokens": ["Continue", "Freeze", "Loop", "PingPong"]
-        }
+        },
+        "uiName": "Looping Type"
       },
       "interpolation": {
         "description": ["How the float will change over time.\nAllowed values:  - Bounce: Bouncy, playful motion.\n  - Cubic: The float will change in a cubic curve over time.\n  - EaseIn: The float will start slow, then accelerate.\n  - EaseInOut: The float will start slow, accelerate, then decelerate.\n  - EaseOut: The float will start fast, then decelerate.\n  - Elastic: Spring-like motion.\n  - Exponential: Dramatic acceleration effect.\n  - Linear: The float will have a constant velocity.\n  - Sine: Smooth, natural motion using sine wave.\n "],
-        "uiName": "Interpolation",
-        "type": "uint",
-        "default": 0,
+        "type": "token",
+        "default": "Linear",
         "metadata": {
           "allowedTokens": ["Bounce", "Cubic", "EaseIn", "EaseInOut", "EaseOut", "Elastic", "Exponential", "Linear", "Sine"]
         },
-        "optional": true
-      }
-    },
-    "state": {
-      "accumulatedTime": {
-        "description": ["How much time has passed since the animation started."],
-        "uiName": "",
-        "type": "float",
-        "default": 0.000000
+        "optional": true,
+        "uiName": "Interpolation"
       }
     },
     "outputs": {
       "currentValue": {
         "description": ["The animated float value."],
-        "uiName": "Current Value",
         "type": "float",
-        "default": 0.000000
+        "default": 0.000000,
+        "uiName": "Current Value"
       }
     }
   }
diff --git a/src/ogn/lightspeed.trex.components/AnimatedFloat.py b/src/ogn/lightspeed.trex.components/AnimatedFloat.py
@@ -1,6 +1,13 @@
-from lightspeed.trex.omni.graph.ogn.OgnTemplateNodePyDatabase import OgnTemplateNodePyDatabase
 # GENERATED FILE - DO NOT EDIT
 # This file is a stub for OmniGraph editor compatibility, and is not used by the Remix Runtime.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from lightspeed.trex.components.ogn.ogn.OgnTemplateNodePyDatabase import OgnTemplateNodePyDatabase
+
+
 class AnimatedFloat:
     @staticmethod
     def compute(db: OgnTemplateNodePyDatabase):
diff --git a/src/ogn/lightspeed.trex.components/SphereLightOverride.ogn b/src/ogn/lightspeed.trex.components/SphereLightOverride.ogn
@@ -4,26 +4,27 @@
     "version": 1,
     "uiName": "Sphere Light",
     "language": "python",
+    "categoryDefinitions": "config/CategoryDefinition.json",
     "categories": "light",
     "inputs": {
       "enabled": {
         "description": ["If true, the overrides will be applied"],
-        "uiName": "Enabled",
         "type": "bool",
         "default": true,
-        "optional": true
+        "optional": true,
+        "uiName": "Enabled"
       },
       "radius": {
         "description": ["The radius of the sphere light."],
-        "uiName": "Radius",
         "type": "float",
         "default": 0.000000,
-        "optional": true
+        "optional": true,
+        "uiName": "Radius"
       },
       "target": {
         "description": ["The sphere light to override."],
-        "uiName": "Target",
-        "type": "target"
+        "type": "target",
+        "uiName": "Target"
       }
     }
   }
diff --git a/src/ogn/lightspeed.trex.components/SphereLightOverride.py b/src/ogn/lightspeed.trex.components/SphereLightOverride.py
@@ -1,6 +1,13 @@
-from lightspeed.trex.omni.graph.ogn.OgnTemplateNodePyDatabase import OgnTemplateNodePyDatabase
 # GENERATED FILE - DO NOT EDIT
 # This file is a stub for OmniGraph editor compatibility, and is not used by the Remix Runtime.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from lightspeed.trex.components.ogn.ogn.OgnTemplateNodePyDatabase import OgnTemplateNodePyDatabase
+
+
 class SphereLightOverride:
     @staticmethod
     def compute(db: OgnTemplateNodePyDatabase):
