Adds unit tests for transform components

Fixes some issues that came up while writing the tests:

* counter gets a default value
* interpolate float has been replaced by remap
* loop tooltip updated
* ray_mesh_intersection should be in the Sense category

Also updated the documentation a bit.

Author: MarkEHenderson

documentation/RemixLogic.md

@@ -12,13 +12,17 @@ By connecting Components in different ways, you can create sophisticated behavio
 
 **Important:** Components must be connected in a way that has a clear starting point and doesn't create loops - each Component can only use information from Components that come before it in the chain.
 
+# Creating Graphs
+
+This page is primarily intended for people who wish to create their own custom components in c++. If this is your first introduction to Remix Logic, you should probably see the [Remix Toolkit documentation](https://docs.omniverse.nvidia.com/kit/docs/rtx_remix/latest/docs/howto/learning-logic.html) for a high level overview and graph creation tutorials.
+
 # Component List
 
 Documentation for each component is available here: [Component List](components/index.md)
 
 # Types of Components
 
-There are three major categories of components:
+There are four major categories of components:
 
 ## Sense Components
 
@@ -53,29 +57,28 @@ These components alter the renderable state.
 * Swap which replacements are applied to a given mesh hash
 * Alter the time multiplier (pausing or slowing all animations)
 
-# Creating Graphs
+## Const Components
 
-Graph creation should be done in the Remix Toolkit.  The graph editor there is still in development.
+These components simply output a single constant value of a given type.  This can be useful for sharing a value between multiple components, but primarily exist as a way to set properties with a flexible type.
 
 # Component Data Types
 
 The component system supports the following data types as defined in `rtx_graph_types.h`:
 
 | Type | C++ Type | Description | Example Values |
 |------|----------|-------------|----------------|
-| `Bool` | `uint8_t` | True or False boolean values (stored as uint8_t for variant compatibility) | `true`, `false` |
-| `Float` | `float` | A number, including decimal places. Single precision floating point | `1.0f`, `-3.14f` |
+| `Bool` | `uint32_t` | True or False boolean values (stored as uint8_t for variant compatibility) | `true`, `false` |
+| `Float` | `float` | A number, including decimal places. Single precision floating point | `1.0`, `-3.14` |
 | `Float2` | `Vector2` | 2D vector of floats | `Vector2(1.0f, 2.0f)` |
 | `Float3` | `Vector3` | 3D vector of floats | `Vector3(1.0f, 2.0f, 3.0f)` |
-| `Color3` | `Vector3` | RGB color (3D vector) | `Vector3(1.0f, 0.5f, 0.0f)` |
-| `Color4` | `Vector4` | RGBA color (4D vector) | `Vector4(1.0f, 0.5f, 0.0f, 1.0f)` |
-| `Uint32` | `uint32_t` | A positive whole number | `42`, `1000` |
+| `Float4` | `Vector4` | 3D vector of floats | `Vector4(1.0f, 2.0f, 3.0f)` |
+| `Enum` | `uint32_t` | A selection from a limited list of options | `InterpolationType::Linear`, `LoopingType::Loop` |
 | `String` | `std::string` | Some text | `"hello"`, `"world"` |
 | `AssetPath` | `std::string` | Path to an asset file | `"textures/myfile.dds"` |
-| `Hash` | `uint64_t` | 64-bit hash value | `0x123456789ABCDEF0ULL` |
-| `Prim` | `uint32_t` | USD prim identifier | `101`, `102` |
-| `Number` | `std::variant<float, int32_t, uint32_t, uint64_t>` | Flexible numeric type (resolved at load time) | `1.0f`, `42` |
-| `NumberOrVector` | `std::variant<float, Vector2, Vector3, Vector4, int32_t, uint32_t, uint64_t>` | Flexible numeric or vector type (resolved at load time) | `1.0f`, `Vector2(1.0f, 2.0f)` |
+| `Hash` | `uint64_t` | 64-bit hash value | `0x123456789ABCDEF0` |
+| `Prim` | `PrimTarget` | Identifies another object - a mesh, light, material, particle effect, graph, etc. | `</RootNode/meshes/mesh_123456789ABCDEF0/mesh>` |
+| `NumberOrVector` | `std::variant<float, Vector2, Vector3, Vector4>` | Flexible numeric or vector type (resolved at load time) | `1.0f`, `Vector2(1.0f, 2.0f)` |
+| `Any` | `std::variant<...>` | Flexible type that supports all non-flexible types | `1.0f`, `true`, `"textures/myfile.dds"` |
 
 Components with flexible types may not accept all combinations of those types - i.e. you cannot check if a Float is greater than a Vector3.
 
@@ -134,6 +137,9 @@ Available options include:
 * `property.optional` - Whether the component functions without this property being set
 * `property.oldUsdNames` - For backwards compatibility when renaming properties
 * `property.enumValues` - For displaying as an enum in the UI
+* `property.isSettableOutput` - Used for `const` components, use this on an Input property to create an output property which can be set in the toolkit's property panel.
+* `property.treatAsColor` - If set on a Float3 or Float4, this indicates to the toolkit that a color picking widget should be displayed for this property.
+* `property.allowedPrimTypes` - Allows for filtering of `Prim` properties, if the target must be of a specific type (i.e. `PrimType::UsdGeomMesh`  or `PrimType::OmniGraph`)
 
 ### Enum Values Example
 

documentation/components/Counter.md

@@ -1,6 +1,6 @@
 # Counter
 
-Counts up by a value every frame when a condition is true\.<br/><br/>Increments a counter by a specified value every frame that the input bool is true\. Useful for tracking how many frames a condition has been active\.
+Counts up by a value every frame when a condition is true\.<br/><br/>Increments a counter by a specified value every frame that the input bool is true\. Use \`Starting Value\` to set the initial counter value\. Useful for tracking how many frames a condition has been active\.
 
 ## Component Information
 
@@ -15,6 +15,7 @@ Counts up by a value every frame when a condition is true\.<br/><br/>Increments
 |----------|--------------|------|---------|---------------|----------|
 | increment | Increment | Bool | Input | false | No | 
 | incrementValue | Increment Value | Float | Input | 1\.0 | Yes | 
+| defaultValue | Starting Value | Float | Input | 0\.0 | No | 
 
 ### Increment
 
@@ -26,6 +27,11 @@ When true, the counter increments by the increment value each frame\.
 The value to add to the counter each frame when increment is true\.
 
 
+### Starting Value
+
+The initial value of the counter when the component is created\.
+
+
 ## State Properties
 
 | Property | Display Name | Type | IO Type | Default Value | Optional |

documentation/components/InterpolateFloat.md

@@ -61,7 +61,7 @@ The value with looping applied\.
 
 ### Is Reversing
 
-True if the value is in the reverse phase of ping pong looping\. If passing \`loopedValue\` to an \`interpolateFloat\` component, hook this up to \`shouldReverse\` from that component\.
+True if the value is in the reverse phase of ping pong looping\. If passing \`loopedValue\` to a \`Remap\` component, hook this up to \`shouldReverse\` from that component\.
 
 
 ## Valid Type Combinations

documentation/components/Loop.md

@@ -7,7 +7,7 @@ Tests if a ray intersects with a mesh\.<br/><br/>Performs a ray\-mesh intersecti
 - **Name:** `RayMeshIntersection`
 - **UI Name:** Ray Mesh Intersection
 - **Version:** 1
-- **Categories:** Transform
+- **Categories:** Sense
 
 ## Input Properties
 

documentation/components/RayMeshIntersection.md

@@ -1,6 +1,6 @@
 # Remap
 
-Smoothly maps a value from one range to another range with customizable easing curves\.<br/><br/>Remaps a value from an input range to an output range with optional easing\. Values will be normalized \(mapped from input range to 0\-1\), eased \(changed from linear to some curve\), then mapped \(0\-1 value to output range\)\.<br/><br/>Note: Input values outside of input range are valid, and easing can lead to the output value being outside of the output range even when input is inside the input range\.<br/><br/>Inverted ranges \(max < min\) are supported, but the results are undefined and may change without warning\.
+Smoothly maps a value from one range to another range with customizable easing curves\.<br/><br/>Remaps a value from an input range to an output range with optional easing\. Values will be normalized \(mapped from input range to 0\-1\), eased \(changed from linear to some curve\), then mapped \(0\-1 value to output range\)\.<br/><br/>Note: Input values outside of input range are valid, and easing can lead to the output value being outside of the output range even when input is inside the input range\.<br/><br/>Inverted ranges \(max < min\) are supported\.
 
 ## Component Information
 

documentation/components/Remap.md

@@ -36,7 +36,6 @@ This documentation provides detailed information about all available components
 | [Equal To](EqualTo.md) | Returns true if A is equal to B, false otherwise\.<br/><br/>For floating point values, this performs exact eq\.\.\. | 1 |
 | [Floor](Floor.md) | Rounds a value down to the previous integer\.<br/><br/>Returns the largest integer less than or equal to the \.\.\. | 1 |
 | [Greater Than](GreaterThan.md) | Returns true if A is greater than B, false otherwise\. | 1 |
-| [Interpolate Float](InterpolateFloat.md) | Smoothly maps a value from one range to another range with customizable easing curves\.<br/><br/>Interpolates\.\.\. | 1 |
 | [Invert](Invert.md) | Outputs 1 minus the input value\.<br/><br/>Calculates 1 \- input\. Useful for inverting normalized values \(e\.g\.\.\.\. | 1 |
 | [Less Than](LessThan.md) | Returns true if A is less than B, false otherwise\. | 1 |
 | [Loop](Loop.md) | Wraps a number back into a range when it goes outside the boundaries\.<br/><br/>Applies looping behavior to a\.\.\. | 1 |
@@ -45,7 +44,6 @@ This documentation provides detailed information about all available components
 | [Multiply](Multiply.md) | Multiplies two values together\.<br/><br/>Vector \* Number will multiply all components of the vector by the n\.\.\. | 1 |
 | [Normalize](Normalize.md) | Normalizes a vector to have length 1\.<br/><br/>Divides the vector by its length to produce a unit vector \(le\.\.\. | 1 |
 | [Previous Frame Value](PreviousFrameValue.md) | Outputs the value from the previous frame\.<br/><br/>Stores the input value and outputs it on the next frame\.\.\.\. | 1 |
-| [Ray Mesh Intersection](RayMeshIntersection.md) | Tests if a ray intersects with a mesh\.<br/><br/>Performs a ray\-mesh intersection test\. Currently supports bo\.\.\. | 1 |
 | [Remap](Remap.md) | Smoothly maps a value from one range to another range with customizable easing curves\.<br/><br/>Remaps a val\.\.\. | 1 |
 | [Round](Round.md) | Rounds a value to the nearest integer\.<br/><br/>Rounds to the nearest whole number\. For example: 1\.4 becomes\.\.\. | 1 |
 | [Select](Select.md) | Selects between two values based on a boolean condition\.<br/><br/>If the condition is true, outputs Input A\.\.\.\. | 1 |
@@ -66,6 +64,7 @@ This documentation provides detailed information about all available components
 | [Light Hash Checker](LightHashChecker.md) | Detects if a specific light is currently active in the scene\.<br/><br/>Checks if a specific light hash is pr\.\.\. | 1 |
 | [Mesh Hash Checker](MeshHashChecker.md) | Detects if a specific mesh is currently being drawn in the scene\.<br/><br/>Checks if a specific mesh hash wa\.\.\. | 1 |
 | [Mesh Proximity](MeshProximity.md) | Measures how far a point is from a mesh's bounding box\. This can be used to determine if the camera \.\.\. | 1 |
+| [Ray Mesh Intersection](RayMeshIntersection.md) | Tests if a ray intersects with a mesh\.<br/><br/>Performs a ray\-mesh intersection test\. Currently supports bo\.\.\. | 1 |
 | [Read Bone Transform](ReadBoneTransform.md) | Reads the transform \(position, rotation, scale\) of a bone from a skinned mesh\.<br/><br/>Extracts the transfo\.\.\. | 1 |
 | [Read Transform](ReadTransform.md) | Reads the transform \(position, rotation, scale\) of a mesh or light in world space\.<br/><br/>Extracts the tra\.\.\. | 1 |
 | [Rtx Option Layer Sensor](RtxOptionLayerSensor.md) | Reads the state of a configuration layer\.<br/><br/>Outputs whether a given RtxOptionLayer is enabled, along \.\.\. | 1 |
@@ -102,8 +101,8 @@ This documentation provides detailed information about all available components
 
 ## Statistics
 
-- **Total Components:** 69
-- **Categorized Components:** 69
+- **Total Components:** 68
+- **Categorized Components:** 68
 - **Categories:** 5
 
 ---

documentation/components/index.md

@@ -29,38 +29,58 @@ namespace components {
 
 #define LIST_INPUTS(X) \
   X(RtComponentPropertyType::Bool, false, increment, "Increment", "When true, the counter increments by the increment value each frame.") \
-  X(RtComponentPropertyType::Float, 1.0f, incrementValue, "Increment Value", "The value to add to the counter each frame when increment is true.", property.optional = true)
+  X(RtComponentPropertyType::Float, 1.0f, incrementValue, "Increment Value", "The value to add to the counter each frame when increment is true.", property.optional = true) \
+  X(RtComponentPropertyType::Float, 0.0f, defaultValue, "Starting Value", "The initial value of the counter when the component is created.")
 
 #define LIST_STATES(X) \
   X(RtComponentPropertyType::Float, 0.0f, count, "", "The current counter value.")
 
 #define LIST_OUTPUTS(X) \
   X(RtComponentPropertyType::Float, 0.0f, value, "Value", "The current counter value.")
 
-REMIX_COMPONENT( \
-  /* the Component name */ Counter, \
-  /* the UI name */        "Counter", \
-  /* the UI categories */  "Transform", \
-  /* the doc string */     "Counts up by a value every frame when a condition is true.\n\n" \
-    "Increments a counter by a specified value every frame that the input bool is true. " \
-    "Useful for tracking how many frames a condition has been active.", \
-  /* the version number */ 1, \
-  LIST_INPUTS, LIST_STATES, LIST_OUTPUTS);
+
+// Manually declaring the class to allow for custom initialize method
+class Counter : public RtRegisteredComponentBatch<Counter> {
+private:
+  REMIX_COMPONENT_GENERATE_PROP_TYPES(LIST_INPUTS, LIST_STATES, LIST_OUTPUTS)
+  REMIX_COMPONENT_BODY(
+    /* the Component class name */ Counter,
+    /* the UI name */        "Counter",
+    /* the UI categories */  "Transform",
+    /* the doc string */     "Counts up by a value every frame when a condition is true.\n\n"
+      "Increments a counter by a specified value every frame that the input bool is true. "
+      "Use `Starting Value` to set the initial counter value. "
+      "Useful for tracking how many frames a condition has been active.",
+    /* the version number */ 1,
+    LIST_INPUTS, LIST_STATES, LIST_OUTPUTS,
+    /* optional arguments: */
+    spec.initialize = initialize; // Initialize callback to set initial value
+  )
+  void updateRange(const Rc<DxvkContext>& context, const size_t start, const size_t end) final {
+    for (size_t i = start; i < end; i++) {
+      if (m_increment[i]) {
+        m_count[i] += m_incrementValue[i];
+      }
+      
+      m_value[i] = m_count[i];
+    }
+  }
+  
+  // Static wrapper for the initialize callback
+  static void initialize(const Rc<DxvkContext>& context, RtComponentBatch& batch, const size_t index) {
+    static_cast<Counter&>(batch).initializeInstance(context, index);
+  }
+  void initializeInstance(const Rc<DxvkContext>& context, const size_t index)  {
+    // Set the initial counter value based on the default value
+    m_count[index] = m_defaultValue[index];
+    m_value[index] = m_count[index];
+  }
+};
 
 #undef LIST_INPUTS
 #undef LIST_STATES
 #undef LIST_OUTPUTS
 
-void Counter::updateRange(const Rc<DxvkContext>& context, const size_t start, const size_t end) {
-  for (size_t i = start; i < end; i++) {
-    if (m_increment[i]) {
-      m_count[i] += m_incrementValue[i];
-    }
-    
-    m_value[i] = m_count[i];
-  }
-}
-
 }  // namespace components
 }  // namespace dxvk