4 #ifndef OPENVDB_GRID_HAS_BEEN_INCLUDED 5 #define OPENVDB_GRID_HAS_BEEN_INCLUDED 18 #include <type_traits> 28 template<
typename>
class Grid;
35 template<
typename Gr
idType>
36 inline typename GridType::Ptr
createGrid(
const typename GridType::ValueType& background);
42 template<
typename Gr
idType>
50 template<
typename TreePtrType>
68 template<
typename Gr
idType>
83 using GridFactory =
Ptr (*)();
129 static bool isRegistered(
const Name &type);
132 static void clearRegistry();
140 virtual Name type()
const = 0;
142 virtual Name valueType()
const = 0;
145 template<
typename Gr
idType>
146 bool isType()
const {
return (this->type() == GridType::gridType()); }
153 template<
typename Gr
idType>
155 template<
typename Gr
idType>
157 template<
typename Gr
idType>
158 static typename GridType::ConstPtr constGrid(
const GridBase::Ptr&);
159 template<
typename Gr
idType>
177 virtual bool isTreeUnique()
const = 0;
204 virtual void newTree() = 0;
209 virtual bool empty()
const = 0;
211 virtual void clear() = 0;
222 virtual void pruneGrid(
float tolerance = 0.0) = 0;
228 void clipGrid(
const BBoxd&);
262 template<
typename Gr
idTypeListT,
typename OpT>
inline bool apply(OpT&)
const;
263 template<
typename Gr
idTypeListT,
typename OpT>
inline bool apply(OpT&);
264 template<
typename Gr
idTypeListT,
typename OpT>
inline bool apply(
const OpT&)
const;
265 template<
typename Gr
idTypeListT,
typename OpT>
inline bool apply(
const OpT&);
272 std::string getName()
const;
274 void setName(
const std::string&);
277 std::string getCreator()
const;
279 void setCreator(
const std::string&);
283 bool saveFloatAsHalf()
const;
284 void setSaveFloatAsHalf(
bool);
295 void clearGridClass();
300 static std::string gridClassToString(
GridClass);
302 static std::string gridClassToMenuName(
GridClass);
307 static GridClass stringToGridClass(
const std::string&);
321 void clearVectorType();
326 static std::string vecTypeToString(
VecType);
329 static std::string vecTypeExamples(
VecType);
332 static std::string vecTypeDescription(
VecType);
333 static VecType stringToVecType(
const std::string&);
341 bool isInWorldSpace()
const;
343 void setIsInWorldSpace(
bool);
369 virtual Index64 activeVoxelCount()
const = 0;
373 virtual CoordBBox evalActiveVoxelBoundingBox()
const = 0;
376 virtual Coord evalActiveVoxelDim()
const = 0;
385 void addStatsMetadata();
430 Vec3d
voxelSize()
const {
return transform().voxelSize(); }
433 Vec3d
voxelSize(
const Vec3d& xyz)
const {
return transform().voxelSize(xyz); }
437 Vec3d
indexToWorld(
const Vec3d& xyz)
const {
return transform().indexToWorld(xyz); }
439 Vec3d
indexToWorld(
const Coord& ijk)
const {
return transform().indexToWorld(ijk); }
441 Vec3d
worldToIndex(
const Vec3d& xyz)
const {
return transform().worldToIndex(xyz); }
451 virtual void readTopology(std::istream&) = 0;
454 virtual void writeTopology(std::ostream&)
const = 0;
457 virtual void readBuffers(std::istream&) = 0;
459 virtual void readBuffers(std::istream&,
const CoordBBox&) = 0;
465 virtual void readNonresidentBuffers()
const = 0;
467 virtual void writeBuffers(std::ostream&)
const = 0;
475 virtual void print(std::ostream& = std::cout,
int verboseLevel = 1)
const = 0;
482 GridBase(): mTransform(math::Transform::createLinearTransform()) {}
495 static void registerGrid(
const Name& type, GridFactory);
497 static void unregisterGrid(
const Name& type);
538 template<
typename Gr
idPtrContainerT>
539 inline typename GridPtrContainerT::value_type
542 using GridPtrT =
typename GridPtrContainerT::value_type;
543 typename GridPtrContainerT::const_iterator it =
544 std::find_if(container.begin(), container.end(),
GridNamePred(name));
545 return (it == container.end() ? GridPtrT() : *it);
549 template<
typename KeyT,
typename Gr
idPtrT>
553 using GridPtrMapT = std::map<KeyT, GridPtrT>;
554 for (
typename GridPtrMapT::const_iterator it = container.begin(), end = container.end();
557 const GridPtrT& grid = it->second;
558 if (grid && grid->getName() == name)
return grid;
569 template<
typename _TreeType>
600 template<
typename OtherValueType>
632 template<
typename OtherTreeType>
643 Grid& operator=(
const Grid&) =
delete;
656 Ptr copyWithNewTree()
const;
709 Name type()
const override {
return this->gridType(); }
725 bool empty()
const override {
return tree().empty(); }
727 void clear()
override { tree().clear(); }
806 void pruneGrid(
float tolerance = 0.0)
override;
834 template<
typename OtherTreeType>
849 template<
typename OtherTreeType>
862 template<
typename OtherTreeType>
873 CoordBBox evalActiveVoxelBoundingBox()
const override;
875 Coord evalActiveVoxelDim()
const override;
878 tools::minMax(grid->tree()). Use threaded = false for serial execution")
901 bool isTreeUnique()
const final;
927 void newTree()
override;
937 void readTopology(std::istream&)
override;
940 void writeTopology(std::ostream&)
const override;
943 void readBuffers(std::istream&)
override;
945 void readBuffers(std::istream&,
const CoordBBox&)
override;
951 void readNonresidentBuffers()
const override;
953 void writeBuffers(std::ostream&)
const override;
956 void print(std::ostream& = std::cout,
int verboseLevel = 1)
const override;
963 static inline bool hasMultiPassIO();
1000 template<
typename Gr
idType>
1001 inline typename GridType::Ptr
1004 return GridBase::grid<GridType>(grid);
1016 template<
typename Gr
idType>
1017 inline typename GridType::ConstPtr
1020 return GridBase::constGrid<GridType>(grid);
1033 template<
typename Gr
idType>
1034 inline typename GridType::Ptr
1037 if (!grid || !grid->isType<
GridType>())
return typename GridType::Ptr();
1038 return gridPtrCast<GridType>(grid->deepCopyGrid());
1042 template<
typename Gr
idType>
1043 inline typename GridType::Ptr
1058 template<
typename _TreeType>
1088 template<
typename _TreeType>
1117 template<
typename _TreeType>
1158 template<
typename LeafNodeType>
1164 template<
typename RootNodeType>
1171 template<
typename TreeType>
1187 template<
typename Gr
idType>
1188 inline typename GridType::Ptr
1193 if (grid && grid->type() == GridType::gridType()) {
1194 return StaticPtrCast<GridType>(
grid);
1196 return typename GridType::Ptr();
1200 template<
typename Gr
idType>
1201 inline typename GridType::ConstPtr
1204 return ConstPtrCast<const GridType>(
1205 GridBase::grid<GridType>(ConstPtrCast<GridBase>(
grid)));
1209 template<
typename Gr
idType>
1210 inline typename GridType::ConstPtr
1213 return ConstPtrCast<const GridType>(GridBase::grid<GridType>(
grid));
1217 template<
typename Gr
idType>
1218 inline typename GridType::ConstPtr
1221 return ConstPtrCast<const GridType>(
1222 GridBase::grid<GridType>(ConstPtrCast<GridBase>(
grid)));
1244 template<
typename TreeT>
1250 template<
typename TreeT>
1256 template<
typename TreeT>
1263 template<
typename TreeT>
1272 template<
typename TreeT>
1280 template<
typename TreeT>
1281 template<
typename OtherTreeType>
1289 template<
typename TreeT>
1297 template<
typename TreeT>
1306 template<
typename TreeT>
1315 template<
typename TreeT>
1319 return Ptr(
new Grid(background));
1324 template<
typename TreeT>
1333 template<
typename TreeT>
1344 template<
typename TreeT>
1352 template<
typename TreeT>
1362 template<
typename TreeT>
1369 template<
typename TreeT>
1379 template<
typename TreeT>
1387 template<
typename TreeT>
1397 template<
typename TreeT>
1401 return this->
copy();
1404 template<
typename TreeT>
1408 return this->
copy();
1411 template<
typename TreeT>
1418 template<
typename TreeT>
1425 template<
typename TreeT>
1433 template<
typename TreeT>
1444 template<
typename TreeT>
1448 return mTree.use_count() == 1;
1452 template<
typename TreeT>
1457 if (tree->type() != TreeType::treeType()) {
1459 + tree->type() +
" to a grid of type " + this->
type());
1461 mTree = StaticPtrCast<TreeType>(
tree);
1465 template<
typename TreeT>
1476 template<
typename TreeT>
1480 tree().sparseFill(bbox, value, active);
1484 template<
typename TreeT>
1491 template<
typename TreeT>
1495 tree().denseFill(bbox, value, active);
1498 template<
typename TreeT>
1503 this->
tree().prune(static_cast<ValueType>(
value));
1506 template<
typename TreeT>
1513 template<
typename TreeT>
1517 tree().merge(other.
tree(), policy);
1521 template<
typename TreeT>
1522 template<
typename OtherTreeType>
1526 tree().topologyUnion(other.
tree());
1530 template<
typename TreeT>
1531 template<
typename OtherTreeType>
1535 tree().topologyIntersection(other.
tree());
1539 template<
typename TreeT>
1540 template<
typename OtherTreeType>
1544 tree().topologyDifference(other.
tree());
1551 template<
typename TreeT>
1556 tree().evalMinMax(minVal, maxVal);
1561 template<
typename TreeT>
1566 tree().evalActiveVoxelBoundingBox(bbox);
1571 template<
typename TreeT>
1576 const bool nonempty =
tree().evalActiveVoxelDim(dim);
1577 return (nonempty ? dim : Coord());
1587 template<
typename TreeT>
1595 template<
typename TreeT>
1603 template<
typename TreeT>
1610 uint16_t numPasses = 1;
1611 is.read(reinterpret_cast<char*>(&numPasses),
sizeof(uint16_t));
1614 for (uint16_t passIndex = 0; passIndex < numPasses; ++passIndex) {
1615 uint32_t pass = (uint32_t(numPasses) << 16) | uint32_t(passIndex);
1616 meta->setPass(pass);
1625 template<
typename TreeT>
1632 uint16_t numPasses = 1;
1633 is.read(reinterpret_cast<char*>(&numPasses),
sizeof(uint16_t));
1636 for (uint16_t passIndex = 0; passIndex < numPasses; ++passIndex) {
1637 uint32_t pass = (uint32_t(numPasses) << 16) | uint32_t(passIndex);
1638 meta->setPass(pass);
1648 template<
typename TreeT>
1652 tree().readNonresidentBuffers();
1656 template<
typename TreeT>
1666 uint16_t numPasses = 1;
1667 meta->setCountingPasses(
true);
1670 numPasses =
static_cast<uint16_t
>(meta->pass());
1671 os.write(reinterpret_cast<const char*>(&numPasses),
sizeof(uint16_t));
1672 meta->setCountingPasses(
false);
1675 for (uint16_t passIndex = 0; passIndex < numPasses; ++passIndex) {
1676 uint32_t pass = (uint32_t(numPasses) << 16) | uint32_t(passIndex);
1677 meta->setPass(pass);
1685 template<
typename TreeT>
1693 template<
typename TreeT>
1697 tree().print(os, verboseLevel);
1700 os <<
"Additional metadata:" << std::endl;
1702 os <<
" " << it->first;
1704 const std::string
value = it->second->str();
1705 if (!value.empty()) os <<
": " << value;
1711 os <<
"Transform:" << std::endl;
1720 template<
typename Gr
idType>
1721 inline typename GridType::Ptr
1724 return GridType::create(background);
1728 template<
typename Gr
idType>
1729 inline typename GridType::Ptr
1732 return GridType::create();
1736 template<
typename TreePtrType>
1740 using TreeType =
typename TreePtrType::element_type;
1745 template<
typename Gr
idType>
1746 typename GridType::Ptr
1749 using ValueType =
typename GridType::ValueType;
1753 "level-set grids must be floating-point-valued");
1755 typename GridType::Ptr
grid = GridType::create(
1756 static_cast<ValueType>(voxelSize * halfWidth));
1766 template<
typename Gr
idTypeListT,
typename OpT>
1770 return GridTypeListT::template apply<OpT&, const GridBase>(std::ref(op), *
this);
1773 template<
typename Gr
idTypeListT,
typename OpT>
1777 return GridTypeListT::template apply<OpT&, GridBase>(std::ref(op), *
this);
1780 template<
typename Gr
idTypeListT,
typename OpT>
1784 return GridTypeListT::template apply<const OpT&, const GridBase>(std::ref(op), *
this);
1787 template<
typename Gr
idTypeListT,
typename OpT>
1791 return GridTypeListT::template apply<const OpT&, GridBase>(std::ref(op), *
this);
1798 #endif // OPENVDB_GRID_HAS_BEEN_INCLUDED TreeBase::Ptr baseTreePtr()
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
Definition: Grid.h:1227
math::Transform::Ptr transformPtr()
Return a pointer to this grid's transform, which might be shared with other grids.
Definition: Grid.h:402
typename tree::ValueAccessor< NonConstTreeType > NonConstAccessorType
Definition: Grid.h:1104
static const TreeType & tree(const GridType &g)
Definition: Grid.h:1109
GridBase::ConstPtr copyGridReplacingMetadataAndTransform(const MetaMap &meta, math::Transform::Ptr xform) const override
Return a new grid of the same type as this grid whose tree is shared with this grid and whose transfo...
Definition: Grid.h:1427
static const TreeType & constTree(GridType &g)
Definition: Grid.h:1111
static GridType::Ptr grid(const GridBase::Ptr &)
Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type...
Definition: Grid.h:1189
OPENVDB_AX_API void print(const ast::Node &node, const bool numberStatements=true, std::ostream &os=std::cout, const char *indent=" ")
Writes a descriptive printout of a Node hierarchy into a target stream.
uint64_t Index64
Definition: Types.h:53
SharedPtr< TreeBase > Ptr
Definition: Tree.h:39
Abstract base class for typed grids.
Definition: Grid.h:77
virtual TreeBase::ConstPtr constBaseTreePtr() const =0
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
ConstPtr copyReplacingMetadata(const MetaMap &meta) const
Return a new grid of the same type as this grid whose tree and transform is shared with this grid and...
Definition: Grid.h:1354
typename NonConstGridType::Ptr NonConstGridPtrType
Definition: Grid.h:1069
typename _TreeType::ValueOnIter ValueOnIter
Definition: Grid.h:582
static const char *const META_FILE_VOXEL_COUNT
Definition: Grid.h:361
ValueOffIter beginValueOff()
Return an iterator over all of this grid's inactive values (tile and voxel).
Definition: Grid.h:761
static const char *const META_IS_LOCAL_SPACE
Definition: Grid.h:355
static const TreeType & constTree(const TreeType &t)
Definition: Grid.h:1082
#define OPENVDB_THROW(exception, message)
Definition: Exceptions.h:74
void sparseFill(const CoordBBox &bbox, const ValueType &value, bool active=true)
Set all voxels within a given axis-aligned box to a constant value.
Definition: Grid.h:1478
TreePtrType treePtr()
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
Definition: Grid.h:894
GridClass
Definition: Types.h:414
typename tree::ValueAccessor< NonConstTreeType > NonConstAccessorType
Definition: Grid.h:1133
ValueOnCIter beginValueOn() const
Return an iterator over all of this grid's active values (tile and voxel).
Definition: Grid.h:757
void newTree() override
Associate a new, empty tree with this grid, in place of its existing tree.
Definition: Grid.h:1467
TreeBase::ConstPtr baseTreePtr() const
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
Definition: Grid.h:171
Accessor getAccessor()
Return an accessor that provides random read and write access to this grid's voxels.
Definition: Grid.h:732
static const Real LEVEL_SET_HALF_WIDTH
Definition: Types.h:422
typename tree::ValueAccessor< const TreeType > ConstAccessorType
Definition: Grid.h:1132
static const TreeType & tree(const AccessorType &a)
Definition: Grid.h:1140
ValueOnCIter cbeginValueOn() const
Return an iterator over all of this grid's active values (tile and voxel).
Definition: Grid.h:759
GridCPtrSet::iterator GridCPtrSetIter
Definition: Grid.h:524
typename std::remove_const< TreeType >::type NonConstTreeType
Definition: Grid.h:1121
static const TreeType & tree(const TreeType &t)
Definition: Grid.h:1108
void clip(const CoordBBox &) override
Clip this grid to the given index-space bounding box.
Definition: Grid.h:1508
Index64 activeVoxelCount() const override
Return the number of active voxels.
Definition: Grid.h:871
SharedPtr< GridBase > Ptr
Definition: Grid.h:80
typename NonConstGridType::Ptr NonConstGridPtrType
Definition: Grid.h:1128
_TreeType TreeType
Definition: Grid.h:1061
VecType
Definition: Types.h:444
void writeTopology(std::ostream &) const override
Write the grid topology to a stream. This will write only the grid structure, not the actual data buf...
Definition: Grid.h:1597
const ValueType & background() const
Return this grid's background value.
Definition: Grid.h:722
GridPtrVec::iterator GridPtrVecIter
Definition: Grid.h:509
SharedPtr< GridCPtrVec > GridCPtrVecPtr
Definition: Grid.h:516
SharedPtr< GridCPtrSet > GridCPtrSetPtr
Definition: Grid.h:526
GridBase::Ptr deepCopyGrid() const override
Return a new grid whose metadata, transform and tree are deep copies of this grid's.
Definition: Grid.h:703
typename tree::ValueAccessor< TreeType > AccessorType
Definition: Grid.h:1131
typename _TreeType::ValueType ValueType
Definition: Grid.h:579
static const TreeType & tree(const TreeType &t)
Definition: Grid.h:1138
ValueAllIter beginValueAll()
Return an iterator over all of this grid's values (tile and voxel).
Definition: Grid.h:767
GridCPtrVec::iterator GridCPtrVecIter
Definition: Grid.h:514
bool empty() const override
Return true if this grid contains only inactive background voxels.
Definition: Grid.h:725
typename GridType::ConstPtr ConstGridPtrType
Definition: Grid.h:1070
typename GridType::ConstPtr ConstGridPtrType
Definition: Grid.h:1100
static const char *const META_GRID_CREATOR
Definition: Grid.h:352
void setTree(TreeBase::Ptr) override
Associate the given tree with this grid, in place of its existing tree.
Definition: Grid.h:1454
ConstUnsafeAccessor getConstUnsafeAccessor() const
Return an unsafe accessor that provides random read-only access to this grid's voxels.
Definition: Grid.h:752
void topologyIntersection(const Grid< OtherTreeType > &other)
Intersect this grid's set of active values with the active values of the other grid, whose value type may be different.
Definition: Grid.h:1533
typename NonConstTreeType::Ptr NonConstTreePtrType
Definition: Grid.h:1095
typename GridType::Ptr GridPtrType
Definition: Grid.h:1127
typename _TreeType::ConstPtr ConstTreePtrType
Definition: Grid.h:578
GridPtrVec::const_iterator GridPtrVecCIter
Definition: Grid.h:510
ValueOffCIter beginValueOff() const
Return an iterator over all of this grid's inactive values (tile and voxel).
Definition: Grid.h:763
const math::Transform & constTransform() const
Return a reference to this grid's transform, which might be shared with other grids.
Definition: Grid.h:413
_TreeType TreeType
Definition: Grid.h:1091
SharedPtr< GridPtrSet > GridPtrSetPtr
Definition: Grid.h:521
typename NonConstTreeType::Ptr NonConstTreePtrType
Definition: Grid.h:1065
GridType::Ptr gridPtrCast(const GridBase::Ptr &grid)
Cast a generic grid pointer to a pointer to a grid of a concrete class.
Definition: Grid.h:1002
typename _TreeType::ValueAllCIter ValueAllCIter
Definition: Grid.h:587
Grid()
Construct a new grid with background value zero.
Definition: Grid.h:1245
static const char *const META_GRID_NAME
Definition: Grid.h:353
static const char *const META_FILE_COMPRESSION
Definition: Grid.h:359
std::vector< GridBase::Ptr > GridPtrVec
Definition: Grid.h:508
typename TreeType::ValueType ValueType
Definition: Grid.h:1071
ConstAccessor getAccessor() const
Return an accessor that provides random read-only access to this grid's voxels.
Definition: Grid.h:742
void readBuffers(std::istream &) override
Read all data buffers for this grid.
Definition: Grid.h:1605
typename tree::ValueAccessor< const TreeType > ConstAccessorType
Definition: Grid.h:1073
Definition: Exceptions.h:65
void readTopology(std::istream &) override
Read the grid topology from a stream. This will read only the grid structure, not the actual data buf...
Definition: Grid.h:1589
GridCPtrVec::const_iterator GridCPtrVecCIter
Definition: Grid.h:515
ValueOffCIter cbeginValueOff() const
Return an iterator over all of this grid's inactive values (tile and voxel).
Definition: Grid.h:765
void evalMinMax(ValueType &minVal, ValueType &maxVal) const
Return the minimum and maximum active values in this grid.
Definition: Grid.h:1553
static const TreeType & tree(const GridType &g)
Definition: Grid.h:1139
void merge(Grid &other, MergePolicy policy=MERGE_ACTIVE_STATES)
Efficiently merge another grid into this grid using one of several schemes.
Definition: Grid.h:1515
UnsafeAccessor getUnsafeAccessor()
Return an unsafe accessor that provides random read and write access to this grid's voxels...
Definition: Grid.h:740
Definition: version.h.in:259
ConstAccessor getConstAccessor() const
Return an accessor that provides random read-only access to this grid's voxels.
Definition: Grid.h:744
static const TreeType & constTree(const GridType &g)
Definition: Grid.h:1113
ConstTreePtrType treePtr() const
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
Definition: Grid.h:895
ConstPtr copyReplacingTransform(math::Transform::Ptr xform) const
Return a new grid of the same type as this grid whose tree is shared with this grid, whose metadata is a deep copy of this grid's and whose transform is provided as an argument.
Definition: Grid.h:1364
ValueOnIter beginValueOn()
Return an iterator over all of this grid's active values (tile and voxel).
Definition: Grid.h:755
GridNamePred(const Name &_name)
Definition: Grid.h:532
void writeBuffers(std::ostream &) const override
Write out all data buffers for this grid.
Definition: Grid.h:1658
typename TreeType::Ptr TreePtrType
Definition: Grid.h:1122
Vec3d indexToWorld(const Vec3d &xyz) const
Apply this grid's transform to the given coordinates.
Definition: Grid.h:437
ValueAllCIter beginValueAll() const
Return an iterator over all of this grid's values (tile and voxel).
Definition: Grid.h:769
typename TreeType::ConstPtr ConstTreePtrType
Definition: Grid.h:1064
static Ptr create()
Return a new grid with background value zero.
Definition: Grid.h:1308
typename NonConstGridType::Ptr NonConstGridPtrType
Definition: Grid.h:1099
void writeTransform(std::ostream &os) const
Write out the transform for this grid.
Definition: Grid.h:472
BBox< Coord > CoordBBox
Definition: NanoVDB.h:1809
SharedPtr< const TreeBase > ConstPtr
Definition: Tree.h:40
GridBase(const GridBase &other)
Deep copy another grid's metadata and transform.
Definition: Grid.h:489
typename _TreeType::ValueOnCIter ValueOnCIter
Definition: Grid.h:583
Ptr copy()
Return a new grid of the same type as this grid whose metadata and transform are deep copies of this ...
Definition: Grid.h:1381
static TreeType & tree(TreeType &t)
Definition: Grid.h:1076
Ptr deepCopy() const
Return a new grid whose metadata, transform and tree are deep copies of this grid's.
Definition: Grid.h:701
typename _TreeType::Ptr TreePtrType
Definition: Grid.h:577
typename _TreeType::ValueAllIter ValueAllIter
Definition: Grid.h:586
typename tree::ValueAccessor< TreeType > AccessorType
Definition: Grid.h:1072
Base class for typed trees.
Definition: Tree.h:36
TreeBase & baseTree()
Return a reference to this grid's tree, which might be shared with other grids.
Definition: Grid.h:183
OPENVDB_API uint32_t getGridClass(std::ios_base &)
Return the class (GRID_LEVEL_SET, GRID_UNKNOWN, etc.) of the grid currently being read from or writte...
typename GridType::ConstPtr ConstGridPtrType
Definition: Grid.h:1129
const TreeBase & constBaseTree() const
Return a reference to this grid's tree, which might be shared with other grids.
Definition: Grid.h:193
static const TreeType & tree(const TreeType &t)
Definition: Grid.h:1078
Vec3d indexToWorld(const Coord &ijk) const
Apply this grid's transform to the given coordinates.
Definition: Grid.h:439
openvdb::GridBase Grid
Definition: Utils.h:34
static bool isRegistered(const Name &type)
Return true if the given grid type name is registered.
Name type() const override
Return the name of this grid's type.
Definition: Grid.h:709
void topologyDifference(const Grid< OtherTreeType > &other)
Difference this grid's set of active values with the active values of the other grid, whose value type may be different.
Definition: Grid.h:1542
static Name gridType()
Return the name of this type of grid.
Definition: Grid.h:711
Ptr copyWithNewTree() const
Return a new grid of the same type as this grid whose metadata and transform are deep copies of this ...
Definition: Grid.h:1389
const TreeType & constTree() const
Return a reference to this grid's tree, which might be shared with other grids.
Definition: Grid.h:910
static const TreeType & constTree(GridType &g)
Definition: Grid.h:1142
typename _TreeType::ValueOffCIter ValueOffCIter
Definition: Grid.h:585
math::Transform::ConstPtr constTransformPtr() const
Return a pointer to this grid's transform, which might be shared with other grids.
Definition: Grid.h:404
static const char *const META_VECTOR_TYPE
Definition: Grid.h:356
std::set< GridBase::ConstPtr > GridCPtrSet
Definition: Grid.h:523
static void unregisterGrid(const Name &type)
Remove a grid type from the registry.
void pruneGrid(float tolerance=0.0) override
Reduce the memory footprint of this grid by increasing its sparseness.
Definition: Grid.h:1500
ConstPtr copyReplacingMetadataAndTransform(const MetaMap &meta, math::Transform::Ptr xform) const
Return a new grid of the same type as this grid whose tree is shared with this grid and whose transfo...
Definition: Grid.h:1371
OPENVDB_API uint32_t getFormatVersion(std::ios_base &)
Return the file format version number associated with the given input stream.
bool isTreeUnique() const final
Return true if tree is not shared with another grid.
Definition: Grid.h:1446
const math::Transform & transform() const
Return a reference to this grid's transform, which might be shared with other grids.
Definition: Grid.h:412
_TreeType TreeType
Definition: Grid.h:576
GridType::Ptr deepCopyTypedGrid(const GridBase &grid)
Return a pointer to a deep copy of the given grid, provided that the grid's concrete type is GridType...
Definition: Grid.h:1044
typename NonConstTreeType::Ptr NonConstTreePtrType
Definition: Grid.h:1124
Name name
Definition: Grid.h:534
TreeType & tree()
Return a reference to this grid's tree, which might be shared with other grids.
Definition: Grid.h:908
GridType::ConstPtr gridConstPtrCast(const GridBase::ConstPtr &grid)
Cast a generic const grid pointer to a const pointer to a grid of a concrete class.
Definition: Grid.h:1018
SharedPtr< const GridBase > ConstPtr
Definition: Grid.h:81
GridBase::Ptr copyGrid() override
Return a new grid of the same type as this grid whose metadata is a deep copy of this grid's and whos...
Definition: Grid.h:1399
static const TreeType & constTree(const GridType &g)
Definition: Grid.h:1144
typename tree::ValueAccessor< NonConstTreeType > NonConstAccessorType
Definition: Grid.h:1074
typename tree::ValueAccessor< const TreeType > ConstAccessorType
Definition: Grid.h:1103
OPENVDB_API void setGridClass(std::ios_base &, uint32_t)
Associate with the given stream the class (GRID_LEVEL_SET, GRID_UNKNOWN, etc.) of the grid currently ...
GridBase()
Initialize with an identity linear transform.
Definition: Grid.h:482
Definition: Exceptions.h:13
Name valueType() const override
Return the name of the type of a voxel's value (e.g., "float" or "vec3d").
Definition: Grid.h:714
void setTransform(math::Transform::Ptr)
Associate the given transform with this grid, in place of its existing transform. ...
Definition: Grid.h:1234
bool saveFloatAsHalf() const
Return true if this grid should be written out with floating-point voxel values (including components...
static TreeType & tree(GridType &g)
Definition: Grid.h:1107
ValueT value
Definition: GridBuilder.h:1290
void clear() override
Empty this grid, so that all voxels become inactive background voxels.
Definition: Grid.h:727
static const char *const META_FILE_DELAYED_LOAD
Definition: Grid.h:362
virtual GridBase::Ptr deepCopyGrid() const =0
Return a new grid whose metadata, transform and tree are deep copies of this grid's.
typename TreeType::ValueType ValueType
Definition: Grid.h:1130
static const TreeType & constTree(const TreeType &t)
Definition: Grid.h:1112
const TreeType & tree() const
Return a reference to this grid's tree, which might be shared with other grids.
Definition: Grid.h:909
Definition: Exceptions.h:64
std::set< GridBase::Ptr > GridPtrSet
Definition: Grid.h:518
static void unregisterGrid()
Remove this grid type from the registry.
Definition: Grid.h:974
GridType::Ptr createLevelSet(Real voxelSize=1.0, Real halfWidth=LEVEL_SET_HALF_WIDTH)
Create a new grid of type GridType classified as a "Level Set", i.e., a narrow-band level set...
Definition: Grid.h:1747
void print(std::ostream &=std::cout, int verboseLevel=1) const override
Output a human-readable description of this grid.
Definition: Grid.h:1695
static const char *const META_SAVE_HALF_FLOAT
Definition: Grid.h:354
typename tree::ValueAccessor< const _TreeType, false > ConstUnsafeAccessor
Definition: Grid.h:592
const TreeBase & baseTree() const
Return a reference to this grid's tree, which might be shared with other grids.
Definition: Grid.h:188
bool apply(OpT &) const
If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid...
Definition: Grid.h:1768
MergePolicy
Definition: Types.h:467
~GridBase() override
Definition: Grid.h:86
typename std::remove_const< TreeType >::type NonConstTreeType
Definition: Grid.h:1092
Metafunction that specifies whether a given leaf node, tree, or grid type requires multiple passes to...
Definition: Grid.h:1159
static TreeType & tree(TreeType &t)
Definition: Grid.h:1135
typename GridType::Ptr GridPtrType
Definition: Grid.h:1098
bool hasUniformVoxels() const
Return true if the voxels in world space are uniformly sized cubes.
Definition: Grid.h:435
void readNonresidentBuffers() const override
Read all of this grid's data buffers that are not yet resident in memory (because delayed loading is ...
Definition: Grid.h:1650
Tag dispatch class that distinguishes shallow copy constructors from deep copy constructors.
Definition: Types.h:641
typename tree::ValueAccessor< const _TreeType, true > ConstAccessor
Definition: Grid.h:590
typename GridType::Ptr GridPtrType
Definition: Grid.h:1068
void topologyUnion(const Grid< OtherTreeType > &other)
Union this grid's set of active values with the active values of the other grid, whose value type may...
Definition: Grid.h:1524
GridType
List of types that are currently supported by NanoVDB.
Definition: NanoVDB.h:243
SharedPtr< Grid > Ptr
Definition: Grid.h:573
GridPtrT findGridByName(const std::map< KeyT, GridPtrT > &container, const Name &name)
Return the first grid in the given map whose name is name.
Definition: Grid.h:551
static TreeType & tree(GridType &g)
Definition: Grid.h:1077
tree::TreeBase TreeBase
Definition: Grid.h:26
static GridType::ConstPtr constGrid(const GridBase::Ptr &)
Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type...
Definition: Grid.h:1211
static const char *const META_FILE_BBOX_MIN
Definition: Grid.h:357
static const TreeType & constTree(GridType &g)
Definition: Grid.h:1081
static const TreeType & tree(const GridType &g)
Definition: Grid.h:1079
typename std::remove_const< TreeType >::type NonConstTreeType
Definition: Grid.h:1062
std::shared_ptr< T > SharedPtr
Definition: Types.h:114
static void registerGrid(const Name &type, GridFactory)
Register a grid type along with a factory function.
Predicate functor that returns true for grids that have a specified name.
Definition: Grid.h:530
math::Transform::ConstPtr transformPtr() const
Return a pointer to this grid's transform, which might be shared with other grids.
Definition: Grid.h:403
bool isType() const
Return true if this grid is of the same type as the template parameter.
Definition: Grid.h:146
SharedPtr< T > StaticPtrCast(const SharedPtr< U > &ptr)
Return a new shared pointer that points to the same object as the given pointer after a static_cast...
Definition: Types.h:146
math::Transform & transform()
Return a reference to this grid's transform, which might be shared with other grids.
Definition: Grid.h:411
typename TreeType::Ptr TreePtrType
Definition: Grid.h:1093
static TreeType & tree(AccessorType &a)
Definition: Grid.h:1137
Vec3d voxelSize(const Vec3d &xyz) const
Return the size of this grid's voxel at position (x, y, z).
Definition: Grid.h:433
typename _TreeType::ValueOffIter ValueOffIter
Definition: Grid.h:584
Definition: ValueAccessor.h:190
ValueAllCIter cbeginValueAll() const
Return an iterator over all of this grid's values (tile and voxel).
Definition: Grid.h:771
~Grid() override
Definition: Grid.h:640
Index64 memUsage() const override
Definition: Grid.h:883
typename tree::ValueAccessor< _TreeType, false > UnsafeAccessor
Definition: Grid.h:591
TreeBase::ConstPtr constBaseTreePtr() const override
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
Definition: Grid.h:897
Vec3d worldToIndex(const Vec3d &xyz) const
Apply the inverse of this grid's transform to the given coordinates.
Definition: Grid.h:441
GridPtrSet::iterator GridPtrSetIter
Definition: Grid.h:519
void denseFill(const CoordBBox &bbox, const ValueType &value, bool active=true)
Set all voxels within a given axis-aligned box to a constant value and ensure that those voxels are a...
Definition: Grid.h:1493
static const TreeType & constTree(const GridType &g)
Definition: Grid.h:1083
typename _TreeType::BuildType BuildType
Definition: Grid.h:580
GridBase(GridBase &other, ShallowCopy)
Copy another grid's metadata but share its transform.
Definition: Grid.h:492
Container class that associates a tree with a transform and metadata.
Definition: Grid.h:28
static const TreeType & constTree(TreeType &t)
Definition: Grid.h:1080
static const char *const META_FILE_BBOX_MAX
Definition: Grid.h:358
CoordBBox evalActiveVoxelBoundingBox() const override
Return the axis-aligned bounding box of all active voxels.
Definition: Grid.h:1563
GridBase::Ptr copyGridWithNewTree() const override
Return a new grid of the same type as this grid whose metadata and transform are deep copies of this ...
Definition: Grid.h:1435
typename TreeType::ValueType ValueType
Definition: Grid.h:1101
static const char *const META_GRID_CLASS
Definition: Grid.h:351
GridBase::ConstPtr copyGridReplacingMetadata(const MetaMap &meta) const override
Return a new grid of the same type as this grid whose tree and transform is shared with this grid and...
Definition: Grid.h:1413
bool operator()(const GridBase::ConstPtr &g) const
Definition: Grid.h:533
_TreeType TreeType
Definition: Grid.h:1120
static const char *const META_FILE_MEM_BYTES
Definition: Grid.h:360
GridBase::ConstPtr copyGridReplacingTransform(math::Transform::Ptr xform) const override
Return a new grid of the same type as this grid whose tree is shared with this grid, whose metadata is a deep copy of this grid's and whose transform is provided as an argument.
Definition: Grid.h:1420
typename tree::ValueAccessor< TreeType > AccessorType
Definition: Grid.h:1102
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:121
ValueConverter<T>::Type is the type of a grid having the same hierarchy as this grid but a different ...
Definition: Grid.h:601
OPENVDB_API SharedPtr< StreamMetadata > getStreamMetadataPtr(std::ios_base &)
Return a shared pointer to an object that stores metadata (file format, compression scheme...
static const TreeType & constTree(TreeType &t)
Definition: Grid.h:1141
Coord evalActiveVoxelDim() const override
Return the dimensions of the axis-aligned bounding box of all active voxels.
Definition: Grid.h:1573
typename TreeType::ConstPtr ConstTreePtrType
Definition: Grid.h:1123
std::pair< ValueT, ValueT > evalMinMax(const PointDataTreeT &points, const std::string &attribute, const FilterT &filter=NullFilter())
Evaluates the minimum and maximum values of a point attribute.
Definition: PointStatistics.h:697
This adapter allows code that is templated on a Tree type to accept either a Tree type or a Grid type...
Definition: Grid.h:1059
SharedPtr< const Grid > ConstPtr
Definition: Grid.h:574
Vec3d voxelSize() const
Return the size of this grid's voxels.
Definition: Grid.h:430
double Real
Definition: Types.h:60
static void registerGrid()
Register this grid type along with a factory function.
Definition: Grid.h:972
static TreeType & tree(GridType &g)
Definition: Grid.h:1136
void fill(const CoordBBox &bbox, const ValueType &value, bool active=true)
Set all voxels within a given axis-aligned box to a constant value.
Definition: Grid.h:1486
static bool isRegistered()
Return true if this grid type is registered.
Definition: Grid.h:970
static Ptr createGrid(const Name &type)
Create a new grid of the given (registered) type.
GridCPtrSet::const_iterator GridCPtrSetCIter
Definition: Grid.h:525
Grid< typename TreePtrType::element_type >::Ptr createGrid(TreePtrType)
Create a new grid of the appropriate type that wraps the given tree.
Definition: Grid.h:1738
static const TreeType & constTree(const TreeType &t)
Definition: Grid.h:1143
Mat3< Type1 > cwiseAdd(const Mat3< Type1 > &m, const Type2 s)
Definition: Mat3.h:806
void readTransform(std::istream &is)
Read in the transform for this grid.
Definition: Grid.h:470
static const TreeType & constTree(TreeType &t)
Definition: Grid.h:1110
std::string Name
Definition: Name.h:17
static bool hasMultiPassIO()
Return true if grids of this type require multiple I/O passes to read and write data buffers...
Definition: Grid.h:1687
std::vector< GridBase::ConstPtr > GridCPtrVec
Definition: Grid.h:513
ConstTreePtrType constTreePtr() const
Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guarante...
Definition: Grid.h:896
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:212
static TreeType & tree(TreeType &t)
Definition: Grid.h:1106
SharedPtr< GridPtrVec > GridPtrVecPtr
Definition: Grid.h:511
GridPtrSet::const_iterator GridPtrSetCIter
Definition: Grid.h:520
typename tree::ValueAccessor< _TreeType, true > Accessor
Definition: Grid.h:589
typename TreeType::Ptr TreePtrType
Definition: Grid.h:1063
typename TreeType::ConstPtr ConstTreePtrType
Definition: Grid.h:1094