NanoVDB v32.7.0 by kmuseth · Pull Request #1807 · AcademySoftwareFoundation/openvdb

kmuseth · May 8, 2024

Introducing NanoVDB v32.7.0, which is a major refactoring of v32.6, primarily related to the introduction of new namespaces and an accompanying restructuring of the directory layout of header files. This will likely require changes to client code! To this end I have included a shell script (cmd/updateFiles.sh) that will scan files and make (most) of the required changes.

The motivation for there these changes is twofold: First we want to use the same practice in terms of name spaces as OpenVDB and second the old version (32.6) was getting cluttered and messy. Specifically the main changes are:

Virtually everything in NanoVDB is no using nanovdb as a namespace
Additionally the following nested namespaces are introduced: math, tools, cuda, io
these namespaces are reflected in matching restructures in the directories of header files as well as names of functions, kernels and a classes.

Here are some examples of changes:

nanovdb::CpuTimer -> nanovdb::util::Timer
nanovdb::GpuTimer -> nanovdb::util::cuda::Timer
nanovdb::gridStats -> nanovdb::tools::gridStats
nanovdb::Coord -> nanovdb::math::Coord

Signed-off-by: Ken Museth <ken.museth@gmail.com>

apradhana · May 20, 2024

+* [GridHandle.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/GridHandle.h) defines a handler for the memory allocated to a NanoVDB grid.
+* [io/IO.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/io/IO.h) implements I/O support.
+* [tools/CreateNanoGrid.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/tools/CreateNanoGrid.h) defines the converter from OpenVDB to NanoVDB and obviously depends on the OpenVDB library (as the only header file).
+* [util/Ray.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/util/Ray.h) Ray class.


Should be math/Ray.h and https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/math/Ray.h.

apradhana · May 20, 2024

+* [io/IO.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/io/IO.h) implements I/O support.
+* [tools/CreateNanoGrid.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/tools/CreateNanoGrid.h) defines the converter from OpenVDB to NanoVDB and obviously depends on the OpenVDB library (as the only header file).
+* [util/Ray.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/util/Ray.h) Ray class.
+* [util/HDDA.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/util/HDDA.h) HDDA related.


Should be math.HDDA.h and https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/math/HDDA.h.

apradhana · May 20, 2024

+* [tools/CreateNanoGrid.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/tools/CreateNanoGrid.h) defines the converter from OpenVDB to NanoVDB and obviously depends on the OpenVDB library (as the only header file).
+* [util/Ray.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/util/Ray.h) Ray class.
+* [util/HDDA.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/util/HDDA.h) HDDA related.
+* [util/SampleFromVoxels.h](https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/util/SampleFromVoxels.h) interpolation.


Should be math/SampleFromVoxels.h and https://github.com/AcademySoftwareFoundation/openvdb/blob/master/nanovdb/nanovdb/math/SampleFromVoxels.h.

apradhana · May 20, 2024

 │   └── validate
 │       └── nanovdb_validate.cc
 ├── CNanoVDB.h
+├── cuda


apradhana · May 21, 2024

 │   ├── codingstyle.txt
 │   └── doxygen-config
 ├── examples
-│   ├── benchmark


I forgot that we took away the benchmarks.

apradhana · May 21, 2024

@@ -0,0 +1,100 @@
+#!/bin/bash


We probably need a similar file that runs on Windows.

yes good idea but I have no idea how to do scripting with string replacements in Windows

Signed-off-by: Ken Museth <ken.museth@gmail.com>

…32.7

Signed-off-by: Ken Museth <ken.museth@gmail.com>

apradhana · Jun 28, 2024

+/// @details This function allows for generic programming by converting GridData
+///          to a NanoGrid of the type encoded in GridData::mGridType.
+template<typename OpT, typename GridDataT, typename... ArgsT>
+auto callNanoGrid(GridDataT *gridData, ArgsT&&... args)


Would it make sense to change the name of this function from callNanoGrid to processTypedGrid? The argument for changing the name to processTypedGrid is that it provides a similar functionality as the one in openvdb, cf. this documentation. The argument against changing the name is because it expects a different 'signature' on the operator that a user needs to pass.

apradhana

Approved!

kmuseth · Jul 10, 2024

