OpenVDB  12.0.0
Public Types | Public Member Functions | List of all members
LevelSetFracture< GridType, InterruptType > Class Template Reference

Level set fracturing. More...

#include <openvdb/tools/LevelSetFracture.h>

Public Types

using Vec3sList = std::vector< Vec3s >
 
using QuatsList = std::vector< math::Quats >
 
using GridPtrList = std::list< typename GridType::Ptr >
 
using GridPtrListIter = typename GridPtrList::iterator
 

Public Member Functions

 LevelSetFracture (InterruptType *interrupter=nullptr)
 Default constructor. More...
 
void fracture (GridPtrList &grids, const GridType &cutter, bool segment=false, const Vec3sList *points=nullptr, const QuatsList *rotations=nullptr, bool cutterOverlap=true)
 Divide volumes represented by level set grids into multiple, disjoint pieces by intersecting them with one or more "cutter" volumes, also represented by level sets. More...
 
GridPtrListfragments ()
 Return a list of new fragments, not including the residuals from the input grids. More...
 
void clear ()
 Remove all elements from the fragment list. More...
 

Detailed Description

template<class GridType, class InterruptType = util::NullInterrupter>
class openvdb::v12_0::tools::LevelSetFracture< GridType, InterruptType >

Level set fracturing.

Member Typedef Documentation

using GridPtrList = std::list<typename GridType::Ptr>
using GridPtrListIter = typename GridPtrList::iterator
using QuatsList = std::vector<math::Quats>
using Vec3sList = std::vector<Vec3s>

Constructor & Destructor Documentation

LevelSetFracture ( InterruptType *  interrupter = nullptr)
explicit

Default constructor.

Parameters
interrupteroptional interrupter object

Member Function Documentation

void clear ( )
inline

Remove all elements from the fragment list.

void fracture ( GridPtrList grids,
const GridType &  cutter,
bool  segment = false,
const Vec3sList points = nullptr,
const QuatsList rotations = nullptr,
bool  cutterOverlap = true 
)

Divide volumes represented by level set grids into multiple, disjoint pieces by intersecting them with one or more "cutter" volumes, also represented by level sets.

If desired, the process can be applied iteratively, so that fragments created with one cutter are subdivided by other cutters.

Note
The incoming grids and the cutter are required to have matching transforms and narrow band widths!
Parameters
gridslist of grids to fracture. The residuals of the fractured grids will remain in this list
cuttera level set grid to use as the cutter object
segmenttoggle to split disjoint fragments into their own grids
pointsoptional list of world space points at which to instance the cutter object (if null, use the cutter's current position only)
rotationsoptional list of custom rotations for each cutter instance
cutterOverlaptoggle to allow consecutive cutter instances to fracture previously generated fragments
GridPtrList& fragments ( )
inline

Return a list of new fragments, not including the residuals from the input grids.