Merge pull request #29 from frenchdog/feature/BIFROST-11395/update_for_bifrost_2_13_release

BIFROST-11395 - Update to Bifrost 2.13.0.0

Author: frenchdog

.gitignore

@@ -1,7 +1,13 @@
 .DS_Store
 __pycache__
 
+# clangd
+.cache
+
 # Visual Studio Code
 .vscode
 # jetbrains solutions
 .idea
+
+# Compilation database
+compile_commands.json

CHANGELOG.md

@@ -1,3 +1,32 @@
+## [1.3.3] - 2025-03-26 (Bifrost 2.13)
+
+### Build
+ - BIFROST-11259 - update to Open USD 24.11
+
+### Feature
+  - BIFROST-11322 - Add Lookdev workflow
+    - New runtime commands to:
+         - create_maya_usd_material_library_cmd
+         - create_lookdev_stage_from_layers_cmd
+         - open_maya_usd_material_library_cmd
+         - usd_attribute_quick_look_from_selection_cmd
+         - prim_selection_to_string_array_compound_cmd
+         - remove_prim_selection_from_string_to_array_compound_cmd
+         - select_prims_from_selected_node_cmd
+    - New compounds:
+         - apply_look_v2 (for 'iterate_on_model_variants' case)
+         - apply_usd_material_bindings
+         - resolve_bindings
+         - create_lookdev_workflow_stage
+         - usd_collection_schema
+         - usd_string_paths_to_array
+    - New UI dialogs to create or open mayaUsdProxyShape from a USD file:
+
+### Bugfix
+ - BIFROST-10481 - Fix PointInstancer prototype ordering when using the _define_usd_point_instancer_
+ - BIFROST-10481 - The default material option is now disable by default in the _define_usd_point_instancer_
+ - BIFROST-11306 - Fix the model exporter for mayaUSD plugin >= 0.30
+
 ## [1.3.1] - 2024-10-29 (Bifrost 2.12)
 
 ### Build

CMakeLists.txt

@@ -185,6 +185,7 @@ if( NOT BIFUSD_TEST_RESOURCES_LOCATION )
     set( BIFUSD_TEST_RESOURCES_LOCATION "${CMAKE_CURRENT_SOURCE_DIR}/test")
 endif()
 enable_testing()
+option(BIFUSD_TEST_GRAPHS "Enable test_graphs.py" ON)
 add_subdirectory(utils/test)
 add_subdirectory(test)
 

cmake/bifusd/compiler_Clang.cmake

@@ -190,5 +190,51 @@ set(CMAKE_CXX_FLAGS_DEBUG_INIT "${cxx_flags_debug}")
 set(cxx_flags -fPIC)
 
 if (BIFUSD_ENABLE_ADDRESS_SANITIZER)
-    list(APPEND cxx_flags -fsanitize=address)
+    list(APPEND cxx_flags
+        -fsanitize=address
+        -fno-omit-frame-pointer
+    )
+endif()
+
+# Compile using the Undefined Behavior Sanitizer. See:
+#
+# http://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html
+# http://developers.redhat.com/blog/2014/10/16/gcc-undefined-behavior-sanitizer-ubsan/
+#
+# We are using the same set of flags as using by LLVM when running its own sets
+# of checks under UBSan.
+if (BIFUSD_ENABLE_UNDEFINED_SANITIZER)
+    list(APPEND cxx_flags
+        # All of the checks other than unsigned-integer-overflow
+        -fsanitize=undefined
+
+        # Exclude:
+        #
+        #   vptr: Use of an object whose vptr indicates that it is of the wrong
+        #   dynamic type, or that its lifetime has not begun or has
+        #   ended. Incompatible with -fno-rtti. Link must be performed by
+        #   clang++, not clang, to make sure C++-specific parts of the runtime
+        #   library and C++ standard libraries are present.
+        #
+        #   function: Indirect call of a function through a function pointer of
+        #   the wrong type (Linux, C++ and x86/x86_64 only).
+        #
+        #   object-size: XCode 7.1 version of libc++ contains UB that the
+        #   sanitizer correctly identifies. These are fixed or being fixed in
+        #   the LLVM libc++ development branch. Disable this particular check
+        #   until we get a version of libc++ which supports this.
+        #
+        #   bool: The bool sanitizer is OFF due to some code in USD that triggers it.
+        #
+        #   See: http://lists.llvm.org/pipermail/cfe-dev/2013-August/031194.html
+        #        https://llvm.org/bugs/show_bug.cgi?id=19302
+        #        https://llvm.org/bugs/show_bug.cgi?id=24574
+        -fno-sanitize=bool,vptr,function,object-size
+
+        # Helps to get more precise diagnostics for undefined behavior.
+        -fno-omit-frame-pointer
+
+        # exit after the first detected undefined behavior.
+        -fno-sanitize-recover=undefined,integer
+    )
 endif()

