Merge release v0.8.2

Author: pixar-oss

BUILDING.md

@@ -152,7 +152,7 @@ This plugin is compatible with Alembic 1.5.2. The additional dependencies that m
 
 | Dependency Name    | Description                                                             | Version |
 | ------------------ |-----------------------------------------------------------------------  | ------- |
-| ALEMBIC_LOCATION   | The location of [Alembic](https://https://github.com/alembic/alembic)   | 1.5.2   |
+| ALEMBIC_DIR        | The location of [Alembic](https://https://github.com/alembic/alembic)   | 1.5.2   |
 | OPENEXR_LOCATION   | The location of [OpenEXR](http://www.openexr.com)                       | 2.2.0   |
 
 Support for Alembic files using the HDF5 backend is enabled by default but can be

CHANGELOG.md

@@ -1,5 +1,150 @@
 # Change Log
 
+## [0.8.2] - 2017-12-01
+
+Release 0.8.2 increments the file format version for .usdc files. New .usdc
+files created in this release will not be readable by earlier releases. See
+below for more details.
+
+### Added
+- SdfCopySpec for copying scene description specs in layers.
+- Usd.GetVersion() for retrieving USD version in Python (Issue #306)
+- UsdProperty::FlattenTo for copying a UsdProperty's resolved metadata/values.
+- IsTyped and IsConcrete schema queries on UsdSchemaRegistry and UsdSchemaBase. 
+- UsdCollectionAPI schema for representing collections of objects. This schema
+  is more expressive than UsdGeomCollectionAPI and can represent large numbers
+  of objects compactly.
+- Utility functions in UsdUtils for determining compact representations of
+  objects for UsdCollectionAPI.
+- UsdUtilsCoalescingDiagnosticDelegate, a Tf diagnostic delegate that provides
+  condensed output for diagnostic messages.
+- UsdUtilsFlattenLayerStack for flattening a UsdStage's layer stack into a
+  single layer, as well as a --flattenLayerStack option to usdcat.
+- Support for named clip sets for clip stitching API in UsdUtils.
+- Schema for cards rendering in UsdGeomModelAPI and imaging support. This
+  provides a lightweight way to collapse model hierarchies into simple
+  geometry for visualization of large scenes.
+- Ability to encode familyType on owners of families of UsdGeomSubsets.
+- Size properties for UsdLuxDiskLight, UsdLuxSphereLight, and UsdLuxRectLight. 
+  (Issue #290)
+- Support for computing bounding boxes for UsdGeomPointInstancer instances 
+  using UsdGeomBBoxCache.
+- Support for residual GPU computations in Hydra.
+- Sheer display mode in Hydra, a 'see-through' display mode akin to the
+  mesh being covered in a sheer mesh fabric instead of its regular surface.
+  Implemented as a regular grid stipple pattern of the surface at 20% opacity.
+- Testing framework for usdview.
+- PxrUsdMayaXformStack for representing transform stacks in the Maya plugin.
+- Support for exporting Maya instancers to UsdGeomPointInstancers in the Maya
+  plugin.
+- Support for exporting groups of objects with the same material binding as
+  collections encoded with UsdCollectionAPI in the Maya plugin.
+- Support for vec4 primvars in the Katana plugin.
+- Support for point instancers with varying topology that don't have authored 
+  velocities in the Katana plugin.
+- Support for importing collections encoded with new UsdCollectionAPI schema
+  in the Katana plugin.
+- Support for overriding data on a subset of point instancer instances in
+  the Houdini plugin.
+
+### Changed
+- Build system now checks that the compiler being used supports 64-bit builds. 
+- Tf diagnostic warnings and status messages issued in secondary threads are
+  no longer printed to the terminal.
+- Multiple delegates may now be registered with the Tf diagnostic system.
+- SdfLayer::RemoveInertSceneDescription removes inert overs in variants.
+- When saving a new .usdc file over an existing file, data is first saved to a 
+  temporary file then renamed to the destination file. This provides some 
+  protection for other processes that were reading the old file.
+- Compression for structural sections in .usdc files is now enabled by default.
+  New .usdc files will be marked as version 0.4.0 instead of 0.3.0 to 
+  accommodate a bug fix described below. This means that any new .usdc files 
+  created in this release will not be readable by previous USD releases.
+
+  Users can disable the compression functionality by setting the environment
+  variable `USD_WRITE_NEW_USDC_FILES_AS_VERSION` to "0.0.1". This will ensure 
+  new .usdc files will be readable in older releases.
+
+- UsdStage now uses the composed layer offset instead of its inverse when
+  mapping times in layers to the stage. For example, to shift the time samples
+  in a referenced layer stack forward by 10, users previously authored an
+  offset of -10. Under the new behavior, users need to author an offset of 10
+  instead. 
+
+  Users can revert to the old behavior by setting the environment variable
+  `USD_USE_INVERSE_LAYER_OFFSET` to 1. This will be deprecated in a future 
+  release.
+
+- UsdStage now allows a prim to be loaded without loading its descendants via
+  a new UsdLoadPolicy argument supplied to UsdStage::Load and LoadAndUnload.
+- UsdInherits, UsdSpecializes, and UsdReferences now map non-root prim paths
+  to the namespace of the edit target.
+- UsdAttribute::GetTimeSamplesInInterval now supports open/finite end points.
+- UsdClipsAPI now authors the dictionary-style clips metadata introduced in
+  release 0.7.6 by default.
+- Schemas may now define fallback values for the majority of metadata fields,
+  including custom metadata fields.
+- Schemas may now have more than 256 tokens defined.
+- usdedit now checks `USD_EDITOR` environment variable first when determining
+  which editor to use.
+- Ongoing refactoring to move code from hd to hdSt in preparation for material
+  support in Hydra and use of Hydra in other renderer backends.
+- Several performance optimizations in Hydra and UsdImaging.
+- usdview now uses a new JSON-based format for its settings file. Settings
+  files from older releases will be ignored.
+- Several changes to provide better support for Viewport 2.0 in Maya plugin.
+- Enum attributes in Maya now have their integer values exported to USD 
+  instead of their descriptive names.
+- Improved attribute transfer on USD Unpack node in Houdini plugin.
+- usdvisible and usdactive attributes in Houdini plugin are now integers
+  instead of strings.
+- Several changes to Houdini plugin for compatibility with Houdini 16.5
+  and improved HDK usage.
+
+### Deprecated
+- UsdGeomCollectionAPI, in favor of new UsdCollectionAPI.
+
+### Removed
+- TfDiagnosticNotice. The Tf diagnostic system no longer emits notices; 
+  consumers relying on these notices should use diagnostic delegates instead.
+- UsdGeomPointInstancer prototypeDrawMode attribute. Consumers should use
+  the new drawMode attributes on UsdGeomModelAPI instead.
+
+### Fixed
+- Issue where users were forced to define certain preprocessor macros in 
+  order to build code against USD. In particular, an issue introduced in 0.8.1
+  caused users who did not #define PXR_ENABLE_PYTHON_SUPPORT to run into odd
+  errors at runtime. (Issue #304)
+- Bug that caused invalid .usdc files to be written. This affected all files
+  with version 0.3.0; however, this file version was not enabled by default in
+  release 0.8.1 and would only affect users who had explicitly enabled the
+  new version via the `USD_WRITE_NEW_USDC_FILES_AS_VERSION` environment setting.
+- Precision loss when writing time sample times to .usda files.
+- Performance issue in UsdStage where memory would still be consumed by 
+  child prims after their parent prim had been deactivated.
+- Bug that caused UsdStage::ExpandPopulationMask to add invalid paths.
+- Bug that caused UsdObject::GetMetadata to not fill in resolved paths for
+  asset-valued metadata.
+- Bug where layer offsets were incorrectly applied when authoring time samples.
+- Bug in UsdUtilsStageCache that led to crashes during static destruction.
+- Unpickable objects now act as occluders during picking in Hydra.
+- Bug that caused usdview to stop drawing after "Reopen Stage" or "Open Stage".
+- Bug that caused usdview to not play all frames if the step size was changed.
+  (Issue #321)
+- Several performance and UI issues in usdview.
+- Crash in Maya plugin with nested assemblies and variant set selections.
+  (Issue #288)
+- Bug in Maya plugin where exporting over a previously-imported layer failed.
+- Bug in Maya plugin that caused lights to flip between directional and 
+  non-directional in legacy viewport.
+- Various issues that prevented UsdKatana Python module from being imported.
+  (Issue #323)
+- Material bindings above point instancer prototypes are now preserved in 
+  the Katana plugin.
+- Reworked how USD masters/sources are built in the Katana plugin so 
+  that material bindings use the correct Katana paths.
+- Hang in Houdini plugin when importing from variant paths. (Issue #309)
+
 ## [0.8.1] - 2017-10-02
 
 ### Added

CMakeLists.txt

@@ -6,6 +6,17 @@ else()
     cmake_minimum_required(VERSION 2.8.8)
 endif()
 
+if (NOT CMAKE_SIZEOF_VOID_P EQUAL 8)
+    if (WIN32)
+        message(FATAL_ERROR "Compiler does not support 64-bit builds. "
+                "If you are using Visual Studio, make sure you are in the "
+                "x64 command prompt and have specified the Win64 cmake "
+                "generator (e.g., -G \"Visual Studio 14 2015 Win64\")")
+    else()
+        message(FATAL_ERROR "Compiler does not support 64-bit builds.")
+    endif()
+endif()
+
 set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/defaults
                       ${CMAKE_SOURCE_DIR}/cmake/modules
                       ${CMAKE_SOURCE_DIR}/cmake/macros)

build_scripts/build_usd.py

@@ -99,6 +99,12 @@ def GetVisualStudioCompilerAndVersion():
 
 MSVC_2017_COMPILER_VERSION = (19, 10, 00000)
 
+def GetCPUCount():
+    try:
+        return multiprocessing.cpu_count()
+    except NotImplementedError:
+        return 1
+
 def Run(cmd):
     """Run the specified command in a subprocess."""
     PrintInfo('Running "{cmd}"'.format(cmd=cmd))
@@ -209,7 +215,7 @@ def RunCMake(context, force, extraArgs = None):
                     extraArgs=(" ".join(extraArgs) if extraArgs else "")))
         Run("cmake --build . --config Release --target install -- {multiproc}"
             .format(multiproc=("/M:{procs}" if Windows() else "-j{procs}")
-                               .format(procs=multiprocessing.cpu_count())))
+                               .format(procs=context.numJobs)))
 
 def PatchFile(filename, patches):
     """Applies patches to the specified file. patches is a list of tuples
@@ -378,10 +384,13 @@ def InstallBoost(context, force):
         Run('{bootstrap} --prefix="{instDir}"'
             .format(bootstrap=bootstrap, instDir=context.instDir))
 
+        # b2 supports at most -j64 and will error if given a higher value.
+        num_procs = min(64, context.numJobs)
+
         b2_settings = [
             '--prefix="{instDir}"'.format(instDir=context.instDir),
             '--build-dir="{buildDir}"'.format(buildDir=context.buildDir),
-            '-j{procs}'.format(procs=multiprocessing.cpu_count()),
+            '-j{procs}'.format(procs=num_procs),
             'address-model=64',
             'link=shared',
             'runtime-link=shared',
@@ -463,7 +472,7 @@ def InstallTBB_LinuxOrMacOS(context, force):
     with CurrentWorkingDirectory(DownloadURL(TBB_URL, context, force)):
         # TBB does not support out-of-source builds in a custom location.
         Run('make -j{procs}'
-            .format(procs=multiprocessing.cpu_count()))
+            .format(procs=context.numJobs))
 
         CopyFiles(context, "build/*_release/libtbb*.*", "lib")
         CopyDirectory(context, "include/serial", "include/serial")
@@ -495,7 +504,7 @@ def InstallJPEG_Lib(context, force):
             '--disable-static --enable-shared'
             .format(instDir=context.instDir))
         Run('make -j{procs} install'
-            .format(procs=multiprocessing.cpu_count()))
+            .format(procs=context.numJobs))
 
 JPEG = Dependency("JPEG", InstallJPEG, "include/jpeglib.h")
 
@@ -596,7 +605,7 @@ def InstallGLEW_LinuxOrMacOS(context, force):
     with CurrentWorkingDirectory(DownloadURL(GLEW_URL, context, force)):
         Run('make GLEW_DEST="{instDir}" -j{procs} install'
             .format(instDir=context.instDir,
-                    procs=multiprocessing.cpu_count()))
+                    procs=context.numJobs))
 
 GLEW = Dependency("GLEW", InstallGLEW, "include/GL/glew.h")
 
@@ -742,7 +751,7 @@ def GetPySideInstructions():
 ############################################################
 # HDF5
 
-HDF5_URL = "http://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.10/hdf5-1.10.0-patch1/src/hdf5-1.10.0-patch1.zip"
+HDF5_URL = "https://support.hdfgroup.org/ftp/HDF5/releases/hdf5-1.10/hdf5-1.10.0-patch1/src/hdf5-1.10.0-patch1.zip"
 
 def InstallHDF5(context, force):
     with CurrentWorkingDirectory(DownloadURL(HDF5_URL, context, force)):
@@ -903,6 +912,10 @@ def InstallUSD(context):
                    help="Suppress all output except for error messages")
 
 group = parser.add_argument_group(title="Build Options")
+group.add_argument("-j", "--jobs", type=int, default=GetCPUCount(),
+                   help=("Number of build jobs to run in parallel. "
+                         "(default: # of processors [{0}])"
+                         .format(GetCPUCount())))
 group.add_argument("--build", type=str,
                    help=("Build directory for USD and 3rd-party dependencies " 
                          "(default: <install_dir>/build)"))
@@ -1052,6 +1065,9 @@ def __init__(self, args):
         # CMake generator
         self.cmakeGenerator = args.generator
 
+        # Number of jobs
+        self.numJobs = args.jobs
+
         # Build type
         self.buildShared = (args.build_type == SHARED_LIBS)
         self.buildMonolithic = (args.build_type == MONOLITHIC_LIB)
@@ -1107,6 +1123,10 @@ def ForceBuildDependency(self, dep):
 context = InstallContext(args)
 verbosity = args.verbosity
 
+if context.numJobs <= 0:
+    PrintError("Number of jobs must be greater than 0")
+    sys.exit(1)
+
 # Augment PATH on Windows so that 3rd-party dependencies can find libraries
 # they depend on. In particular, this is needed for building IlmBase/OpenEXR.
 extraPaths = []

cmake/defaults/CXXDefaults.cmake

@@ -33,10 +33,6 @@ elseif(MSVC)
     include(msvcdefaults)
 endif()
 
-# We don't use this prefix in the open source build
-# because CMake bakes out full paths.
-_add_define(BUILD_COMPONENT_SRC_PREFIX="")
-
 _add_define(GL_GLEXT_PROTOTYPES)
 _add_define(GLX_GLXEXT_PROTOTYPES)
 
@@ -48,13 +44,7 @@ if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
     _add_define(LINUX)
 endif()
 
-if(CMAKE_BUILD_TYPE STREQUAL "Release")
-    _add_define(BUILD_OPTLEVEL_OPT)
-elseif(CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
-    _add_define(BUILD_OPTLEVEL_OPT)
-elseif(CMAKE_BUILD_TYPE STREQUAL "MinSizeRel")
-    _add_define(BUILD_OPTLEVEL_OPT)
-elseif(CMAKE_BUILD_TYPE STREQUAL "Debug")
+if(CMAKE_BUILD_TYPE STREQUAL "Debug")
     _add_define(BUILD_OPTLEVEL_DEV)
 endif()
 
@@ -85,6 +75,13 @@ else()
     message(STATUS "C++ namespaces disabled.")
 endif()
 
+# Set Python configuration
+if (PXR_ENABLE_PYTHON_SUPPORT)
+    set(PXR_PYTHON_SUPPORT_ENABLED "1")
+else()
+    set(PXR_PYTHON_SUPPORT_ENABLED "0")
+endif()
+
 # XXX: This is a workaround for an issue in which Python headers unequivocally
 # redefine macros defined in standard library headers. This behavior 
 # prevents users from running strict builds with PXR_STRICT_BUILD_MODE

cmake/defaults/Options.cmake

@@ -23,6 +23,7 @@
 #
 option(PXR_STRICT_BUILD_MODE "Turn on additional warnings. Enforce all warnings as errors." OFF)
 option(PXR_VALIDATE_GENERATED_CODE "Validate script generated code" OFF)
+option(PXR_HEADLESS_TEST_MODE "Disallow GUI based tests, useful for running under headless CI systems." OFF)
 option(PXR_BUILD_TESTS "Build tests" ON)
 option(PXR_BUILD_IMAGING "Build imaging components" ON)
 option(PXR_BUILD_EMBREE_PLUGIN "Build embree imaging plugin" OFF)

cmake/defaults/Packages.cmake

@@ -39,7 +39,6 @@ set(PXR_THREAD_LIBS "${CMAKE_THREAD_LIBS_INIT}")
 
 if(PXR_ENABLE_PYTHON_SUPPORT)
     # --Python.  We are generally but not completely 2.6 compliant.
-    add_definitions(-DPXR_PYTHON_SUPPORT_ENABLED)
     find_package(PythonInterp 2.7 REQUIRED)
     find_package(PythonLibs 2.7 REQUIRED)
 

cmake/defaults/Version.cmake

@@ -24,4 +24,4 @@
 # Versioning information
 set(PXR_MAJOR_VERSION "0")
 set(PXR_MINOR_VERSION "8")
-set(PXR_PATCH_VERSION "1")
+set(PXR_PATCH_VERSION "2")

cmake/defaults/clangdefaults.cmake

@@ -24,10 +24,7 @@
 
 include(gccclangshareddefaults)
 
-# Defining TF_NO_GNU_EXT disables using the gnu hash_set and hash_map
-# containers on platforms where we can't. The implementation will
-# substitute C++11 containers with equivalent semantics in this case.
-set(_PXR_CXX_FLAGS "${_PXR_GCC_CLANG_SHARED_CXX_FLAGS} -DTF_NO_GNU_EXT")
+set(_PXR_CXX_FLAGS "${_PXR_GCC_CLANG_SHARED_CXX_FLAGS}")
 
 # clang annoyingly warns about the -pthread option if it's only linking.
 if(CMAKE_USE_PTHREADS_INIT)

cmake/defaults/msvcdefaults.cmake

@@ -77,11 +77,6 @@ _add_define("_SCL_SECURE_NO_WARNINGS")
 # will conflict with std::min() and std::max().
 _add_define("NOMINMAX")
 
-# Defining TF_NO_GNU_EXT disables using the gnu hash_set and  hash_map
-# containers on platforms where we can't. The implementation will
-# substitute C++11 containers with equivalent semantics in this case.
-_add_define("TF_NO_GNU_EXT")
-
 # Needed to prevent YY files trying to include unistd.h
 # (which doesn't exist on Windows)
 _add_define("YY_NO_UNISTD_H")

cmake/macros/Public.cmake

@@ -560,7 +560,7 @@ endfunction() # pxr_install_test_dir
 function(pxr_register_test TEST_NAME)
     if (PXR_BUILD_TESTS)
         cmake_parse_arguments(bt
-            "PYTHON;REQUIRES_DISPLAY;REQUIRES_SHARED_LIBS;REQUIRES_PYTHON_MODULES" 
+            "PYTHON;REQUIRES_SHARED_LIBS;REQUIRES_PYTHON_MODULES" 
             "CUSTOM_PYTHON;COMMAND;STDOUT_REDIRECT;STDERR_REDIRECT;DIFF_COMPARE;POST_COMMAND;POST_COMMAND_STDOUT_REDIRECT;POST_COMMAND_STDERR_REDIRECT;PRE_COMMAND;PRE_COMMAND_STDOUT_REDIRECT;PRE_COMMAND_STDERR_REDIRECT;FILES_EXIST;FILES_DONT_EXIST;CLEAN_OUTPUT;EXPECTED_RETURN_CODE;TESTENV"
             "ENV;PRE_PATH;POST_PATH"
             ${ARGN}
@@ -602,10 +602,6 @@ function(pxr_register_test TEST_NAME)
             set(testWrapperCmd ${testWrapperCmd} --stderr-redirect=${bt_STDERR_REDIRECT})
         endif()
 
-        if (bt_REQUIRES_DISPLAY)
-            set(testWrapperCmd ${testWrapperCmd} --requires-display)
-        endif()
-
         if (bt_PRE_COMMAND_STDOUT_REDIRECT)
             set(testWrapperCmd ${testWrapperCmd} --pre-command-stdout-redirect=${bt_PRE_COMMAND_STDOUT_REDIRECT})
         endif()