Merge pull request #1492 from danrbailey/remove_string_grids

Remove string grids

Author: danrbailey

doc/examplecode.txt

@@ -1199,7 +1199,6 @@ void processTypedGrid(openvdb::GridBase::Ptr grid, OpType& op)
     else if (grid->isType<openvdb::Vec3IGrid>())  CALL_OP(openvdb::Vec3IGrid);
     else if (grid->isType<openvdb::Vec3SGrid>())  CALL_OP(openvdb::Vec3SGrid);
     else if (grid->isType<openvdb::Vec3DGrid>())  CALL_OP(openvdb::Vec3DGrid);
-    else if (grid->isType<openvdb::StringGrid>()) CALL_OP(openvdb::StringGrid);
 
 #undef CALL_OP
 }
@@ -1221,11 +1220,6 @@ struct PruneOp {
     {
         grid->tree().prune(typename GridType::ValueType(tolerance));
     }
-    // Overload to handle string-valued grids
-    void operator()(openvdb::StringGrid::Ptr grid) const
-    {
-        grid->tree().prune();
-    }
 };
 
 // Read all grids from a file.

openvdb/openvdb/openvdb.cc

@@ -78,13 +78,6 @@ initialize()
     GridBase::clearRegistry();
     GridTypes::foreach<RegisterGrid>();
 
-    // @note String grids types are deprecated but we still register them
-    //   as supported serializable types for backward compatibility. This
-    //   will likely be removed in a future major version
-OPENVDB_NO_DEPRECATION_WARNING_BEGIN
-    StringGrid::registerGrid();
-OPENVDB_NO_DEPRECATION_WARNING_END
-
     // Register types associated with point index grids.
     Metadata::registerType(typeNameAsString<PointIndex32>(), Int32Metadata::createMetadata);
     Metadata::registerType(typeNameAsString<PointIndex64>(), Int64Metadata::createMetadata);

openvdb/openvdb/openvdb.h

@@ -221,17 +221,6 @@ using MetaTypes = TypeList<
     io::DelayedLoadMetadata>;
 
 
-// Deprecated types
-/// @note  Customizing the type of a VDB tree to an arbitrary class is still
-///  supported however std::string Trees will, in the future, no longer be
-///  provided as a native type by OpenVDB.
-using StringTree OPENVDB_DEPRECATED_MESSAGE("Support for std::string Trees "
-    "as a native type will be dropped in future versions. Please feedback with any concerns.")
-    = tree::Tree4<std::string, 5, 4, 3>::Type;
-using StringGrid OPENVDB_DEPRECATED_MESSAGE("Support for std::string Grids "
-    "as a native type will be dropped in future versions. Please feedback with any concerns.")
-    = Grid<tree::Tree4<std::string, 5, 4, 3>::Type>;
-
 } // namespace OPENVDB_VERSION_NAME
 } // namespace openvdb
 

openvdb/openvdb/unittest/TestInit.cc

@@ -45,9 +45,6 @@ TEST_F(TestInit, test)
     EXPECT_TRUE(DoubleGrid::isRegistered());
     EXPECT_TRUE(Int32Grid::isRegistered());
     EXPECT_TRUE(Int64Grid::isRegistered());
-OPENVDB_NO_DEPRECATION_WARNING_BEGIN
-    EXPECT_TRUE(StringGrid::isRegistered());
-OPENVDB_NO_DEPRECATION_WARNING_END
     EXPECT_TRUE(Vec3IGrid::isRegistered());
     EXPECT_TRUE(Vec3SGrid::isRegistered());
     EXPECT_TRUE(Vec3DGrid::isRegistered());
@@ -78,9 +75,6 @@ OPENVDB_NO_DEPRECATION_WARNING_END
     EXPECT_TRUE(!DoubleGrid::isRegistered());
     EXPECT_TRUE(!Int32Grid::isRegistered());
     EXPECT_TRUE(!Int64Grid::isRegistered());
-OPENVDB_NO_DEPRECATION_WARNING_BEGIN
-    EXPECT_TRUE(!StringGrid::isRegistered());
-OPENVDB_NO_DEPRECATION_WARNING_END
     EXPECT_TRUE(!Vec3IGrid::isRegistered());
     EXPECT_TRUE(!Vec3SGrid::isRegistered());
     EXPECT_TRUE(!Vec3DGrid::isRegistered());

openvdb_ax/openvdb_ax/test/compiler/TestVolumeExecutable.cc

@@ -578,11 +578,13 @@ TestVolumeExecutable::testActiveTileStreaming()
     }
 
     // test spatially varying voxelization for string grids which use specialized implementations