cmake/bifusd/utils.cmake

@@ -22,6 +22,7 @@ set(bifusd_utils_included true)
 
 option(BIFUSD_USE_DEBUGGER "Launch unit tests using the platform-specific debugger." OFF)
 option(BIFUSD_ENABLE_ADDRESS_SANITIZER "Enable AddressSanitizer compiler instrumentations." OFF)
+option(BIFUSD_ENABLE_UNDEFINED_SANITIZER "Enable UndefinedBehaviorSanitizer compiler instrumentations." OFF)
 
 # Export the given list of variables from the local scope to the parent scope.
 #
@@ -2740,6 +2741,25 @@ function(bifusd_configure_unittest  unittest_target)
         set(test_command $<TARGET_FILE:${unittest_target}>)
     endif()
 
+    # Adjust LD_PRELOAD and DYLD_INSERT_LIBRARIES based on BIFUSD_ASAN_LIBRARY
+    # Pass BIFUSD_ASAN_LIBRARY to the test command as an environment variable so that
+    # it is part of the python environment when python is launched.
+    # For not python tests, it is just an extra env var
+    if( BIFUSD_ENABLE_ADDRESS_SANITIZER OR BIFUSD_ENABLE_UNDEFINED_SANITIZER)
+        bifusd_append_option(ENV_VARS "BIFUSD_ASAN_LIBRARY=${BIFUSD_ASAN_LIBRARY}")
+        if( BIFUSD_EXTRA_SANITIZER_ENV_VARS )
+            bifusd_append_option(ENV_VARS "${BIFUSD_EXTRA_SANITIZER_ENV_VARS}")
+        endif()
+        if (BIFUSD_ASAN_LIBRARY)
+            bifusd_append_option(ENV_VARS "BIFUSD_ASAN_LIBRARY=${BIFUSD_ASAN_LIBRARY}")
+            if (BIFUSD_IS_LINUX)
+                bifusd_append_option(ENV_VARS "LD_PRELOAD=${BIFUSD_ASAN_LIBRARY}")
+            elseif (BIFUSD_IS_OSX)
+                bifusd_append_option(ENV_VARS "DYLD_INSERT_LIBRARIES=${BIFUSD_ASAN_LIBRARY}")
+            endif()
+        endif()
+    endif()
+
     if ( BIFUSD_USE_DEBUGGER )
         if ( BIFUSD_IS_WINDOWS )
             # Open the source files in Visual Studio, except when they are targets.

cmake/setup.cmake

@@ -1,6 +1,6 @@
 #-
 #*****************************************************************************
-# Copyright 2024 Autodesk, Inc.
+# Copyright 2025 Autodesk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,31 +21,38 @@
 
 set(BIFROST_USD_PACK_INSTALL_RES_DIR             "${BIFUSD_INSTALL_COMMON_DIR}/resources")
 set(BIFROST_USD_PACK_INSTALL_RES_JSON_DIR        "${BIFROST_USD_PACK_INSTALL_RES_DIR}/json")
