Merge branch 'RB-10.5'

Author: murraystevenson

Changes

@@ -37,11 +37,25 @@ Breaking Changes
 - IECoreNuke : Removed.
 - Removed support for `IECORE_RTLD_GLOBAL` environment variable.
 
-10.5.x.x (relative to 10.5.15.1)
+10.5.x.x (relative to 10.5.15.2)
 ========
 
 
 
+10.5.15.2 (relative to 10.5.15.1)
+=========
+
+Fixes
+-----
+
+- VDBObject : Fixed worldBound() result when bbox metadata not already present.
+
+API
+---
+
+- SConstruct : Install "private" headers.
+- VDBObject : Marked metadata() as deprecated.
+
 10.5.15.1 (relative to 10.5.15.0)
 =========
 

SConstruct

@@ -1641,6 +1641,7 @@ if doConfigure :
 		# source list
 		imageSources = sorted( glob.glob( "src/IECoreImage/*.cpp" ) )
 		imageHeaders = sorted( glob.glob( "include/IECoreImage/*.h" ) + glob.glob( "include/IECoreImage/*.inl" ) )
+		imagePrivateHeaders =  glob.glob( "include/IECoreImage/Private/*.h" )
 		imagePythonHeaders = sorted( glob.glob( "include/IECoreImageBindings/*.h" ) + glob.glob( "include/IECoreImageBindings/*.inl" ) )
 		imagePythonSources = sorted( glob.glob( "src/IECoreImageBindings/*.cpp" ) )
 		imagePythonModuleSources = sorted( glob.glob( "src/IECoreImageModule/*.cpp" ) )
@@ -1664,10 +1665,12 @@ if doConfigure :
 
 		# headers
 		imageHeaderInstall = imageEnv.Install( "$INSTALL_HEADER_DIR/IECoreImage", imageHeaders )
+		imagePrivateHeaderInstall = imageEnv.Install( "$INSTALL_HEADER_DIR/IECoreImage/Private", imagePrivateHeaders )
+
 		if env[ "INSTALL_CREATE_SYMLINKS" ] :
 			imageEnv.AddPostAction( "$INSTALL_HEADER_DIR/IECoreImage", lambda target, source, env : makeSymLinks( imageEnv, imageEnv["INSTALL_HEADER_DIR"] ) )
-		imageEnv.Alias( "install", imageHeaderInstall )
-		imageEnv.Alias( "installImage", imageHeaderInstall )
+		imageEnv.Alias( "install", [ imageHeaderInstall, imagePrivateHeaderInstall ] )
+		imageEnv.Alias( "installImage", [ imageHeaderInstall, imagePrivateHeaderInstall ] )
 
 		# python headers
 		imagePythonHeaderInstall = imageEnv.Install( "$INSTALL_HEADER_DIR/IECoreImageBindings", imagePythonHeaders )
@@ -1724,6 +1727,7 @@ scenePythonModuleEnv = corePythonModuleEnv.Clone( IECORE_NAME="IECoreScene" )
 
 sceneSources = sorted( glob.glob( "src/IECoreScene/*.cpp" ) )
 sceneHeaders = glob.glob( "include/IECoreScene/*.h" ) + glob.glob( "include/IECoreScene/*.inl" )
+scenePrivateHeaders =  glob.glob( "include/IECoreScene/private/*.h" )
 scenePythonModuleSources = sorted( glob.glob( "src/IECoreScene/bindings/*.cpp" ) )
 scenePythonScripts = glob.glob( "python/IECoreScene/*.py" )
 
@@ -1752,10 +1756,11 @@ if doConfigure :
 
 	# headers
 	sceneHeaderInstall = sceneEnv.Install( "$INSTALL_HEADER_DIR/IECoreScene", sceneHeaders )
+	scenePrivateHeaderInstall = sceneEnv.Install( "$INSTALL_HEADER_DIR/IECoreScene/private", scenePrivateHeaders )
 	if env[ "INSTALL_CREATE_SYMLINKS" ] :
 		sceneEnv.AddPostAction( "$INSTALL_HEADER_DIR/IECoreScene", lambda target, source, env : makeSymLinks( sceneEnv, sceneEnv["INSTALL_HEADER_DIR"] ) )
