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 {
68 explicit LeafNode(
const Coord& xyz,
bool value =
false,
bool dummy =
false);
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;
178 std::string str()
const;
182 template<
typename OtherType, Index OtherLog2Dim>
186 bool operator==(
const LeafNode&)
const;
187 bool operator!=(
const LeafNode&)
const;
202 void readTopology(std::istream&,
bool fromHalf =
false);
204 void writeTopology(std::ostream&,
bool toHalf =
false)
const;
207 void readBuffers(std::istream&,
bool fromHalf =
false);
208 void readBuffers(std::istream& is,
const CoordBBox&,
bool fromHalf =
false);
210 void writeBuffers(std::ostream&,
bool toHalf =
false)
const;
216 const bool& getValue(
const Coord& xyz)
const;
218 const bool& getValue(
Index offset)
const;
223 bool probeValue(
const Coord& xyz,
bool& val)
const;
229 void setActiveState(
const Coord& xyz,
bool on);
234 void setValueOnly(
const Coord& xyz,
bool val);
236 void setValueOnly(
Index offset,
bool val) { assert(offset<SIZE); mBuffer.setValue(offset,val); }
244 void setValueOff(
const Coord& xyz,
bool val);
246 void setValueOff(
Index offset,
bool val);
254 void setValueOn(
const Coord& xyz,
bool val);
258 void setValueOn(
Index offset,
bool val);
262 template<
typename ModifyOp>
263 void modifyValue(
Index offset,
const ModifyOp& op);
266 template<
typename ModifyOp>
267 void modifyValue(
const Coord& xyz,
const ModifyOp& op);
270 template<
typename ModifyOp>
271 void modifyValueAndActiveState(
const Coord& xyz,
const ModifyOp& op);
279 bool isValueOn(
const Coord& xyz)
const {
return mBuffer.mData.isOn(this->coordToOffset(xyz)); }
281 bool isValueOn(
Index offset)
const { assert(offset < SIZE);
return mBuffer.mData.isOn(offset); }
287 void clip(
const CoordBBox&,
bool background);
290 void fill(
const CoordBBox& bbox,
bool value,
bool =
false);
295 void fill(
const bool& value,
bool dummy =
false);
308 template<
typename DenseT>
309 void copyToDense(
const CoordBBox& bbox, DenseT& dense)
const;
327 template<
typename DenseT>
328 void copyFromDense(
const CoordBBox& bbox,
const DenseT& dense,
bool background,
bool tolerance);
332 template<
typename AccessorT>
337 template<
typename AccessorT>
342 template<
typename AccessorT>
348 template<
typename AccessorT>
353 template<
typename AccessorT>
356 this->setValueOff(xyz, value);
362 template<
typename ModifyOp,
typename AccessorT>
365 this->modifyValue(xyz, op);
370 template<
typename ModifyOp,
typename AccessorT>
373 this->modifyValueAndActiveState(xyz, op);
379 template<
typename AccessorT>
382 this->setActiveState(xyz, on);
388 template<
typename AccessorT>
391 return this->probeValue(xyz, val);
396 template<
typename AccessorT>
402 const bool&
getFirstValue()
const {
if (mBuffer.mData.isOn(0))
return Buffer::sOn;
else return Buffer::sOff; }
406 const bool&
getLastValue()
const {
if (mBuffer.mData.isOn(SIZE-1))
return Buffer::sOn;
else return Buffer::sOff; }
411 bool isConstant(
bool& constValue,
bool& state,
bool tolerance = 0)
const;
418 bool medianAll()
const;
427 Index medianOn(ValueType &value)
const;
437 Index medianOff(ValueType &value)
const;
447 void negate() { mBuffer.mData.toggle(); }
449 template<MergePolicy Policy>
450 void merge(
const LeafNode& other,
bool bg =
false,
bool otherBG =
false);
451 template<MergePolicy Policy>
void merge(
bool tileValue,
bool tileActive=
false);
463 template<
typename OtherType>
477 template<
typename OtherType>
491 template<
typename OtherType>
494 template<
typename CombineOp>
495 void combine(
const LeafNode& other, CombineOp& op);
496 template<
typename CombineOp>
497 void combine(
bool,
bool valueIsActive, CombineOp& op);
499 template<
typename CombineOp,
typename OtherType >
500 void combine2(
const LeafNode& other,
const OtherType&,
bool valueIsActive, CombineOp&);
501 template<
typename CombineOp,
typename OtherNodeT >
502 void combine2(
bool,
const OtherNodeT& other,
bool valueIsActive, CombineOp&);
503 template<
typename CombineOp,
typename OtherNodeT >
504 void combine2(
const LeafNode& b0,
const OtherNodeT& b1, CombineOp&);
510 template<
typename AccessorT>
512 template<
typename NodeT>
514 template<
typename NodeT>
516 template<
typename NodeT>
518 template<
typename ArrayT>
void getNodes(ArrayT&)
const {}
522 void addTile(
Index level,
const Coord&,
bool val,
bool active);
523 void addTile(
Index offset,
bool val,
bool active);
524 template<
typename AccessorT>
525 void addTileAndCache(
Index level,
const Coord&,
bool val,
bool active, AccessorT&);
530 template<
typename AccessorT>
533 template<
typename AccessorT>
535 template<
typename NodeT,
typename AccessorT>
539 if (!(std::is_same<NodeT, LeafNode>::value))
return nullptr;
540 return reinterpret_cast<NodeT*
>(
this);
547 template<
typename AccessorT>
550 template<
typename AccessorT>
552 template<
typename NodeT,
typename AccessorT>
556 if (!(std::is_same<NodeT, LeafNode>::value))
return nullptr;
557 return reinterpret_cast<const NodeT*
>(
this);
570 template<
typename MaskIterT,
typename NodeT,
typename ValueT>
574 public SparseIteratorBase<MaskIterT, ValueIter<MaskIterT, NodeT, ValueT>, NodeT, ValueT>
581 const bool&
getItem(
Index pos)
const {
return this->parent().getValue(pos); }
582 const bool&
getValue()
const {
return this->getItem(this->pos()); }
585 void setItem(
Index pos,
bool value)
const { this->parent().setValueOnly(pos, value); }
587 void setValue(
bool value)
const { this->setItem(this->pos(), value); }
590 template<
typename ModifyOp>
591 void modifyItem(
Index n,
const ModifyOp& op)
const { this->parent().modifyValue(n, op); }
593 template<
typename ModifyOp>
594 void modifyValue(
const ModifyOp& op)
const { this->modifyItem(this->pos(), op); }
598 template<
typename MaskIterT,
typename NodeT>
604 MaskIterT, ChildIter<MaskIterT, NodeT>, NodeT, bool>(iter, parent) {}
607 template<
typename NodeT,
typename ValueT>
609 MaskDenseIter, DenseIter<NodeT, ValueT>, NodeT, void, ValueT>
619 value = this->parent().getValue(pos);
628 void unsetItem(
Index pos,
const ValueT& val)
const {this->parent().setValueOnly(pos, val);}
633 using ValueOnCIter = ValueIter<MaskOnIter, const LeafNode, const bool>;
744template<Index Log2Dim>
751template<Index Log2Dim>
754 : mBuffer(value || active)
755 , mOrigin(xyz & (~(DIM - 1)))
760template<Index Log2Dim>
763 : mBuffer(value || active)
764 , mOrigin(xyz & (~(DIM - 1)))
769template<Index Log2Dim>
772 : mBuffer(other.mBuffer)
773 , mOrigin(other.mOrigin)
774 , mTransientData(other.mTransientData)
780template<Index Log2Dim>
781template<
typename ValueT>
784 : mBuffer(other.valueMask())
785 , mOrigin(other.origin())
786 , mTransientData(other.mTransientData)
791template<Index Log2Dim>
792template<
typename ValueT>
796 : mBuffer(other.valueMask())
797 , mOrigin(other.origin())
798 , mTransientData(other.mTransientData)
803template<Index Log2Dim>
804template<
typename ValueT>
807 : mBuffer(other.valueMask())
808 , mOrigin(other.origin())
809 , mTransientData(other.mTransientData)
814template<Index Log2Dim>
815template<
typename ValueT>
819 : mBuffer(other.valueMask())
820 , mOrigin(other.origin())
821 , mTransientData(other.mTransientData)
823 if (offValue==
true) {
824 if (onValue==
false) {
825 mBuffer.mData.toggle();
827 mBuffer.mData.setOn();
833template<Index Log2Dim>
843template<Index Log2Dim>
848 return sizeof(*this);
852template<Index Log2Dim>
857 return sizeof(*this);
861template<Index Log2Dim>
865 CoordBBox this_bbox = this->getNodeBoundingBox();
866 if (bbox.
isInside(this_bbox))
return;
870 for(; iter; ++iter) this_bbox.
expand(this->offsetToLocalCoord(iter.pos()));
878template<Index Log2Dim>
879template<
typename OtherType, Index OtherLog2Dim>
884 return (Log2Dim == OtherLog2Dim && mBuffer.mData == other->
getValueMask());
888template<Index Log2Dim>
892 std::ostringstream ostr;
893 ostr <<
"LeafNode @" << mOrigin <<
": ";
894 for (
Index32 n = 0; n < SIZE; ++n) ostr << (mBuffer.mData.isOn(n) ?
'#' :
'.');
902template<Index Log2Dim>
906 assert ((xyz[0] & (DIM-1u)) < DIM && (xyz[1] & (DIM-1u)) < DIM && (xyz[2] & (DIM-1u)) < DIM);
907 return ((xyz[0] & (DIM-1u)) << 2*Log2Dim)
908 + ((xyz[1] & (DIM-1u)) << Log2Dim)
909 + (xyz[2] & (DIM-1u));
913template<Index Log2Dim>
917 assert(n < (1 << 3*Log2Dim));
919 xyz.
setX(n >> 2*Log2Dim);
920 n &= ((1 << 2*Log2Dim) - 1);
921 xyz.
setY(n >> Log2Dim);
922 xyz.
setZ(n & ((1 << Log2Dim) - 1));
927template<Index Log2Dim>
931 return (this->offsetToLocalCoord(n) + this->origin());
938template<Index Log2Dim>
942 mBuffer.mData.load(is);
946template<Index Log2Dim>
950 mBuffer.mData.save(os);
954template<Index Log2Dim>
961 this->readBuffers(is, fromHalf);
964 bool background =
false;
966 background = *
static_cast<const bool*
>(bgPtr);
968 this->clip(clipBBox, background);
972template<Index Log2Dim>
977 mBuffer.mData.load(is);
983template<Index Log2Dim>
988 mBuffer.mData.save(os);
990 os.write(
reinterpret_cast<const char*
>(&mOrigin),
sizeof(
Coord::ValueType) * 3);
997template<Index Log2Dim>
1001 return mOrigin == other.mOrigin && mBuffer == other.mBuffer;
1005template<Index Log2Dim>
1009 return !(this->operator==(other));
1016template<Index Log2Dim>
1020 if (!mBuffer.mData.isConstant(state))
return false;
1029template<Index Log2Dim>
1033 const Index countTrue = mBuffer.mData.countOn();
1034 return countTrue > (NUM_VALUES >> 1);
1037template<Index Log2Dim>
1041 const Index countTrueOn = mBuffer.mData.countOn();
1046template<Index Log2Dim>
1050 const Index countFalseOff = mBuffer.mData.countOff();
1052 return countFalseOff;
1059template<Index Log2Dim>
1063 this->addTile(this->coordToOffset(xyz), val, active);
1066template<Index Log2Dim>
1070 assert(offset < SIZE);
1071 this->setValueOnly(offset, val);
1072 this->setActiveState(offset, active);
1075template<Index Log2Dim>
1076template<
typename AccessorT>
1079 bool val,
bool active, AccessorT&)
1081 this->addTile(level, xyz, val, active);
1088template<Index Log2Dim>
1093 if (mBuffer.mData.isOn(this->coordToOffset(xyz)))
return Buffer::sOn;
else return Buffer::sOff;
1097template<Index Log2Dim>
1101 assert(offset < SIZE);
1103 if (mBuffer.mData.isOn(offset))
return Buffer::sOn;
else return Buffer::sOff;
1107template<Index Log2Dim>
1111 const Index offset = this->coordToOffset(xyz);
1112 val = mBuffer.mData.isOn(offset);
1117template<Index Log2Dim>
1121 this->setValueOn(this->coordToOffset(xyz), val);
1125template<Index Log2Dim>
1129 assert(offset < SIZE);
1130 mBuffer.mData.set(offset, val);
1134template<Index Log2Dim>
1138 this->setValueOnly(this->coordToOffset(xyz), val);
1142template<Index Log2Dim>
1146 mBuffer.mData.set(this->coordToOffset(xyz), on);
1150template<Index Log2Dim>
1154 this->setValueOff(this->coordToOffset(xyz), val);
1158template<Index Log2Dim>
1162 assert(offset < SIZE);
1163 mBuffer.mData.set(offset, val);
1167template<Index Log2Dim>
1168template<
typename ModifyOp>
1172 bool val = mBuffer.mData.isOn(offset);
1174 mBuffer.mData.set(offset, val);
1178template<Index Log2Dim>
1179template<
typename ModifyOp>
1183 this->modifyValue(this->coordToOffset(xyz), op);
1187template<Index Log2Dim>
1188template<
typename ModifyOp>
1192 const Index offset = this->coordToOffset(xyz);
1193 bool val = mBuffer.mData.isOn(offset), state = val;
1195 mBuffer.mData.set(offset, val);
1202template<Index Log2Dim>
1203template<MergePolicy Policy>
1209 mBuffer.mData |= other.mBuffer.mData;
1213template<Index Log2Dim>
1214template<MergePolicy Policy>
1220 if (tileValue) mBuffer.mData.setOn();
1228template<Index Log2Dim>
1229template<
typename OtherType>
1237template<Index Log2Dim>
1238template<
typename OtherType>
1247template<Index Log2Dim>
1248template<
typename OtherType>
1260template<Index Log2Dim>
1264 CoordBBox nodeBBox = this->getNodeBoundingBox();
1267 this->fill(nodeBBox, background,
false);
1268 }
else if (clipBBox.
isInside(nodeBBox)) {
1280 int &x = xyz.
x(), &y = xyz.
y(), &z = xyz.
z();
1281 for (x = nodeBBox.
min().
x(); x <= nodeBBox.
max().
x(); ++x) {
1282 for (y = nodeBBox.
min().
y(); y <= nodeBBox.
max().
y(); ++y) {
1283 for (z = nodeBBox.
min().
z(); z <= nodeBBox.
max().
z(); ++z) {
1284 mask.
setOn(
static_cast<Index32>(this->coordToOffset(xyz)));
1292 this->setValueOff(maskIter.pos(), background);
1300template<Index Log2Dim>
1304 auto clippedBBox = this->getNodeBoundingBox();
1305 clippedBBox.intersect(bbox);
1306 if (!clippedBBox)
return;
1308 for (
Int32 x = clippedBBox.min().x(); x <= clippedBBox.max().x(); ++x) {
1309 const Index offsetX = (x & (DIM-1u))<<2*Log2Dim;
1310 for (
Int32 y = clippedBBox.min().y(); y <= clippedBBox.max().y(); ++y) {
1311 const Index offsetXY = offsetX + ((y & (DIM-1u))<< Log2Dim);
1312 for (
Int32 z = clippedBBox.min().z(); z <= clippedBBox.max().z(); ++z) {
1313 const Index offset = offsetXY + (z & (DIM-1u));
1314 mBuffer.mData.set(offset, value);
1320template<Index Log2Dim>
1324 mBuffer.fill(value);
1331template<Index Log2Dim>
1332template<
typename DenseT>
1336 using DenseValueType =
typename DenseT::ValueType;
1338 const size_t xStride = dense.xStride(), yStride = dense.yStride(), zStride = dense.zStride();
1339 const Coord& min = dense.bbox().min();
1340 DenseValueType* t0 = dense.data() + zStride * (bbox.
min()[2] - min[2]);
1341 const Int32 n0 = bbox.
min()[2] & (DIM-1u);
1342 for (
Int32 x = bbox.
min()[0], ex = bbox.
max()[0] + 1; x < ex; ++x) {
1343 DenseValueType* t1 = t0 + xStride * (x - min[0]);
1344 const Int32 n1 = n0 + ((x & (DIM-1u)) << 2*LOG2DIM);
1345 for (
Int32 y = bbox.
min()[1], ey = bbox.
max()[1] + 1; y < ey; ++y) {
1346 DenseValueType* t2 = t1 + yStride * (y - min[1]);
1347 Int32 n2 = n1 + ((y & (DIM-1u)) << LOG2DIM);
1348 for (
Int32 z = bbox.
min()[2], ez = bbox.
max()[2] + 1; z < ez; ++z, t2 += zStride) {
1349 *t2 = DenseValueType(mBuffer.mData.isOn(n2++));
1356template<Index Log2Dim>
1357template<
typename DenseT>
1360 bool background,
bool tolerance)
1362 using DenseValueType =
typename DenseT::ValueType;
1364 inline static bool toBool(
const DenseValueType& v) {
return !math::isZero(v); }
1367 const size_t xStride = dense.xStride(), yStride = dense.yStride(), zStride = dense.zStride();
1368 const Coord& min = dense.bbox().min();
1369 const DenseValueType* s0 = dense.data() + zStride * (bbox.
min()[2] - min[2]);
1370 const Int32 n0 = bbox.
min()[2] & (DIM-1u);
1371 for (
Int32 x = bbox.
min()[0], ex = bbox.
max()[0] + 1; x < ex; ++x) {
1372 const DenseValueType* s1 = s0 + xStride * (x - min[0]);
1373 const Int32 n1 = n0 + ((x & (DIM-1u)) << 2*LOG2DIM);
1374 for (
Int32 y = bbox.
min()[1], ey = bbox.
max()[1] + 1; y < ey; ++y) {
1375 const DenseValueType* s2 = s1 + yStride * (y - min[1]);
1376 Int32 n2 = n1 + ((y & (DIM-1u)) << LOG2DIM);
1377 for (
Int32 z = bbox.
min()[2], ez = bbox.
max()[2]+1; z < ez; ++z, ++n2, s2 += zStride) {
1379 if (tolerance || (background == Local::toBool(*s2))) {
1380 mBuffer.mData.set(n2, background);
1382 mBuffer.mData.set(n2, Local::toBool(*s2));
1393template<Index Log2Dim>
1394template<
typename CombineOp>
1399 for (
Index i = 0; i < SIZE; ++i) {
1400 bool result =
false, aVal = mBuffer.mData.isOn(i), bVal = other.mBuffer.mData.isOn(i);
1406 mBuffer.mData.set(i, result);
1411template<Index Log2Dim>
1412template<
typename CombineOp>
1418 for (
Index i = 0; i < SIZE; ++i) {
1419 bool result =
false, aVal = mBuffer.mData.isOn(i);
1423 mBuffer.mData.set(i, result);
1431template<Index Log2Dim>
1432template<
typename CombineOp,
typename OtherType>
1435 bool valueIsActive, CombineOp& op)
1439 for (
Index i = 0; i < SIZE; ++i) {
1440 bool result =
false, aVal = other.mBuffer.mData.isOn(i);
1444 mBuffer.mData.set(i, result);
1449template<Index Log2Dim>
1450template<
typename CombineOp,
typename OtherNodeT>
1453 bool valueIsActive, CombineOp& op)
1457 for (
Index i = 0; i < SIZE; ++i) {
1458 bool result =
false, bVal = other.mBuffer.mData.isOn(i);
1462 mBuffer.mData.set(i, result);
1467template<Index Log2Dim>
1468template<
typename CombineOp,
typename OtherNodeT>
1473 for (
Index i = 0; i < SIZE; ++i) {
1474 bool result =
false, b0Val = b0.mBuffer.mData.isOn(i), b1Val = b1.mBuffer.mData.isOn(i);
1480 mBuffer.mData.set(i, result);
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:569
CombineArgs & setARef(const AValueType &a)
Redirect the A value to a new external source.
Definition Types.h:621
CombineArgs & setBIsActive(bool b)
Set the active state of the B value.
Definition Types.h:637
CombineArgs & setResultRef(AValueType &val)
Redirect the result value to a new external destination.
Definition Types.h:625
CombineArgs & setBRef(const BValueType &b)
Redirect the B value to a new external source.
Definition Types.h:623
CombineArgs & setAIsActive(bool b)
Set the active state of the A value.
Definition Types.h:635
Tag dispatch class that distinguishes constructors during file input.
Definition Types.h:689
Tag dispatch class that distinguishes topology copy constructors from deep copy constructors.
Definition Types.h:683
Axis-aligned bounding box of signed integer coordinates.
Definition Coord.h:251
void translate(const Coord &t)
Translate this bounding box by (tx, ty, tz).
Definition Coord.h:460
void expand(ValueType padding)
Pad this bounding box with the specified padding.
Definition Coord.h:420
const Coord & min() const
Definition Coord.h:323
bool hasOverlap(const CoordBBox &b) const
Return true if the given bounding box overlaps with this bounding box.
Definition Coord.h:414
const Coord & max() const
Definition Coord.h:324
bool isInside(const Coord &xyz) const
Return true if point (x, y, z) is inside this bounding box.
Definition Coord.h:402
void intersect(const CoordBBox &bbox)
Intersect this bounding box with the given bounding box.
Definition Coord.h:446
void reset()
Definition Coord.h:329
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:519
bool isValueOn(Index offset) const
Return true if the voxel at the given offset is active.
Definition LeafNodeMask.h:281
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:667
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:696
void setValueOn(Index offset)
Mark the voxel at the given offset as active but don't change its value.
Definition LeafNodeMask.h:251
bool isChildMaskOn(Index) const
Definition LeafNodeMask.h:698
ChildOnCIter beginChildOn() const
Definition LeafNodeMask.h:668
ChildOnIter beginChildOn()
Definition LeafNodeMask.h:669
bool isValueOn(const Coord &xyz) const
Return true if the voxel at the given coordinates is active.
Definition LeafNodeMask.h:279
ValueOnIter endValueOn()
Definition LeafNodeMask.h:657
bool isChildMaskOff() const
Definition LeafNodeMask.h:700
ValueOffCIter cbeginValueOff() const
Definition LeafNodeMask.h:648
Index32 transientData() const
Return the transient data value.
Definition LeafNodeMask.h:173
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:697
ChildOnIter endChildOn()
Definition LeafNodeMask.h:679
ValueAllIter endValueAll()
Definition LeafNodeMask.h:663
LeafNode * touchLeaf(const Coord &)
Return a pointer to this node.
Definition LeafNodeMask.h:529
LeafNode * probeLeaf(const Coord &)
Definition LeafNodeMask.h:532
bool isValueMaskOff() const
Definition LeafNodeMask.h:693
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:508
bool isValueMaskOn() const
Definition LeafNodeMask.h:691
DenseIter< const LeafNode, const bool > ChildAllCIter
Definition LeafNodeMask.h:643
void getNodes(ArrayT &) const
Definition LeafNodeMask.h:518
void setValuesOff()
Mark all voxels as inactive but don't change their values.
Definition LeafNodeMask.h:276
ValueAllCIter endValueAll() const
Definition LeafNodeMask.h:662
ChildIter< MaskOnIter, const LeafNode > ChildOnCIter
Definition LeafNodeMask.h:639
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:236
ChildOffCIter endChildOff() const
Definition LeafNodeMask.h:681
ValueAllCIter cbeginValueAll() const
Definition LeafNodeMask.h:651
NodeT * probeNode(const Coord &)
Definition LeafNodeMask.h:515
ValueOnCIter beginValueOn() const
Definition LeafNodeMask.h:646
static void evalNodeOrigin(Coord &xyz)
Compute the origin of the leaf node that contains the voxel with the given coordinates.
Definition LeafNodeMask.h:707
const Buffer & buffer() const
Definition LeafNodeMask.h:195
LeafNode * probeLeafAndCache(const Coord &, AccessorT &)
Definition LeafNodeMask.h:534
void setValueMaskOn(Index n)
Definition LeafNodeMask.h:703
Index64 offLeafVoxelCount() const
Definition LeafNodeMask.h:125
const LeafNode * probeLeaf(const Coord &) const
Return a const pointer to this node.
Definition LeafNodeMask.h:546
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:226
typename NodeMaskType::OnIterator MaskOnIter
Definition LeafNodeMask.h:566
bool isInactive() const
Return true if all of this node's values are inactive.
Definition LeafNodeMask.h:440
Buffer mBuffer
Bitmask representing the values AND state of voxels.
Definition LeafNodeMask.h:710
ValueIter< MaskOnIter, const LeafNode, const bool > ValueOnCIter
Definition LeafNodeMask.h:633
bool isValueMaskOff(Index n) const
Definition LeafNodeMask.h:692
ValueOnCIter cendValueOn() const
Definition LeafNodeMask.h:655
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:397
static Index numValues()
Return the total number of voxels represented by this LeafNode.
Definition LeafNodeMask.h:106
ValueOffCIter beginValueOff() const
Definition LeafNodeMask.h:649
ValueIter< MaskOffIter, LeafNode, const bool > ValueOffIter
Definition LeafNodeMask.h:634
ChildAllCIter cbeginChildAll() const
Definition LeafNodeMask.h:673
ChildOffIter endChildOff()
Definition LeafNodeMask.h:682
ChildAllIter beginChildAll()
Definition LeafNodeMask.h:675
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:338
void denseFill(const CoordBBox &bbox, bool value, bool=false)
Set all voxels within an axis-aligned box to the specified value.
Definition LeafNodeMask.h:292
void addLeaf(LeafNode *)
Definition LeafNodeMask.h:509
ValueOnIter beginValueOn()
Definition LeafNodeMask.h:647
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:363
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:354
ChildIter< MaskOffIter, const LeafNode > ChildOffCIter
Definition LeafNodeMask.h:641
NodeT * probeNodeAndCache(const Coord &, AccessorT &)
Definition LeafNodeMask.h:536
ValueIter< MaskDenseIter, LeafNode, const bool > ValueAllIter
Definition LeafNodeMask.h:636
ChildOffCIter cbeginChildOff() const
Definition LeafNodeMask.h:670
ChildOffIter beginChildOff()
Definition LeafNodeMask.h:672
bool isChildMaskOff(Index) const
Definition LeafNodeMask.h:699
Index64 onVoxelCount() const
Return the number of active voxels.
Definition LeafNodeMask.h:121
typename NodeMaskType::OffIterator MaskOffIter
Definition LeafNodeMask.h:567
ChildOffCIter beginChildOff() const
Definition LeafNodeMask.h:671
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:239
bool ValueType
Definition LeafNodeMask.h:35
ValueOffIter endValueOff()
Definition LeafNodeMask.h:660
void setValueOff(Index offset)
Mark the voxel at the given offset as inactive but don't change its value.
Definition LeafNodeMask.h:241
const LeafNode * probeConstLeafAndCache(const Coord &, AccessorT &) const
Definition LeafNodeMask.h:551
ChildAllCIter endChildAll() const
Definition LeafNodeMask.h:684
const NodeT * probeConstNodeAndCache(const Coord &, AccessorT &) const
Definition LeafNodeMask.h:553
ValueOnCIter cbeginValueOn() const
Definition LeafNodeMask.h:645
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:444
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:678
const LeafNode * probeConstLeaf(const Coord &) const
Definition LeafNodeMask.h:549
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:389
ChildOnCIter cendChildOn() const
Definition LeafNodeMask.h:677
static bool hasActiveTiles()
Return false since leaf nodes never contain tiles.
Definition LeafNodeMask.h:284
ChildAllCIter cendChildAll() const
Definition LeafNodeMask.h:683
ValueIter< MaskOnIter, LeafNode, const bool > ValueOnIter
Definition LeafNodeMask.h:632
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:349
DenseIter< LeafNode, bool > ChildAllIter
Definition LeafNodeMask.h:642
ChildAllIter endChildAll()
Definition LeafNodeMask.h:685
void setValueMask(Index n, bool on)
Definition LeafNodeMask.h:702
const NodeMaskType & valueMask() const
Definition LeafNodeMask.h:695
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:194
ValueAllCIter cendValueAll() const
Definition LeafNodeMask.h:661
ChildIter< MaskOnIter, LeafNode > ChildOnIter
Definition LeafNodeMask.h:638
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:447
ChildAllCIter beginChildAll() const
Definition LeafNodeMask.h:674
const LeafNode * probeLeafAndCache(const Coord &, AccessorT &) const
Definition LeafNodeMask.h:548
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:380
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:274
void setTransientData(Index32 transientData)
Set the transient data value.
Definition LeafNodeMask.h:175
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:680
typename NodeMaskType::DenseIterator MaskDenseIter
Definition LeafNodeMask.h:568
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:343
ValueOffIter beginValueOff()
Definition LeafNodeMask.h:650
const NodeT * probeConstNode(const Coord &) const
Definition LeafNodeMask.h:517
void setValueOn(const Coord &xyz)
Mark the voxel at the given coordinates as active but don't change its value.
Definition LeafNodeMask.h:249
Buffer & buffer()
Definition LeafNodeMask.h:196
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:231
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:694
const bool & getFirstValue() const
Return a const reference to the first entry in the buffer.
Definition LeafNodeMask.h:402
void addLeafAndCache(LeafNode *, AccessorT &)
Definition LeafNodeMask.h:511
const bool & getLastValue() const
Return a const reference to the last entry in the buffer.
Definition LeafNodeMask.h:406
ValueOffCIter cendValueOff() const
Definition LeafNodeMask.h:658
ValueIter< MaskDenseIter, const LeafNode, const bool > ValueAllCIter
Definition LeafNodeMask.h:637
const bool & getValueAndCache(const Coord &xyz, AccessorT &) const
Return the value of the voxel at the given coordinates.
Definition LeafNodeMask.h:333
void setValueMaskOff(Index n)
Definition LeafNodeMask.h:704
bool isDense() const
Return true if this node only contains active voxels.
Definition LeafNodeMask.h:132
ValueOffCIter endValueOff() const
Definition LeafNodeMask.h:659
NodeT * stealNode(const Coord &, const ValueType &, bool)
Definition LeafNodeMask.h:513
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:256
ValueOnCIter endValueOn() const
Definition LeafNodeMask.h:656
void voxelizeActiveTiles(bool=true)
No-op.
Definition LeafNodeMask.h:455
void modifyValueAndActiveStateAndCache(const Coord &xyz, const ModifyOp &op, AccessorT &)
Definition LeafNodeMask.h:371
LeafNode * touchLeafAndCache(const Coord &, AccessorT &)
Definition LeafNodeMask.h:531
ValueAllCIter beginValueAll() const
Definition LeafNodeMask.h:652
Coord mOrigin
Global grid index coordinates (x,y,z) of the local origin of this node.
Definition LeafNodeMask.h:712
static Index dim()
Return the number of voxels in each dimension.
Definition LeafNodeMask.h:102
ChildIter< MaskOffIter, LeafNode > ChildOffIter
Definition LeafNodeMask.h:640
ValueIter< MaskOffIter, const LeafNode, const bool > ValueOffCIter
Definition LeafNodeMask.h:635
bool isValueMaskOn(Index n) const
Definition LeafNodeMask.h:690
ValueAllIter beginValueAll()
Definition LeafNodeMask.h:653
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:1020
void writeTopology(std::ostream &os, bool toHalf=false) const
Write out just the topology.
Definition LeafNode.h:1276
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:1204
bool operator!=(const LeafNode &other) const
Definition LeafNode.h:201
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:1231
const ValueType & getValue(const Coord &xyz) const
Return the value of the voxel at the given coordinates.
Definition LeafNode.h:1045
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:1103
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:1696
Index medianOff(ValueType &value, ValueType *tmp=nullptr) const
Computes the median value of all the inactive voxels in this node.
Definition LeafNode.h:1553
ValueType medianAll(ValueType *tmp=nullptr) const
Computes the median value of all the active AND inactive voxels in this node.
Definition LeafNode.h:1511
~LeafNode()
Destructor.
Definition LeafNode.h:990
void readTopology(std::istream &is, bool fromHalf=false)
Read in just the topology.
Definition LeafNode.h:1268
Index medianOn(ValueType &value, ValueType *tmp=nullptr) const
Computes the median value of all the active voxels in this node.
Definition LeafNode.h:1529
void addTile(Index level, const Coord &, const ValueType &, bool)
Definition LeafNode.h:1580
void modifyValueAndActiveState(const Coord &xyz, const ModifyOp &op)
Apply a functor to the voxel at the given coordinates.
Definition LeafNode.h:456
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:1687
void clip(const CoordBBox &, const ValueType &background)
Set all voxels that lie outside the given axis-aligned box to the background.
Definition LeafNode.h:1121
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:1095
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:1679
static Index coordToOffset(const Coord &xyz)
Return the linear table offset of the given global or local coordinates.
Definition LeafNode.h:1010
void setValueOff(const Coord &xyz)
Mark the voxel at the given coordinates as inactive but don't change its value.
Definition LeafNode.h:407
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:1467
void writeBuffers(std::ostream &os, bool toHalf=false) const
Write buffers to a stream.
Definition LeafNode.h:1402
void combine(const LeafNode &other, CombineOp &op)
Definition LeafNode.h:1720
Index64 memUsageIfLoaded() const
Definition LeafNode.h:1439
void combine2(const LeafNode &other, const OtherType &, bool valueIsActive, CombineOp &)
Definition LeafNode.h:1760
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:1161
const NodeMaskType & valueMask() const
Definition LeafNode.h:856
void readBuffers(std::istream &is, bool fromHalf=false)
Read buffers from a stream.
Definition LeafNode.h:1304
bool isConstant(ValueType &firstValue, bool &state, const ValueType &tolerance=zeroVal< ValueType >()) const
Definition LeafNode.h:1475
friend class LeafNode
Definition LeafNode.h:833
Coord offsetToGlobalCoord(Index n) const
Return the global coordinates for a linear table offset.
Definition LeafNode.h:1034
bool operator==(const LeafNode &other) const
Check for buffer, state and origin equivalence.
Definition LeafNode.h:1419
void evalActiveBoundingBox(CoordBBox &bbox, bool visitVoxels=true) const
Definition LeafNode.h:1449
void merge(const LeafNode &)
Definition LeafNode.h:1630
void setValueOn(const Coord &xyz)
Mark the voxel at the given coordinates as active but don't change its value.
Definition LeafNode.h:417
const NodeMaskType & getValueMask() const
Definition LeafNode.h:854
void addTileAndCache(Index, const Coord &, const ValueType &, bool, AccessorT &)
Definition LeafNode.h:1597
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:435
Index64 memUsage() const
Return the memory in bytes occupied by this node.
Definition LeafNode.h:1429
std::string str() const
Return a string representation of this node.
Definition LeafNode.h:997
bool probeValue(const Coord &xyz, ValueType &val) const
Return true if the voxel at the given coordinates is active.
Definition LeafNode.h:1061
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:508
@ MERGE_ACTIVE_STATES_AND_NODES
Definition Types.h:509
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:603
ChildIter()
Definition LeafNodeMask.h:602
bool getItem(Index pos, void *&child, NonConstValueT &value) const
Definition LeafNodeMask.h:617
DenseIter()
Definition LeafNodeMask.h:614
DenseIter(const MaskDenseIter &iter, NodeT *parent)
Definition LeafNodeMask.h:615
typename BaseT::NonConstValueType NonConstValueT
Definition LeafNodeMask.h:612
void unsetItem(Index pos, const ValueT &val) const
Definition LeafNodeMask.h:628
void setItem(Index pos, bool value) const
Definition LeafNodeMask.h:585
void modifyValue(const ModifyOp &op) const
Definition LeafNodeMask.h:594
ValueIter(const MaskIterT &iter, NodeT *parent)
Definition LeafNodeMask.h:579
const bool & getValue() const
Definition LeafNodeMask.h:582
const bool & getItem(Index pos) const
Definition LeafNodeMask.h:581
ValueIter()
Definition LeafNodeMask.h:578
void setValue(bool value) const
Definition LeafNodeMask.h:587
void modifyItem(Index n, const ModifyOp &op) const
Definition LeafNodeMask.h:591
Definition LeafNode.h:890
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