+set(BIFROST_USD_PACK_INSTALL_RES_COMP_DIR        "${BIFROST_USD_PACK_INSTALL_RES_DIR}/compound")
 set(BIFROST_USD_PACK_INSTALL_RES_ICONS_DIR       "${BIFROST_USD_PACK_INSTALL_RES_DIR}/icons")
 set(BIFROST_USD_PACK_INSTALL_RES_DOCS_DIR        "${BIFROST_USD_PACK_INSTALL_RES_DIR}/docs")
 set(BIFROST_USD_PACK_INSTALL_RES_CONFIG_DIR      "${BIFROST_USD_PACK_INSTALL_RES_DIR}/config")
 set(BIFROST_USD_PACK_INSTALL_RES_PROC_DIR        "${BIFROST_USD_PACK_INSTALL_RES_DIR}/procedural")
 
 # TODO: is "usd_pack" or the name of the config file defined somewhere?
-set(BIFROST_USD_PACK_INSTALL_CONFIG_FILE         "usd_pack/usd_pack_config.json")
+set(BIFROST_USD_PACK_CONFIG_FILE_MAIN            "usd_pack/usd_pack_config.json")
+set(BIFROST_USD_PACK_CONFIG_FILE_LIBS            "usd_pack/usd_pack_config_shared_libs.json")
+set(BIFROST_USD_PACK_CONFIG_FILE_COMP            "usd_pack/usd_pack_config_compound.json")
 
 set(BIFROST_USD_PACK_SHARED_LIB_DIR ${BIFUSD_INSTALL_LIB_DIR})
 if( BIFUSD_IS_WINDOWS)
     set(BIFROST_USD_PACK_SHARED_LIB_DIR ${BIFUSD_INSTALL_BIN_DIR})
 endif()
 
 file(RELATIVE_PATH BIFROST_USD_CONFIG_JSON        "/${BIFUSD_INSTALL_ROOT_DIR}" "/${BIFROST_USD_PACK_INSTALL_RES_JSON_DIR}")
+file(RELATIVE_PATH BIFROST_USD_CONFIG_COMP        "/${BIFUSD_INSTALL_ROOT_DIR}" "/${BIFROST_USD_PACK_INSTALL_RES_COMP_DIR}")
 file(RELATIVE_PATH BIFROST_USD_CONFIG_SHARED_LIB  "/${BIFUSD_INSTALL_ROOT_DIR}" "/${BIFROST_USD_PACK_SHARED_LIB_DIR}")
 
 #==============================================================================
 # Build resource outputs
 
 set(BIFROST_USD_OUTPUT_JSON_DIR    "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_INSTALL_RES_JSON_DIR}")
+set(BIFROST_USD_OUTPUT_COMP_DIR    "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_INSTALL_RES_COMP_DIR}")
 set(BIFROST_USD_OUTPUT_ICONS_DIR   "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_INSTALL_RES_ICONS_DIR}")
 set(BIFROST_USD_OUTPUT_DOCS_DIR    "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_INSTALL_RES_DOCS_DIR}")
 set(BIFROST_USD_OUTPUT_PROC_DIR    "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_INSTALL_RES_PROC_DIR}")
 
-set(BIFROST_USD_OUTPUT_LIB_CONFIG_FILE "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_INSTALL_CONFIG_FILE}")
+set(BIFROST_USD_OUTPUT_MAIN_CONFIG_FILE "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_CONFIG_FILE_MAIN}")
+set(BIFROST_USD_OUTPUT_LIBS_CONFIG_FILE "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_CONFIG_FILE_LIBS}")
+set(BIFROST_USD_OUTPUT_COMP_CONFIG_FILE "${PROJECT_BINARY_DIR}/${BIFROST_USD_PACK_CONFIG_FILE_COMP}")
 
 #==============================================================================
 # External dependencies