-	sceneEnv.Alias( "install", sceneHeaderInstall )
-	sceneEnv.Alias( "installScene", sceneHeaderInstall )
+	sceneEnv.Alias( "install", [ sceneHeaderInstall, scenePrivateHeaderInstall ] )
+	sceneEnv.Alias( "installScene", [ sceneHeaderInstall, scenePrivateHeaderInstall ] )
 
 	# python module
 	scenePythonModuleEnv.Append( LIBS = os.path.basename( sceneEnv.subst( "$INSTALL_LIB_NAME" ) ) )
@@ -1990,11 +1995,13 @@ if env["WITH_GL"] and doConfigure :
 		glEnv.Alias( "installLib", [ glLibraryInstall ] )
 
 		glHeaders = glob.glob( "include/IECoreGL/*.h" ) + glob.glob( "include/IECoreGL/*.inl" )
+		glPrivateHeaders = glob.glob( "include/IECoreGL/private/*.h" )
 		glHeaderInstall = glEnv.Install( "$INSTALL_HEADER_DIR/IECoreGL", glHeaders )
+		glPrivateHeaderInstall = glEnv.Install( "$INSTALL_HEADER_DIR/IECoreGL/private", glPrivateHeaders )
 		if env[ "INSTALL_CREATE_SYMLINKS" ] :
 			glEnv.AddPostAction( "$INSTALL_HEADER_DIR/IECoreGL", lambda target, source, env : makeSymLinks( glEnv, glEnv["INSTALL_HEADER_DIR"] ) )
-		glEnv.Alias( "install", glHeaderInstall )
-		glEnv.Alias( "installGL", glHeaderInstall )
+		glEnv.Alias( "install", [ glHeaderInstall, glPrivateHeaderInstall ] )
+		glEnv.Alias( "installGL", [ glHeaderInstall, glPrivateHeaderInstall ] )
 
 		glslHeaders = glob.glob( "glsl/IECoreGL/*.h" )
 		glslHeaderInstall = glEnv.Install( "$INSTALL_GLSL_HEADER_DIR/IECoreGL", glslHeaders )

include/IECoreVDB/VDBObject.h

@@ -82,6 +82,12 @@ class IECOREVDB_API VDBObject : public IECoreScene::VisibleRenderable
 
 		Imath::Box3f bound() const override;
 
+		// \deprecated
+		// Not threadsafe ( it computes statistics if not present and stores them on the grids ).
+		// Instead, use the VDB api, for example:
+		// findGrid( name )->beginMeta() to iterate the metadata,
+		// or
+		// findGrid( name )->evalActiveVoxelBoundingBox() or activeVoxelCount() to compute statistics
 		IECore::CompoundObjectPtr metadata( const std::string &name );
 
 		//! Are the grids in this VDBObject unmodified from the vdb file in filename?

src/IECoreVDB/VDBObject.cpp

@@ -57,11 +57,23 @@ namespace
 template<typename T>
 Imath::Box<Imath::Vec3<T> > worldBound( const openvdb::GridBase *grid, float padding = 0.50f )
 {
-	openvdb::Vec3i min = grid->metaValue<openvdb::Vec3i>( grid->META_FILE_BBOX_MIN );
-	openvdb::Vec3i max = grid->metaValue<openvdb::Vec3i>( grid->META_FILE_BBOX_MAX );
+	openvdb::CoordBBox vdbBbox;
+	try
+	{
+		vdbBbox.min() = openvdb::Coord( grid->metaValue<openvdb::Vec3i>( grid->META_FILE_BBOX_MIN ) );
+		vdbBbox.max() = openvdb::Coord( grid->metaValue<openvdb::Vec3i>( grid->META_FILE_BBOX_MAX ) );
+	}
+	catch( ... )
+	{
+		// If we don't have metadata available, then hopefully it's because the vdb was freshly created and
+		// hasn't been saved to file yet, which should mean it's fully loaded, and we can call
+		// evalActiveVoxelBoundingBox.
+		// \todo : Can we guarantee that every VDB either is loaded, or has metadata?
+		vdbBbox = grid->evalActiveVoxelBoundingBox();
+	}
 
 	openvdb::Vec3d offset = openvdb::Vec3d( padding );
-	openvdb::BBoxd indexBounds = openvdb::BBoxd( min - offset, max + offset );
+	openvdb::BBoxd indexBounds = openvdb::BBoxd( vdbBbox.min() - offset, vdbBbox.max() + offset );
 	openvdb::BBoxd worldBounds = grid->transform().indexToWorld( indexBounds );
 	openvdb::Vec3d minBB = worldBounds.min();
 	openvdb::Vec3d maxBB = worldBounds.max();