Merge pull request #1079 from Idclip/morph_deprecation_msgs

Improved deprecation messages on dilation and erosion API

Author: Idclip

openvdb/openvdb/tools/Morphology.h

@@ -1192,7 +1192,7 @@ inline void erodeActiveValues(TreeOrLeafManagerT& treeOrLeafM,
 ///
 /// @note The values of any voxels are unchanged.
 template<typename TreeType>
-OPENVDB_DEPRECATED
+OPENVDB_DEPRECATED_MESSAGE("Switch to tools::dilateActiveValues. Use tools::IGNORE_TILES to maintain same (but perhaps unintended) behaviour")
 inline void dilateVoxels(TreeType& tree,
                          int iterations = 1,
                          NearestNeighbors nn = NN_FACE)
@@ -1219,7 +1219,7 @@ inline void dilateVoxels(TreeType& tree,
 ///
 /// @note The values of any voxels are unchanged.
 template<typename TreeType>
-OPENVDB_DEPRECATED
+OPENVDB_DEPRECATED_MESSAGE("Switch to tools::dilateActiveValues. Use tools::IGNORE_TILES to maintain same (but perhaps unintended) behaviour")
 inline void dilateVoxels(tree::LeafManager<TreeType>& manager,
                          int iterations = 1,
                          NearestNeighbors nn = NN_FACE)
@@ -1237,7 +1237,7 @@ inline void dilateVoxels(tree::LeafManager<TreeType>& manager,
 /// of any voxels, only their active states.
 /// @todo Currently operates only on leaf voxels; need to extend to tiles.
 template<typename TreeType>
-OPENVDB_DEPRECATED
+OPENVDB_DEPRECATED_MESSAGE("Switch to tools::erodeActiveValues. Use tools::IGNORE_TILES to maintain same (but perhaps unintended) behaviour")
 inline void erodeVoxels(TreeType& tree,
                         int iterations=1,
                         NearestNeighbors nn = NN_FACE)
@@ -1252,7 +1252,7 @@ inline void erodeVoxels(TreeType& tree,
 }
 
 template<typename TreeType>
-OPENVDB_DEPRECATED
+OPENVDB_DEPRECATED_MESSAGE("Switch to tools::erodeActiveValues. Use tools::IGNORE_TILES to maintain same (but perhaps unintended) behaviour")
 inline void erodeVoxels(tree::LeafManager<TreeType>& manager,
                         int iterations = 1,
                         NearestNeighbors nn = NN_FACE)

openvdb/openvdb/unittest/TestMorphology.cc

@@ -683,3 +683,22 @@ TEST_F(TestMorphology, testPreserveMaskLeafNodes)
         EXPECT_EQ(mask.probeConstLeaf({i,i,i}), nodes[i]);
     }
 }
+
+
+TEST_F(TestMorphology, testDeprecated)
+{
+    // just test these can be instantiated
+
+OPENVDB_NO_DEPRECATION_WARNING_BEGIN
+    openvdb::FloatTree tree;
+    openvdb::tree::LeafManager<openvdb::FloatTree> lm(tree);
+
+    openvdb::tools::dilateVoxels(tree, 1);
+    lm.rebuild();
+    openvdb::tools::dilateVoxels(lm, 1);
+    openvdb::tools::erodeVoxels(tree, 1);
+
+    lm.rebuild();
+    openvdb::tools::erodeVoxels(lm, 1);
+OPENVDB_NO_DEPRECATION_WARNING_END
+}