C++ API Reference

Class Summary:

Class

Description

omni::vdb::tool::IVDBTool

IVDBTool interface.

omni::vdb::tool::LoadVDBParameters

Parameter set for loading VDB volumes

omni::vdb::tool::SaveVDBParameters

Parameter set for saving VDB volumes

This is an example of how to acquire IVDBTool interface:

static const char s_vdbtool[] = "omni.vdb.tool.plugin";
omni::vdb::tool::IVDBTool* ivdbtool =
    carb::getCachedInterface<omni::vdb::tool::IVDBTool, s_vdbtool>();
if (!ivdbtool)
{
    CARB_LOG_ERROR("Failed to get IVDBTool interface");
    return false;
}

The methods of omni::vdb::tool::IVDBTool are listed below.

Methods Summary:

Method

Description

bufferToVolume

Get a volume from serialized NanoVDB buffer.

clipVolume

Clip a VDB grid against another grid.

compareVolume

Compare volumes and print evaluation results.

compositeVolume

Composite two given grids.

computeVolume

Generate a grid by computation on given grid.

convertVolume

Convert a sequence of volumes.

createVolumeFromCoordValuePairs

Create a volume from a pair of ijk coordinates and corresponding values.

csgLevelset

CSG op. of two level sets surfaces.

expandLevelset

Expand narrow band of a level set VDB.

filterLevelset

Filter a level set surface.

floodLevelset

Signed-flood filling of a level set VDB.

isoToLevelset

Convert an iso-surface of a scalar field into a level set (i.e. SDF).

levelsetToFog

Convert a level set VDB into a VDB with a fog volume, i.e. normalized density.

levelsetToMesh

Get mesh data from a level set volume.

loadVolume

Load a volume from the specified fullpath with loader parameters.

meshToLevelset

Get a level set volume from mesh data.

multiResGrid

Construct a LoD sequences of VDB trees with powers of two refinements.

offsetLevelset

Morphological operations on level set surface by a fixed radius (dilate, erode, open, close).

pointsToLevelset

Convert geometry points into a narrow-band level set.

printVolume

Print a volume information.

pruneLevelset

Prune away inactive values in a level set VDB.

resampleVolume

Resample one VDB grid into another VDB grid.

saveVolume

Save a volume to specified fullpath with saver parameters.

scatterPointsToVolume

Scatter point into the active values of an input VDB grid.

segmentVolume

Segment an input VDB into a list if topologically disconnected VDB grids.

transformVolume

Apply affine transform to a given volume.

volumeToBuffer

Get serialized NanoVDB buffer from a volume.