4#ifndef OPENVDB_TREE_LEAF_NODE_MASK_HAS_BEEN_INCLUDED
5#define OPENVDB_TREE_LEAF_NODE_MASK_HAS_BEEN_INCLUDED
7#include <openvdb/version.h>
29template<Index Log2Dim>
41 static const Index LOG2DIM = Log2Dim;
42 static const Index TOTAL = Log2Dim;
43 static const Index DIM = 1 << TOTAL;
44 static const Index NUM_VALUES = 1 << 3 * Log2Dim;
45 static const Index NUM_VOXELS = NUM_VALUES;
46 static const Index SIZE = NUM_VALUES;
51 template<
typename OtherValueType>
56 template<
typename OtherNodeType>
57 struct SameConfiguration {
77 template<
typename OtherValueType>
81 template<
typename ValueType>
87 template<
typename ValueType>
89 template<
typename ValueType>
130 bool isEmpty()
const {
return mBuffer.mData.isOff(); }
132 bool isDense()
const {
return mBuffer.mData.isOn(); }
144 Index64 memUsageIfLoaded()
const;
149 void evalActiveBoundingBox(
CoordBBox& bbox,
bool visitVoxels =
true)
const;
172#if OPENVDB_ABI_VERSION_NUMBER >= 9
180 std::string str()
const;
184 template<
typename OtherType, Index OtherLog2Dim>
188 bool operator==(
const LeafNode&)
const;
189 bool operator!=(
const LeafNode&)
const;
204 void readTopology(std::istream&,
bool fromHalf =
false);
206 void writeTopology(std::ostream&,
bool toHalf =
false)
const;
209 void readBuffers(std::istream&,
bool fromHalf =
false);
210 void readBuffers(std::istream& is,
const CoordBBox&,
bool fromHalf =
false);
212 void writeBuffers(std::ostream&,
bool toHalf =
false)
const;
218 const bool& getValue(
const Coord& xyz)
const;
220 const bool& getValue(
Index offset)
const;
225 bool probeValue(
const Coord& xyz,
bool& val)
const;
231 void setActiveState(
const Coord& xyz,
bool on);
236 void setValueOnly(
const Coord& xyz,
bool val);
238 void setValueOnly(
Index offset,
bool val) { assert(offset<SIZE); mBuffer.setValue(offset,val); }
246 void setValueOff(
const Coord& xyz,
bool val);
248 void setValueOff(
Index offset,
bool val);
256 void setValueOn(
const Coord& xyz,
bool val);
260 void setValueOn(
Index offset,
bool val);
264 template<
typename ModifyOp>
265 void modifyValue(
Index offset,
const ModifyOp& op);
268 template<
typename ModifyOp>
269 void modifyValue(
const Coord& xyz,
const ModifyOp& op);
272 template<
typename ModifyOp>
273 void modifyValueAndActiveState(
const Coord& xyz,
const ModifyOp& op);
281 bool isValueOn(
const Coord& xyz)
const {
return mBuffer.mData.isOn(this->coordToOffset(xyz)); }
283 bool isValueOn(
Index offset)
const { assert(offset < SIZE);
return mBuffer.mData.isOn(offset); }
289 void clip(
const CoordBBox&,
bool background);
297 void fill(
const bool&
value,
bool dummy =
false);
310 template<
typename DenseT>
311 void copyToDense(
const CoordBBox& bbox, DenseT& dense)
const;
329 template<
typename DenseT>
330 void copyFromDense(
const CoordBBox& bbox,
const DenseT& dense,
bool background,
bool tolerance);
334 template<
typename AccessorT>
339 template<
typename AccessorT>
344 template<
typename AccessorT>
350 template<
typename AccessorT>
355 template<
typename AccessorT>
358 this->setValueOff(xyz,
value);
364 template<
typename ModifyOp,
typename AccessorT>
367 this->modifyValue(xyz, op);
372 template<
typename ModifyOp,
typename AccessorT>
375 this->modifyValueAndActiveState(xyz, op);
381 template<
typename AccessorT>
384 this->setActiveState(xyz, on);
390 template<
typename AccessorT>
393 return this->probeValue(xyz, val);
398 template<
typename AccessorT>
404 const bool&
getFirstValue()
const {
if (mBuffer.mData.isOn(0))
return Buffer::sOn;
else return Buffer::sOff; }
408 const bool&
getLastValue()
const {
if (mBuffer.mData.isOn(SIZE-1))
return Buffer::sOn;
else return Buffer::sOff; }
413 bool isConstant(
bool& constValue,
bool& state,
bool tolerance = 0)
const;
420 bool medianAll()
const;
449 void negate() { mBuffer.mData.toggle(); }
451 template<MergePolicy Policy>
452 void merge(
const LeafNode& other,
bool bg =
false,
bool otherBG =
false);
453 template<MergePolicy Policy>
void merge(
bool tileValue,
bool tileActive=
false);
465 template<
typename OtherType>
479 template<
typename OtherType>
493 template<
typename OtherType>
496 template<
typename CombineOp>
497 void combine(
const LeafNode& other, CombineOp& op);
498 template<
typename CombineOp>
499 void combine(
bool,
bool valueIsActive, CombineOp& op);
501 template<
typename CombineOp,
typename OtherType >
502 void combine2(
const LeafNode& other,
const OtherType&,
bool valueIsActive, CombineOp&);
503 template<
typename CombineOp,
typename OtherNodeT >
504 void combine2(
bool,
const OtherNodeT& other,
bool valueIsActive, CombineOp&);
505 template<
typename CombineOp,
typename OtherNodeT >
506 void combine2(
const LeafNode& b0,
const OtherNodeT& b1, CombineOp&);
512 template<
typename AccessorT>
514 template<
typename NodeT>
516 template<
typename NodeT>
518 template<
typename NodeT>
520 template<
typename ArrayT>
void getNodes(ArrayT&)
const {}
524 void addTile(
Index level,
const Coord&,
bool val,
bool active);
525 void addTile(
Index offset,
bool val,
bool active);
526 template<
typename AccessorT>
527 void addTileAndCache(
Index level,
const Coord&,
bool val,
bool active, AccessorT&);
532 template<
typename AccessorT>
535 template<
typename AccessorT>
537 template<
typename NodeT,
typename AccessorT>
541 if (!(std::is_same<NodeT, LeafNode>::value))
return nullptr;
542 return reinterpret_cast<NodeT*
>(
this);
549 template<
typename AccessorT>
552 template<
typename AccessorT>
554 template<
typename NodeT,
typename AccessorT>
558 if (!(std::is_same<NodeT, LeafNode>::value))
return nullptr;
559 return reinterpret_cast<const NodeT*
>(
this);
572 template<
typename MaskIterT,
typename NodeT,
typename ValueT>
576 public SparseIteratorBase<MaskIterT, ValueIter<MaskIterT, NodeT, ValueT>, NodeT, ValueT>
583 const bool&
getItem(
Index pos)
const {
return this->parent().getValue(pos); }
584 const bool&
getValue()
const {
return this->getItem(this->pos()); }
592 template<
typename ModifyOp>
593 void modifyItem(
Index n,
const ModifyOp& op)
const { this->parent().modifyValue(n, op); }
595 template<
typename ModifyOp>
596 void modifyValue(
const ModifyOp& op)
const { this->modifyItem(this->pos(), op); }
600 template<
typename MaskIterT,
typename NodeT>
606 MaskIterT, ChildIter<MaskIterT, NodeT>, NodeT, bool>(iter, parent) {}
609 template<
typename NodeT,
typename ValueT>
611 MaskDenseIter, DenseIter<NodeT, ValueT>, NodeT, void, ValueT>
621 value = this->parent().getValue(pos);
630 void unsetItem(
Index pos,
const ValueT& val)
const {this->parent().setValueOnly(pos, val);}
635 using ValueOnCIter = ValueIter<MaskOnIter, const LeafNode, const bool>;
715#if OPENVDB_ABI_VERSION_NUMBER >= 9
748template<Index Log2Dim>
755template<Index Log2Dim>
758 : mBuffer(
value || active)
759 , mOrigin(xyz & (~(DIM - 1)))
764template<Index Log2Dim>
767 : mBuffer(
value || active)
768 , mOrigin(xyz & (~(DIM - 1)))
773template<Index Log2Dim>
776 : mBuffer(other.mBuffer)
777 , mOrigin(other.mOrigin)
778#if OPENVDB_ABI_VERSION_NUMBER >= 9
779 , mTransientData(other.mTransientData)
786template<Index Log2Dim>
787template<
typename ValueT>
790 : mBuffer(other.valueMask())
791 , mOrigin(other.origin())
792#if OPENVDB_ABI_VERSION_NUMBER >= 9
793 , mTransientData(other.mTransientData)
799template<Index Log2Dim>
800template<
typename ValueT>
804 : mBuffer(other.valueMask())
805 , mOrigin(other.origin())
806#if OPENVDB_ABI_VERSION_NUMBER >= 9
807 , mTransientData(other.mTransientData)
813template<Index Log2Dim>
814template<
typename ValueT>
817 : mBuffer(other.valueMask())
818 , mOrigin(other.origin())
819#if OPENVDB_ABI_VERSION_NUMBER >= 9
820 , mTransientData(other.mTransientData)
826template<Index Log2Dim>
827template<
typename ValueT>
831 : mBuffer(other.valueMask())
832 , mOrigin(other.origin())
833#if OPENVDB_ABI_VERSION_NUMBER >= 9
834 , mTransientData(other.mTransientData)
837 if (offValue==
true) {
838 if (onValue==
false) {
839 mBuffer.mData.toggle();
841 mBuffer.mData.setOn();
847template<Index Log2Dim>
857template<Index Log2Dim>
862 return sizeof(*this);
866template<Index Log2Dim>
871 return sizeof(*this);
875template<Index Log2Dim>
879 CoordBBox this_bbox = this->getNodeBoundingBox();
880 if (bbox.
isInside(this_bbox))
return;
884 for(; iter; ++iter) this_bbox.
expand(this->offsetToLocalCoord(iter.pos()));
892template<Index Log2Dim>
893template<
typename OtherType, Index OtherLog2Dim>
898 return (Log2Dim == OtherLog2Dim && mBuffer.mData == other->
getValueMask());
902template<Index Log2Dim>
906 std::ostringstream ostr;
907 ostr <<
"LeafNode @" << mOrigin <<
": ";
908 for (
Index32 n = 0; n < SIZE; ++n) ostr << (mBuffer.mData.isOn(n) ?
'#' :
'.');
916template<Index Log2Dim>
920 assert ((xyz[0] & (DIM-1u)) < DIM && (xyz[1] & (DIM-1u)) < DIM && (xyz[2] & (DIM-1u)) < DIM);
921 return ((xyz[0] & (DIM-1u)) << 2*Log2Dim)
922 + ((xyz[1] & (DIM-1u)) << Log2Dim)
923 + (xyz[2] & (DIM-1u));
927template<Index Log2Dim>
931 assert(n < (1 << 3*Log2Dim));
933 xyz.
setX(n >> 2*Log2Dim);
934 n &= ((1 << 2*Log2Dim) - 1);
935 xyz.
setY(n >> Log2Dim);
936 xyz.
setZ(n & ((1 << Log2Dim) - 1));
941template<Index Log2Dim>
945 return (this->offsetToLocalCoord(n) + this->origin());
952template<Index Log2Dim>
956 mBuffer.mData.load(is);
960template<Index Log2Dim>
964 mBuffer.mData.save(os);
968template<Index Log2Dim>
975 this->readBuffers(is, fromHalf);
978 bool background =
false;
980 background = *
static_cast<const bool*
>(bgPtr);
982 this->clip(clipBBox, background);
986template<Index Log2Dim>
991 mBuffer.mData.load(is);
997template<Index Log2Dim>
1002 mBuffer.mData.save(os);
1004 os.write(
reinterpret_cast<const char*
>(&mOrigin),
sizeof(
Coord::ValueType) * 3);
1011template<Index Log2Dim>
1015 return mOrigin == other.mOrigin && mBuffer == other.mBuffer;
1019template<Index Log2Dim>
1023 return !(this->operator==(other));
1030template<Index Log2Dim>
1034 if (!mBuffer.mData.isConstant(state))
return false;
1043template<Index Log2Dim>
1047 const Index countTrue = mBuffer.mData.countOn();
1048 return countTrue > (NUM_VALUES >> 1);
1051template<Index Log2Dim>
1055 const Index countTrueOn = mBuffer.mData.countOn();
1060template<Index Log2Dim>
1064 const Index countFalseOff = mBuffer.mData.countOff();
1066 return countFalseOff;
1073template<Index Log2Dim>
1077 this->addTile(this->coordToOffset(xyz), val, active);
1080template<Index Log2Dim>
1084 assert(offset < SIZE);
1085 this->setValueOnly(offset, val);
1086 this->setActiveState(offset, active);
1089template<Index Log2Dim>
1090template<
typename AccessorT>
1093 bool val,
bool active, AccessorT&)
1095 this->addTile(level, xyz, val, active);
1102template<Index Log2Dim>
1107 if (mBuffer.mData.isOn(this->coordToOffset(xyz)))
return Buffer::sOn;
else return Buffer::sOff;
1111template<Index Log2Dim>
1115 assert(offset < SIZE);
1117 if (mBuffer.mData.isOn(offset))
return Buffer::sOn;
else return Buffer::sOff;
1121template<Index Log2Dim>
1125 const Index offset = this->coordToOffset(xyz);
1126 val = mBuffer.mData.isOn(offset);
1131template<Index Log2Dim>
1135 this->setValueOn(this->coordToOffset(xyz), val);
1139template<Index Log2Dim>
1143 assert(offset < SIZE);
1144 mBuffer.mData.set(offset, val);
1148template<Index Log2Dim>
1152 this->setValueOnly(this->coordToOffset(xyz), val);
1156template<Index Log2Dim>
1160 mBuffer.mData.set(this->coordToOffset(xyz), on);
1164template<Index Log2Dim>
1168 this->setValueOff(this->coordToOffset(xyz), val);
1172template<Index Log2Dim>
1176 assert(offset < SIZE);
1177 mBuffer.mData.set(offset, val);
1181template<Index Log2Dim>
1182template<
typename ModifyOp>
1186 bool val = mBuffer.mData.isOn(offset);
1188 mBuffer.mData.set(offset, val);
1192template<Index Log2Dim>
1193template<
typename ModifyOp>
1197 this->modifyValue(this->coordToOffset(xyz), op);
1201template<Index Log2Dim>
1202template<
typename ModifyOp>
1206 const Index offset = this->coordToOffset(xyz);
1207 bool val = mBuffer.mData.isOn(offset), state = val;
1209 mBuffer.mData.set(offset, val);
1216template<Index Log2Dim>
1217template<MergePolicy Policy>
1223 mBuffer.mData |= other.mBuffer.mData;
1227template<Index Log2Dim>
1228template<MergePolicy Policy>
1234 if (tileValue) mBuffer.mData.setOn();
1242template<Index Log2Dim>
1243template<
typename OtherType>
1251template<Index Log2Dim>
1252template<
typename OtherType>
1261template<Index Log2Dim>
1262template<
typename OtherType>
1274template<Index Log2Dim>
1278 CoordBBox nodeBBox = this->getNodeBoundingBox();
1281 this->fill(nodeBBox, background,
false);
1282 }
else if (clipBBox.
isInside(nodeBBox)) {
1294 int &x = xyz.
x(), &y = xyz.
y(), &z = xyz.
z();
1295 for (x = nodeBBox.
min().
x(); x <= nodeBBox.
max().
x(); ++x) {
1296 for (y = nodeBBox.
min().
y(); y <= nodeBBox.
max().
y(); ++y) {
1297 for (z = nodeBBox.
min().
z(); z <= nodeBBox.
max().
z(); ++z) {
1298 mask.
setOn(
static_cast<Index32>(this->coordToOffset(xyz)));
1306 this->setValueOff(maskIter.pos(), background);
1314template<Index Log2Dim>
1318 auto clippedBBox = this->getNodeBoundingBox();
1319 clippedBBox.intersect(bbox);
1320 if (!clippedBBox)
return;
1322 for (
Int32 x = clippedBBox.min().x(); x <= clippedBBox.max().x(); ++x) {
1323 const Index offsetX = (x & (DIM-1u))<<2*Log2Dim;
1324 for (
Int32 y = clippedBBox.min().y(); y <= clippedBBox.max().y(); ++y) {
1325 const Index offsetXY = offsetX + ((y & (DIM-1u))<< Log2Dim);
1326 for (
Int32 z = clippedBBox.min().z(); z <= clippedBBox.max().z(); ++z) {
1327 const Index offset = offsetXY + (z & (DIM-1u));
1328 mBuffer.mData.set(offset,
value);
1334template<Index Log2Dim>
1338 mBuffer.fill(
value);
1345template<Index Log2Dim>
1346template<
typename DenseT>
1350 using DenseValueType =
typename DenseT::ValueType;
1352 const size_t xStride = dense.xStride(), yStride = dense.yStride(), zStride = dense.zStride();
1353 const Coord& min = dense.bbox().min();
1354 DenseValueType* t0 = dense.data() + zStride * (bbox.
min()[2] - min[2]);
1355 const Int32 n0 = bbox.
min()[2] & (DIM-1u);
1356 for (
Int32 x = bbox.
min()[0], ex = bbox.
max()[0] + 1; x < ex; ++x) {
1357 DenseValueType* t1 = t0 + xStride * (x - min[0]);
1358 const Int32 n1 = n0 + ((x & (DIM-1u)) << 2*LOG2DIM);
1359 for (
Int32 y = bbox.
min()[1], ey = bbox.
max()[1] + 1; y < ey; ++y) {
1360 DenseValueType* t2 = t1 + yStride * (y - min[1]);
1361 Int32 n2 = n1 + ((y & (DIM-1u)) << LOG2DIM);
1362 for (
Int32 z = bbox.
min()[2], ez = bbox.
max()[2] + 1; z < ez; ++z, t2 += zStride) {
1363 *t2 = DenseValueType(mBuffer.mData.isOn(n2++));
1370template<Index Log2Dim>
1371template<
typename DenseT>
1374 bool background,
bool tolerance)
1376 using DenseValueType =
typename DenseT::ValueType;
1378 inline static bool toBool(
const DenseValueType& v) {
return !math::isZero(v); }
1381 const size_t xStride = dense.xStride(), yStride = dense.yStride(), zStride = dense.zStride();
1382 const Coord& min = dense.bbox().min();
1383 const DenseValueType* s0 = dense.data() + zStride * (bbox.
min()[2] - min[2]);
1384 const Int32 n0 = bbox.
min()[2] & (DIM-1u);
1385 for (
Int32 x = bbox.
min()[0], ex = bbox.
max()[0] + 1; x < ex; ++x) {
1386 const DenseValueType* s1 = s0 + xStride * (x - min[0]);
1387 const Int32 n1 = n0 + ((x & (DIM-1u)) << 2*LOG2DIM);
1388 for (
Int32 y = bbox.
min()[1], ey = bbox.
max()[1] + 1; y < ey; ++y) {
1389 const DenseValueType* s2 = s1 + yStride * (y - min[1]);
1390 Int32 n2 = n1 + ((y & (DIM-1u)) << LOG2DIM);
1391 for (
Int32 z = bbox.
min()[2], ez = bbox.
max()[2]+1; z < ez; ++z, ++n2, s2 += zStride) {
1393 if (tolerance || (background == Local::toBool(*s2))) {
1394 mBuffer.mData.set(n2, background);
1396 mBuffer.mData.set(n2, Local::toBool(*s2));
1407template<Index Log2Dim>
1408template<
typename CombineOp>
1413 for (
Index i = 0; i < SIZE; ++i) {
1414 bool result =
false, aVal = mBuffer.mData.isOn(i), bVal = other.mBuffer.mData.isOn(i);
1420 mBuffer.mData.set(i, result);
1425template<Index Log2Dim>
1426template<
typename CombineOp>
1432 for (
Index i = 0; i < SIZE; ++i) {
1433 bool result =
false, aVal = mBuffer.mData.isOn(i);
1437 mBuffer.mData.set(i, result);
1445template<Index Log2Dim>
1446template<
typename CombineOp,
typename OtherType>
1449 bool valueIsActive, CombineOp& op)
1453 for (
Index i = 0; i < SIZE; ++i) {
1454 bool result =
false, aVal = other.mBuffer.mData.isOn(i);
1458 mBuffer.mData.set(i, result);
1463template<Index Log2Dim>
1464template<
typename CombineOp,
typename OtherNodeT>
1467 bool valueIsActive, CombineOp& op)
1471 for (
Index i = 0; i < SIZE; ++i) {
1472 bool result =
false, bVal = other.mBuffer.mData.isOn(i);
1476 mBuffer.mData.set(i, result);
1481template<Index Log2Dim>
1482template<
typename CombineOp,
typename OtherNodeT>
1487 for (
Index i = 0; i < SIZE; ++i) {
1488 bool result =
false, b0Val = b0.mBuffer.mData.isOn(i), b1Val = b1.mBuffer.mData.isOn(i);
1494 mBuffer.mData.set(i, result);
ValueT value
Definition: GridBuilder.h:1290
ChildT * child
Definition: GridBuilder.h:1289
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
This struct collects both input and output arguments to "grid combiner" functors used with the tree::...
Definition: Types.h:530
CombineArgs & setARef(const AValueType &a)
Redirect the A value to a new external source.
Definition: Types.h:582
CombineArgs & setBIsActive(bool b)
Set the active state of the B value.
Definition: Types.h:598
CombineArgs & setResultRef(AValueType &val)
Redirect the result value to a new external destination.
Definition: Types.h:586
CombineArgs & setBRef(const BValueType &b)
Redirect the B value to a new external source.
Definition: Types.h:584
CombineArgs & setAIsActive(bool b)
Set the active state of the A value.
Definition: Types.h:596
Tag dispatch class that distinguishes constructors during file input.
Definition: Types.h:650
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition: Types.h:644
Axis-aligned bounding box of signed integer coordinates.
Definition: Coord.h:249
void translate(const Coord &t)
Translate this bounding box by (tx, ty, tz).
Definition: Coord.h:458
void expand(ValueType padding)
Pad this bounding box with the specified padding.
Definition: Coord.h:418
const Coord & min() const
Definition: Coord.h:321
bool hasOverlap(const CoordBBox &b) const
Return true if the given bounding box overlaps with this bounding box.
Definition: Coord.h:412
const Coord & max() const
Definition: Coord.h:322
bool isInside(const Coord &xyz) const
Return true if point (x, y, z) is inside this bounding box.
Definition: Coord.h:400
void intersect(const CoordBBox &bbox)
Intersect this bounding box with the given bounding box.
Definition: Coord.h:444
void reset()
Definition: Coord.h:327
Signed (x, y, z) 32-bit integer coordinates.
Definition: Coord.h:25
Int32 ValueType
Definition: Coord.h:32
Int32 y() const
Definition: Coord.h:131
Int32 x() const
Definition: Coord.h:130
Coord & setZ(Int32 z)
Definition: Coord.h:81
Coord & setY(Int32 y)
Definition: Coord.h:80
Int32 z() const
Definition: Coord.h:132
Coord & setX(Int32 x)
Definition: Coord.h:79
Base class for iterators over internal and leaf nodes.
Definition: Iterator.h:30
LeafNode specialization for values of type ValueMask that encodes both the active states and the bool...
Definition: LeafNodeMask.h:31
void stealNodes(ArrayT &, const ValueType &, bool)
Definition: LeafNodeMask.h:521
bool isValueOn(Index offset) const
Return true if the voxel at the given offset is active.
Definition: LeafNodeMask.h:283
static Index64 onTileCount()
Definition: LeafNodeMask.h:126
void getOrigin(Int32 &x, Int32 &y, Int32 &z) const
Definition: LeafNodeMask.h:161
ChildOnCIter cbeginChildOn() const
Definition: LeafNodeMask.h:669
CoordBBox getNodeBoundingBox() const
Return the bounding box of this node, i.e., the full index space spanned by this leaf node.
Definition: LeafNodeMask.h:153
NodeMaskType & getValueMask()
Definition: LeafNodeMask.h:698
void setValueOn(Index offset)
Mark the voxel at the given offset as active but don't change its value.
Definition: LeafNodeMask.h:253
bool isChildMaskOn(Index) const
Definition: LeafNodeMask.h:700
ChildOnCIter beginChildOn() const
Definition: LeafNodeMask.h:670
ChildOnIter beginChildOn()
Definition: LeafNodeMask.h:671
bool isValueOn(const Coord &xyz) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNodeMask.h:281
ValueOnIter endValueOn()
Definition: LeafNodeMask.h:659
bool isChildMaskOff() const
Definition: LeafNodeMask.h:702
ValueOffCIter cbeginValueOff() const
Definition: LeafNodeMask.h:650
Index32 transientData() const
Return the transient data value.
Definition: LeafNodeMask.h:174
SharedPtr< LeafNodeType > Ptr
Definition: LeafNodeMask.h:38
static Index getChildDim()
Return the dimension of child nodes of this LeafNode, which is one for voxels.
Definition: LeafNodeMask.h:112
void setValueMask(const NodeMaskType &mask)
Definition: LeafNodeMask.h:699
ChildOnIter endChildOn()
Definition: LeafNodeMask.h:681
ValueAllIter endValueAll()
Definition: LeafNodeMask.h:665
LeafNode * touchLeaf(const Coord &)
Return a pointer to this node.
Definition: LeafNodeMask.h:531
LeafNode * probeLeaf(const Coord &)
Definition: LeafNodeMask.h:534
bool isValueMaskOff() const
Definition: LeafNodeMask.h:695
LeafNode(const LeafNode< ValueType, Log2Dim > &other, bool offValue, bool onValue, TopologyCopy)
Topology copy constructor.
void prune(const ValueType &=zeroVal< ValueType >())
This function exists only to enable template instantiation.
Definition: LeafNodeMask.h:510
bool isValueMaskOn() const
Definition: LeafNodeMask.h:693
DenseIter< const LeafNode, const bool > ChildAllCIter
Definition: LeafNodeMask.h:645
void getNodes(ArrayT &) const
Definition: LeafNodeMask.h:520
void setValuesOff()
Mark all voxels as inactive but don't change their values.
Definition: LeafNodeMask.h:278
ValueAllCIter endValueAll() const
Definition: LeafNodeMask.h:664
ChildIter< MaskOnIter, const LeafNode > ChildOnCIter
Definition: LeafNodeMask.h:641
Index64 onLeafVoxelCount() const
Definition: LeafNodeMask.h:124
void setValueOnly(Index offset, bool val)
Set the value of the voxel at the given offset but don't change its active state.
Definition: LeafNodeMask.h:238
ChildOffCIter endChildOff() const
Definition: LeafNodeMask.h:683
ValueAllCIter cbeginValueAll() const
Definition: LeafNodeMask.h:653
NodeT * probeNode(const Coord &)
Definition: LeafNodeMask.h:517
ValueOnCIter beginValueOn() const
Definition: LeafNodeMask.h:648
static void evalNodeOrigin(Coord &xyz)
Compute the origin of the leaf node that contains the voxel with the given coordinates.
Definition: LeafNodeMask.h:709
const Buffer & buffer() const
Definition: LeafNodeMask.h:197
LeafNode * probeLeafAndCache(const Coord &, AccessorT &)
Definition: LeafNodeMask.h:536
void setValueMaskOn(Index n)
Definition: LeafNodeMask.h:705
Index64 offLeafVoxelCount() const
Definition: LeafNodeMask.h:125
const LeafNode * probeLeaf(const Coord &) const
Return a const pointer to this node.
Definition: LeafNodeMask.h:548
void setOrigin(const Coord &origin)
Set the grid index coordinates of this node's local origin.
Definition: LeafNodeMask.h:156
const Coord & origin() const
Return the grid index coordinates of this node's local origin.
Definition: LeafNodeMask.h:159
static Index getValueLevel(const Coord &)
Return the level (0) at which leaf node values reside.
Definition: LeafNodeMask.h:228
typename NodeMaskType::OnIterator MaskOnIter
Definition: LeafNodeMask.h:568
bool isInactive() const
Return true if all of this node's values are inactive.
Definition: LeafNodeMask.h:442
Buffer mBuffer
Bitmask representing the values AND state of voxels.
Definition: LeafNodeMask.h:712
ValueIter< MaskOnIter, const LeafNode, const bool > ValueOnCIter
Definition: LeafNodeMask.h:635
bool isValueMaskOff(Index n) const
Definition: LeafNodeMask.h:694
ValueOnCIter cendValueOn() const
Definition: LeafNodeMask.h:657
bool isAllocated() const
Return true if memory for this node's buffer has been allocated.
Definition: LeafNodeMask.h:136
static Index getValueLevelAndCache(const Coord &, AccessorT &)
Return the LEVEL (=0) at which leaf node values reside.
Definition: LeafNodeMask.h:399
static Index numValues()
Return the total number of voxels represented by this LeafNode.
Definition: LeafNodeMask.h:106
ValueOffCIter beginValueOff() const
Definition: LeafNodeMask.h:651
ValueIter< MaskOffIter, LeafNode, const bool > ValueOffIter
Definition: LeafNodeMask.h:636
ChildAllCIter cbeginChildAll() const
Definition: LeafNodeMask.h:675
ChildOffIter endChildOff()
Definition: LeafNodeMask.h:684
ChildAllIter beginChildAll()
Definition: LeafNodeMask.h:677
static Index getLevel()
Return the level of this node, which by definition is zero for LeafNodes.
Definition: LeafNodeMask.h:108
bool isValueOnAndCache(const Coord &xyz, AccessorT &) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNodeMask.h:340
void denseFill(const CoordBBox &bbox, bool value, bool=false)
Set all voxels within an axis-aligned box to the specified value.
Definition: LeafNodeMask.h:294
void addLeaf(LeafNode *)
Definition: LeafNodeMask.h:511
ValueOnIter beginValueOn()
Definition: LeafNodeMask.h:649
void modifyValueAndCache(const Coord &xyz, const ModifyOp &op, AccessorT &)
Apply a functor to the value of the voxel at the given coordinates and mark the voxel as active.
Definition: LeafNodeMask.h:365
void setValueOffAndCache(const Coord &xyz, bool value, AccessorT &)
Change the value of the voxel at the given coordinates and mark it as inactive.
Definition: LeafNodeMask.h:356
ChildIter< MaskOffIter, const LeafNode > ChildOffCIter
Definition: LeafNodeMask.h:643
NodeT * probeNodeAndCache(const Coord &, AccessorT &)
Definition: LeafNodeMask.h:538
ValueIter< MaskDenseIter, LeafNode, const bool > ValueAllIter
Definition: LeafNodeMask.h:638
ChildOffCIter cbeginChildOff() const
Definition: LeafNodeMask.h:672
ChildOffIter beginChildOff()
Definition: LeafNodeMask.h:674
bool isChildMaskOff(Index) const
Definition: LeafNodeMask.h:701
Index64 onVoxelCount() const
Return the number of active voxels.
Definition: LeafNodeMask.h:121
typename NodeMaskType::OffIterator MaskOffIter
Definition: LeafNodeMask.h:569
ChildOffCIter beginChildOff() const
Definition: LeafNodeMask.h:673
LeafNode(const LeafNode< ValueType, Log2Dim > &other, bool background, TopologyCopy)
static Index64 offTileCount()
Definition: LeafNodeMask.h:127
void setValueOff(const Coord &xyz)
Mark the voxel at the given coordinates as inactive but don't change its value.
Definition: LeafNodeMask.h:241
bool ValueType
Definition: LeafNodeMask.h:35
ValueOffIter endValueOff()
Definition: LeafNodeMask.h:662
void setValueOff(Index offset)
Mark the voxel at the given offset as inactive but don't change its value.
Definition: LeafNodeMask.h:243
const LeafNode * probeConstLeafAndCache(const Coord &, AccessorT &) const
Definition: LeafNodeMask.h:553
ChildAllCIter endChildAll() const
Definition: LeafNodeMask.h:686
const NodeT * probeConstNodeAndCache(const Coord &, AccessorT &) const
Definition: LeafNodeMask.h:555
ValueOnCIter cbeginValueOn() const
Definition: LeafNodeMask.h:647
static Index log2dim()
Return log2 of the size of the buffer storage.
Definition: LeafNodeMask.h:100
void resetBackground(bool, bool)
no-op since for this template specialization voxel values and states are indistinguishable.
Definition: LeafNodeMask.h:446
static void getNodeLog2Dims(std::vector< Index > &dims)
Append the Log2Dim of this LeafNode to the specified vector.
Definition: LeafNodeMask.h:110
ChildOnCIter endChildOn() const
Definition: LeafNodeMask.h:680
const LeafNode * probeConstLeaf(const Coord &) const
Definition: LeafNodeMask.h:551
static Index32 nonLeafCount()
Return the non-leaf count for this node, which is zero.
Definition: LeafNodeMask.h:118
bool probeValueAndCache(const Coord &xyz, bool &val, AccessorT &) const
Return true if the voxel at the given coordinates is active and return the voxel value in val.
Definition: LeafNodeMask.h:391
ChildOnCIter cendChildOn() const
Definition: LeafNodeMask.h:679
static bool hasActiveTiles()
Return false since leaf nodes never contain tiles.
Definition: LeafNodeMask.h:286
ChildAllCIter cendChildAll() const
Definition: LeafNodeMask.h:685
ValueIter< MaskOnIter, LeafNode, const bool > ValueOnIter
Definition: LeafNodeMask.h:634
void setValueOnlyAndCache(const Coord &xyz, bool val, AccessorT &)
Change the value of the voxel at the given coordinates but preserve its state.
Definition: LeafNodeMask.h:351
DenseIter< LeafNode, bool > ChildAllIter
Definition: LeafNodeMask.h:644
ChildAllIter endChildAll()
Definition: LeafNodeMask.h:687
void setValueMask(Index n, bool on)
Definition: LeafNodeMask.h:704
const NodeMaskType & valueMask() const
Definition: LeafNodeMask.h:697
Index64 offVoxelCount() const
Return the number of inactive voxels.
Definition: LeafNodeMask.h:123
void swap(Buffer &other)
Exchange this node's data buffer with the given data buffer without changing the active states of the...
Definition: LeafNodeMask.h:196
ValueAllCIter cendValueAll() const
Definition: LeafNodeMask.h:663
ChildIter< MaskOnIter, LeafNode > ChildOnIter
Definition: LeafNodeMask.h:640
LeafNode(const LeafNode< ValueType, Log2Dim > &other, TopologyCopy)
Topology copy constructor.
void negate()
Invert the bits of the voxels, i.e. states and values.
Definition: LeafNodeMask.h:449
ChildAllCIter beginChildAll() const
Definition: LeafNodeMask.h:676
const LeafNode * probeLeafAndCache(const Coord &, AccessorT &) const
Definition: LeafNodeMask.h:550
void setActiveStateAndCache(const Coord &xyz, bool on, AccessorT &)
Set the active state of the voxel at the given coordinates without changing its value.
Definition: LeafNodeMask.h:382
void getOrigin(Coord &origin) const
Definition: LeafNodeMask.h:160
void setValuesOn()
Mark all voxels as active but don't change their values.
Definition: LeafNodeMask.h:276
void setTransientData(Index32 transientData)
Set the transient data value.
Definition: LeafNodeMask.h:176
void nodeCount(std::vector< Index32 > &) const
no-op
Definition: LeafNodeMask.h:116
static Index size()
Return the total number of voxels represented by this LeafNode.
Definition: LeafNodeMask.h:104
ChildOffCIter cendChildOff() const
Definition: LeafNodeMask.h:682
typename NodeMaskType::DenseIterator MaskDenseIter
Definition: LeafNodeMask.h:570
bool isEmpty() const
Return true if this node has no active voxels.
Definition: LeafNodeMask.h:130
void setValueAndCache(const Coord &xyz, bool val, AccessorT &)
Change the value of the voxel at the given coordinates and mark it as active.
Definition: LeafNodeMask.h:345
ValueOffIter beginValueOff()
Definition: LeafNodeMask.h:652
const NodeT * probeConstNode(const Coord &) const
Definition: LeafNodeMask.h:519
void setValueOn(const Coord &xyz)
Mark the voxel at the given coordinates as active but don't change its value.
Definition: LeafNodeMask.h:251
Buffer & buffer()
Definition: LeafNodeMask.h:198
void setActiveState(Index offset, bool on)
Set the active state of the voxel at the given offset but don't change its value.
Definition: LeafNodeMask.h:233
static Index32 leafCount()
Return the leaf count for this node, which is one.
Definition: LeafNodeMask.h:114
bool allocate()
Allocate memory for this node's buffer if it has not already been allocated.
Definition: LeafNodeMask.h:140
const NodeMaskType & getValueMask() const
Definition: LeafNodeMask.h:696
const bool & getFirstValue() const
Return a const reference to the first entry in the buffer.
Definition: LeafNodeMask.h:404
void addLeafAndCache(LeafNode *, AccessorT &)
Definition: LeafNodeMask.h:513
const bool & getLastValue() const
Return a const reference to the last entry in the buffer.
Definition: LeafNodeMask.h:408
ValueOffCIter cendValueOff() const
Definition: LeafNodeMask.h:660
ValueIter< MaskDenseIter, const LeafNode, const bool > ValueAllCIter
Definition: LeafNodeMask.h:639
const bool & getValueAndCache(const Coord &xyz, AccessorT &) const
Return the value of the voxel at the given coordinates.
Definition: LeafNodeMask.h:335
void setValueMaskOff(Index n)
Definition: LeafNodeMask.h:706
bool isDense() const
Return true if this node only contains active voxels.
Definition: LeafNodeMask.h:132
ValueOffCIter endValueOff() const
Definition: LeafNodeMask.h:661
NodeT * stealNode(const Coord &, const ValueType &, bool)
Definition: LeafNodeMask.h:515
void setValue(const Coord &xyz, bool val)
Set the value of the voxel at the given coordinates and mark the voxel as active.
Definition: LeafNodeMask.h:258
ValueOnCIter endValueOn() const
Definition: LeafNodeMask.h:658
void voxelizeActiveTiles(bool=true)
No-op.
Definition: LeafNodeMask.h:457
void modifyValueAndActiveStateAndCache(const Coord &xyz, const ModifyOp &op, AccessorT &)
Definition: LeafNodeMask.h:373
LeafNode * touchLeafAndCache(const Coord &, AccessorT &)
Definition: LeafNodeMask.h:533
ValueAllCIter beginValueAll() const
Definition: LeafNodeMask.h:654
Coord mOrigin
Global grid index coordinates (x,y,z) of the local origin of this node.
Definition: LeafNodeMask.h:714
static Index dim()
Return the number of voxels in each dimension.
Definition: LeafNodeMask.h:102
ChildIter< MaskOffIter, LeafNode > ChildOffIter
Definition: LeafNodeMask.h:642
ValueIter< MaskOffIter, const LeafNode, const bool > ValueOffCIter
Definition: LeafNodeMask.h:637
bool isValueMaskOn(Index n) const
Definition: LeafNodeMask.h:692
ValueAllIter beginValueAll()
Definition: LeafNodeMask.h:655
LeafNode(const LeafNode< OtherValueType, Log2Dim > &other)
Value conversion copy constructor.
Templated block class to hold specific data types and a fixed number of values determined by Log2Dim....
Definition: LeafNode.h:38
static Coord offsetToLocalCoord(Index n)
Return the local coordinates for a linear table offset, where offset 0 has coordinates (0,...
Definition: LeafNode.h:1032
void writeTopology(std::ostream &os, bool toHalf=false) const
Write out just the topology.
Definition: LeafNode.h:1288
void copyToDense(const CoordBBox &bbox, DenseT &dense) const
Copy into a dense grid the values of the voxels that lie within a given bounding box.
Definition: LeafNode.h:1216
bool operator!=(const LeafNode &other) const
Definition: LeafNode.h:203
void copyFromDense(const CoordBBox &bbox, const DenseT &dense, const ValueType &background, const ValueType &tolerance)
Copy from a dense grid into this node the values of the voxels that lie within a given bounding box.
Definition: LeafNode.h:1243
const ValueType & getValue(const Coord &xyz) const
Return the value of the voxel at the given coordinates.
Definition: LeafNode.h:1057
void setValueOnly(const Coord &xyz, const ValueType &val)
Set the value of the voxel at the given coordinates but don't change its active state.
Definition: LeafNode.h:1115
void topologyDifference(const LeafNode< OtherType, Log2Dim > &other, const ValueType &)
Difference this node's set of active values with the active values of the other node,...
Definition: LeafNode.h:1708
Index medianOff(ValueType &value, ValueType *tmp=nullptr) const
Computes the median value of all the inactive voxels in this node.
Definition: LeafNode.h:1565
ValueType medianAll(ValueType *tmp=nullptr) const
Computes the median value of all the active AND inactive voxels in this node.
Definition: LeafNode.h:1523
~LeafNode()
Destructor.
Definition: LeafNode.h:1002
void readTopology(std::istream &is, bool fromHalf=false)
Read in just the topology.
Definition: LeafNode.h:1280
Index medianOn(ValueType &value, ValueType *tmp=nullptr) const
Computes the median value of all the active voxels in this node.
Definition: LeafNode.h:1541
void addTile(Index level, const Coord &, const ValueType &, bool)
Definition: LeafNode.h:1592
void modifyValueAndActiveState(const Coord &xyz, const ModifyOp &op)
Apply a functor to the voxel at the given coordinates.
Definition: LeafNode.h:458
void topologyIntersection(const LeafNode< OtherType, Log2Dim > &other, const ValueType &)
Intersect this node's set of active values with the active values of the other node,...
Definition: LeafNode.h:1699
void clip(const CoordBBox &, const ValueType &background)
Set all voxels that lie outside the given axis-aligned box to the background.
Definition: LeafNode.h:1133
void setActiveState(const Coord &xyz, bool on)
Set the active state of the voxel at the given coordinates but don't change its value.
Definition: LeafNode.h:1107
void topologyUnion(const LeafNode< OtherType, Log2Dim > &other, const bool preserveTiles=false)
Union this node's set of active values with the active values of the other node, whose ValueType may ...
Definition: LeafNode.h:1691
static Index coordToOffset(const Coord &xyz)
Return the linear table offset of the given global or local coordinates.
Definition: LeafNode.h:1022
void setValueOff(const Coord &xyz)
Mark the voxel at the given coordinates as inactive but don't change its value.
Definition: LeafNode.h:409
bool hasSameTopology(const LeafNode< OtherType, OtherLog2Dim > *other) const
Return true if the given node (which may have a different ValueType than this node) has the same acti...
Definition: LeafNode.h:1479
void writeBuffers(std::ostream &os, bool toHalf=false) const
Write buffers to a stream.
Definition: LeafNode.h:1414
void combine(const LeafNode &other, CombineOp &op)
Definition: LeafNode.h:1732
Index64 memUsageIfLoaded() const
Definition: LeafNode.h:1451
void combine2(const LeafNode &other, const OtherType &, bool valueIsActive, CombineOp &)
Definition: LeafNode.h:1772
void fill(const CoordBBox &bbox, const ValueType &, bool active=true)
Set all voxels within an axis-aligned box to the specified value and active state.
Definition: LeafNode.h:1173
const NodeMaskType & valueMask() const
Definition: LeafNode.h:858
void readBuffers(std::istream &is, bool fromHalf=false)
Read buffers from a stream.
Definition: LeafNode.h:1316
bool isConstant(ValueType &firstValue, bool &state, const ValueType &tolerance=zeroVal< ValueType >()) const
Definition: LeafNode.h:1487
friend class LeafNode
Definition: LeafNode.h:835
Coord offsetToGlobalCoord(Index n) const
Return the global coordinates for a linear table offset.
Definition: LeafNode.h:1046
bool operator==(const LeafNode &other) const
Check for buffer, state and origin equivalence.
Definition: LeafNode.h:1431
void evalActiveBoundingBox(CoordBBox &bbox, bool visitVoxels=true) const
Definition: LeafNode.h:1461
void merge(const LeafNode &)
Definition: LeafNode.h:1642
void setValueOn(const Coord &xyz)
Mark the voxel at the given coordinates as active but don't change its value.
Definition: LeafNode.h:419
const NodeMaskType & getValueMask() const
Definition: LeafNode.h:856
void addTileAndCache(Index, const Coord &, const ValueType &, bool, AccessorT &)
Definition: LeafNode.h:1609
void modifyValue(Index offset, const ModifyOp &op)
Apply a functor to the value of the voxel at the given offset and mark the voxel as active.
Definition: LeafNode.h:437
Index64 memUsage() const
Return the memory in bytes occupied by this node.
Definition: LeafNode.h:1441
std::string str() const
Return a string representation of this node.
Definition: LeafNode.h:1009
bool probeValue(const Coord &xyz, ValueType &val) const
Return true if the voxel at the given coordinates is active.
Definition: LeafNode.h:1073
Definition: NodeMasks.h:271
Bit mask for the internal and leaf nodes of VDB. This is a 64-bit implementation.
Definition: NodeMasks.h:308
OffIterator beginOff() const
Definition: NodeMasks.h:354
void setOn(Index32 n)
Set the nth bit on.
Definition: NodeMasks.h:452
Definition: NodeMasks.h:240
Definition: NodeMasks.h:209
OPENVDB_API const void * getGridBackgroundValuePtr(std::ios_base &)
Return a pointer to the background value of the grid currently being read from or written to the give...
Index32 Index
Definition: Types.h:54
uint32_t Index32
Definition: Types.h:52
int32_t Int32
Definition: Types.h:56
uint64_t Index64
Definition: Types.h:53
std::shared_ptr< T > SharedPtr
Definition: Types.h:114
@ MERGE_NODES
Definition: Types.h:469
@ MERGE_ACTIVE_STATES_AND_NODES
Definition: Types.h:470
Definition: Exceptions.h:13
Base class for dense iterators over internal and leaf nodes.
Definition: Iterator.h:179
typename std::remove_const< UnsetItemT >::type NonConstValueType
Definition: Iterator.h:184
ChildIter(const MaskIterT &iter, NodeT *parent)
Definition: LeafNodeMask.h:605
ChildIter()
Definition: LeafNodeMask.h:604
bool getItem(Index pos, void *&child, NonConstValueT &value) const
Definition: LeafNodeMask.h:619
DenseIter()
Definition: LeafNodeMask.h:616
DenseIter(const MaskDenseIter &iter, NodeT *parent)
Definition: LeafNodeMask.h:617
typename BaseT::NonConstValueType NonConstValueT
Definition: LeafNodeMask.h:614
void unsetItem(Index pos, const ValueT &val) const
Definition: LeafNodeMask.h:630
void setItem(Index pos, bool value) const
Definition: LeafNodeMask.h:587
void modifyValue(const ModifyOp &op) const
Definition: LeafNodeMask.h:596
ValueIter(const MaskIterT &iter, NodeT *parent)
Definition: LeafNodeMask.h:581
const bool & getValue() const
Definition: LeafNodeMask.h:584
const bool & getItem(Index pos) const
Definition: LeafNodeMask.h:583
ValueIter()
Definition: LeafNodeMask.h:580
void setValue(bool value) const
Definition: LeafNodeMask.h:589
void modifyItem(Index n, const ModifyOp &op) const
Definition: LeafNodeMask.h:593
Definition: LeafNode.h:894
Base class for sparse iterators over internal and leaf nodes.
Definition: Iterator.h:115
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:121
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:212