+    // Note: StringGrids are no longer registered by default
     {
-OPENVDB_NO_DEPRECATION_WARNING_BEGIN
-        openvdb::StringGrid grid;
+        using StringTree = openvdb::tree::Tree4<std::string, 5, 4, 3>::Type;
+        using StringGrid = openvdb::Grid<openvdb::tree::Tree4<std::string, 5, 4, 3>::Type>;
+        StringGrid grid;
         grid.setName("test");
-        openvdb::StringTree& tree = grid.tree();
+        StringTree& tree = grid.tree();
         tree.addTile(2, openvdb::Coord(NodeT1::DIM*0, 0, 0), "foo", /*active*/true); // NodeT1 tile
         tree.addTile(2, openvdb::Coord(NodeT1::DIM*1, 0, 0), "foo", /*active*/true); // NodeT1 tile
         tree.addTile(2, openvdb::Coord(NodeT1::DIM*2, 0, 0), "foo", /*active*/true); // NodeT1 tile
@@ -599,14 +601,14 @@ OPENVDB_NO_DEPRECATION_WARNING_BEGIN
             executable->getActiveTileStreaming("empty", openvdb::ax::ast::tokens::CoreType::FLOAT));
         executable->getTreeExecutionLevel(min,max);
         CPPUNIT_ASSERT_EQUAL(openvdb::Index(0), min);
-        CPPUNIT_ASSERT_EQUAL(openvdb::Index(openvdb::StringTree::DEPTH-1), max);
+        CPPUNIT_ASSERT_EQUAL(openvdb::Index(StringTree::DEPTH-1), max);
 
         executable->execute(grid);
 
         const openvdb::Index64 face = NodeT1::DIM * NodeT1::DIM; // face voxel count of NodeT2 x==0
         const openvdb::Index64 leafs = // expected leaf nodes that need to be created
-            (face * openvdb::StringTree::LeafNodeType::DIM) /
-            openvdb::StringTree::LeafNodeType::NUM_VOXELS;
+            (face * StringTree::LeafNodeType::DIM) /
+            StringTree::LeafNodeType::NUM_VOXELS;
 
         // number of child nodes in NodeT1;
         const openvdb::Index64 n1ChildAxisCount = NodeT1::DIM / NodeT1::getChildDim();
@@ -618,10 +620,10 @@ OPENVDB_NO_DEPRECATION_WARNING_BEGIN
 
         CPPUNIT_ASSERT_EQUAL(openvdb::Index32(leafs), tree.leafCount());
         CPPUNIT_ASSERT_EQUAL(openvdb::Index64(tiles), tree.activeTileCount());
-        CPPUNIT_ASSERT_EQUAL(int(openvdb::StringTree::DEPTH-3), tree.getValueDepth(openvdb::Coord(NodeT1::DIM*1, 0, 0)));
-        CPPUNIT_ASSERT_EQUAL(int(openvdb::StringTree::DEPTH-3), tree.getValueDepth(openvdb::Coord(NodeT1::DIM*2, 0, 0)));
-        CPPUNIT_ASSERT_EQUAL(int(openvdb::StringTree::DEPTH-3), tree.getValueDepth(openvdb::Coord(NodeT1::DIM*3, 0, 0)));
-        CPPUNIT_ASSERT_EQUAL(int(openvdb::StringTree::DEPTH-2), tree.getValueDepth(openvdb::Coord(NodeT2::DIM)));
+        CPPUNIT_ASSERT_EQUAL(int(StringTree::DEPTH-3), tree.getValueDepth(openvdb::Coord(NodeT1::DIM*1, 0, 0)));
+        CPPUNIT_ASSERT_EQUAL(int(StringTree::DEPTH-3), tree.getValueDepth(openvdb::Coord(NodeT1::DIM*2, 0, 0)));
+        CPPUNIT_ASSERT_EQUAL(int(StringTree::DEPTH-3), tree.getValueDepth(openvdb::Coord(NodeT1::DIM*3, 0, 0)));
+        CPPUNIT_ASSERT_EQUAL(int(StringTree::DEPTH-2), tree.getValueDepth(openvdb::Coord(NodeT2::DIM)));
         CPPUNIT_ASSERT_EQUAL((openvdb::Index64(NodeT1::NUM_VOXELS)*4) +
             openvdb::Index64(NodeT0::NUM_VOXELS), tree.activeVoxelCount());
 
@@ -630,7 +632,6 @@ OPENVDB_NO_DEPRECATION_WARNING_BEGIN
             if (coord.x() == 0) CPPUNIT_ASSERT_EQUAL(*it, std::string("bar"));
             else                CPPUNIT_ASSERT_EQUAL(*it, std::string("foo"));
         });
-OPENVDB_NO_DEPRECATION_WARNING_END
     }
 
     // test streaming with an OFF iterator (no streaming behaviour) and an ALL iterator (streaming behaviour for ON values only)

pendingchanges/remove_string_grids.txt

@@ -0,0 +1,2 @@
+API Changes:
+	- StringGrid and StringTrees have been removed.