PolySoupToLevelSet< GridType > Class Template Reference

Class that implements the actual shrink wrap algorithm. More...

#include <openvdb/tools/PolySoupToLevelSet.h>

Public Member Functions
	PolySoupToLevelSet (PolySoup &&poly, int dim, float width=float(LEVEL_SET_HALF_WIDTH))
	Constructor from a desired voxel dimension.
	PolySoupToLevelSet (PolySoup &&poly, float voxelSize, float width=float(LEVEL_SET_HALF_WIDTH))
	Constructor from a desired voxel size.
template<class ShrinkWrapT, class ProgressT>
void	process (const ShrinkWrapT &D, ProgressT *progress, int mode=0)
	Performs the actual processing to generate the shrink wrap surfaces.
size_t	gridCount () const
	Number of shrink wrap grids generated, i.e. depth of the LOD hierarchy.
GridType::Ptr	grid (int n=0) const
	Returns a shared pointer to a particular shrink wrap grid.
std::vector< typename GridType::Ptr >	grids () const
	Vector with shared pointers to all the shrink wrap grids.
const PolySoup &	mesh (int n=0, float adaptivity=0.005f, float isoValue=0.0f)
	Generate an adaptive polygon mesh from a particular shrink wrap SDF.
auto	offset (float dx, int mode=0)
	Generates a dx-offset level set surface from the internal polygon soup.
float	minVoxelSize () const
	Returns the finest/smallest voxel size, in world units, i.e. the voxel size of the final (highest-resolution) level set surface.
float	maxVoxelSize () const
	Returns the coarsest/largest voxel size, in world units, used to initiate the coarse-to-fine shrink wrap algorithm.
float	halfWidth () const
	Returns the half-width of the output narrow-band level set, in voxel units.

Static Public Member Functions
static math::BBox< Vec3f >	getBBox (const std::vector< Vec3s > &vtx)
	Static method that computes the bounding box of a list of vertex coordinates.

Detailed Description

template<typename GridType>
class openvdb::v13_0::tools::PolySoupToLevelSet< GridType >

Class that implements the actual shrink wrap algorithm.

This class implements our shrink wrap algorithm. Normally the free-standing function called above should be used instead of this class.

Template Parameters

GridType	Template parameter of the desired shrink wrap grids
GridType	Grid type of the generated level set surfaces (defaults to FloatGrid)

Constructor & Destructor Documentation

PolySoupToLevelSet() [1/2]

template<typename GridType>

PolySoupToLevelSet	(	PolySoup &&	poly,
		int	dim,
		float	width = float(LEVEL_SET_HALF_WIDTH) )

Constructor from a desired voxel dimension.

Parameters

poly	Polygon soup that will be moved to this instance.
dim	Desired voxel dimension of the output level set.
width	Half-width of the output narrow-band level set, in voxel units.

PolySoupToLevelSet() [2/2]

template<typename GridType>

PolySoupToLevelSet	(	PolySoup &&	poly,
		float	voxelSize,
		float	width = float(LEVEL_SET_HALF_WIDTH) )

Constructor from a desired voxel size.

Parameters

poly	Polygon soup that will be moved to this instance.
voxelSize	Desired voxel size of the output level set in world units.
width	Half-width of the output narrow-band level set, in voxel units.

Member Function Documentation

getBBox()

template<typename GridType>

math::BBox< Vec3f > getBBox ( const std::vector< Vec3s > & vtx )

static

Static method that computes the bounding box of a list of vertex coordinates.

Parameters

vtx	Vector of vertex coordinates.

grid()

template<typename GridType>

GridType::Ptr grid ( int n = 0 ) const

inline

Returns a shared pointer to a particular shrink wrap grid.

Parameters

n	Number of the shrink wrap grid, where n = 0 has the finest sampling and n = gridCount-1 is the coarsest voxel sampling.

gridCount()

template<typename GridType>

size_t gridCount ( ) const

inline

Number of shrink wrap grids generated, i.e. depth of the LOD hierarchy.

grids()

template<typename GridType>

std::vector< typename GridType::Ptr > grids ( ) const

inline

Vector with shared pointers to all the shrink wrap grids.

Note

The grids are arranged fine to coarse, grids()[0] is the finest.

halfWidth()

template<typename GridType>

float halfWidth ( ) const

inline

Returns the half-width of the output narrow-band level set, in voxel units.

maxVoxelSize()

template<typename GridType>

float maxVoxelSize ( ) const

inline

Returns the coarsest/largest voxel size, in world units, used to initiate the coarse-to-fine shrink wrap algorithm.

mesh()

template<typename GridType>

const PolySoup & mesh ( int n = 0, float adaptivity = 0.005f, float isoValue = 0.0f )

inline

Generate an adaptive polygon mesh from a particular shrink wrap SDF.

Parameters

n	Number of the shrink wrap grid, where n = 0 has the finest sampling and n = gridCount-1 is the coarsest voxel sampling.
adaptivity	Optional adaptivity parameter used for meshing. A value of zero means adaptivity is disabled, i.e. uniform quads are produced.
isoValue	Iso-value used for the mesh generation.

Returns

Reference to the internal PolySoup populated with the generated mesh.

minVoxelSize()

template<typename GridType>

float minVoxelSize ( ) const

inline

Returns the finest/smallest voxel size, in world units, i.e. the voxel size of the final (highest-resolution) level set surface.

offset()

template<typename GridType>

auto offset	(	float	dx,
		int	mode = 0 )

Generates a dx-offset level set surface from the internal polygon soup.

Parameters

dx	Voxel size (world units) of the output level set.
mode	0) old method (using mesh -> UDF -> mesh -> SDF), 1) Mihai's signed-flood-fill and 2) Greg's createLevelSetDilatedMesh

Returns

Shared pointer to the newly created level set grid.

process()

template<typename GridType>

template<class ShrinkWrapT, class ProgressT>

void process	(	const ShrinkWrapT &	D,
		ProgressT *	progress,
		int	mode = 0 )

Performs the actual processing to generate the shrink wrap surfaces.

Template Parameters

ShrinkWrapT	Optional template parameter of the functor controlling the number of constrained erosion steps (see our paper).
ProgressT	Template parameter of the optional progress bar.

Parameters

D	Optional functor controlling the number of constrained erosion steps and the closing threshold (see our paper).
progress	Optional pointer to a progress bar.
mode	EXPERIMENTAL parameter that will be removed in the near future. It should only be used by experts!