@apradhana - so other than the fact that the CI is broken you're fine if I merge this into master?

apradhana · Jul 10, 2024

Hi, @kmuseth, yes, you can merge it to master. These are my reasons:

As for the CI concerns: (1) I tested building and running the unit tests locally on my Linux and Windows machine, (2) I tested running your PR with a limited CI on my fork to see that the nanovdb-lite and Windows-dynamic CI were passing, (3) I'm working on top of the CI fixes that @Idclip has been working on (PR-1837) to fix the CI issues [see this PR]. As far as I can tell, the problems are not in your PR, but either in the CI runner or in CentOS 7.
As far as this PR is concerned: the biggest change introduced in this PR is the major restructuring of the APIs to make it conform better with OpenVDB. You bumped the NanoVDB minor version for that and we added updateFiles.sh and updateFiles.py to aid developers make the necessary changes. That should cover all use cases. This also allows fVDB to use the NanoVDB version in the main repository, which should help us to discover any bug we may have missed.

One thing to note after this change is that we need to keep in mind that Util.h should always be at the bottom of the NanoVDB dependency tree, followed by Math.h, followed by NanoVDB.h.

apradhana · Jul 10, 2024

For completeness, I tested the NanoVDB version that comes from this PR along with the CI work that is currently in progress here and it shows that the failing CIs are the windows-static builds.

Idclip · Jul 10, 2024

Maybe fix the CI first if you're doing that anyway

NanoVDB 32.7. Signed-off-by: apradhana <andre.pradhana@gmail.com>

initial commit of NanoVDB v32.7.0

5bc540d

Signed-off-by: Ken Museth <ken.museth@gmail.com>

kmuseth requested review from Idclip, apradhana, danrbailey, jmlait and richhones as code owners May 8, 2024 04:51

kmuseth added 2 commits May 7, 2024 21:58

fix to CMakeLists.txt

02ec97a

Signed-off-by: Ken Museth <ken.museth@gmail.com>

fixed readGrids so it works with raw grid buffers

f591ab1

Signed-off-by: Ken Museth <ken.museth@gmail.com>

kmuseth changed the title ~~initial commit of NanoVDB v32.7.0~~ NanoVDB v32.7.0 May 10, 2024

improved documentation

d57ab80

Signed-off-by: Ken Museth <ken.museth@gmail.com>

apradhana reviewed May 20, 2024

View reviewed changes

apradhana reviewed May 21, 2024

View reviewed changes

addressed review comments

d813f6d

Signed-off-by: Ken Museth <ken.museth@gmail.com>

apradhana reviewed May 26, 2024

View reviewed changes

Comment thread nanovdb/nanovdb/NanoVDB.h

Merge remote-tracking branch 'upstream/master' into feature/nanovdb_v…

1aaa3d6

…32.7

matthewdcong reviewed Jun 24, 2024

View reviewed changes

Comment thread nanovdb/nanovdb/cuda/DeviceBuffer.h Outdated

fixed typo

a836f7e

Signed-off-by: Ken Museth <ken.museth@gmail.com>

apradhana reviewed Jun 28, 2024

View reviewed changes

apradhana approved these changes Jul 9, 2024

View reviewed changes

Add updateFiles.py, bug fix in updateFiles.sh, add pending changes for

569eda1

NanoVDB 32.7. Signed-off-by: apradhana <andre.pradhana@gmail.com>

apradhana mentioned this pull request Jul 16, 2024

NanoVDB v32.7.0 with DCO Fix #1861

Merged

kmuseth force-pushed the feature/nanovdb_v32.7 branch from 94da828 to 569eda1 Compare July 16, 2024 17:09

apradhana merged commit aea0f0e into AcademySoftwareFoundation:master Jul 16, 2024

Search code, repositories, users, issues, pull requests...

Uh oh!

Conversation

kmuseth commented May 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apradhana left a comment

Choose a reason for hiding this comment

Uh oh!

kmuseth commented Jul 10, 2024

Uh oh!

apradhana commented Jul 10, 2024

Uh oh!

apradhana commented Jul 10, 2024

Uh oh!

Idclip commented Jul 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kmuseth commented May 8, 2024 •

edited

Loading