# SPDX-FileCopyrightText: 2023 Blender Authors # # SPDX-License-Identifier: GPL-2.0-or-later import math import os import pathlib import sys import tempfile import unittest from pxr import Gf, Sdf, Usd, UsdGeom, UsdLux, UsdMtlx, UsdShade, UsdSkel, UsdUI, UsdUtils, UsdVol, UsdValidation import bpy sys.path.append(str(pathlib.Path(__file__).parent.absolute())) from modules.colored_print import (print_message, use_message_colors) args = None class AbstractUSDTest(unittest.TestCase): @classmethod def setUpClass(cls): cls._tempdir = tempfile.TemporaryDirectory() cls.testdir = args.testdir cls.tempdir = pathlib.Path(cls._tempdir.name) if os.environ.get("BLENDER_TEST_COLOR") is not None: use_message_colors() def setUp(self): self.assertTrue(self.testdir.exists(), "Test dir {0} should exist".format(self.testdir)) print_message(self._testMethodName, 'SUCCESS', 'RUN') def tearDown(self): self._tempdir.cleanup() result = self._outcome.result ok = all(test != self for test, _ in result.errors + result.failures) if not ok: print_message(self._testMethodName, 'FAILURE', 'FAILED') else: print_message(self._testMethodName, 'SUCCESS', 'PASSED') def export_and_validate(self, **kwargs): """Export and validate the resulting USD file.""" export_path = kwargs["filepath"] # Do the actual export res = bpy.ops.wm.usd_export(**kwargs) self.assertEqual({'FINISHED'}, res, f"Unable to export to {export_path}") # Validate resulting file # Any validators to exclude. E.g. "usdUtilsValidators:MissingReferenceValidator" to_skip = [] validation_reg = UsdValidation.ValidationRegistry() metadata = [m for m in validation_reg.GetAllValidatorMetadata() if m.name not in to_skip] metadata = sorted(metadata, key=lambda m: m.name) stage = Usd.Stage.Open(export_path) validation_ctx = UsdValidation.ValidationContext(metadata=metadata) failures = validation_ctx.Validate(stage) failure_msgs = [] for failure in failures: failure_msgs.append(f"{failure.GetIdentifier()} : {failure.GetMessage()}") stage = None self.assertEqual(len(failure_msgs), 0, failure_msgs) class USDExportTest(AbstractUSDTest): # Utility function to round each component of a vector to a few digits. The "+ 0" is to # ensure that any negative zeros (-0.0) are converted to positive zeros (0.0). @staticmethod def round_vector(vector): return [round(c, 4) + 0 for c in vector] # Utility function to compare two Gf.Vec3d's def compareVec3d(self, first, second): places = 5 self.assertAlmostEqual(first[0], second[0], places) self.assertAlmostEqual(first[1], second[1], places) self.assertAlmostEqual(first[2], second[2], places) # Utility function to force frame evaluation (ensures simulation zone data is baked etc.) @staticmethod def ensure_simulation_frame_range(frame_start, frame_end): for frame in range(frame_start, frame_end + 1): bpy.context.scene.frame_set(frame) bpy.context.scene.frame_set(frame_start) def test_export_extents(self): """Test that exported scenes contain have a properly authored extent attribute on each boundable prim""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_extent_test.blend")) export_path = self.tempdir / "usd_extent_test.usda" self.export_and_validate( filepath=str(export_path), export_materials=True, evaluation_mode="RENDER", convert_world_material=False, ) # if prims are missing, the exporter must have skipped some objects stats = UsdUtils.ComputeUsdStageStats(str(export_path)) self.assertEqual(stats["totalPrimCount"], 16, "Unexpected number of prims") # validate the overall world bounds of the scene stage = Usd.Stage.Open(str(export_path)) scenePrim = stage.GetPrimAtPath("/root/scene") bboxcache = UsdGeom.BBoxCache(Usd.TimeCode.Default(), [UsdGeom.Tokens.default_]) bounds = bboxcache.ComputeWorldBound(scenePrim) bound_min = bounds.GetRange().GetMin() bound_max = bounds.GetRange().GetMax() self.compareVec3d(bound_min, Gf.Vec3d(-5.76875186, -1, -2.798513651)) self.compareVec3d(bound_max, Gf.Vec3d(1, 2.9515805244, 2.7985136508)) # validate the locally authored extents prim = stage.GetPrimAtPath("/root/scene/BigCube/BigCubeMesh") extent = UsdGeom.Boundable(prim).GetExtentAttr().Get() self.compareVec3d(Gf.Vec3d(extent[0]), Gf.Vec3d(-1, -1, -2.7985137)) self.compareVec3d(Gf.Vec3d(extent[1]), Gf.Vec3d(1, 1, 2.7985137)) prim = stage.GetPrimAtPath("/root/scene/LittleCube/LittleCubeMesh") extent = UsdGeom.Boundable(prim).GetExtentAttr().Get() self.compareVec3d(Gf.Vec3d(extent[0]), Gf.Vec3d(-1, -1, -1)) self.compareVec3d(Gf.Vec3d(extent[1]), Gf.Vec3d(1, 1, 1)) prim = stage.GetPrimAtPath("/root/scene/Volume/Volume") extent = UsdGeom.Boundable(prim).GetExtentAttr().Get() self.compareVec3d( Gf.Vec3d(extent[0]), Gf.Vec3d(-0.74715018, -0.69621181, -0.59592748) ) self.compareVec3d( Gf.Vec3d(extent[1]), Gf.Vec3d(0.76734608, 0.56586843, 0.91856879) ) def test_material_transforms(self): """Validate correct export of image mapping parameters to the UsdTransform2d shader def""" # Use the common materials .blend file bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_export.blend")) export_path = self.tempdir / "material_transforms.usda" self.export_and_validate(filepath=str(export_path), export_materials=True) # Inspect the UsdTransform2d prim on the "Transforms" material stage = Usd.Stage.Open(str(export_path)) shader_prim = stage.GetPrimAtPath("/root/_materials/Transforms/Mapping") shader = UsdShade.Shader(shader_prim) self.assertEqual(shader.GetIdAttr().Get(), "UsdTransform2d") input_trans = shader.GetInput('translation') input_rot = shader.GetInput('rotation') input_scale = shader.GetInput('scale') self.assertEqual(input_trans.Get(), [0.75, 0.75]) self.assertEqual(input_rot.Get(), 180) self.assertEqual(input_scale.Get(), [0.5, 0.5]) def test_material_normal_maps(self): """Validate correct export of typical normal map setups to the UsdUVTexture shader def. Namely validate that scale, bias, and ColorSpace settings are correct""" # Use the common materials .blend file bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_export.blend")) export_path = self.tempdir / "material_normalmaps.usda" self.export_and_validate(filepath=str(export_path), export_materials=True) # Inspect the UsdUVTexture prim on the "typical" "NormalMap" material stage = Usd.Stage.Open(str(export_path)) shader_prim = stage.GetPrimAtPath("/root/_materials/NormalMap/Image_Texture") shader = UsdShade.Shader(shader_prim) self.assertEqual(shader.GetIdAttr().Get(), "UsdUVTexture") input_scale = shader.GetInput('scale') input_bias = shader.GetInput('bias') input_colorspace = shader.GetInput('sourceColorSpace') self.assertEqual(input_scale.Get(), [2, 2, 2, 2]) self.assertEqual(input_bias.Get(), [-1, -1, -1, -1]) self.assertEqual(input_colorspace.Get(), 'raw') # Inspect the UsdUVTexture prim on the "inverted" "NormalMap_Scale_Bias" material stage = Usd.Stage.Open(str(export_path)) shader_prim = stage.GetPrimAtPath("/root/_materials/NormalMap_Scale_Bias/Image_Texture") shader = UsdShade.Shader(shader_prim) self.assertEqual(shader.GetIdAttr().Get(), "UsdUVTexture") input_scale = shader.GetInput('scale') input_bias = shader.GetInput('bias') input_colorspace = shader.GetInput('sourceColorSpace') self.assertEqual(input_scale.Get(), [2, -2, 2, 1]) self.assertEqual(input_bias.Get(), [-1, 1, -1, 0]) self.assertEqual(input_colorspace.Get(), 'raw') def test_material_opacity_threshold(self): """Validate correct export of opacity and opacity_threshold parameters to the UsdPreviewSurface shader def""" # Use the common materials .blend file bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_channels.blend")) export_path = self.tempdir / "usd_materials_channels.usda" self.export_and_validate(filepath=str(export_path), export_materials=True) # Opaque no-Alpha stage = Usd.Stage.Open(str(export_path)) shader_prim = stage.GetPrimAtPath("/root/_materials/Opaque/Principled_BSDF") shader = UsdShade.Shader(shader_prim) opacity_input = shader.GetInput('opacity') self.assertEqual(opacity_input.HasConnectedSource(), False, "Opacity input should not be connected for opaque material") self.assertAlmostEqual(opacity_input.Get(), 1.0, 2, "Opacity input should be set to 1") # Validate Image Alpha to BSDF Alpha shader_prim = stage.GetPrimAtPath("/root/_materials/Alpha/Principled_BSDF") shader = UsdShade.Shader(shader_prim) opacity_input = shader.GetInput('opacity') opacity_thresh_input = shader.GetInput('opacityThreshold') self.assertEqual(opacity_input.HasConnectedSource(), True, "Alpha input should be connected") self.assertEqual(opacity_thresh_input.Get(), None, "Opacity threshold input should be empty") # Validate Image Alpha to BSDF Alpha w/Round shader_prim = stage.GetPrimAtPath("/root/_materials/AlphaClip_Round/Principled_BSDF") shader = UsdShade.Shader(shader_prim) opacity_input = shader.GetInput('opacity') opacity_thresh_input = shader.GetInput('opacityThreshold') self.assertEqual(opacity_input.HasConnectedSource(), True, "Alpha input should be connected") self.assertAlmostEqual(opacity_thresh_input.Get(), 0.5, 2, "Opacity threshold input should be 0.5") # Validate Image Alpha to BSDF Alpha w/LessThan+Invert shader_prim = stage.GetPrimAtPath("/root/_materials/AlphaClip_LessThan/Principled_BSDF") shader = UsdShade.Shader(shader_prim) opacity_input = shader.GetInput('opacity') opacity_thresh_input = shader.GetInput('opacityThreshold') self.assertEqual(opacity_input.HasConnectedSource(), True, "Alpha input should be connected") self.assertAlmostEqual(opacity_thresh_input.Get(), 0.8, 2, "Opacity threshold input should be 0.8") # Validate Image RGB to BSDF Metallic, Roughness, Alpha shader_prim = stage.GetPrimAtPath("/root/_materials/Channel/Principled_BSDF") shader = UsdShade.Shader(shader_prim) metallic_input = shader.GetInput("metallic") roughness_input = shader.GetInput("roughness") opacity_input = shader.GetInput('opacity') opacity_thresh_input = shader.GetInput('opacityThreshold') self.assertEqual(metallic_input.HasConnectedSource(), True, "Metallic input should be connected") self.assertEqual(roughness_input.HasConnectedSource(), True, "Roughness input should be connected") self.assertEqual(opacity_input.HasConnectedSource(), True, "Alpha input should be connected") self.assertEqual(opacity_thresh_input.Get(), None, "Opacity threshold input should be empty") # Validate Image RGB to BSDF Metallic, Roughness, Alpha w/Round shader_prim = stage.GetPrimAtPath("/root/_materials/ChannelClip_Round/Principled_BSDF") shader = UsdShade.Shader(shader_prim) metallic_input = shader.GetInput("metallic") roughness_input = shader.GetInput("roughness") opacity_input = shader.GetInput('opacity') opacity_thresh_input = shader.GetInput('opacityThreshold') self.assertEqual(metallic_input.HasConnectedSource(), True, "Metallic input should be connected") self.assertEqual(roughness_input.HasConnectedSource(), True, "Roughness input should be connected") self.assertEqual(opacity_input.HasConnectedSource(), True, "Alpha input should be connected") self.assertAlmostEqual(opacity_thresh_input.Get(), 0.5, 2, "Opacity threshold input should be 0.5") # Validate Image RGB to BSDF Metallic, Roughness, Alpha w/LessThan+Invert shader_prim = stage.GetPrimAtPath("/root/_materials/ChannelClip_LessThan/Principled_BSDF") shader = UsdShade.Shader(shader_prim) metallic_input = shader.GetInput("metallic") roughness_input = shader.GetInput("roughness") opacity_input = shader.GetInput('opacity') opacity_thresh_input = shader.GetInput('opacityThreshold') self.assertEqual(metallic_input.HasConnectedSource(), True, "Metallic input should be connected") self.assertEqual(roughness_input.HasConnectedSource(), True, "Roughness input should be connected") self.assertEqual(opacity_input.HasConnectedSource(), True, "Alpha input should be connected") self.assertAlmostEqual(opacity_thresh_input.Get(), 0.2, 2, "Opacity threshold input should be 0.2") def test_export_material_subsets(self): """Validate multiple materials assigned to the same mesh work correctly.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_multi.blend")) # Ensure the simulation zone data is baked for all relevant frames... self.ensure_simulation_frame_range(1, 4) export_path = self.tempdir / "usd_materials_multi.usda" self.export_and_validate( filepath=str(export_path), export_animation=True, incremental_frames=1, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) # The static mesh should have 4 materials each assigned to 4 faces (16 faces total) static_mesh_prim = UsdGeom.Mesh(stage.GetPrimAtPath("/root/static_mesh/static_mesh")) geom_subsets = UsdGeom.Subset.GetGeomSubsets(static_mesh_prim) self.assertEqual(len(geom_subsets), 4) unique_face_indices = set() for subset in geom_subsets: face_indices = subset.GetIndicesAttr().Get() self.assertEqual(len(face_indices), 4) unique_face_indices.update(face_indices) self.assertEqual(len(unique_face_indices), 16) # The dynamic mesh varies over time (currently blocked, see #124554 and #118754) # - Frame 1: 1 face and 1 material [mat2] # - Frame 2: 2 faces and 2 materials [mat2, mat3] # - Frame 3: 4 faces and 3 materials [mat2, mat3, mat2, mat1] # - Frame 4: 4 faces and 2 materials [mat2, mat3, mat2, mat3] dynamic_mesh_prim = UsdGeom.Mesh(stage.GetPrimAtPath("/root/dynamic_mesh/Mesh")) geom_subsets = UsdGeom.Subset.GetGeomSubsets(dynamic_mesh_prim) self.assertEqual(len(geom_subsets), 0) def test_export_material_inmem(self): """Validate correct export of in memory and packed images""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_inmem_pack.blend")) export_path1 = self.tempdir / "usd_materials_inmem_pack_relative.usda" self.export_and_validate(filepath=str(export_path1), export_textures_mode='NEW', relative_paths=True) export_path2 = self.tempdir / "usd_materials_inmem_pack_absolute.usda" self.export_and_validate(filepath=str(export_path2), export_textures_mode='NEW', relative_paths=False) # Validate that we actually see the correct set of files being saved to the filesystem # Relative path variations stage = Usd.Stage.Open(str(export_path1)) stage_path = pathlib.Path(stage.GetRootLayer().realPath) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_inmem_single/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) self.assertFalse(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(asset_path).is_file()) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_inmem_udim/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) image_path1 = pathlib.Path(str(asset_path).replace("", "1001")) image_path2 = pathlib.Path(str(asset_path).replace("", "1002")) self.assertFalse(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(image_path1).is_file()) self.assertTrue(stage_path.parent.joinpath(image_path2).is_file()) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_pack_single/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) self.assertFalse(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(asset_path).is_file()) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_pack_udim/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) image_path1 = pathlib.Path(str(asset_path).replace("", "1001")) image_path2 = pathlib.Path(str(asset_path).replace("", "1002")) self.assertFalse(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(image_path1).is_file()) self.assertTrue(stage_path.parent.joinpath(image_path2).is_file()) # Absolute path variations stage = Usd.Stage.Open(str(export_path2)) stage_path = pathlib.Path(stage.GetRootLayer().realPath) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_inmem_single/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) self.assertTrue(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(asset_path).is_file()) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_inmem_udim/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) image_path1 = pathlib.Path(str(asset_path).replace("", "1001")) image_path2 = pathlib.Path(str(asset_path).replace("", "1002")) self.assertTrue(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(image_path1).is_file()) self.assertTrue(stage_path.parent.joinpath(image_path2).is_file()) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_pack_single/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) self.assertTrue(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(asset_path).is_file()) shader_prim = stage.GetPrimAtPath("/root/_materials/MAT_pack_udim/Image_Texture") shader = UsdShade.Shader(shader_prim) asset_path = pathlib.Path(shader.GetInput("file").GetAttr().Get().path) image_path1 = pathlib.Path(str(asset_path).replace("", "1001")) image_path2 = pathlib.Path(str(asset_path).replace("", "1002")) self.assertTrue(asset_path.is_absolute()) self.assertTrue(stage_path.parent.joinpath(image_path1).is_file()) self.assertTrue(stage_path.parent.joinpath(image_path2).is_file()) def test_export_material_textures_mode(self): """Validate the non-default export textures mode options.""" # Use the common materials .blend file bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_export.blend")) # For this test, the "textures" directory should NOT exist and the image paths # should all point to the original test location, not the temp output location. def check_image_paths(stage): orig_tex_path = (self.testdir / "textures") temp_tex_path = (self.tempdir / "textures") self.assertFalse(temp_tex_path.is_dir()) shader_prim = stage.GetPrimAtPath("/root/_materials/Material/Image_Texture") shader = UsdShade.Shader(shader_prim) filepath = pathlib.Path(shader.GetInput('file').Get().path) self.assertEqual(orig_tex_path, filepath.parent) export_file = str(self.tempdir / "usd_materials_texture_preserve.usda") self.export_and_validate( filepath=export_file, export_materials=True, convert_world_material=False, export_textures_mode='PRESERVE') check_image_paths(Usd.Stage.Open(export_file)) export_file = str(self.tempdir / "usd_materials_texture_keep.usda") self.export_and_validate( filepath=export_file, export_materials=True, convert_world_material=False, export_textures_mode='KEEP') check_image_paths(Usd.Stage.Open(export_file)) def test_export_material_opacity(self): """Validate correct export of opacity/transmission setups for the UsdPreviewSurface""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_transmission.blend")) export_path = self.tempdir / "usd_materials_transmission.usda" self.export_and_validate(filepath=str(export_path), export_materials=True) stage = Usd.Stage.Open(str(export_path)) # Verify "constant" opacity shader_surface = UsdShade.Shader(stage.GetPrimAtPath("/root/_materials/MAT_transmission01/Principled_BSDF")) self.assertEqual(shader_surface.GetIdAttr().Get(), "UsdPreviewSurface") input_opacity = shader_surface.GetInput('opacity') self.assertEqual(input_opacity.HasConnectedSource(), False, "Opacity input should not be connected") self.assertAlmostEqual(input_opacity.Get(), 0.0, 3) shader_surface = UsdShade.Shader(stage.GetPrimAtPath("/root/_materials/MAT_transmission02/Principled_BSDF")) self.assertEqual(shader_surface.GetIdAttr().Get(), "UsdPreviewSurface") input_opacity = shader_surface.GetInput('opacity') self.assertEqual(input_opacity.HasConnectedSource(), False, "Opacity input should not be connected") self.assertAlmostEqual(input_opacity.Get(), 0.158, 3) # Validate simple opacity networks def validate_opacity(mat_name, expected_scale, expected_bias): shader_surface = UsdShade.Shader(stage.GetPrimAtPath(f"/root/_materials/{mat_name}/Principled_BSDF")) shader_image = UsdShade.Shader(stage.GetPrimAtPath(f"/root/_materials/{mat_name}/Image_Texture")) self.assertEqual(shader_surface.GetIdAttr().Get(), "UsdPreviewSurface") self.assertEqual(shader_image.GetIdAttr().Get(), "UsdUVTexture") input_opacity = shader_surface.GetInput('opacity') input_scale = shader_image.GetInput('scale') input_bias = shader_image.GetInput('bias') self.assertEqual(input_opacity.HasConnectedSource(), True, "Opacity input should be connected") self.assertEqual(self.round_vector(input_scale.Get()), expected_scale) self.assertEqual(self.round_vector(input_bias.Get()), expected_bias) # Validate a few texture usage networks validate_opacity("MAT_transmission03", [-1, 1, 1, 1], [1, 0, 0, 0]) validate_opacity("MAT_transmission04", [-1, 0, 0, 1], [1, 0, 0, 0]) validate_opacity("MAT_transmission05", [1, -1, 1, 1], [0, 1, 0, 0]) validate_opacity("MAT_transmission06", [1, 1, -1, 1], [0, 0, 1, 0]) def test_export_material_displacement(self): """Validate correct export of Displacement information for the UsdPreviewSurface""" # Use the common materials .blend file bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_displace.blend")) export_path = self.tempdir / "material_displace.usda" self.export_and_validate(filepath=str(export_path), export_materials=True) stage = Usd.Stage.Open(str(export_path)) # Verify "constant" displacement shader_surface = UsdShade.Shader(stage.GetPrimAtPath("/root/_materials/constant/Principled_BSDF")) self.assertEqual(shader_surface.GetIdAttr().Get(), "UsdPreviewSurface") input_displacement = shader_surface.GetInput('displacement') self.assertEqual(input_displacement.HasConnectedSource(), False, "Displacement input should not be connected") self.assertAlmostEqual(input_displacement.Get(), 0.45, 5) # Validate various Midlevel and Scale scenarios def validate_displacement(mat_name, expected_scale, expected_bias): shader_surface = UsdShade.Shader(stage.GetPrimAtPath(f"/root/_materials/{mat_name}/Principled_BSDF")) shader_image = UsdShade.Shader(stage.GetPrimAtPath(f"/root/_materials/{mat_name}/Image_Texture")) self.assertEqual(shader_surface.GetIdAttr().Get(), "UsdPreviewSurface") self.assertEqual(shader_image.GetIdAttr().Get(), "UsdUVTexture") input_displacement = shader_surface.GetInput('displacement') input_colorspace = shader_image.GetInput('sourceColorSpace') input_scale = shader_image.GetInput('scale') input_bias = shader_image.GetInput('bias') self.assertEqual(input_displacement.HasConnectedSource(), True, "Displacement input should be connected") self.assertEqual(input_colorspace.Get(), 'raw') self.assertEqual(self.round_vector(input_scale.Get()), expected_scale) self.assertEqual(self.round_vector(input_bias.Get()), expected_bias) validate_displacement("mid_0_0", [1.0, 1.0, 1.0, 1.0], [0, 0, 0, 0]) validate_displacement("mid_0_5", [1.0, 1.0, 1.0, 1.0], [-0.5, -0.5, -0.5, 0]) validate_displacement("mid_1_0", [1.0, 1.0, 1.0, 1.0], [-1, -1, -1, 0]) validate_displacement("mid_0_0_scale_0_3", [0.3, 0.3, 0.3, 1.0], [0, 0, 0, 0]) validate_displacement("mid_0_5_scale_0_3", [0.3, 0.3, 0.3, 1.0], [-0.15, -0.15, -0.15, 0]) validate_displacement("mid_1_0_scale_0_3", [0.3, 0.3, 0.3, 1.0], [-0.3, -0.3, -0.3, 0]) # Validate that no displacement occurs for scenarios USD doesn't support shader_surface = UsdShade.Shader(stage.GetPrimAtPath(f"/root/_materials/bad_wrong_space/Principled_BSDF")) input_displacement = shader_surface.GetInput('displacement') self.assertTrue(input_displacement.Get() is None) shader_surface = UsdShade.Shader(stage.GetPrimAtPath(f"/root/_materials/bad_non_const/Principled_BSDF")) input_displacement = shader_surface.GetInput('displacement') self.assertTrue(input_displacement.Get() is None) def test_export_material_attributes(self): """Validate correct export of Attribute information to UsdPrimvarReaders""" # Use the common materials .blend file bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_attributes.blend")) export_path = self.tempdir / "usd_materials_attributes.usda" self.export_and_validate(filepath=str(export_path), export_materials=True) stage = Usd.Stage.Open(str(export_path)) shader_attr = UsdShade.Shader(stage.GetPrimAtPath("/root/_materials/Material/Attribute")) shader_attr1 = UsdShade.Shader(stage.GetPrimAtPath("/root/_materials/Material/Attribute_001")) shader_attr2 = UsdShade.Shader(stage.GetPrimAtPath("/root/_materials/Material/Attribute_002")) self.assertEqual(shader_attr.GetIdAttr().Get(), "UsdPrimvarReader_float3") self.assertEqual(shader_attr1.GetIdAttr().Get(), "UsdPrimvarReader_float") self.assertEqual(shader_attr2.GetIdAttr().Get(), "UsdPrimvarReader_vector") self.assertEqual(shader_attr.GetInput("varname").Get(), "displayColor") self.assertEqual(shader_attr1.GetInput("varname").Get(), "ns:f_float") self.assertEqual(shader_attr2.GetInput("varname").Get(), "f_vec") self.assertEqual(shader_attr.GetOutput("result").GetTypeName().type.typeName, "GfVec3f") self.assertEqual(shader_attr1.GetOutput("result").GetTypeName().type.typeName, "float") self.assertEqual(shader_attr2.GetOutput("result").GetTypeName().type.typeName, "GfVec3f") def test_export_material_world(self): """Validate world material (dome light) export.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_world.blend")) # Export each World separately bpy.context.scene.world = bpy.data.worlds["WorldDefault"] export_default = self.tempdir / "usd_materials_world-default.usda" self.export_and_validate(filepath=str(export_default), convert_world_material=True, evaluation_mode="RENDER") bpy.context.scene.world = bpy.data.worlds["WorldSimple"] export_simple = self.tempdir / "usd_materials_world-simple.usda" self.export_and_validate(filepath=str(export_simple), convert_world_material=True, evaluation_mode="RENDER") bpy.context.scene.world = bpy.data.worlds["WorldMapping"] export_mapping = self.tempdir / "usd_materials_world-mapping.usda" self.export_and_validate(filepath=str(export_mapping), convert_world_material=True, evaluation_mode="RENDER") # Validate relevant information stage = Usd.Stage.Open(str(export_default)) dome_prim = UsdLux.DomeLight(stage.GetPrimAtPath("/root/env_light")) self.assertEqual(round(dome_prim.GetIntensityAttr().Get(), 4), 0.2) self.assertEqual(dome_prim.GetTextureFileAttr().Get().authoredPath, "./textures/color_0C0C0C.exr") stage = Usd.Stage.Open(str(export_simple)) dome_prim = UsdLux.DomeLight(stage.GetPrimAtPath("/root/env_light")) self.assertEqual(self.round_vector(dome_prim.GetRotateXYZOp().Get()), [90, 0, 90]) self.assertEqual(dome_prim.GetTextureFileAttr().Get().authoredPath, "./textures/test_single.png") stage = Usd.Stage.Open(str(export_mapping)) dome_prim = UsdLux.DomeLight(stage.GetPrimAtPath("/root/env_light")) self.assertEqual(self.round_vector(dome_prim.GetRotateXYZOp().Get()), [67.754, -1.033, 61.9707]) self.assertEqual(dome_prim.GetTextureFileAttr().Get().authoredPath, "./textures/test_single.png") def test_export_metaballs(self): """Validate correct export of Metaball objects. These are written out as Meshes.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_metaballs.blend")) export_path = self.tempdir / "usd_metaballs.usda" self.export_and_validate(filepath=str(export_path), evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) # There should be 3 Mesh prims and they should each correspond to the "basis" # metaball (i.e. the ones without any numeric suffix) mesh_prims = [prim for prim in stage.Traverse() if prim.IsA(UsdGeom.Mesh)] prim_names = [prim.GetPath().pathString for prim in mesh_prims] self.assertEqual(len(mesh_prims), 3) self.assertListEqual( sorted(prim_names), ["/root/Ball_A/Ball_A", "/root/Ball_B/Ball_B", "/root/Ball_C/Ball_C"]) # Make rough check of vertex counts to ensure geometry is present actual_prim_verts = {prim.GetName(): len(UsdGeom.Mesh(prim).GetPointsAttr().Get()) for prim in mesh_prims} expected_prim_verts = {"Ball_A": 2232, "Ball_B": 2876, "Ball_C": 1152} self.assertDictEqual(actual_prim_verts, expected_prim_verts) def test_particle_hair(self): """Validate correct export of particle hair emitters.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_particle_hair.blend")) # Ensure the hair dynamics are baked for all relevant frames... self.ensure_simulation_frame_range(1, 10) export_path = self.tempdir / "usd_particle_hair.usda" self.export_and_validate( filepath=str(export_path), export_hair=True, export_animation=True, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) main_prim = stage.GetPrimAtPath("/root/Sphere") hair_prim = stage.GetPrimAtPath("/root/Sphere/ParticleSystem") self.assertTrue(main_prim.IsValid()) self.assertTrue(hair_prim.IsValid()) # Ensure we have 5 frames of rotation data for the main Sphere and 10 frames for the hair data rot_samples = UsdGeom.Xformable(main_prim).GetRotateXYZOp().GetTimeSamples() self.assertEqual(len(rot_samples), 5) hair_curves = UsdGeom.BasisCurves(hair_prim) hair_samples = hair_curves.GetPointsAttr().GetTimeSamples() self.assertEqual(hair_curves.GetTypeAttr().Get(), "cubic") self.assertEqual(hair_curves.GetBasisAttr().Get(), "catmullRom") self.assertEqual(len(hair_samples), 10) def check_primvar(self, prim, pv_name, pv_typeName, pv_interp, elements_len): pv = UsdGeom.PrimvarsAPI(prim).GetPrimvar(pv_name) self.assertTrue(pv.HasValue()) self.assertEqual(pv.GetTypeName().type.typeName, pv_typeName) self.assertEqual(pv.GetInterpolation(), pv_interp) self.assertEqual(len(pv.Get()), elements_len) def check_primvar_missing(self, prim, pv_name): pv = UsdGeom.PrimvarsAPI(prim).GetPrimvar(pv_name) self.assertFalse(pv.HasValue()) def test_export_attributes(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_attribute_test.blend")) export_path = self.tempdir / "usd_attribute_test.usda" self.export_and_validate(filepath=str(export_path), evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) # Validate all expected Mesh attributes. Notice that nothing on # the Edge domain is supported by USD. prim = stage.GetPrimAtPath("/root/Mesh/Mesh") self.check_primvar(prim, "p_bool", "VtArray", "vertex", 4) self.check_primvar(prim, "p_int8", "VtArray", "vertex", 4) self.check_primvar(prim, "p_int32", "VtArray", "vertex", 4) self.check_primvar(prim, "p_float", "VtArray", "vertex", 4) self.check_primvar(prim, "p_color", "VtArray", "vertex", 4) self.check_primvar(prim, "p_byte_color", "VtArray", "vertex", 4) self.check_primvar(prim, "p_vec2", "VtArray", "vertex", 4) self.check_primvar(prim, "p_vec3", "VtArray", "vertex", 4) self.check_primvar(prim, "p_quat", "VtArray", "vertex", 4) self.check_primvar(prim, "p_mat4x4", "VtArray", "vertex", 4) self.check_primvar_missing(prim, "e_bool") self.check_primvar_missing(prim, "e_int8") self.check_primvar_missing(prim, "e_int32") self.check_primvar_missing(prim, "e_float") self.check_primvar_missing(prim, "e_color") self.check_primvar_missing(prim, "e_byte_color") self.check_primvar_missing(prim, "e_vec2") self.check_primvar_missing(prim, "e_vec3") self.check_primvar_missing(prim, "e_quat") self.check_primvar_missing(prim, "e_mat4x4") self.check_primvar(prim, "f_bool", "VtArray", "uniform", 1) self.check_primvar(prim, "f_int8", "VtArray", "uniform", 1) self.check_primvar(prim, "f_int32", "VtArray", "uniform", 1) self.check_primvar(prim, "f_float", "VtArray", "uniform", 1) self.check_primvar(prim, "f_color", "VtArray", "uniform", 1) self.check_primvar(prim, "f_byte_color", "VtArray", "uniform", 1) self.check_primvar(prim, "displayColor", "VtArray", "uniform", 1) self.check_primvar(prim, "f_vec2", "VtArray", "uniform", 1) self.check_primvar(prim, "f_vec3", "VtArray", "uniform", 1) self.check_primvar(prim, "f_quat", "VtArray", "uniform", 1) self.check_primvar(prim, "f_mat4x4", "VtArray", "uniform", 1) self.check_primvar(prim, "fc_bool", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_int8", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_int32", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_float", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_color", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_byte_color", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_vec2", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_vec3", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_quat", "VtArray", "faceVarying", 4) self.check_primvar(prim, "fc_mat4x4", "VtArray", "faceVarying", 4) # Matrix attributes need additional validation to check row-major vs. col-major differences. # Pick a representative matrix to check. pv = UsdGeom.PrimvarsAPI(prim).GetPrimvar("p_mat4x4") usd_mat = pv.Get()[3] usd_values = [usd_mat[i][j] for i in range(0, 4) for j in range(0, 4)] expected = [0.4, 0.8, 1.2, 1.6] * 4 self.assertEqual(self.round_vector(usd_values), expected) prim = stage.GetPrimAtPath("/root/Curve_base/Curves/Curves") self.check_primvar(prim, "p_bool", "VtArray", "vertex", 24) self.check_primvar(prim, "p_int8", "VtArray", "vertex", 24) self.check_primvar(prim, "p_int32", "VtArray", "vertex", 24) self.check_primvar(prim, "p_float", "VtArray", "vertex", 24) self.check_primvar(prim, "p_color", "VtArray", "vertex", 24) self.check_primvar(prim, "p_byte_color", "VtArray", "vertex", 24) self.check_primvar(prim, "p_vec2", "VtArray", "vertex", 24) self.check_primvar(prim, "p_vec3", "VtArray", "vertex", 24) self.check_primvar(prim, "p_quat", "VtArray", "vertex", 24) self.check_primvar(prim, "p_mat4x4", "VtArray", "vertex", 24) self.check_primvar(prim, "sp_bool", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_int8", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_int32", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_float", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_color", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_byte_color", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_vec2", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_vec3", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_quat", "VtArray", "uniform", 2) self.check_primvar(prim, "sp_mat4x4", "VtArray", "uniform", 2) prim = stage.GetPrimAtPath("/root/Curve_bezier_base/Curves_bezier/Curves") self.check_primvar(prim, "p_bool", "VtArray", "varying", 10) self.check_primvar(prim, "p_int8", "VtArray", "varying", 10) self.check_primvar(prim, "p_int32", "VtArray", "varying", 10) self.check_primvar(prim, "p_float", "VtArray", "varying", 10) self.check_primvar(prim, "p_color", "VtArray", "varying", 10) self.check_primvar(prim, "p_byte_color", "VtArray", "varying", 10) self.check_primvar(prim, "p_vec2", "VtArray", "varying", 10) self.check_primvar(prim, "p_vec3", "VtArray", "varying", 10) self.check_primvar(prim, "p_quat", "VtArray", "varying", 10) self.check_primvar(prim, "p_mat4x4", "VtArray", "varying", 10) self.check_primvar(prim, "sp_bool", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_int8", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_int32", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_float", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_color", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_byte_color", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_vec2", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_vec3", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_quat", "VtArray", "uniform", 3) self.check_primvar(prim, "sp_mat4x4", "VtArray", "uniform", 3) def test_export_attributes_varying(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_attribute_varying_test.blend")) # Ensure the simulation zone data is baked for all relevant frames... self.ensure_simulation_frame_range(1, 15) export_path = self.tempdir / "usd_attribute_varying_test.usda" self.export_and_validate( filepath=str(export_path), export_animation=True, incremental_frames=2, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) sparse_frames = [4.0, 5.0, 8.0, 9.0, 12.0, 13.0] # # Validate Mesh data # mesh1 = UsdGeom.Mesh(stage.GetPrimAtPath("/root/mesh1/mesh1")) mesh2 = UsdGeom.Mesh(stage.GetPrimAtPath("/root/mesh2/mesh2")) mesh3 = UsdGeom.Mesh(stage.GetPrimAtPath("/root/mesh3/mesh3")) # Positions (should be sparsely written) self.assertEqual(mesh1.GetPointsAttr().GetTimeSamples(), sparse_frames) self.assertEqual(mesh2.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(mesh3.GetPointsAttr().GetTimeSamples(), []) # Velocity (should be sparsely written) self.assertEqual(mesh1.GetVelocitiesAttr().GetTimeSamples(), []) self.assertEqual(mesh2.GetVelocitiesAttr().GetTimeSamples(), sparse_frames) self.assertEqual(mesh3.GetVelocitiesAttr().GetTimeSamples(), []) # Regular primvar (should be sparsely written) self.assertEqual(UsdGeom.PrimvarsAPI(mesh1).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(mesh2).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(mesh3).GetPrimvar("test").GetTimeSamples(), sparse_frames) # Extents of the mesh (should be sparsely written) self.assertEqual(UsdGeom.Boundable(mesh1).GetExtentAttr().GetTimeSamples(), sparse_frames) self.assertEqual(UsdGeom.Boundable(mesh2).GetExtentAttr().GetTimeSamples(), []) self.assertEqual(UsdGeom.Boundable(mesh3).GetExtentAttr().GetTimeSamples(), []) # # Validate PointCloud data # points1 = UsdGeom.Points(stage.GetPrimAtPath("/root/pointcloud1/PointCloud")) points2 = UsdGeom.Points(stage.GetPrimAtPath("/root/pointcloud2/PointCloud")) points3 = UsdGeom.Points(stage.GetPrimAtPath("/root/pointcloud3/PointCloud")) points4 = UsdGeom.Points(stage.GetPrimAtPath("/root/pointcloud4/PointCloud")) # Positions (should be sparsely written) self.assertEqual(points1.GetPointsAttr().GetTimeSamples(), sparse_frames) self.assertEqual(points2.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(points3.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(points4.GetPointsAttr().GetTimeSamples(), []) # Velocity (should be sparsely written) self.assertEqual(points1.GetVelocitiesAttr().GetTimeSamples(), []) self.assertEqual(points2.GetVelocitiesAttr().GetTimeSamples(), sparse_frames) self.assertEqual(points3.GetVelocitiesAttr().GetTimeSamples(), []) self.assertEqual(points4.GetVelocitiesAttr().GetTimeSamples(), []) # Radius (should be sparsely written) self.assertEqual(points1.GetWidthsAttr().GetTimeSamples(), []) self.assertEqual(points2.GetWidthsAttr().GetTimeSamples(), []) self.assertEqual(points3.GetWidthsAttr().GetTimeSamples(), sparse_frames) self.assertEqual(points4.GetWidthsAttr().GetTimeSamples(), []) # Regular primvar (should be sparsely written) self.assertEqual(UsdGeom.PrimvarsAPI(points1).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(points2).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(points3).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(points4).GetPrimvar("test").GetTimeSamples(), sparse_frames) # Extents of the point cloud (should be sparsely written) self.assertEqual(UsdGeom.Boundable(points1).GetExtentAttr().GetTimeSamples(), sparse_frames) self.assertEqual(UsdGeom.Boundable(points2).GetExtentAttr().GetTimeSamples(), []) self.assertEqual(UsdGeom.Boundable(points3).GetExtentAttr().GetTimeSamples(), sparse_frames) self.assertEqual(UsdGeom.Boundable(points4).GetExtentAttr().GetTimeSamples(), []) # # Validate BasisCurve data # curves1 = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/curves_plane1/curves1/Curves")) curves2 = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/curves_plane2/curves2/Curves")) curves3 = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/curves_plane3/curves3/Curves")) curves4 = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/curves_plane4/curves4/Curves")) # Positions (should be sparsely written) self.assertEqual(curves1.GetPointsAttr().GetTimeSamples(), sparse_frames) self.assertEqual(curves2.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(curves3.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(curves4.GetPointsAttr().GetTimeSamples(), []) # Velocity (should be sparsely written) self.assertEqual(curves1.GetVelocitiesAttr().GetTimeSamples(), []) self.assertEqual(curves2.GetVelocitiesAttr().GetTimeSamples(), sparse_frames) self.assertEqual(curves3.GetVelocitiesAttr().GetTimeSamples(), []) self.assertEqual(curves4.GetVelocitiesAttr().GetTimeSamples(), []) # Radius (should be sparsely written) self.assertEqual(curves1.GetWidthsAttr().GetTimeSamples(), []) self.assertEqual(curves2.GetWidthsAttr().GetTimeSamples(), []) self.assertEqual(curves3.GetWidthsAttr().GetTimeSamples(), sparse_frames) self.assertEqual(curves4.GetWidthsAttr().GetTimeSamples(), []) # Regular primvar (should be sparsely written) self.assertEqual(UsdGeom.PrimvarsAPI(curves1).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(curves2).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(curves3).GetPrimvar("test").GetTimeSamples(), []) self.assertEqual(UsdGeom.PrimvarsAPI(curves4).GetPrimvar("test").GetTimeSamples(), sparse_frames) def test_export_mesh_subd(self): """Test exporting Subdivision Surface attributes and values""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_mesh_subd.blend")) export_path = self.tempdir / "usd_mesh_subd.usda" self.export_and_validate( filepath=str(export_path), export_subdivision='BEST_MATCH', evaluation_mode="RENDER", ) stage = Usd.Stage.Open(str(export_path)) mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_none_boundary_smooth_all/mesh1")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'all') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_corners_boundary_smooth_all/mesh2")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'cornersOnly') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_corners_junctions_boundary_smooth_all/mesh3")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'cornersPlus1') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_corners_junctions_concave_boundary_smooth_all/mesh4")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'cornersPlus2') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_boundaries_boundary_smooth_all/mesh5")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'boundaries') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_all_boundary_smooth_all/mesh6")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'none') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/uv_smooth_boundaries_boundary_smooth_keep/mesh7")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'boundaries') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeAndCorner') mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/crease_verts/crease_verts")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'boundaries') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') self.assertEqual(len(mesh.GetCornerIndicesAttr().Get()), 7) usd_vert_sharpness = mesh.GetCornerSharpnessesAttr().Get() self.assertEqual(len(usd_vert_sharpness), 7) # A 1.0 crease is INFINITE (10) in USD self.assertAlmostEqual(min(usd_vert_sharpness), 0.1, 5) self.assertEqual(len([sharp for sharp in usd_vert_sharpness if sharp < 10]), 6) self.assertEqual(len([sharp for sharp in usd_vert_sharpness if sharp == 10]), 1) mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/crease_edge/crease_edge")) self.assertEqual(mesh.GetSubdivisionSchemeAttr().Get(), 'catmullClark') self.assertEqual(mesh.GetFaceVaryingLinearInterpolationAttr().Get(), 'boundaries') self.assertEqual(mesh.GetInterpolateBoundaryAttr().Get(), 'edgeOnly') self.assertEqual(len(mesh.GetCreaseIndicesAttr().Get()), 20) usd_crease_lengths = mesh.GetCreaseLengthsAttr().Get() self.assertEqual(len(usd_crease_lengths), 10) self.assertTrue(all([length == 2 for length in usd_crease_lengths])) usd_crease_sharpness = mesh.GetCreaseSharpnessesAttr().Get() self.assertEqual(len(usd_crease_sharpness), 10) # A 1.0 crease is INFINITE (10) in USD self.assertAlmostEqual(min(usd_crease_sharpness), 0.1, 5) self.assertEqual(len([sharp for sharp in usd_crease_sharpness if sharp < 10]), 9) self.assertEqual(len([sharp for sharp in usd_crease_sharpness if sharp == 10]), 1) def test_export_mesh_triangulate(self): """Test exporting with different triangulation options for meshes.""" # Use the current scene to create simple geometry to triangulate bpy.ops.mesh.primitive_plane_add(size=1) bpy.ops.mesh.primitive_circle_add(fill_type='NGON', radius=1, vertices=7) # We assume that triangulation is thoroughly tested elsewhere. Here we are only interested # in checking that USD passes its operator properties through correctly. We use a minimal # combination of quad and ngon methods to test. tri_export_path1 = self.tempdir / "usd_mesh_tri_setup1.usda" self.export_and_validate( filepath=str(tri_export_path1), triangulate_meshes=True, quad_method='FIXED', ngon_method='BEAUTY', evaluation_mode="RENDER", ) tri_export_path2 = self.tempdir / "usd_mesh_tri_setup2.usda" self.export_and_validate( filepath=str(tri_export_path2), triangulate_meshes=True, quad_method='FIXED_ALTERNATE', ngon_method='CLIP', evaluation_mode="RENDER", ) stage1 = Usd.Stage.Open(str(tri_export_path1)) stage2 = Usd.Stage.Open(str(tri_export_path2)) # The Plane should have different vertex ordering because of the quad methods chosen plane1 = UsdGeom.Mesh(stage1.GetPrimAtPath("/root/Plane/Plane")) plane2 = UsdGeom.Mesh(stage2.GetPrimAtPath("/root/Plane/Plane")) indices1 = plane1.GetFaceVertexIndicesAttr().Get() indices2 = plane2.GetFaceVertexIndicesAttr().Get() self.assertEqual(len(indices1), 6) self.assertEqual(len(indices2), 6) self.assertNotEqual(indices1, indices2) # The Circle should have different vertex ordering because of the ngon methods chosen circle1 = UsdGeom.Mesh(stage1.GetPrimAtPath("/root/Circle/Circle")) circle2 = UsdGeom.Mesh(stage2.GetPrimAtPath("/root/Circle/Circle")) indices1 = circle1.GetFaceVertexIndicesAttr().Get() indices2 = circle2.GetFaceVertexIndicesAttr().Get() self.assertEqual(len(indices1), 15) self.assertEqual(len(indices2), 15) self.assertNotEqual(indices1, indices2) def test_export_point_ids(self): """Validate we can export animated PointCloud IDs""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_point_ids.blend")) # Ensure the simulation zone data is baked for all relevant frames... self.ensure_simulation_frame_range(1, 6) export_path = self.tempdir / "usd_point_ids.usda" self.export_and_validate(filepath=str(export_path), export_animation=True, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) # # Validate PointCloud data # points1 = UsdGeom.Points(stage.GetPrimAtPath("/root/pointcloud1/PointCloud")) # IDs attr_ids = points1.GetIdsAttr() self.assertEqual(attr_ids.GetTimeSamples(), [1.0, 2.0, 3.0, 4.0, 5.0, 6.0]) self.assertEqual(attr_ids.Get(1), [3]) self.assertEqual(attr_ids.Get(2), [6]) self.assertEqual(attr_ids.Get(3), [6, 9]) self.assertEqual(attr_ids.Get(4), [9, 12]) self.assertEqual(attr_ids.Get(5), [12, 15]) self.assertEqual(attr_ids.Get(6), [12, 15, 18]) def test_export_curves(self): """Test exporting Curve types""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_curves_test.blend")) export_path = self.tempdir / "usd_curves_test.usda" self.export_and_validate(filepath=str(export_path), evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) def check_basis_curve(prim, basis, curve_type, wrap, vert_counts, extent): self.assertEqual(prim.GetBasisAttr().Get(), basis) self.assertEqual(prim.GetTypeAttr().Get(), curve_type) self.assertEqual(prim.GetWrapAttr().Get(), wrap) self.assertEqual(prim.GetWidthsInterpolation(), "varying" if basis == "bezier" else "vertex") self.assertEqual(prim.GetCurveVertexCountsAttr().Get(), vert_counts) usd_extent = prim.GetExtentAttr().Get() self.assertEqual(self.round_vector(usd_extent[0]), extent[0]) self.assertEqual(self.round_vector(usd_extent[1]), extent[1]) def check_nurbs_curve(prim, cyclic, orders, vert_counts, weights, knots_count, extent): self.assertEqual(prim.GetOrderAttr().Get(), orders) self.assertEqual(prim.GetCurveVertexCountsAttr().Get(), vert_counts) self.assertEqual(self.round_vector(prim.GetPointWeightsAttr().Get()), weights) self.assertEqual(prim.GetWidthsInterpolation(), "vertex") knots = prim.GetKnotsAttr().Get() usd_extent = prim.GetExtentAttr().Get() self.assertEqual(self.round_vector(usd_extent[0]), extent[0]) self.assertEqual(self.round_vector(usd_extent[1]), extent[1]) curve_count = len(vert_counts) self.assertEqual(len(knots), knots_count * curve_count) if not cyclic: for i in range(0, curve_count): zeroth_knot = i * len(knots) // curve_count self.assertEqual(knots[zeroth_knot], knots[zeroth_knot + 1], "Knots start rule violated") self.assertEqual( knots[zeroth_knot + knots_count - 1], knots[zeroth_knot + knots_count - 2], "Knots end rule violated") else: self.assertEqual(curve_count, 1, "Validation is only correct for 1 cyclic curve currently") self.assertEqual( knots[0], knots[1] - (knots[knots_count - 2] - knots[knots_count - 3]), "Knots rule violated") self.assertEqual( knots[knots_count - 1], knots[knots_count - 2] + (knots[2] - knots[1]), "Knots rule violated") # Contains 3 CatmullRom curves curve = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/Cube/Curves/Curves")) check_basis_curve( curve, "catmullRom", "cubic", "pinned", [8, 8, 8], [[-0.3884, -0.0966, 0.99], [0.2814, -0.0388, 1.31]]) # Contains 1 Bezier curve curve = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/BezierCurve/BezierCurve")) check_basis_curve(curve, "bezier", "cubic", "nonperiodic", [7], [[-3.644, -1.0777, -1.0], [2.0, 1.9815, 1.0]]) # Contains 1 Bezier curve curve = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/BezierCircle/BezierCircle")) check_basis_curve(curve, "bezier", "cubic", "periodic", [12], [[-2.0, -2.0, -1.0], [2.0, 2.0, 1.0]]) # Contains 2 NURBS curves curve = UsdGeom.NurbsCurves(stage.GetPrimAtPath("/root/NurbsCurve/NurbsCurve")) weights = [1] * 12 check_nurbs_curve( curve, False, [4, 4], [6, 6], weights, 10, [[-1.75, -2.6891, -1.0117], [3.0896, 1.9583, 1.0293]]) # Contains 1 NURBS curve curve = UsdGeom.NurbsCurves(stage.GetPrimAtPath("/root/NurbsCircle/NurbsCircle")) weights = self.round_vector([1, math.sqrt(2) / 2] * 5) check_nurbs_curve(curve, True, [3], [10], weights, 13, [[-2, -2, -1], [2, 2, 1]]) def test_export_curves_empty(self): """Test exporting Curves that are empty""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_curves_empty.blend")) # Ensure the simulation zone data is baked for all relevant frames... self.ensure_simulation_frame_range(1, 4) export_path = self.tempdir / "usd_curves_empty.usda" self.export_and_validate(filepath=str(export_path), export_animation=True, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) def check_attribute_lengths(curve, frame, vert_counts, point_counts, width_counts): self.assertEqual(len(curve.GetCurveVertexCountsAttr().Get(frame)), vert_counts) self.assertEqual(len(curve.GetPointsAttr().Get(frame)), point_counts) self.assertEqual(len(curve.GetWidthsAttr().Get(frame)), width_counts) curve = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/BézierCurve/BézierCurve")) check_attribute_lengths(curve, 1, 0, 0, 0) curve = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/Curves/Curves")) check_attribute_lengths(curve, 1, 42, 336, 336) check_attribute_lengths(curve, 2, 2, 16, 16) check_attribute_lengths(curve, 3, 0, 0, 0) check_attribute_lengths(curve, 4, 1, 2, 2) def test_export_animation(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_anim_test.blend")) export_path = self.tempdir / "usd_anim_test.usda" self.export_and_validate( filepath=str(export_path), export_animation=True, evaluation_mode="RENDER", ) stage = Usd.Stage.Open(str(export_path)) # Validate the simple object animation prim = stage.GetPrimAtPath("/root/cube_anim_xform") self.assertEqual(prim.GetTypeName(), "Xform") loc_samples = UsdGeom.Xformable(prim).GetTranslateOp().GetTimeSamples() rot_samples = UsdGeom.Xformable(prim).GetRotateXYZOp().GetTimeSamples() scale_samples = UsdGeom.Xformable(prim).GetScaleOp().GetTimeSamples() self.assertEqual(loc_samples, [1.0, 2.0, 3.0, 4.0]) self.assertEqual(rot_samples, [1.0]) self.assertEqual(scale_samples, [1.0]) prim = stage.GetPrimAtPath("/root/cube_anim_xform/cube_anim_child") self.assertEqual(prim.GetTypeName(), "Xform") loc_samples = UsdGeom.Xformable(prim).GetTranslateOp().GetTimeSamples() rot_samples = UsdGeom.Xformable(prim).GetRotateXYZOp().GetTimeSamples() scale_samples = UsdGeom.Xformable(prim).GetScaleOp().GetTimeSamples() self.assertEqual(loc_samples, [1.0]) self.assertEqual(rot_samples, [1.0, 2.0, 3.0, 4.0]) self.assertEqual(scale_samples, [1.0]) # Validate the armature animation prim = stage.GetPrimAtPath("/root/Armature/Armature") self.assertEqual(prim.GetTypeName(), "Skeleton") prim_skel = UsdSkel.BindingAPI(prim) anim = UsdSkel.Animation(prim_skel.GetAnimationSource()) self.assertEqual(anim.GetPrim().GetName(), "ArmatureAction_001") self.assertEqual(anim.GetJointsAttr().Get(), ['Bone', 'Bone/Bone_001', 'Bone/Bone_001/Bone_002', 'Bone/Bone_001/Bone_002/Bone_003', 'Bone/Bone_001/Bone_002/Bone_003/Bone_004']) loc_samples = anim.GetTranslationsAttr().GetTimeSamples() rot_samples = anim.GetRotationsAttr().GetTimeSamples() scale_samples = anim.GetScalesAttr().GetTimeSamples() self.assertEqual(loc_samples, []) self.assertEqual(rot_samples, [1.0, 2.0, 3.0]) self.assertEqual(scale_samples, []) # Validate the shape key animation prim = stage.GetPrimAtPath("/root/cube_anim_keys") self.assertEqual(prim.GetTypeName(), "SkelRoot") prim_skel = UsdSkel.BindingAPI(prim.GetPrimAtPath("cube_anim_keys")) self.assertEqual(prim_skel.GetBlendShapesAttr().Get(), ['Key_1']) prim_skel = UsdSkel.BindingAPI(prim.GetPrimAtPath("Skel")) anim = UsdSkel.Animation(prim_skel.GetAnimationSource()) weight_samples = anim.GetBlendShapeWeightsAttr().GetTimeSamples() self.assertEqual(weight_samples, [1.0, 2.0, 3.0, 4.0, 5.0]) def test_export_animation_missing_geo(self): """Test that animated geometry export handles frames containing no data.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_anim_missing_geo.blend")) # Ensure the simulation zone data is baked for all relevant frames... self.ensure_simulation_frame_range(1, 9) export_path = self.tempdir / "usd_anim_missing_geo.usda" self.export_and_validate( filepath=str(export_path), convert_world_material=False, export_animation=True, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) stats = UsdUtils.ComputeUsdStageStats(stage) self.assertEqual(stats["primary"]["primCountsByType"], {'BasisCurves': 1, 'Mesh': 1, 'Xform': 3}) mesh_prim = UsdGeom.Mesh(stage.GetPrimAtPath("/root/Plane/Plane")) curve_prim = UsdGeom.BasisCurves(stage.GetPrimAtPath("/root/Curves/Curves")) # Frames 1-3 and 7-9 contain no data. Frames 4-6 contain data. The USD writer should encode # this sequence with data for frames 3, 4, 6, and 7. expected_time_samples = [3.0, 4.0, 6.0, 7.0] # Validate mesh data self.assertEqual(mesh_prim.GetPointsAttr().GetTimeSamples(), expected_time_samples) self.assertEqual(mesh_prim.GetFaceVertexCountsAttr().GetTimeSamples(), expected_time_samples) self.assertEqual(mesh_prim.GetFaceVertexIndicesAttr().GetTimeSamples(), expected_time_samples) self.assertEqual(mesh_prim.GetNormalsAttr().GetTimeSamples(), expected_time_samples) self.assertEqual( [len(mesh_prim.GetPointsAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 4, 4, 4, 0, 0, 0]) self.assertEqual( [len(mesh_prim.GetFaceVertexCountsAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 1, 1, 1, 0, 0, 0]) self.assertEqual( [len(mesh_prim.GetFaceVertexIndicesAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 4, 4, 4, 0, 0, 0]) self.assertEqual( [len(mesh_prim.GetNormalsAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 4, 4, 4, 0, 0, 0]) # Validate curve data self.assertEqual(curve_prim.GetPointsAttr().GetTimeSamples(), expected_time_samples) self.assertEqual(curve_prim.GetCurveVertexCountsAttr().GetTimeSamples(), expected_time_samples) self.assertEqual(curve_prim.GetWidthsAttr().GetTimeSamples(), expected_time_samples) self.assertEqual( [len(curve_prim.GetPointsAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 3, 3, 3, 0, 0, 0]) self.assertEqual( [len(curve_prim.GetCurveVertexCountsAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 1, 1, 1, 0, 0, 0]) self.assertEqual( [len(curve_prim.GetWidthsAttr().Get(frame)) for frame in range(1, 10)], [0, 0, 0, 3, 3, 3, 0, 0, 0]) def test_export_text(self): """Test various forms of Text/Font export.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_text_test.blend")) export_path = str(self.tempdir / "usd_text_test.usda") self.export_and_validate(filepath=export_path, export_animation=True, evaluation_mode="RENDER") stats = UsdUtils.ComputeUsdStageStats(export_path) stage = Usd.Stage.Open(export_path) # There should be 4 meshes in the output self.assertEqual(stats['primary']['primCountsByType']['Mesh'], 4) bboxcache_frame1 = UsdGeom.BBoxCache(1.0, [UsdGeom.Tokens.default_]) bboxcache_frame5 = UsdGeom.BBoxCache(5.0, [UsdGeom.Tokens.default_]) # Static, flat, text mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/static/static")) bounds1 = bboxcache_frame1.ComputeWorldBound(mesh.GetPrim()) bbox1 = bounds1.GetRange().GetMax() - bounds1.GetRange().GetMin() self.assertEqual(mesh.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(mesh.GetExtentAttr().GetTimeSamples(), []) self.assertTrue(bbox1[0] > 0.0) self.assertTrue(bbox1[1] > 0.0) self.assertAlmostEqual(bbox1[2], 0.0, 5) # Dynamic, flat, text mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/dynamic/dynamic")) bounds1 = bboxcache_frame1.ComputeWorldBound(mesh.GetPrim()) bounds5 = bboxcache_frame5.ComputeWorldBound(mesh.GetPrim()) bbox1 = bounds1.GetRange().GetMax() - bounds1.GetRange().GetMin() bbox5 = bounds5.GetRange().GetMax() - bounds5.GetRange().GetMin() self.assertEqual(mesh.GetPointsAttr().GetTimeSamples(), [1.0, 2.0, 3.0, 4.0, 5.0]) self.assertEqual(mesh.GetExtentAttr().GetTimeSamples(), [1.0, 2.0, 3.0, 4.0, 5.0]) self.assertEqual(bbox1[2], 0.0) self.assertTrue(bbox1[0] < bbox5[0]) # Text grows on x-axis self.assertAlmostEqual(bbox1[1], bbox5[1], 5) self.assertAlmostEqual(bbox1[2], bbox5[2], 5) # Static, extruded on Z, text mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/extruded/extruded")) bounds1 = bboxcache_frame1.ComputeWorldBound(mesh.GetPrim()) bbox1 = bounds1.GetRange().GetMax() - bounds1.GetRange().GetMin() self.assertEqual(mesh.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(mesh.GetExtentAttr().GetTimeSamples(), []) self.assertTrue(bbox1[0] > 0.0) self.assertTrue(bbox1[1] > 0.0) self.assertAlmostEqual(bbox1[2], 0.1, 5) # Static, uses depth, text mesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/has_depth/has_depth")) bounds1 = bboxcache_frame1.ComputeWorldBound(mesh.GetPrim()) bbox1 = bounds1.GetRange().GetMax() - bounds1.GetRange().GetMin() self.assertEqual(mesh.GetPointsAttr().GetTimeSamples(), []) self.assertEqual(mesh.GetExtentAttr().GetTimeSamples(), []) self.assertTrue(bbox1[0] > 0.0) self.assertTrue(bbox1[1] > 0.0) self.assertAlmostEqual(bbox1[2], 0.1, 5) def test_export_volumes(self): """Test various combinations of volume export including with all supported volume modifiers.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_volumes.blend")) # Ensure the simulation zone data is baked for all relevant frames... self.ensure_simulation_frame_range(4, 14) export_path = self.tempdir / "usd_volumes.usda" self.export_and_validate(filepath=str(export_path), export_animation=True, evaluation_mode="RENDER") stage = Usd.Stage.Open(str(export_path)) # Validate that we see some form of time varyability across the Volume prim's extents and # file paths. The data should be sparse so it should only be written on the frames which # change. # File sequence vol_fileseq = UsdVol.Volume(stage.GetPrimAtPath("/root/vol_filesequence/vol_filesequence")) density = UsdVol.OpenVDBAsset(stage.GetPrimAtPath("/root/vol_filesequence/vol_filesequence/density_noise")) flame = UsdVol.OpenVDBAsset(stage.GetPrimAtPath("/root/vol_filesequence/vol_filesequence/flame_noise")) self.assertEqual(vol_fileseq.GetExtentAttr().GetTimeSamples(), [10.0, 11.0]) self.assertEqual(density.GetFieldNameAttr().GetTimeSamples(), []) self.assertEqual(density.GetFilePathAttr().GetTimeSamples(), [8.0, 9.0, 10.0, 11.0, 12.0, 13.0]) self.assertEqual(flame.GetFieldNameAttr().GetTimeSamples(), []) self.assertEqual(flame.GetFilePathAttr().GetTimeSamples(), [8.0, 9.0, 10.0, 11.0, 12.0, 13.0]) # Mesh To Volume vol_mesh2vol = UsdVol.Volume(stage.GetPrimAtPath("/root/vol_mesh2vol/vol_mesh2vol")) density = UsdVol.OpenVDBAsset(stage.GetPrimAtPath("/root/vol_mesh2vol/vol_mesh2vol/density")) self.assertEqual(vol_mesh2vol.GetExtentAttr().GetTimeSamples(), [5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0]) self.assertEqual(density.GetFieldNameAttr().GetTimeSamples(), []) self.assertEqual(density.GetFilePathAttr().GetTimeSamples(), [4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0]) # Volume Displace vol_displace = UsdVol.Volume(stage.GetPrimAtPath("/root/vol_displace/vol_displace")) unnamed = UsdVol.OpenVDBAsset(stage.GetPrimAtPath("/root/vol_displace/vol_displace/_")) self.assertEqual(vol_displace.GetExtentAttr().GetTimeSamples(), [5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0]) self.assertEqual(unnamed.GetFieldNameAttr().GetTimeSamples(), []) self.assertEqual(unnamed.GetFilePathAttr().GetTimeSamples(), [4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0]) # Geometry Node simulation vol_sim = UsdVol.Volume(stage.GetPrimAtPath("/root/vol_sim/Volume")) density = UsdVol.OpenVDBAsset(stage.GetPrimAtPath("/root/vol_sim/Volume/density")) self.assertEqual(vol_sim.GetExtentAttr().GetTimeSamples(), [4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0]) self.assertEqual(density.GetFieldNameAttr().GetTimeSamples(), []) self.assertEqual(density.GetFilePathAttr().GetTimeSamples(), [4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0]) def test_export_xform_ops(self): """Test exporting different xform operation modes.""" # Create a simple scene and export using each of our xform op modes bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "empty.blend")) loc = [1, 2, 3] rot = [math.pi / 4, 0, math.pi / 8] scale = [1, 2, 3] bpy.ops.mesh.primitive_plane_add(location=loc, rotation=rot) bpy.data.objects[0].scale = scale test_path1 = self.tempdir / "temp_xform_trs_test.usda" self.export_and_validate(filepath=str(test_path1), xform_op_mode='TRS') test_path2 = self.tempdir / "temp_xform_tos_test.usda" self.export_and_validate(filepath=str(test_path2), xform_op_mode='TOS') test_path3 = self.tempdir / "temp_xform_mat_test.usda" self.export_and_validate(filepath=str(test_path3), xform_op_mode='MAT') # Validate relevant details for each case stage = Usd.Stage.Open(str(test_path1)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/root/Plane")) rot_degs = [math.degrees(rot[0]), math.degrees(rot[1]), math.degrees(rot[2])] self.assertEqual(xf.GetXformOpOrderAttr().Get(), ['xformOp:translate', 'xformOp:rotateXYZ', 'xformOp:scale']) self.assertEqual(self.round_vector(xf.GetTranslateOp().Get()), loc) self.assertEqual(self.round_vector(xf.GetRotateXYZOp().Get()), rot_degs) self.assertEqual(self.round_vector(xf.GetScaleOp().Get()), scale) stage = Usd.Stage.Open(str(test_path2)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/root/Plane")) orient_quat = xf.GetOrientOp().Get() self.assertEqual(xf.GetXformOpOrderAttr().Get(), ['xformOp:translate', 'xformOp:orient', 'xformOp:scale']) self.assertEqual(self.round_vector(xf.GetTranslateOp().Get()), loc) self.assertEqual(round(orient_quat.GetReal(), 4), 0.9061) self.assertEqual(self.round_vector(orient_quat.GetImaginary()), [0.3753, 0.0747, 0.1802]) self.assertEqual(self.round_vector(xf.GetScaleOp().Get()), scale) stage = Usd.Stage.Open(str(test_path3)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/root/Plane")) mat = xf.GetTransformOp().Get() mat = [ self.round_vector(mat[0]), self.round_vector(mat[1]), self.round_vector(mat[2]), self.round_vector(mat[3]) ] expected = [ [0.9239, 0.3827, 0.0, 0.0], [-0.5412, 1.3066, 1.4142, 0.0], [0.8118, -1.9598, 2.1213, 0.0], [1.0, 2.0, 3.0, 1.0] ] self.assertEqual(xf.GetXformOpOrderAttr().Get(), ['xformOp:transform']) self.assertEqual(mat, expected) def test_export_orientation(self): """Test exporting different orientation configurations.""" # Using the empty scene is fine for checking Stage metadata bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "empty.blend")) test_path1 = self.tempdir / "temp_orientation_yup.usda" self.export_and_validate( filepath=str(test_path1), convert_orientation=True, export_global_forward_selection='NEGATIVE_Z', export_global_up_selection='Y') test_path2 = self.tempdir / "temp_orientation_zup_rev.usda" self.export_and_validate( filepath=str(test_path2), convert_orientation=True, export_global_forward_selection='NEGATIVE_Y', export_global_up_selection='Z') stage = Usd.Stage.Open(str(test_path1)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/root")) self.assertEqual(self.round_vector(xf.GetRotateXYZOp().Get()), [-90, 0, 0]) stage = Usd.Stage.Open(str(test_path2)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/root")) self.assertEqual(self.round_vector(xf.GetRotateXYZOp().Get()), [0, 0, 180]) # Check one final orientation using no /root xform at all (it's a different code path) bpy.ops.mesh.primitive_cube_add() test_path3 = self.tempdir / "temp_orientation_non_root.usda" self.export_and_validate(filepath=str(test_path3), convert_orientation=True, root_prim_path="") stage = Usd.Stage.Open(str(test_path3)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/Cube")) self.assertEqual(self.round_vector(xf.GetRotateXYZOp().Get()), [-90, 0, 0]) def test_materialx_network(self): """Test exporting that a MaterialX export makes it out alright""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_export.blend")) export_path = self.tempdir / "materialx.usda" # USD currently has an issue where embedded MaterialX graphs cause validation to fail. # Note: We use the below patch for now; keep this in mind if it causes issues in the future. # See: https://github.com/PixarAnimationStudios/OpenUSD/pull/3243 res = self.export_and_validate( filepath=str(export_path), export_materials=True, generate_materialx_network=True, evaluation_mode="RENDER", ) stage = Usd.Stage.Open(str(export_path)) material_prim = stage.GetPrimAtPath("/root/_materials/Material") self.assertTrue(material_prim, "Could not find Material prim") self.assertTrue(material_prim.HasAPI(UsdMtlx.MaterialXConfigAPI)) mtlx_config_api = UsdMtlx.MaterialXConfigAPI(material_prim) mtlx_version_attr = mtlx_config_api.GetConfigMtlxVersionAttr() self.assertTrue(mtlx_version_attr, "Could not find mtlx config version attribute") material = UsdShade.Material(material_prim) mtlx_output = material.GetOutput("mtlx:surface") self.assertTrue(mtlx_output, "Could not find mtlx output") connection, source_name, _ = UsdShade.ConnectableAPI.GetConnectedSource( mtlx_output ) or [None, None, None] self.assertTrue((connection and source_name), "Could not find mtlx output source") shader = UsdShade.Shader(connection.GetPrim()) self.assertTrue(shader, "Connected prim is not a shader") shader_id = shader.GetIdAttr().Get() self.assertEqual(shader_id, "ND_open_pbr_surface_surfaceshader", "Shader is not an OpenPBR Surface") def test_get_prim_map_export_xfrom_not_merged_animated(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_anim_test.blend")) bpy.data.scenes["Scene"].frame_end = 2 bpy.utils.register_class(GetPrimMapUsdExportHook) bpy.ops.wm.usd_export( filepath=str(self.tempdir / "test_prim_map_export.usda"), merge_parent_xform=False, export_animation=True ) prim_map = GetPrimMapUsdExportHook.prim_map bpy.utils.unregister_class(GetPrimMapUsdExportHook) expected_prim_map = { Sdf.Path('/root/cube_anim_xform/cube_anim_child'): [bpy.data.objects['cube_anim_child']], Sdf.Path('/root/Armature/column_anim_armature/column_anim_armature'): [bpy.data.meshes['column_anim_armature']], Sdf.Path('/root/_materials/Material'): [bpy.data.materials['Material']], Sdf.Path('/root/Armature2/side_b'): [bpy.data.objects['side_b']], Sdf.Path('/root/Armature2/side_b/side_b'): [bpy.data.meshes['side_b']], Sdf.Path('/root/cube_anim_keys'): [bpy.data.objects['cube_anim_keys']], Sdf.Path('/root/Armature2/side_a'): [bpy.data.objects['side_a']], Sdf.Path('/root/cube_anim_xform/cube_anim_child/cube_anim_child_mesh'): [bpy.data.meshes['cube_anim_child_mesh']], Sdf.Path('/root/Armature'): [bpy.data.objects['Armature']], Sdf.Path('/root/cube_anim_xform/cube_anim_xform_mesh'): [bpy.data.meshes['cube_anim_xform_mesh']], Sdf.Path('/root/Armature2'): [bpy.data.objects['Armature2']], Sdf.Path('/root/Armature/column_anim_armature'): [bpy.data.objects['column_anim_armature']], Sdf.Path('/root/cube_anim_keys/cube_anim_keys'): [bpy.data.meshes['cube_anim_keys']], Sdf.Path('/root/cube_anim_xform'): [bpy.data.objects['cube_anim_xform']], Sdf.Path('/root/Armature2/side_a/side_a'): [bpy.data.meshes['side_a']], } self.assertDictEqual(prim_map, expected_prim_map) def test_get_prim_map_export_xfrom_not_merged(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_extent_test.blend")) bpy.utils.register_class(GetPrimMapUsdExportHook) bpy.ops.wm.usd_export(filepath=str(self.tempdir / "test_prim_map_export.usda"), merge_parent_xform=False) prim_map = GetPrimMapUsdExportHook.prim_map bpy.utils.unregister_class(GetPrimMapUsdExportHook) expected_prim_map = { Sdf.Path('/root/_materials/Material'): [bpy.data.materials['Material']], Sdf.Path('/root/Camera'): [bpy.data.objects['Camera']], Sdf.Path('/root/Camera/Camera'): [bpy.data.cameras['Camera']], Sdf.Path('/root/Light'): [bpy.data.objects['Light']], Sdf.Path('/root/Light/Light'): [bpy.data.lights['Light']], Sdf.Path('/root/scene'): [bpy.data.objects['scene']], Sdf.Path('/root/scene/BigCube'): [bpy.data.objects['BigCube']], Sdf.Path('/root/scene/BigCube/BigCubeMesh'): [bpy.data.meshes['BigCubeMesh']], Sdf.Path('/root/scene/LittleCube'): [bpy.data.objects['LittleCube']], Sdf.Path('/root/scene/LittleCube/LittleCubeMesh'): [bpy.data.meshes['LittleCubeMesh']], Sdf.Path('/root/scene/Volume'): [bpy.data.objects['Volume']], } self.assertDictEqual(prim_map, expected_prim_map) def test_get_prim_map_export_xfrom_merged(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_extent_test.blend")) bpy.utils.register_class(GetPrimMapUsdExportHook) bpy.ops.wm.usd_export(filepath=str(self.tempdir / "test_prim_map_export.usda"), merge_parent_xform=True) prim_map = GetPrimMapUsdExportHook.prim_map bpy.utils.unregister_class(GetPrimMapUsdExportHook) expected_prim_map = { Sdf.Path('/root/_materials/Material'): [bpy.data.materials['Material']], Sdf.Path('/root/Camera'): [bpy.data.objects['Camera'], bpy.data.cameras['Camera']], Sdf.Path('/root/Light'): [bpy.data.objects['Light'], bpy.data.lights['Light']], Sdf.Path('/root/scene'): [bpy.data.objects['scene']], Sdf.Path('/root/scene/BigCube'): [bpy.data.objects['BigCube'], bpy.data.meshes['BigCubeMesh']], Sdf.Path('/root/scene/LittleCube'): [bpy.data.objects['LittleCube'], bpy.data.meshes['LittleCubeMesh']], Sdf.Path('/root/scene/Volume'): [bpy.data.objects['Volume']], } self.assertDictEqual(prim_map, expected_prim_map) def test_hooks(self): """Validate USD Hook integration for both import and export""" # Create a simple scene with 1 object and 1 material bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "empty.blend")) material = bpy.data.materials.new(name="test_material") node_tree = material.node_tree node_tree.nodes.clear() bsdf = node_tree.nodes.new("ShaderNodeBsdfPrincipled") output = node_tree.nodes.new("ShaderNodeOutputMaterial") node_tree.links.new(bsdf.outputs["BSDF"], output.inputs["Surface"]) bpy.ops.mesh.primitive_plane_add() bpy.data.objects[0].data.materials.append(material) # Register both USD hooks bpy.utils.register_class(USDHook1) bpy.utils.register_class(USDHook2) # Instruct them to do various actions inside their implementation USDHookBase.instructions = { "on_material_export": ["return False", "return True"], "on_export": ["throw", "return True"], "on_import": ["throw", "return True"], } USDHookBase.responses = { "on_material_export": [], "on_export": [], "on_import": [], } test_path = self.tempdir / "hook.usda" try: self.export_and_validate(filepath=str(test_path)) except: pass try: bpy.ops.wm.usd_import(filepath=str(test_path)) except: pass # Unregister the hooks. We do this here in case the following asserts fail. bpy.utils.unregister_class(USDHook1) bpy.utils.unregister_class(USDHook2) # Validate that the Hooks executed and responded accordingly... self.assertEqual(USDHookBase.responses["on_material_export"], ["returned False", "returned True"]) self.assertEqual(USDHookBase.responses["on_export"], ["threw exception", "returned True"]) self.assertEqual(USDHookBase.responses["on_import"], ["threw exception", "returned True"]) # Now that the hooks are unregistered they should not be executed for import and export. USDHookBase.responses = { "on_material_export": [], "on_export": [], "on_import": [], } self.export_and_validate(filepath=str(test_path)) self.export_and_validate(filepath=str(test_path)) self.assertEqual(USDHookBase.responses["on_material_export"], []) self.assertEqual(USDHookBase.responses["on_export"], []) self.assertEqual(USDHookBase.responses["on_import"], []) def test_merge_parent_xform_false(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_hierarchy_export_test.blend")) test_path = self.tempdir / "test_merge_parent_xform_false.usda" self.export_and_validate(filepath=str(test_path), merge_parent_xform=False) expected = ( ("/root", "Xform"), ("/root/Dupli1", "Xform"), ("/root/Dupli1/GEO_Head_0", "Xform"), ("/root/Dupli1/GEO_Head_0/Face", "Mesh"), ("/root/Dupli1/GEO_Head_0/GEO_Ear_R_2", "Xform"), ("/root/Dupli1/GEO_Head_0/GEO_Ear_R_2/Ear", "Mesh"), ("/root/Dupli1/GEO_Head_0/GEO_Ear_L_1", "Xform"), ("/root/Dupli1/GEO_Head_0/GEO_Ear_L_1/Ear", "Mesh"), ("/root/Dupli1/GEO_Head_0/GEO_Nose_3", "Xform"), ("/root/Dupli1/GEO_Head_0/GEO_Nose_3/Nose", "Mesh"), ("/root/_materials", "Scope"), ("/root/_materials/Head", "Material"), ("/root/_materials/Head/Principled_BSDF", "Shader"), ("/root/_materials/Nose", "Material"), ("/root/_materials/Nose/Principled_BSDF", "Shader"), ("/root/ParentOfDupli2", "Xform"), ("/root/ParentOfDupli2/Icosphere", "Mesh"), ("/root/ParentOfDupli2/Dupli2", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/Face", "Mesh"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Ear_L_1", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Ear_L_1/Ear", "Mesh"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Ear_R_2", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Ear_R_2/Ear", "Mesh"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Nose_3", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Nose_3/Nose", "Mesh"), ("/root/Ground_plane", "Xform"), ("/root/Ground_plane/Plane", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/Face", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Ear_R", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Ear_R/Ear", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Nose", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Nose/Nose", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Ear_L", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Ear_L/Ear", "Mesh"), ("/root/Camera", "Xform"), ("/root/Camera/Camera", "Camera"), ("/root/env_light", "DomeLight") ) expected = tuple(sorted(expected, key=lambda pair: pair[0])) stage = Usd.Stage.Open(str(test_path)) actual = ((str(p.GetPath()), p.GetTypeName()) for p in stage.Traverse()) actual = tuple(sorted(actual, key=lambda pair: pair[0])) self.assertTupleEqual(expected, actual) def test_merge_parent_xform_true(self): bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_hierarchy_export_test.blend")) test_path = self.tempdir / "test_merge_parent_xform_true.usda" self.export_and_validate(filepath=str(test_path), merge_parent_xform=True) expected = ( ("/root", "Xform"), ("/root/Dupli1", "Xform"), ("/root/Dupli1/GEO_Head_0", "Xform"), ("/root/Dupli1/GEO_Head_0/Face", "Mesh"), ("/root/Dupli1/GEO_Head_0/GEO_Ear_R_2", "Mesh"), ("/root/Dupli1/GEO_Head_0/GEO_Ear_L_1", "Mesh"), ("/root/Dupli1/GEO_Head_0/GEO_Nose_3", "Mesh"), ("/root/_materials", "Scope"), ("/root/_materials/Head", "Material"), ("/root/_materials/Head/Principled_BSDF", "Shader"), ("/root/_materials/Nose", "Material"), ("/root/_materials/Nose/Principled_BSDF", "Shader"), ("/root/ParentOfDupli2", "Xform"), ("/root/ParentOfDupli2/Icosphere", "Mesh"), ("/root/ParentOfDupli2/Dupli2", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0", "Xform"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/Face", "Mesh"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Ear_L_1", "Mesh"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Ear_R_2", "Mesh"), ("/root/ParentOfDupli2/Dupli2/GEO_Head_0/GEO_Nose_3", "Mesh"), ("/root/Ground_plane", "Xform"), ("/root/Ground_plane/Plane", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head", "Xform"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/Face", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Ear_R", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Nose", "Mesh"), ("/root/Ground_plane/OutsideDupliGrandParent/OutsideDupliParent/GEO_Head/GEO_Ear_L", "Mesh"), ("/root/Camera", "Camera"), ("/root/env_light", "DomeLight") ) expected = tuple(sorted(expected, key=lambda pair: pair[0])) stage = Usd.Stage.Open(str(test_path)) actual = ((str(p.GetPath()), p.GetTypeName()) for p in stage.Traverse()) actual = tuple(sorted(actual, key=lambda pair: pair[0])) self.assertTupleEqual(expected, actual) def test_export_units(self): """Test specifying stage meters per unit on export.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "empty.blend")) # Check all unit conversions we support units = ( ("mm", 'MILLIMETERS', 0.001), ("cm", 'CENTIMETERS', 0.01), ("km", 'KILOMETERS', 1000), ("in", 'INCHES', 0.0254), ("ft", 'FEET', 0.3048), ("yd", 'YARDS', 0.9144), ("default", "", 1), ("custom", 'CUSTOM', 0.125) ) for name, unit, value in units: export_path = self.tempdir / f"usd_export_units_test_{name}.usda" if name == "default": self.export_and_validate(filepath=str(export_path)) elif name == "custom": self.export_and_validate(filepath=str(export_path), convert_scene_units=unit, meters_per_unit=value) else: self.export_and_validate(filepath=str(export_path), convert_scene_units=unit) # Verify that the Stage meters per unit metadata is set correctly stage = Usd.Stage.Open(str(export_path)) self.assertEqual(UsdGeom.GetStageMetersPerUnit(stage), value) # Verify that the /root xform has the expected scale (the default case should be empty) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/root")) if name == "default": self.assertFalse(xf.GetScaleOp().GetAttr().IsValid()) else: scale = self.round_vector([1.0 / value] * 3) self.assertEqual(self.round_vector(xf.GetScaleOp().Get()), scale) # Check one final unit conversion using no /root xform at all (it's a different code path) bpy.ops.mesh.primitive_cube_add() ob = bpy.data.objects[0] ob.location = (.1, .2, .3) export_path = self.tempdir / f"usd_export_units_test_non_root.usda" self.export_and_validate(filepath=str(export_path), convert_scene_units="CENTIMETERS", root_prim_path="") stage = Usd.Stage.Open(str(export_path)) xf = UsdGeom.Xformable(stage.GetPrimAtPath("/Cube")) self.assertEqual(self.round_vector(xf.GetScaleOp().Get()), [100, 100, 100]) self.assertEqual(self.round_vector(xf.GetTranslateOp().Get()), [10, 20, 30]) def test_export_native_instancing_true(self): """Test exporting instanced objects to native (scne graph) instances.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "nested_instancing_test.blend")) export_path = self.tempdir / "usd_export_nested_instancing_true.usda" self.export_and_validate( filepath=str(export_path), use_instancing=True ) # The USD should contain two instances of a plane which has two # instances of a point cloud as children. stage = Usd.Stage.Open(str(export_path)) stats = UsdUtils.ComputeUsdStageStats(stage) self.assertEqual(stats['totalInstanceCount'], 6, "Unexpected number of instances") self.assertEqual(stats['prototypeCount'], 2, "Unexpected number of prototypes") self.assertEqual(stats['primary']['primCountsByType']['Mesh'], 1, "Unexpected number of primary meshes") self.assertEqual(stats['primary']['primCountsByType']['Points'], 1, "Unexpected number of primary point clouds") self.assertEqual(stats['prototypes']['primCountsByType']['Mesh'], 1, "Unexpected number of prototype meshes") self.assertEqual(stats['prototypes']['primCountsByType']['Points'], 1, "Unexpected number of prototype point clouds") # Get the prototypes root. protos_root_path = Sdf.Path("/root/prototypes") prim = stage.GetPrimAtPath(protos_root_path) assert prim self.assertTrue(prim.IsAbstract()) # Get the first plane instance. prim = stage.GetPrimAtPath("/root/plane_001/Plane_0") assert prim assert prim.IsInstance() # Get the second plane instance. prim = stage.GetPrimAtPath("/root/plane/Plane_0") assert prim assert prim.IsInstance() # Ensure all the prototype paths are under the pototypes root. for prim in stage.Traverse(): if prim.IsInstance(): arcs = Usd.PrimCompositionQuery.GetDirectReferences(prim).GetCompositionArcs() for arc in arcs: target_path = arc.GetTargetPrimPath() self.assertTrue(target_path.HasPrefix(protos_root_path)) def test_export_native_instancing_false(self): """Test exporting instanced objects with instancing disabled.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "nested_instancing_test.blend")) export_path = self.tempdir / "usd_export_nested_instancing_false.usda" self.export_and_validate( filepath=str(export_path), use_instancing=False ) # The USD should contain no instances. stage = Usd.Stage.Open(str(export_path)) stats = UsdUtils.ComputeUsdStageStats(stage) self.assertEqual(stats['totalInstanceCount'], 0, "Unexpected number of instances") self.assertEqual(stats['prototypeCount'], 0, "Unexpected number of prototypes") self.assertEqual(stats['primary']['primCountsByType']['Mesh'], 2, "Unexpected number of primary meshes") self.assertEqual(stats['primary']['primCountsByType']['Points'], 4, "Unexpected number of primary point clouds") def test_instancing_nonmesh(self): """Test that certain non-mesh object types are properly instanced correctly.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_instancing_nonmesh.blend")) export_path = self.tempdir / "usd_instancing_nonmesh.usda" self.export_and_validate( filepath=str(export_path), use_instancing=True ) stage = Usd.Stage.Open(str(export_path)) # Note: This test purposely uses Text, Metaball, and NURBS surface objects which are non # meshes but are currently converted to mesh on export. stats = UsdUtils.ComputeUsdStageStats(stage) self.assertEqual(stats['totalInstanceCount'], 6, "Unexpected number of instances") self.assertEqual(stats['prototypeCount'], 4, "Unexpected number of prototypes") self.assertEqual(stats['primary']['primCountsByType']['Mesh'], 4, "Unexpected number of primary meshes") self.assertEqual( stats['primary']['primCountsByType']['PointInstancer'], 1, "Unexpected number of primary point clouds") self.assertEqual(stats['prototypes']['primCountsByType']['Mesh'], 4, "Unexpected number of prototype meshes") # Ensure the prims are marked as instances prim_list = [ ("/root/Text", True), ("/root/SurfPatch", True), ("/root/Mball", False), # Metaballs are not instanced in Blender at the moment ] for prim_path, expected in prim_list: prim = stage.GetPrimAtPath(prim_path) self.assertEqual(prim.IsInstance(), expected, f"Unexpected result for {prim_path}") # Ensure all the prototype paths are under the pototypes root. protos_root_path = Sdf.Path("/root/prototypes") for prim in stage.Traverse(): if prim.IsInstance(): arcs = Usd.PrimCompositionQuery.GetDirectReferences(prim).GetCompositionArcs() for arc in arcs: target_path = arc.GetTargetPrimPath() self.assertTrue(target_path.HasPrefix(protos_root_path)) def test_texture_export_hook(self): """Exporting textures from on_material_export USD hook.""" # Clear USD hook results. ExportTextureUSDHook.exported_textures = {} bpy.utils.register_class(ExportTextureUSDHook) bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_export.blend")) export_path = self.tempdir / "usd_materials_export.usda" self.export_and_validate( filepath=str(export_path), export_materials=True, generate_preview_surface=False, ) # Verify that the exported texture paths were returned as expected. expected = {'/root/_materials/Transforms': './textures/test_grid_.png', '/root/_materials/Clip_With_Round': './textures/test_grid_.png', '/root/_materials/NormalMap': './textures/test_normal.exr', '/root/_materials/Material': './textures/test_grid_.png', '/root/_materials/Clip_With_LessThanInvert': './textures/test_grid_.png', '/root/_materials/NormalMap_Scale_Bias': './textures/test_normal_invertY.exr'} self.assertDictEqual(ExportTextureUSDHook.exported_textures, expected, "Unexpected texture export paths") bpy.utils.unregister_class(ExportTextureUSDHook) # Verify that the texture files were copied as expected. tex_names = ['test_grid_1001.png', 'test_grid_1002.png', 'test_normal.exr', 'test_normal_invertY.exr'] for name in tex_names: tex_path = self.tempdir / "textures" / name self.assertTrue(tex_path.exists(), f"Exported texture {tex_path} doesn't exist") def test_inmem_pack_texture_export_hook(self): """Exporting packed and in memory textures from on_material_export USD hook.""" # Clear hook results. ExportTextureUSDHook.exported_textures = {} bpy.utils.register_class(ExportTextureUSDHook) bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_materials_inmem_pack.blend")) export_path = self.tempdir / "usd_materials_inmem_pack.usda" self.export_and_validate( filepath=str(export_path), export_materials=True, generate_preview_surface=False, ) # Verify that the exported texture paths were returned as expected. expected = {'/root/_materials/MAT_pack_udim': './textures/test_grid_.png', '/root/_materials/MAT_pack_single': './textures/test_single.png', '/root/_materials/MAT_inmem_udim': './textures/inmem_udim..png', '/root/_materials/MAT_inmem_single': './textures/inmem_single.png'} self.assertDictEqual(ExportTextureUSDHook.exported_textures, expected, "Unexpected texture export paths") bpy.utils.unregister_class(ExportTextureUSDHook) # Verify that the texture files were copied as expected. tex_names = ['test_grid_1001.png', 'test_grid_1002.png', 'test_single.png', 'inmem_udim.1001.png', 'inmem_udim.1002.png', 'inmem_single.png'] for name in tex_names: tex_path = self.tempdir / "textures" / name self.assertTrue(tex_path.exists(), f"Exported texture {tex_path} doesn't exist") def test_naming_collision_hierarchy(self): """Validate that naming collisions during export are handled correctly""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_hierarchy_collision.blend")) export_path = self.tempdir / "usd_hierarchy_collision.usda" self.export_and_validate(filepath=str(export_path)) expected = ( ('/root', 'Xform'), ('/root/Empty', 'Xform'), ('/root/Empty/Par_002', 'Xform'), ('/root/Empty/Par_002/Par_1', 'Mesh'), ('/root/Empty/Par_003', 'Xform'), ('/root/Empty/Par_003/Par_1', 'Mesh'), ('/root/Empty/Par_004', 'Xform'), ('/root/Empty/Par_004/Par_002', 'Mesh'), ('/root/Empty/Par_1', 'Xform'), ('/root/Empty/Par_1/Par_1', 'Mesh'), ('/root/Level1', 'Xform'), ('/root/Level1/Level2', 'Xform'), ('/root/Level1/Level2/Par2_002', 'Xform'), ('/root/Level1/Level2/Par2_002/Par2_002', 'Mesh'), ('/root/Level1/Level2/Par2_1', 'Xform'), ('/root/Level1/Level2/Par2_1/Par2_1', 'Mesh'), ('/root/Level1/Par2_002', 'Xform'), ('/root/Level1/Par2_002/Par2_1', 'Mesh'), ('/root/Level1/Par2_1', 'Xform'), ('/root/Level1/Par2_1/Par2_1', 'Mesh'), ('/root/Test_002', 'Xform'), ('/root/Test_002/Test_1', 'Mesh'), ('/root/Test_003', 'Xform'), ('/root/Test_003/Test_1', 'Mesh'), ('/root/Test_004', 'Xform'), ('/root/Test_004/Test_002', 'Mesh'), ('/root/Test_1', 'Xform'), ('/root/Test_1/Test_1', 'Mesh'), ('/root/env_light', 'DomeLight'), ('/root/xSource_002', 'Xform'), ('/root/xSource_002/Dup_002', 'Xform'), ('/root/xSource_002/Dup_002/Dup_002', 'Mesh'), ('/root/xSource_002/Dup_002_0', 'Xform'), ('/root/xSource_002/Dup_002_0/Dup_002', 'Mesh'), ('/root/xSource_002/Dup_002_1', 'Xform'), ('/root/xSource_002/Dup_002_1/Dup_002', 'Mesh'), ('/root/xSource_002/Dup_002_2', 'Xform'), ('/root/xSource_002/Dup_002_2/Dup_002', 'Mesh'), ('/root/xSource_002/Dup_002_3', 'Xform'), ('/root/xSource_002/Dup_002_3/Dup_002', 'Mesh'), ('/root/xSource_002/Dup_1', 'Xform'), ('/root/xSource_002/Dup_1/Dup_1', 'Mesh'), ('/root/xSource_002/Dup_1_0', 'Xform'), ('/root/xSource_002/Dup_1_0/Dup_1', 'Mesh'), ('/root/xSource_002/Dup_1_1', 'Xform'), ('/root/xSource_002/Dup_1_1/Dup_1', 'Mesh'), ('/root/xSource_002/Dup_1_2', 'Xform'), ('/root/xSource_002/Dup_1_2/Dup_1', 'Mesh'), ('/root/xSource_002/Dup_1_3', 'Xform'), ('/root/xSource_002/Dup_1_3/Dup_1', 'Mesh'), ('/root/xSource_002/xSource_1', 'Mesh'), ('/root/xSource_1', 'Xform'), ('/root/xSource_1/Dup_002', 'Xform'), ('/root/xSource_1/Dup_002/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1', 'Xform'), ('/root/xSource_1/Dup_1/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_0', 'Xform'), ('/root/xSource_1/Dup_1_0/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_001', 'Xform'), ('/root/xSource_1/Dup_1_001/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_002', 'Xform'), ('/root/xSource_1/Dup_1_002/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_003', 'Xform'), ('/root/xSource_1/Dup_1_003/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_004', 'Xform'), ('/root/xSource_1/Dup_1_004/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_1', 'Xform'), ('/root/xSource_1/Dup_1_1/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_2', 'Xform'), ('/root/xSource_1/Dup_1_2/Dup_1', 'Mesh'), ('/root/xSource_1/Dup_1_3', 'Xform'), ('/root/xSource_1/Dup_1_3/Dup_1', 'Mesh'), ('/root/xSource_1/xSource_1', 'Mesh') ) expected = tuple(sorted(expected, key=lambda pair: pair[0])) stage = Usd.Stage.Open(str(export_path)) actual = ((str(p.GetPath()), p.GetTypeName()) for p in stage.Traverse()) actual = tuple(sorted(actual, key=lambda pair: pair[0])) self.assertTupleEqual(expected, actual) def test_point_instancing_export(self): """Test exporting scenes that use point instancing.""" def confirm_point_instancing_stats(stage, num_meshes, num_instancers, num_instances, num_prototypes): mesh_count = 0 instancer_count = 0 instance_count = 0 prototype_count = 0 for prim in stage.TraverseAll(): prim_path = prim.GetPath() prim_type_name = prim.GetTypeName() if prim_type_name == "PointInstancer": point_instancer = UsdGeom.PointInstancer(prim) if point_instancer: # get instance count positions_attr = point_instancer.GetPositionsAttr() if positions_attr: positions = positions_attr.Get() if positions: instance_count += len(positions) # get prototype count prototypes_rel = point_instancer.GetPrototypesRel() if prototypes_rel: target_prims = prototypes_rel.GetTargets() prototype_count += len(target_prims) # show all prims and types # output_string = f" Path: {prim_path}, Type: {prim_type_name}" # print(output_string) stats = UsdUtils.ComputeUsdStageStats(stage) mesh_count = stats['primary']['primCountsByType']['Mesh'] instancer_count = stats['primary']['primCountsByType']['PointInstancer'] return mesh_count, instancer_count, instance_count, prototype_count point_instance_test_scenarios = [ # object reference treated as geometry set {'input_file': str(self.testdir / "usd_point_instancer_object_ref.blend"), 'output_file': self.tempdir / "usd_export_point_instancer_object_ref.usda", 'mesh_count': 3, 'instancer_count': 1, 'total_instances': 16, 'total_prototypes': 1, 'extent': { "/root/Plane/Plane": [Gf.Vec3f(-1.0999999, -1.0999999, -0.1), Gf.Vec3f(1.1, 1.1, 0.1)]}}, # collection reference from single point instancer {'input_file': str(self.testdir / "usd_point_instancer_collection_ref.blend"), 'output_file': self.tempdir / "usd_export_point_instancer_collection_ref.usda", 'mesh_count': 5, 'instancer_count': 1, 'total_instances': 32, 'total_prototypes': 2, 'extent': { "/root/Plane/Plane": [Gf.Vec3f(-1.1758227, -1.1, -0.1), Gf.Vec3f(1.1, 1.1526861, 0.14081651)]}}, # collection references in nested point instancer {'input_file': str(self.testdir / "usd_point_instancer_nested.blend"), 'output_file': self.tempdir / "usd_export_point_instancer_nested.usda", 'mesh_count': 9, 'instancer_count': 3, 'total_instances': 14, 'total_prototypes': 4, 'extent': { "/root/Triangle/Triangle": [Gf.Vec3f(-0.976631, -1.2236981, -0.7395363), Gf.Vec3f(1.8081428, 3.371673, 1.2604637)], "/root/Plane/Plane": [Gf.Vec3f(-1.164238, -3.5953712, -0.2883494), Gf.Vec3f(-0.68365526, -3.1147888, -0.18980181)]}}, # object reference coming from a collection with separate children {'input_file': str(self.testdir / "../render/shader/texture_coordinate_camera.blend"), 'output_file': self.tempdir / "usd_export_point_instancer_separate_children.usda", 'mesh_count': 9, 'instancer_count': 1, 'total_instances': 4, 'total_prototypes': 2, 'extent': { "/root/Rotated_and_Scaled_Instances/Cube_003": [Gf.Vec3f(-8.488519, -6.1219244, -6.964829), Gf.Vec3f(3.2331002, 5.4789553, 7.095813)]}} ] for scenario in point_instance_test_scenarios: bpy.ops.wm.open_mainfile(filepath=scenario['input_file']) export_path = scenario['output_file'] self.export_and_validate( filepath=str(export_path), use_instancing=True ) stage = Usd.Stage.Open(str(export_path)) mesh_count, instancer_count, instance_count, proto_count = confirm_point_instancing_stats( stage, scenario['mesh_count'], scenario['instancer_count'], scenario['total_instances'], scenario['total_prototypes']) self.assertEqual(scenario['mesh_count'], mesh_count, "Unexpected number of primary meshes") self.assertEqual(scenario['instancer_count'], instancer_count, "Unexpected number of point instancers") self.assertEqual(scenario['total_instances'], instance_count, "Unexpected number of total instances") self.assertEqual(scenario['total_prototypes'], proto_count, "Unexpected number of total prototypes") if 'extent' in scenario: for prim_path, (expected_min, expected_max) in scenario['extent'].items(): prim = stage.GetPrimAtPath(prim_path) self.assertTrue(prim.IsValid(), f"Prim {prim_path} not found on stage") boundable = UsdGeom.Boundable(prim) extent_attr = boundable.GetExtentAttr() self.assertTrue(extent_attr.HasAuthoredValue(), f"Prim {prim_path} has no authored extent") extent = extent_attr.Get() self.assertIsNotNone(extent, f"Extent on {prim_path} could not be retrieved") self.compareVec3d(Gf.Vec3d(extent[0]), expected_min) self.compareVec3d(Gf.Vec3d(extent[1]), expected_max) def test_export_usdz(self): """Validate USDZ files are packaged correctly.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usdz_export_test.blend")) export_path = str(self.tempdir / "output_こんにちは.usdz") # USDZ export will not create the output directory if it does not already exist self.tempdir.mkdir() # USDZ export will modify the working directory during the export process, but it should # return to normal once complete original_cwd = pathlib.Path.cwd() self.export_and_validate(filepath=export_path) final_cwd = pathlib.Path.cwd() self.assertEqual(original_cwd, final_cwd) # Validate stage content stage = Usd.Stage.Open(export_path) self.assertTrue(stage.GetPrimAtPath("/root/Cube/Cube").IsValid()) self.assertTrue(stage.GetPrimAtPath("/root/Cylinder/Cylinder").IsValid()) self.assertTrue(stage.GetPrimAtPath("/root/Icosphere/Icosphere").IsValid()) self.assertTrue(stage.GetPrimAtPath("/root/Sphere/Sphere").IsValid()) self.assertTrue(stage.GetPrimAtPath("/root/env_light").IsValid()) # Validate that the archive itself contains what we expect (it is just a ZIP file) import zipfile with zipfile.ZipFile(export_path, 'r') as zfile: file_list = zfile.namelist() self.assertIn('textures/color_0C0C0C.exr', file_list) def test_export_indexed_uvs(self): """Test that UV maps are exported with proper indexing.""" # Create a simple cube bpy.ops.mesh.primitive_cube_add() cube = bpy.context.active_object cube.name = "Cube" # Export the mesh export_path = self.tempdir / "uv_indexed_test.usda" self.export_and_validate( filepath=str(export_path), export_uvmaps=True, rename_uvmaps=True, evaluation_mode="RENDER", ) # Load and validate the exported USD stage = Usd.Stage.Open(str(export_path)) mesh_prim = stage.GetPrimAtPath("/root/Cube/Cube") primvars_api = UsdGeom.PrimvarsAPI(mesh_prim) uv_primvar = primvars_api.GetPrimvar("st") self.assertTrue(uv_primvar.IsIndexed(), "UV primvar should be indexed") self.assertEqual(uv_primvar.GetInterpolation(), UsdGeom.Tokens.faceVarying, "UV interpolation should be faceVarying") uv_values = uv_primvar.Get() uv_indices = uv_primvar.GetIndices() self.assertIsNotNone(uv_indices, "UV primvar should have indices") self.assertEqual(len(uv_indices), 24, "Should have 24 UV indices (one per face vertex)") self.assertLess(len(uv_values), 24, f"Unique UV count ({len(uv_values)}) should be less than face vertex count (24)") def test_export_accessibility(self): """Validate that writing UsdUIAccessibilityAPI metadata exports correctly.""" def verify_accessibility_api(prim, namespace, label, description, priority=None): self.assertTrue(prim.IsValid()) self.assertTrue(prim.HasAPI(UsdUI.AccessibilityAPI)) accessibility_api = UsdUI.AccessibilityAPI(prim, namespace) label_attr = accessibility_api.GetLabelAttr() self.assertTrue(label_attr.HasAuthoredValue()) self.assertEqual(label_attr.Get(), label) description_attr = accessibility_api.GetDescriptionAttr() self.assertTrue(description_attr.HasAuthoredValue()) self.assertEqual(description_attr.Get(), description) if priority is not None: priority_attr = accessibility_api.GetPriorityAttr() self.assertTrue(priority_attr.HasAuthoredValue()) self.assertEqual(priority_attr.Get(), priority) # Create a few objects to export. bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "empty.blend")) bpy.ops.mesh.primitive_uv_sphere_add() sphere = bpy.context.active_object sphere.name = "Sphere" sphere_label = "a sphere" sphere_description = "a primitive uv sphere" sphere["accessibility:default:label"] = sphere_label sphere["accessibility:default:description"] = sphere_description sphere["accessibility:default:priority"] = UsdUI.Tokens.high # Apply a second set of accessibility data. sphere_color_label = "blue" sphere_color_description = "a cool slightly greenish blue" sphere["accessibility:color:label"] = sphere_color_label sphere["accessibility:color:description"] = sphere_color_description export_path = self.tempdir / "accessibility_basic.usda" root_label = "Accessibility Test" root_description = "This is an accessibility test from Python!" self.export_and_validate( filepath=str(export_path), export_custom_properties=True, accessibility_label=root_label, accessibility_description=root_description, selected_objects_only=True, ) stage = Usd.Stage.Open(str(export_path)) root_prim = stage.GetPrimAtPath("/root") sphere_prim = stage.GetPrimAtPath(f"/root/{sphere.name}") # Check the accessibility metadata on the root prim (set via the export args). verify_accessibility_api(root_prim, UsdUI.Tokens.default_, root_label, root_description) # Check the accessibility metadata exported from custom properties. verify_accessibility_api( sphere_prim, UsdUI.Tokens.default_, sphere_label, sphere_description, UsdUI.Tokens.high) verify_accessibility_api( sphere_prim, "color", sphere_color_label, sphere_color_description) # Test another export, but this time do not have the root prim. Verify # that the export settings take precedence over custom properties. export_path = self.tempdir / "accessibility_basic_no_root.usda" self.export_and_validate( filepath=str(export_path), export_custom_properties=True, accessibility_label=root_label, accessibility_description=root_description, root_prim_path="", selected_objects_only=True, ) stage = Usd.Stage.Open(str(export_path)) root_prim = stage.GetPrimAtPath(f"/{sphere.name}") # Check that the accessibility information is pulled from the export args. verify_accessibility_api(root_prim, UsdUI.Tokens.default_, root_label, root_description) def test_export_colorspace(self): """Validate that exported USD files have ColorSpaceAPI applied to the relevant prims with scene linear interop ID.""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "empty.blend")) # Add a light with a specific color. bpy.ops.object.light_add(type='POINT') light_obj = bpy.context.active_object light_obj.data.color = (0.5, 0.3, 0.1) # Add a mesh with a color attribute and a material. bpy.ops.mesh.primitive_plane_add() mesh_obj = bpy.context.active_object mesh_obj.data.color_attributes.new(name="Col", type='FLOAT_COLOR', domain='POINT') mat = bpy.data.materials.new(name="Mat") mat.use_nodes = True mesh_obj.data.materials.append(mat) export_path = self.tempdir / "colorspace_export.usda" self.export_and_validate( filepath=str(export_path), evaluation_mode="RENDER", ) expected = bpy.data.colorspace.working_space_interop_id def check_colorspace(prim, label): self.assertTrue(prim.IsValid(), f"{label} prim should exist") self.assertTrue(prim.HasAPI(Usd.ColorSpaceAPI), f"{label} prim should have ColorSpaceAPI applied") cs_name = Usd.ColorSpaceAPI(prim).GetColorSpaceNameAttr().Get() self.assertEqual(cs_name, expected, f"{label} colorspace '{cs_name}' should match working space " f"interop ID '{expected}'") stage = Usd.Stage.Open(str(export_path)) light_name = light_obj.name mesh_name = mesh_obj.name check_colorspace(stage.GetPrimAtPath(f"/root/{light_name}/{light_name}"), "Light") check_colorspace(stage.GetPrimAtPath(f"/root/_materials/{mat.name}"), "Material") check_colorspace(stage.GetPrimAtPath(f"/root/{mesh_name}/{mesh_name}"), "Mesh") def test_export_mesh_normals(self): """Test that each exported USD normal interpolation and number matches Blender mesh normal domain""" bpy.ops.wm.open_mainfile(filepath=str(self.testdir / "usd_mesh_normals.blend")) export_path = self.tempdir / "usd_mesh_normals.usda" self.export_and_validate( filepath=str(export_path), evaluation_mode="RENDER", ) stage = Usd.Stage.Open(str(export_path)) # validate face normals (uniform) faceMesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/shade_flat/shade_flat")) self.assertEqual( len(faceMesh.GetNormalsAttr().Get()), len(faceMesh.GetFaceVertexCountsAttr().Get()), "Number of normals should equal number of faces") self.assertEqual( faceMesh.GetNormalsInterpolation(), UsdGeom.Tokens.uniform, "Normals should be uniform interpolated") # validate corner normals (face-varying) cornerMesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/shade_auto22/shade_auto22")) self.assertEqual( len(cornerMesh.GetNormalsAttr().Get()), len(cornerMesh.GetFaceVertexIndicesAttr().Get()), "Number of normals should equal number of indices") self.assertEqual( cornerMesh.GetNormalsInterpolation(), UsdGeom.Tokens.faceVarying, "Normals should be faceVarying interpolated") # validate point normals (vertex) pointMesh = UsdGeom.Mesh(stage.GetPrimAtPath("/root/shade_smooth/shade_smooth")) self.assertEqual( len(pointMesh.GetNormalsAttr().Get()), len(pointMesh.GetPointsAttr().Get()), "Number of normals should equal number of points") self.assertEqual( pointMesh.GetNormalsInterpolation(), UsdGeom.Tokens.vertex, "Normals should be vertex interpolated") class USDHookBase: instructions = {} responses = {} @staticmethod def follow_instructions(name, operation): instruction = USDHookBase.instructions[operation].pop(0) if instruction == "throw": USDHookBase.responses[operation].append("threw exception") raise RuntimeError(f"** {name} failing {operation} **") elif instruction == "return False": USDHookBase.responses[operation].append("returned False") return False USDHookBase.responses[operation].append("returned True") return True @staticmethod def do_on_export(name, export_context): stage = export_context.get_stage() depsgraph = export_context.get_depsgraph() if not stage.GetDefaultPrim().IsValid(): raise RuntimeError("Unexpected failure: bad stage") if len(depsgraph.ids) == 0: raise RuntimeError("Unexpected failure: bad depsgraph") return USDHookBase.follow_instructions(name, "on_export") @staticmethod def do_on_material_export(name, export_context, bl_material, usd_material): stage = export_context.get_stage() if stage.expired: raise RuntimeError("Unexpected failure: bad stage") if not usd_material.GetPrim().IsValid(): raise RuntimeError("Unexpected failure: bad usd_material") if bl_material is None: raise RuntimeError("Unexpected failure: bad bl_material") return USDHookBase.follow_instructions(name, "on_material_export") @staticmethod def do_on_import(name, import_context): stage = import_context.get_stage() if not stage.GetDefaultPrim().IsValid(): raise RuntimeError("Unexpected failure: bad stage") return USDHookBase.follow_instructions(name, "on_import") class USDHook1(USDHookBase, bpy.types.USDHook): bl_idname = "usd_hook_1" bl_label = "Hook 1" @staticmethod def on_export(export_context): return USDHookBase.do_on_export(USDHook1.bl_label, export_context) @staticmethod def on_material_export(export_context, bl_material, usd_material): return USDHookBase.do_on_material_export(USDHook1.bl_label, export_context, bl_material, usd_material) @staticmethod def on_import(import_context): return USDHookBase.do_on_import(USDHook1.bl_label, import_context) class USDHook2(USDHookBase, bpy.types.USDHook): bl_idname = "usd_hook_2" bl_label = "Hook 2" @staticmethod def on_export(export_context): return USDHookBase.do_on_export(USDHook2.bl_label, export_context) @staticmethod def on_material_export(export_context, bl_material, usd_material): return USDHookBase.do_on_material_export(USDHook2.bl_label, export_context, bl_material, usd_material) @staticmethod def on_import(import_context): return USDHookBase.do_on_import(USDHook2.bl_label, import_context) class ExportTextureUSDHook(bpy.types.USDHook): bl_idname = "export_texture_usd_hook" bl_label = "Export Texture USD Hook" exported_textures = {} @staticmethod def on_material_export(export_context, bl_material, usd_material): """ If a texture image node exists in the given material's node tree, call exprt_texture() on the image and cache the returned path. """ tex_image_node = None if bl_material and bl_material.node_tree: for node in bl_material.node_tree.nodes: if node.type == 'TEX_IMAGE': tex_image_node = node if tex_image_node is None: return False tex_path = export_context.export_texture(tex_image_node.image) ExportTextureUSDHook.exported_textures[usd_material.GetPath() .pathString] = tex_path return True class GetPrimMapUsdExportHook(bpy.types.USDHook): bl_idname = "get_prim_map_usd_export_hook" bl_label = "Get Prim Map Usd Export Hook" prim_map = None @staticmethod def on_export(context): GetPrimMapUsdExportHook.prim_map = context.get_prim_map() def main(): global args import argparse if "--" in sys.argv: argv = [sys.argv[0]] + sys.argv[sys.argv.index("--") + 1:] else: argv = sys.argv parser = argparse.ArgumentParser() parser.add_argument("--testdir", required=True, type=pathlib.Path) args, remaining = parser.parse_known_args(argv) unittest.main(argv=remaining, verbosity=0) if __name__ == "__main__": main()