Pass readOptions as an argument to all the I/O read routines

Signed-off-by: Dan Bailey <danbailey@ilm.com>

Author: danrbailey

openvdb/openvdb/io/Archive.cc

@@ -887,7 +887,7 @@ Archive::connectInstance(const GridDescriptor& gd, const NamedGridMap& grids) co
 
 
 GridBase::Ptr
-Archive::readGrid(const GridDescriptor& gd, std::istream& is, const BBoxd& worldBBox, bool partial/* = false*/)
+Archive::readGrid(const GridDescriptor& gd, std::istream& is, const io::ReadOptions& readOptions)
 {
     // Read the compression settings for this grid and tag the stream with them
     // so that downstream functions can reference them.
@@ -939,8 +939,9 @@ Archive::readGrid(const GridDescriptor& gd, std::istream& is, const BBoxd& world
     io::setGridClass(is, gridClass);
 
     grid->readTransform(is);
-    if (!partial && !gd.isInstance()) {
+    if (readOptions.readMode != io::ReadMode::TopologyOnly && !gd.isInstance()) {
         grid->readTopology(is);
+        const auto& worldBBox = readOptions.clipBBox;
         const bool clip = worldBBox.isSorted();
         if (clip) {
             const auto indexBBox = grid->constTransform().worldToIndexNodeCentered(worldBBox);

openvdb/openvdb/io/Archive.h

@@ -132,9 +132,9 @@ class OPENVDB_API Archive
     static int32_t readGridCount(std::istream&);
 
     /// @brief Read in and create the grid represented by the given grid descriptor using the
-    /// given input stream, but only where it intersects the given world-space bounding box.
-    /// @param partial If true, only read the metadata and transform of the grid.
-    static GridBase::Ptr readGrid(const GridDescriptor&, std::istream&, const BBoxd&, bool partial = false);
+    /// given input stream, using the provided options if given.
+    static GridBase::Ptr readGrid(const GridDescriptor&, std::istream&,
+        const io::ReadOptions& readOptions = io::ReadOptions{});
 
     using NamedGridMap = std::map<Name /*uniqueName*/, GridBase::Ptr>;
 

openvdb/openvdb/io/File.cc

@@ -224,7 +224,7 @@ File::open()
             gd.readHeader(inputStream());
             gd.readStreamPos(inputStream());
 
-            GridBase::Ptr grid = Archive::readGrid(gd, inputStream(), BBoxd());
+            GridBase::Ptr grid = Archive::readGrid(gd, inputStream(), io::ReadOptions{});
 
             mGridDescriptors.insert(std::make_pair(gd.gridName(), gd));
             mGrids->push_back(grid);
@@ -298,7 +298,7 @@ File::getMetadata() const
 
 
 GridPtrVecPtr
-File::getGrids() const
+File::getGrids(const io::ReadOptions& readOptions) const
 {
     if (!mIsOpen) {
         OPENVDB_THROW(IoError, mFilename << " is not open for reading");
@@ -319,7 +319,7 @@ File::getGrids() const
             const GridDescriptor& gd = i->second;
             // Seek to the grid in the file.
             gd.seekToGrid(inputStream());
-            GridBase::Ptr grid = Archive::readGrid(gd, inputStream(), BBoxd());
+            GridBase::Ptr grid = Archive::readGrid(gd, inputStream(), readOptions);
             ret->push_back(grid);
             namedGrids[gd.uniqueName()] = grid;
         }
@@ -385,7 +385,9 @@ File::readAllGridMetadata()
             const GridDescriptor& gd = i->second;
             // Seek to the grid in the file.
             gd.seekToGrid(inputStream());
-            GridBase::ConstPtr grid = Archive::readGrid(gd, inputStream(), BBoxd(), /*partial=*/true);
+            io::ReadOptions readOptions;
+            readOptions.readMode = io::ReadMode::TopologyOnly;
+            GridBase::ConstPtr grid = Archive::readGrid(gd, inputStream(), readOptions);
             // Return copies of the grids, but with empty trees.
             // (As of 0.98.0, at least, it would suffice to just const cast
             // the grid pointers returned by readGrid(partial=true), but shallow
@@ -423,7 +425,9 @@ File::readGridMetadata(const Name& name)
         // Seek to and read in the grid from the file.
         const GridDescriptor& gd = it->second;
         gd.seekToGrid(inputStream());
-        ret = Archive::readGrid(gd, inputStream(), BBoxd(), /*partial=*/true);
+        io::ReadOptions readOptions;
+        readOptions.readMode = io::ReadMode::TopologyOnly;
+        ret = Archive::readGrid(gd, inputStream(), readOptions);
     }
     return ret->copyGridWithNewTree();
 }
@@ -433,26 +437,28 @@ File::readGridMetadata(const Name& name)
 
 
 GridBase::Ptr
-File::readGrid(const Name& name)
+File::readGrid(const Name& name, const BBoxd& bbox)
 {
-    return readGrid(name, BBoxd());
+    io::ReadOptions readOptions;
+    readOptions.clipBBox = bbox;
+    return readGrid(name, readOptions);
 }
 
 
 GridBase::Ptr
-File::readGrid(const Name& name, const BBoxd& bbox)
+File::readGrid(const Name& name, const io::ReadOptions& readOptions)
 {
     if (!mIsOpen) {
         OPENVDB_THROW(IoError, mFilename << " is not open for reading.");
     }
 
-    const bool clip = bbox.isSorted();
-
     // If a grid with the given name was already read and cached
     // (along with the entire contents of the file, because the file
     // doesn't support random access), retrieve and return it.
     GridBase::Ptr grid = retrieveCachedGrid(name);
     if (grid) {
+        const auto& bbox = readOptions.clipBBox;
+        const bool clip = bbox.isSorted();
         if (clip) {
             grid = grid->deepCopyGrid();
             grid->clipGrid(bbox);
@@ -471,7 +477,7 @@ File::readGrid(const Name& name, const BBoxd& bbox)
     OPENVDB_ASSERT(inputHasGridOffsets());
     // Seek to the grid in the file.
     gd.seekToGrid(inputStream());
-    grid = Archive::readGrid(gd, inputStream(), bbox);
+    grid = Archive::readGrid(gd, inputStream(), readOptions);
 
     if (gd.isInstance()) {
         /// @todo Refactor to share code with Archive::connectInstance()?
@@ -487,7 +493,7 @@ File::readGrid(const Name& name, const BBoxd& bbox)
         GridBase::Ptr parent;
         OPENVDB_ASSERT(inputHasGridOffsets());
         parentIt->second.seekToGrid(inputStream());
-        parent = Archive::readGrid(parentIt->second, inputStream(), bbox);
+        parent = Archive::readGrid(parentIt->second, inputStream(), readOptions);
         if (parent) grid->setTree(parent->baseTreePtr());
     }
     return grid;

openvdb/openvdb/io/File.h

@@ -87,7 +87,7 @@ class OPENVDB_API File: public Archive
     MetaMap::Ptr getMetadata() const;
 
     /// Read the entire contents of the file and return a list of grid pointers.
-    GridPtrVecPtr getGrids() const;
+    GridPtrVecPtr getGrids(const io::ReadOptions& readOptions = io::ReadOptions{}) const;
 
     /// @brief Read just the grid metadata and transforms from the file and return a list
     /// of pointers to grids that are empty except for their metadata and transforms.
@@ -100,8 +100,8 @@ class OPENVDB_API File: public Archive
     /// @throw KeyError if no grid with the given name exists in this file.
     GridBase::Ptr readGridMetadata(const Name&);
 
-    /// Read an entire grid, including all of its data blocks.
-    GridBase::Ptr readGrid(const Name&);
+    /// Read an entire grid, including all of its data blocks, using the provided options if given.
+    GridBase::Ptr readGrid(const Name&, const io::ReadOptions& readOptions = io::ReadOptions{});
     /// @brief Read a grid, including its data blocks, but only where it
     /// intersects the given world-space bounding box.
     GridBase::Ptr readGrid(const Name&, const BBoxd&);

openvdb/openvdb/io/Stream.cc

@@ -51,7 +51,7 @@ Stream::Stream(std::istream& is)
         gd.readHeader(is);
         gd.readStreamPos(is);
         descriptors.push_back(gd);
-        GridBase::Ptr grid = Archive::readGrid(gd, is, BBoxd());
+        GridBase::Ptr grid = Archive::readGrid(gd, is, io::ReadOptions{});
         mGrids->push_back(grid);
         namedGrids[gd.uniqueName()] = grid;
     }