Merge pull request #785 from danrbailey/csgmerge

Faster CSG Operations

Author: danrbailey

CHANGES

@@ -1,10 +1,24 @@
 OpenVDB Version History
 =======================
 
-Version 7.1.1 - In Development
+Version 7.2.0 - In Development
+
+    New features:
+    - Added tree::DynamicNodeManager that lazily caches the nodes at each
+      level of the tree to allow for efficient threading of topology-changing
+      top-down workflows.
+    - Added tools::CsgUnionOp, tools::CsgIntersectionOp and
+      tools::CsgDifferenceOp that use a parallel breadth-first algorithm to
+      accelerate CSG union, intersection and difference operations.
+    - Added tools::TreeToMerge which provides methods to steal or deep-copy
+      from a tree based on the tag dispatch class used in its construction.
 
     Improvements:
     - util::CpuTimer now uses C++11 chrono instead of TBB.
+    - Threaded the construction of LeafManager and NodeManager linear arrays.
+    - tools::csgUnion, tools::csgIntersection and tools::csgDifference now use
+      the new parallel breadth-first algorithms for much faster performance.
+    - Extended tree::NodeManager to allow for use with a const tree.
 
     Houdini:
     - Fixed a bug in the OpenVDB Points Convert SOP where the auto voxel
@@ -19,6 +33,15 @@ Version 7.1.1 - In Development
     - Fixed a bug which could cause recursive compile time instantiations of
       TypeList objects, manifesting in longer compile times.
 
+    API changes:
+    - Deprecated tree::LeafManager::getNodes. This method is no longer used when
+      constructing a NodeManager from a LeafManager.
+    - Deprecated Tree::visitActiveBBox, Tree::visit and Tree::visit2 methods in
+      favor of using a tree::DynamicNodeManager.
+    - Removed tools::CsgVisitorBase, tools::CsgVisitorUnion,
+      tools::CsgVisitorIntersection and tools::CsgVisitorDifference. The CSG
+      tools now use the parallel breath-first algorithms.
+
     Build:
     - Removed the Makefiles.
     - Re-organised the repository layout such that each independent library

doc/CMakeLists.txt

@@ -51,7 +51,7 @@ set(DOXY_FILES
   doc/python.txt)
 
 set(DOXYGEN_PROJECT_NAME "OpenVDB")
-set(DOXYGEN_PROJECT_NUMBER "7.1.1")
+set(DOXYGEN_PROJECT_NUMBER "7.2.0")
 set(DOXYGEN_PROJECT_BRIEF "")
 set(DOXYGEN_FILE_PATTERNS "*.h") # headers only
 set(DOXYGEN_IMAGE_PATH "doc/img")
@@ -85,7 +85,7 @@ set(DOXYGEN_ALIASES
   [[ijk="(<i>i</i>,&nbsp;<i>j</i>,&nbsp;<i>k</i>)"]]
   [[xyz="(<i>x</i>,&nbsp;<i>y</i>,&nbsp;<i>z</i>)"]]
   [[const="<tt>const</tt>"]]
-  [["vdbnamespace=openvdb::v7_1"]]
+  [["vdbnamespace=openvdb::v7_2"]]
   [["hunamespace=houdini_utils"]]
   [["hvdbnamespace=openvdb_houdini"]]
   # Use this command to create a link to an OpenVDB class, function, etc.
@@ -108,7 +108,7 @@ set(DOXYGEN_ALIASES
   )
 
 set(DOXYGEN_PREDEFINED
-  "OPENVDB_VERSION_NAME=v7_1"
+  "OPENVDB_VERSION_NAME=v7_2"
   "OPENVDB_ABI_VERSION_NUMBER=7"
   [[__declspec(x):= __attribute__(x):=]]
   "OPENVDB_USE_LOG4CPLUS=")

doc/changes.txt

@@ -2,13 +2,34 @@
 
 @page changes Release Notes
 
-@htmlonly <a name="v7_1_1_changes"></a>@endhtmlonly
+@htmlonly <a name="v7_2_0_changes"></a>@endhtmlonly
 @par
-<B>Version 7.1.1</B> - <I>In Development</I>
+<B>Version 7.2.0</B> - <I>In Development</I>
+
+@par
+New features:
+- Added @vdblink::tree::DynamicNodeManager DynamicNodeManager@endlink that
+  lazily caches the nodes at each level of the tree to allow for efficient
+  threading of topology-changing top-down workflows.
+- Added @vdblink::tools::CsgUnionOp CsgUnionOp@endlink,
+  @vdblink::tools::CsgIntersectionOp CsgIntersectionOp@endlink and
+  @vdblink::tools::CsgDifferenceOp CsgDifferenceOp@endlink that use a parallel
+  breadth-first algorithm to accelerate CSG union, intersection and difference
+  operations.
+- Added @vdblink::tools::TreeToMerge TreeToMerge@endlink which provides methods
+  to steal or deep-copy from a tree based on the tag dispatch class used in its
+  construction.
 
 @par
 Improvements:
 - util::CpuTimer now uses C++11 chrono instead of TBB.
+- Threaded the construction of LeafManager and NodeManager linear arrays.
+- @vdblink::tools::csgUnion() csgUnion@endlink,
+  @vdblink::tools::csgIntersection() csgIntersection@endlink and
+  @vdblink::tools::csgDifference() csgDifference@endlink now use the new
+  parallel breadth-first algorithms for much faster performance.
+- Extended @vdblink::tree::NodeManager NodeManager@endlink to allow for use with
+  a const tree.
 
 @par
 Houdini:
@@ -25,6 +46,16 @@ Bug Fixes:
 - Fixed a bug which could cause recursive compile time instantiations of
   TypeList objects, manifesting in longer compile times.
 
+@par
+API changes:
+- Deprecated tree::LeafManager::getNodes. This method is no longer used when
+  constructing a NodeManager from a LeafManager.
+- Deprecated Tree::visitActiveBBox, Tree::visit and Tree::visit2 methods in
+  favor of using a tree::DynamicNodeManager.
+- Removed tools::CsgVisitorBase, tools::CsgVisitorUnion,
+  tools::CsgVisitorIntersection and tools::CsgVisitorDifference. The CSG tools
+  now use the parallel breath-first algorithms.
+
 @par
 Build:
 - Removed the Makefiles.

openvdb/openvdb/CMakeLists.txt

@@ -318,6 +318,7 @@ set(OPENVDB_LIBRARY_TOOLS_INCLUDE_FILES
   tools/LevelSetTracker.h
   tools/LevelSetUtil.h
   tools/Mask.h
+  tools/Merge.h
   tools/MeshToVolume.h
   tools/Morphology.h
   tools/MultiResGrid.h

openvdb/openvdb/Types.h

@@ -1045,6 +1045,10 @@ class ShallowCopy {};
 /// @brief Tag dispatch class that distinguishes topology copy constructors
 /// from deep copy constructors
 class TopologyCopy {};
+/// @brief Tag dispatch class that distinguishes constructors that deep copy
+class DeepCopy {};
+/// @brief Tag dispatch class that distinguishes constructors that steal
+class Steal {};
 /// @brief Tag dispatch class that distinguishes constructors during file input
 class PartialCreate {};