update to consolidate kernel and address other notes. Add overview doxygen document.

Author: ld-kerley

pxr/usd/usdLightField/CMakeLists.txt

@@ -22,4 +22,7 @@ pxr_library(usdLightField
 
     PYMODULE_FILES
         __init__.py
+
+    DOXYGEN_FILES
+        overview.dox
 )

pxr/usd/usdLightField/generatedSchema.classes.txt

@@ -1,35 +1,37 @@
 # WARNING: THIS FILE IS GENERATED BY usdGenSchema.  DO NOT EDIT.
 
 # Public Classes
-gaussianFalloffFunctionAPI
-gaussianShapeAPI
-implicitShapeFalloffThresholdAPI
+kernelBaseAPI
+kernelConstantTriangleAPI
+kernelGaussianEllipsoidAPI
+kernelGaussianTriangleAPI
 opacityAttributeAPI
 orientationAttributeAPI
 particleField
 particleField_3DGaussianSplat
 positionAttributeAPI
+radianceBaseAPI
 scaleAttributeAPI
 sphericalBetaAttributeAPI
 sphericalHarmonicsAttributeAPI
 tokens
-triangleShapeAPI
 
 # Python Module Files
 module.cpp
-wrapGaussianFalloffFunctionAPI.cpp
-wrapGaussianShapeAPI.cpp
-wrapImplicitShapeFalloffThresholdAPI.cpp
+wrapKernelBaseAPI.cpp
+wrapKernelConstantTriangleAPI.cpp
+wrapKernelGaussianEllipsoidAPI.cpp
+wrapKernelGaussianTriangleAPI.cpp
 wrapOpacityAttributeAPI.cpp
 wrapOrientationAttributeAPI.cpp
 wrapParticleField.cpp
 wrapParticleField_3DGaussianSplat.cpp
 wrapPositionAttributeAPI.cpp
+wrapRadianceBaseAPI.cpp
 wrapScaleAttributeAPI.cpp
 wrapSphericalBetaAttributeAPI.cpp
 wrapSphericalHarmonicsAttributeAPI.cpp
 wrapTokens.cpp
-wrapTriangleShapeAPI.cpp
 
 # Resource Files
 generatedSchema.usda

pxr/usd/usdLightField/generatedSchema.module.h

@@ -12,10 +12,11 @@ TF_WRAP(UsdLightFieldPositionAttributeAPI);
 TF_WRAP(UsdLightFieldOrientationAttributeAPI);
 TF_WRAP(UsdLightFieldScaleAttributeAPI);
 TF_WRAP(UsdLightFieldOpacityAttributeAPI);
-TF_WRAP(UsdLightFieldGaussianShapeAPI);
-TF_WRAP(UsdLightFieldTriangleShapeAPI);
-TF_WRAP(UsdLightFieldGaussianFalloffFunctionAPI);
-TF_WRAP(UsdLightFieldImplicitShapeFalloffThresholdAPI);
+TF_WRAP(UsdLightFieldKernelBaseAPI);
+TF_WRAP(UsdLightFieldKernelGaussianEllipsoidAPI);
+TF_WRAP(UsdLightFieldKernelGaussianTriangleAPI);
+TF_WRAP(UsdLightFieldKernelConstantTriangleAPI);
+TF_WRAP(UsdLightFieldRadianceBaseAPI);
 TF_WRAP(UsdLightFieldSphericalHarmonicsAttributeAPI);
 TF_WRAP(UsdLightFieldSphericalBetaAttributeAPI);
 TF_WRAP(UsdLightFieldTokens);

pxr/usd/usdLightField/generatedSchema.usda

@@ -5,7 +5,7 @@
 
 class ParticleField "ParticleField" (
     customData = {
-        string userDocBrief = """A ParticleField prim is used as a base to desribe different types
+        string userDocBrief = """A ParticleField prim is used as a base to describe different types
             of concrete ParticleField implementations, such as, but not limited
             to, 3D Gaussian Splats."""
     }
@@ -81,9 +81,9 @@ class ParticleField "ParticleField" (
     )
 }
 
-class "PositionAttributeAPI" (
+class "LightFieldPositionAttributeAPI" (
     customData = {
-        string userDocBrief = """A ParticleField related appliedAPI schema that provides a position
+        string userDocBrief = """A ParticleField related applied schema that provides a position
              attribute to define the locations of the particles."""
     }
 )
@@ -100,9 +100,9 @@ class "PositionAttributeAPI" (
     )
 }
 
-class "OrientationAttributeAPI" (
+class "LightFieldOrientationAttributeAPI" (
     customData = {
-        string userDocBrief = """A ParticleField related appliedAPI schema that provides an
+        string userDocBrief = """A ParticleField related applied schema that provides an
              orientation attribute to define the orientation of the particles."""
     }
 )
@@ -119,9 +119,9 @@ class "OrientationAttributeAPI" (
     )
 }
 
-class "ScaleAttributeAPI" (
+class "LightFieldScaleAttributeAPI" (
     customData = {
-        string userDocBrief = """A ParticleField related appliedAPI schema that provides a
+        string userDocBrief = """A ParticleField related applied schema that provides a
              scale attribute to define the scale of the particles."""
     }
 )
@@ -140,9 +140,9 @@ class "ScaleAttributeAPI" (
     )
 }
 