@@ -99,6 +106,8 @@ set_target_properties( ${BIFUSD_PACKAGE_NAME}_config_info PROPERTIES
     BIFROST_USD_PACK_ALL_JSON_FILES       ""
     BIFROST_USD_PACK_ALL_JSON_FILES_DIR   "${BIFROST_USD_OUTPUT_JSON_DIR}"
     BIFROST_USD_PACK_INSTALL_RES_JSON_DIR "${BIFROST_USD_PACK_INSTALL_RES_JSON_DIR}"
-    BIFROST_USD_LIB_CONFIG_FILE           "${BIFROST_USD_OUTPUT_LIB_CONFIG_FILE}"
+    BIFROST_USD_MAIN_CONFIG_FILE          "${BIFROST_USD_OUTPUT_MAIN_CONFIG_FILE}"
+    BIFROST_USD_LIBS_CONFIG_FILE          "${BIFROST_USD_OUTPUT_LIBS_CONFIG_FILE}"
+    BIFROST_USD_COMP_CONFIG_FILE          "${BIFROST_USD_OUTPUT_COMP_CONFIG_FILE}"
     BIFROST_USD_CONFIG_SHARED_LIB         "${BIFUSD_INSTALL_ROOT_DIR}/${BIFROST_USD_CONFIG_SHARED_LIB}"
 )

cmake/utils.cmake

@@ -1,6 +1,6 @@
 #-
 #*****************************************************************************
-# Copyright 2023 Autodesk, Inc.
+# Copyright 2024 Autodesk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -59,6 +59,22 @@ function(configure_bifusd_unittest unittest_src_file test_module_name)
        "AMINO_ALWAYS_PRINT_ERRORS=1"
         ${ENV_VARS})
 
+    if(BIFUSD_ENABLE_UNDEFINED_SANITIZER)
+        list(APPEND env_vars "UBSAN_OPTIONS=print_stacktrace=1")
+    endif()
+
+    list(APPEND env_vars ${BIFUSD_EXTRA_SANITIZER_ENV_VARS})
+
+    # The google tests are causing some issues with Clang address sanitizer when linking with USD libraries.
+    # The sanitizer will detect some container overflows in USD libs just be creating
+    # an executable with the following empty google test "TEST(TEST_EMPTY, empty_test) {}"!
+    #
+    # See this ticket related to sanitizer errors in OpenUSD:
+    # https://github.com/PixarAnimationStudios/OpenUSD/issues/3088
+    if(BIFUSD_ENABLE_ADDRESS_SANITIZER)
+        list(APPEND env_vars "ASAN_OPTIONS=detect_container_overflow=0")
+    endif()
+
     bifusd_configure_unittest(${unittest_target}
                                SRC_FILES       ${unittest_src_file}
                                                ${EXTRA_SRC_FILES}

cmake/version.info

@@ -1,3 +1,3 @@
 set(BIFROST_USD_PACK_MAJOR_VERSION 1)
 set(BIFROST_USD_PACK_MINOR_VERSION 3)
-set(BIFROST_USD_PACK_PATCH_LEVEL   1)
+set(BIFROST_USD_PACK_PATCH_LEVEL   3)

compound-dev.json

@@ -0,0 +1,20 @@
+{
+    "AminoConfigurations": [
+        {
+            "libraryName": "bifrostUsdPackCompounds",
+            "libraryVersion": "",
+            "vendorName": "Autodesk",
+            "libraryDependencies": [],
+            "jsonLibs": [
+                {
+                    "path": "src/compounds"
+                },
+                {
+                    "path": "src/graphs"
+                }
+            ]
+        }
+    ],
+    "include":  "examples/packs/bifrost_config.json",
+    "include":  "test/usd_pack_test_config.json"
+}

examples/maya_plugin/plug-ins/bifrostUSDExamples.py.in

@@ -42,9 +42,16 @@ def initializePlugin(plugin):
     # Add runtime commands
     import bifrost_usd.runtime_cmds as rtc
 
+    rtc.create_maya_usd_material_library_cmd()
+    rtc.create_new_stage_cmd()
     rtc.create_stage_from_sublayers_cmd()
+    rtc.create_lookdev_stage_from_layers_cmd()
     rtc.open_bifrost_usd_graph_editor_cmd()
-    rtc.create_new_stage_cmd()
+    rtc.open_maya_usd_material_library_cmd()
+    rtc.usd_attribute_quick_look_from_selection_cmd()
+    rtc.prim_selection_to_string_array_compound_cmd()
+    rtc.remove_prim_selection_from_string_to_array_compound_cmd()
+    rtc.select_prims_from_selected_node_cmd()
 
     import bifrost_usd.component_creator.runtime_cmds as cc_rtc