Allow validators (prim and stage level) to provide timeCodes to be ev…

…aluated for validation - Adds a isTimeDependent metadata to UsdValidationValidatorMetadata - Note that Prim and Stage Level Validators can have logic which is time dependent. Though its recommended that prim level validators evaluate properties within a prim etc. But as Stage has access to all the prims, Stage level validators are also provided with TimeCode, if the validation logic requires it. - Introduced UsdValidationTimeRange - Class which holds the GfInterval which needs to be validated, + if default time needs to be included. - Updated various APIs to use UsdValidationTimeRange - Update UsdValidationContext::Validate(prim) and UsdValidationContext::Validate(stage) overloads take in a UsdValidationTimeRange parameter - Update ValidationContext::_ValidateStage and _ValidatePrim logic to use UsdValidationTimeRange - Added tests showing the same (Internal change: 2352274)
Mu-L · Dec 20, 2024 · 5eee5ee · 5eee5ee
1 parent a8e2302
commit 5eee5ee
Show file tree

Hide file tree

Showing 25 changed files with 997 additions and 126 deletions.
diff --git a/pxr/usdValidation/usdGeomValidators/validators.cpp b/pxr/usdValidation/usdGeomValidators/validators.cpp
@@ -16,6 +16,7 @@
 #include "pxr/usdValidation/usdGeomValidators/validatorTokens.h"
 #include "pxr/usdValidation/usdValidation/error.h"
 #include "pxr/usdValidation/usdValidation/registry.h"
+#include "pxr/usdValidation/usdValidation/timeRange.h"
 #include "pxr/usdValidation/usdValidation/validator.h"
 
 #include <algorithm>
@@ -25,7 +26,8 @@
 PXR_NAMESPACE_OPEN_SCOPE
 
 static UsdValidationErrorVector