-class "OpacityAttributeAPI" (
+class "LightFieldOpacityAttributeAPI" (
     customData = {
-        string userDocBrief = """A ParticleField related appliedAPI schema that provides a
+        string userDocBrief = """A ParticleField related applied schema that provides a
              opacity attribute to define the opacity of the particles."""
     }
 )
@@ -159,65 +159,71 @@ class "OpacityAttributeAPI" (
     )
 }
 
-class "GaussianShapeAPI" (
+class "LightFieldKernelBaseAPI" (
     customData = {
-        string userDocBrief = "Defines the Gaussian shape function."
+        string userDocBrief = """Defines a base-class type applied schema that all applied schema
+            that provides the a ParticleField kernel will automatically apply."""
     }
 )
 {
 }
 
-class "TriangleShapeAPI" (
+class "LightFieldKernelGaussianEllipsoidAPI" (
+    apiSchemas = ["LightFieldKernelBaseAPI"]
     customData = {
-        string userDocBrief = """Defines a base shape as a equilateral triangle with given edge
-            length."""
+        string userDocBrief = "Defines the gaussian ellipsoid kernel for a given ParticleField."
     }
 )
 {
-    float kernelShape:triangle:edgeLength = 1 (
+}
+
+class "LightFieldKernelGaussianTriangleAPI" (
+    apiSchemas = ["LightFieldKernelBaseAPI"]
+    customData = {
+        string userDocBrief = "Defines the gaussian triangle kernel for a given ParticleField."
+    }
+)
+{
+    float kernel:triangle:edgeLength = 1 (
         customData = {
             string userDocBrief = """The edge length of the equilateral triangle before any scaling
                 is applied."""
         }
     )
 }
 
-class "GaussianFalloffFunctionAPI" (
+class "LightFieldKernelConstantTriangleAPI" (
+    apiSchemas = ["LightFieldKernelBaseAPI"]
     customData = {
-        string userDocBrief = "Defines a Gaussian fall-off function."
+        string userDocBrief = "Defines the gaussian triangle kernel for a given ParticleField."
     }
 )
 {
 }
 
-class "ImplicitShapeFalloffThresholdAPI" (
+class "LightFieldRadianceBaseAPI" (
     customData = {
-        string userDocBrief = """Defines a shape implicitly by providing a threshold value for the
-             fall-off function linked with the associated shape appliedAPI."""
+        string userDocBrief = """Defines a base-class type applied schema that all applied schema
+            that provides the a ParticleField kernel will automatically apply."""
     }
 )
 {
-    float kernelFalloff:implicitShapeFalloff:threshold = 0.01 (
-        customData = {
-            string userDocBrief = """The threshold value for the kernel's fall-off function that
-                defines the surface boundary."""
-        }
-    )
 }
 
-class "SphericalHarmonicsAttributeAPI" (
+class "LightFieldSphericalHarmonicsAttributeAPI" (
+    apiSchemas = ["LightFieldRadianceBaseAPI"]
     customData = {
-        string userDocBrief = """A ParticleField related appliedAPI schema that provides spherical
+        string userDocBrief = """A ParticleField related applied schema that provides spherical
             harmonics attributes to define the radiance of the particles."""
     }
 )
 {
-    float3[] primvars:radiance:sphericalHarmonicsCoefficients (
+    float3[] radiance:sphericalHarmonicsCoefficients (
         customData = {
             string userDocBrief = "Flattened array of SH coefficients."
         }
     )
-    half3[] primvars:radiance:sphericalHarmonicsCoefficientsh (
+    half3[] radiance:sphericalHarmonicsCoefficientsh (
         customData = {
             string userDocBrief = "Flattened array of SH coefficients."
         }
@@ -229,22 +235,23 @@ class "SphericalHarmonicsAttributeAPI" (
     )
 }
 
-class "SphericalBetaAttributeAPI" (
+class "LightFieldSphericalBetaAttributeAPI" (
+    apiSchemas = ["LightFieldRadianceBaseAPI"]
     customData = {
-        string userDocBrief = """A ParticleField related appliedAPI schema that provides spherical
+        string userDocBrief = """A ParticleField related applied schema that provides spherical
             beta attributes to define the radiance of the particles."""
     }
 )
 {
-    float[] primvars:sphericalBeta:beta (
+    float[] sphericalBeta:beta (
         customData = {
             string userDocBrief = "Beta parameter per-particle."
         }
     )
 }
 
 class ParticleField_3DGaussianSplat "ParticleField_3DGaussianSplat" (
-    apiSchemas = ["PositionAttributeAPI", "OrientationAttributeAPI", "ScaleAttributeAPI", "OpacityAttributeAPI", "GaussianShapeAPI", "GaussianFalloffFunctionAPI", "SphericalHarmonicsAttributeAPI"]
+    apiSchemas = ["LightFieldPositionAttributeAPI", "LightFieldOrientationAttributeAPI", "LightFieldScaleAttributeAPI", "LightFieldOpacityAttributeAPI", "LightFieldKernelGaussianEllipsoidAPI", "LightFieldSphericalHarmonicsAttributeAPI"]
     customData = {
         string userDocBrief = """This is a concrete ParticleField representing the original 3D
             Gaussian Splats technique (https://arxiv.org/abs/2308.04079)."""