-_GetStageMetadataErrors(const UsdStagePtr &usdStage)
+_GetStageMetadataErrors(const UsdStagePtr &usdStage, 
+                        const UsdValidationTimeRange &/*timeRange*/)
 {
     UsdValidationErrorVector errors;
     if (!usdStage->HasAuthoredMetadata(UsdGeomTokens->metersPerUnit)) {
@@ -53,7 +55,8 @@ _GetStageMetadataErrors(const UsdStagePtr &usdStage)
 }
 
 static UsdValidationErrorVector
-_SubsetFamilies(const UsdPrim &usdPrim)
+_SubsetFamilies(const UsdPrim &usdPrim, 
+                const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!(usdPrim
           && usdPrim.IsInFamily<UsdGeomImageable>(
@@ -111,7 +114,8 @@ _SubsetFamilies(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_SubsetParentIsImageable(const UsdPrim &usdPrim)
+_SubsetParentIsImageable(const UsdPrim &usdPrim, 
+                         const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!(usdPrim
           && usdPrim.IsInFamily<UsdGeomSubset>(

diff --git a/pxr/usdValidation/usdShadeValidators/validators.cpp b/pxr/usdValidation/usdShadeValidators/validators.cpp
@@ -24,6 +24,7 @@
 #include "pxr/usdValidation/usdShadeValidators/validatorTokens.h"
 #include "pxr/usdValidation/usdValidation/error.h"
 #include "pxr/usdValidation/usdValidation/registry.h"
+#include "pxr/usdValidation/usdValidation/timeRange.h"
 
 #include <algorithm>
 #include <unordered_map>
@@ -32,7 +33,8 @@
 PXR_NAMESPACE_OPEN_SCOPE
 
 static UsdValidationErrorVector
-_EncapsulationValidator(const UsdPrim &usdPrim)
+_EncapsulationValidator(const UsdPrim &usdPrim, 
+                        const UsdValidationTimeRange &/*timeRange*/)
 {
     const UsdShadeConnectableAPI &connectable = UsdShadeConnectableAPI(usdPrim);
 
@@ -103,7 +105,9 @@ _EncapsulationValidator(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_MaterialBindingApiAppliedValidator(const UsdPrim &usdPrim)
+_MaterialBindingApiAppliedValidator(
+    const UsdPrim &usdPrim, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     UsdValidationErrorVector errors;
 
@@ -136,7 +140,9 @@ _MaterialBindingApiAppliedValidator(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_MaterialBindingRelationships(const UsdPrim &usdPrim)
+_MaterialBindingRelationships(
+    const UsdPrim &usdPrim, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!usdPrim) {
         return {};
@@ -243,7 +249,9 @@ _MaterialBindingCheckCollection(const UsdPrim &prim, const UsdRelationship &rel,
 }
 
 static UsdValidationErrorVector
-_MaterialBindingCollectionValidator(const UsdPrim &usdPrim)
+_MaterialBindingCollectionValidator(
+    const UsdPrim &usdPrim, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!usdPrim || !usdPrim.HasAPI<UsdShadeMaterialBindingAPI>()) {
         return {};
@@ -267,7 +275,9 @@ _MaterialBindingCollectionValidator(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_ShaderPropertyTypeConformance(const UsdPrim &usdPrim)
+_ShaderPropertyTypeConformance(
+    const UsdPrim &usdPrim, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!(usdPrim
           && usdPrim.IsInFamily<UsdShadeShader>(
@@ -442,7 +452,9 @@ _ShaderPropertyTypeConformance(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_SubsetMaterialBindFamilyName(const UsdPrim &usdPrim)
+_SubsetMaterialBindFamilyName(
+    const UsdPrim &usdPrim, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!(usdPrim
           && usdPrim.IsInFamily<UsdGeomSubset>(
@@ -489,7 +501,8 @@ _SubsetMaterialBindFamilyName(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_SubsetsMaterialBindFamily(const UsdPrim &usdPrim)
+_SubsetsMaterialBindFamily(const UsdPrim &usdPrim, 
+                           const UsdValidationTimeRange &/*timeRange*/)
 {
     if (!(usdPrim
           && usdPrim.IsInFamily<UsdGeomImageable>(
@@ -542,8 +555,9 @@ _SubsetsMaterialBindFamily(const UsdPrim &usdPrim)
 
 static
 UsdValidationErrorVector
-_NormalMapTextureValidator(const UsdPrim& usdPrim) {
-
+_NormalMapTextureValidator(const UsdPrim& usdPrim,
+                           const UsdValidationTimeRange& /*timeRange*/) 
+{
     if (!usdPrim.IsA<UsdShadeShader>()) {
         return {};
     }

diff --git a/pxr/usdValidation/usdSkelValidators/validators.cpp b/pxr/usdValidation/usdSkelValidators/validators.cpp
@@ -12,6 +12,7 @@
 #include "pxr/usdValidation/usdSkelValidators/validatorTokens.h"
 #include "pxr/usdValidation/usdValidation/error.h"
 #include "pxr/usdValidation/usdValidation/registry.h"
+#include "pxr/usdValidation/usdValidation/timeRange.h"
 #include "pxr/usdValidation/usdValidation/validator.h"
 
 #include <algorithm>
@@ -20,7 +21,9 @@
 PXR_NAMESPACE_OPEN_SCOPE
 
 static UsdValidationErrorVector
-_SkelBindingApiAppliedValidator(const UsdPrim &usdPrim)
+_SkelBindingApiAppliedValidator(
+    const UsdPrim &usdPrim, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     UsdValidationErrorVector errors;
 
@@ -63,7 +66,8 @@ _SkelBindingApiAppliedValidator(const UsdPrim &usdPrim)
 }
 
 static UsdValidationErrorVector
-_SkelBindingApiValidator(const UsdPrim &usdPrim)
+_SkelBindingApiValidator(const UsdPrim &usdPrim, 
+                         const UsdValidationTimeRange &/*timeRange*/)
 {
     UsdValidationErrorVector errors;
 

diff --git a/pxr/usdValidation/usdUtilsValidators/validators.cpp b/pxr/usdValidation/usdUtilsValidators/validators.cpp
@@ -13,13 +13,16 @@
 #include "pxr/usdValidation/usdUtilsValidators/validatorTokens.h"
 #include "pxr/usdValidation/usdValidation/error.h"
 #include "pxr/usdValidation/usdValidation/registry.h"
+#include "pxr/usdValidation/usdValidation/timeRange.h"
 
 #include "pxr/usd/sdf/fileFormat.h"
 
 PXR_NAMESPACE_OPEN_SCOPE
 
 static UsdValidationErrorVector
-_PackageEncapsulationValidator(const UsdStagePtr &usdStage)
+_PackageEncapsulationValidator(
+    const UsdStagePtr &usdStage, 
+    const UsdValidationTimeRange &/*timeRange*/)
 {
     UsdValidationErrorVector errors;
 
@@ -100,7 +103,9 @@ _PackageEncapsulationValidator(const UsdStagePtr &usdStage)
 }
 
 static UsdValidationErrorVector
-_FileExtensionValidator(const UsdStagePtr& usdStage) {
+_FileExtensionValidator(const UsdStagePtr& usdStage,
+                        const UsdValidationTimeRange& /*timeRange*/) 
+{
     UsdValidationErrorVector errors;
 
     const std::set<TfToken> validExtensions = {TfToken("usda"),

diff --git a/pxr/usdValidation/usdValidation/CMakeLists.txt b/pxr/usdValidation/usdValidation/CMakeLists.txt
@@ -6,6 +6,7 @@ pxr_library(usdValidation
         sdf
         plug
         tf
+        gf
         usd
         work
         ${TBB_tbb_LIBRARY}
@@ -17,6 +18,7 @@ pxr_library(usdValidation
         context 
         error
         registry
+        timeRange
         validator
         validatorTokens
 
@@ -31,6 +33,7 @@ pxr_library(usdValidation
         wrapContext.cpp
         wrapError.cpp
         wrapRegistry.cpp
+        wrapTimeRange.cpp
         wrapValidator.cpp
 
     PYMODULE_FILES