4#ifndef OPENVDB_TREE_LEAFBUFFER_HAS_BEEN_INCLUDED
5#define OPENVDB_TREE_LEAFBUFFER_HAS_BEEN_INCLUDED
10#include <tbb/spin_mutex.h>
29template<
typename T, Index Log2Dim>
36 static const Index SIZE = 1 << 3 * Log2Dim;
38#ifdef OPENVDB_USE_DELAYED_LOADING
41 FileInfo(): bufpos(0) , maskpos(0) {}
42 std::streamoff bufpos;
43 std::streamoff maskpos;
44 io::MappedFile::Ptr mapping;
52#ifdef OPENVDB_USE_DELAYED_LOADING
63#ifdef OPENVDB_USE_DELAYED_LOADING
73#ifdef OPENVDB_USE_DELAYED_LOADING
74 return bool(mOutOfCore);
80 bool empty()
const {
return !mData || this->isOutOfCore(); }
135 inline void setOutOfCore(
bool b)
138#ifdef OPENVDB_USE_DELAYED_LOADING
144 inline void loadValues()
const
146#ifdef OPENVDB_USE_DELAYED_LOADING
147 if (this->isOutOfCore()) this->doLoad();
150 inline void doLoad()
const;
151 inline bool detachFromFile();
153 using FlagsType = std::atomic<Index32>;
155#ifdef OPENVDB_USE_DELAYED_LOADING
163 FlagsType mOutOfCore;
164 tbb::spin_mutex mMutex;
167 friend class ::TestLeaf;
176template<
typename T, Index Log2Dim>
181#ifdef OPENVDB_USE_DELAYED_LOADING
188template<
typename T, Index Log2Dim>
192#ifdef OPENVDB_USE_DELAYED_LOADING
193 if (this->isOutOfCore()) {
194 this->detachFromFile();
204template<
typename T, Index Log2Dim>
209 , mOutOfCore(other.mOutOfCore.load())
212#ifdef OPENVDB_USE_DELAYED_LOADING
214 mFileInfo =
new FileInfo(*other.mFileInfo);
217 if (other.mData !=
nullptr) {
222 while (n--) *target++ = *source++;
224#ifdef OPENVDB_USE_DELAYED_LOADING
230template<
typename T, Index Log2Dim>
236 if (mData) mData[i] = val;
240template<
typename T, Index Log2Dim>
244 if (&other !=
this) {
245#ifdef OPENVDB_USE_DELAYED_LOADING
246 if (this->isOutOfCore()) {
247 this->detachFromFile();
252 mOutOfCore.store(other.mOutOfCore.load(std::memory_order_acquire),
253 std::memory_order_release);
254 mFileInfo =
new FileInfo(*other.mFileInfo);
257 if (other.mData !=
nullptr) {
262 while (n--) *target++ = *source++;
264#ifdef OPENVDB_USE_DELAYED_LOADING
272template<
typename T, Index Log2Dim>
276 this->detachFromFile();
277 if (mData !=
nullptr) {
280 while (n--) *target++ = val;
285template<
typename T, Index Log2Dim>
291 const ValueType *target = mData, *source = other.mData;
292 if (!target && !source)
return true;
293 if (!target || !source)
return false;
300template<
typename T, Index Log2Dim>
304 std::swap(mData, other.mData);
305#ifdef OPENVDB_USE_DELAYED_LOADING
310 auto tmp = other.mOutOfCore.load(std::memory_order_acquire);
311 tmp = mOutOfCore.exchange(std::move(tmp));
312 other.mOutOfCore.store(std::move(tmp), std::memory_order_release);
317template<
typename T, Index Log2Dim>
321 size_t n =
sizeof(*this);
322#ifdef OPENVDB_USE_DELAYED_LOADING
323 if (this->isOutOfCore()) n +=
sizeof(FileInfo);
326 if (mData) n += SIZE *
sizeof(
ValueType);
327#ifdef OPENVDB_USE_DELAYED_LOADING
330 return static_cast<Index>(n);
334template<
typename T, Index Log2Dim>
338 size_t n =
sizeof(*this);
340 return static_cast<Index>(n);
344template<
typename T, Index Log2Dim>
349 if (mData ==
nullptr) {
351#ifdef OPENVDB_USE_DELAYED_LOADING
353 tbb::spin_mutex::scoped_lock lock(self->mMutex);
355 if (mData ==
nullptr) self->mData =
new ValueType[SIZE];
360template<
typename T, Index Log2Dim>
365 if (mData ==
nullptr) {
366#ifdef OPENVDB_USE_DELAYED_LOADING
368 tbb::spin_mutex::scoped_lock lock(mMutex);
370 if (mData ==
nullptr) mData =
new ValueType[SIZE];
376template<
typename T, Index Log2Dim>
380 static const ValueType sZero = zeroVal<T>();
385 if (mData)
return mData[i];
else return sZero;
389template<
typename T, Index Log2Dim>
391LeafBuffer<T, Log2Dim>::deallocate()
394 if (mData !=
nullptr) {
395#ifdef OPENVDB_USE_DELAYED_LOADING
396 if (this->isOutOfCore())
return false;
406template<
typename T, Index Log2Dim>
408LeafBuffer<T, Log2Dim>::doLoad()
const
410#ifdef OPENVDB_USE_DELAYED_LOADING
411 if (!this->isOutOfCore())
return;
413 LeafBuffer<T, Log2Dim>* self =
const_cast<LeafBuffer<T, Log2Dim>*
>(
this);
417 tbb::spin_mutex::scoped_lock lock(self->mMutex);
418 if (!this->isOutOfCore())
return;
420 std::unique_ptr<FileInfo> info(self->mFileInfo);
421 assert(info.get() !=
nullptr);
422 assert(info->mapping.get() !=
nullptr);
423 assert(info->meta.get() !=
nullptr);
426 self->mData =
nullptr;
429 SharedPtr<std::streambuf> buf = info->mapping->createBuffer();
430 std::istream is(buf.get());
435 is.seekg(info->maskpos);
438 is.seekg(info->bufpos);
441 self->setOutOfCore(
false);
446template<
typename T, Index Log2Dim>
448LeafBuffer<T, Log2Dim>::detachFromFile()
450#ifdef OPENVDB_USE_DELAYED_LOADING
451 if (this->isOutOfCore()) {
454 this->setOutOfCore(
false);
466template<Index Log2Dim>
478 static inline const bool sOn =
true;
479 static inline const bool sOff =
false;
486 void fill(
bool val) { mData.set(val); }
494 if (mData.isOn(i))
return sOn;
else return sOff;
503 void swap(
LeafBuffer& other) {
if (&other !=
this) std::swap(mData, other.mData); }
Tag dispatch class that distinguishes constructors during file input.
Definition Types.h:689
LeafBuffer(const NodeMaskType &other)
Definition LeafBuffer.h:483
~LeafBuffer()
Definition LeafBuffer.h:485
WordType StorageType
Definition LeafBuffer.h:473
bool operator!=(const LeafBuffer &other) const
Definition LeafBuffer.h:499
typename NodeMaskType::Word WordType
Definition LeafBuffer.h:471
Index memUsage() const
Definition LeafBuffer.h:505
void swap(LeafBuffer &other)
Definition LeafBuffer.h:503
const WordType * data() const
Return a const pointer to the C-style array of words encoding the bits.
Definition LeafBuffer.h:514
LeafBuffer & operator=(const LeafBuffer &b)
Definition LeafBuffer.h:487
bool operator==(const LeafBuffer &other) const
Definition LeafBuffer.h:498
Index memUsageIfLoaded() const
Definition LeafBuffer.h:506
bool ValueType
Definition LeafBuffer.h:472
LeafBuffer(const LeafBuffer &other)
Definition LeafBuffer.h:484
LeafBuffer(bool on)
Definition LeafBuffer.h:482
const bool & operator[](Index i) const
Definition LeafBuffer.h:496
void fill(bool val)
Definition LeafBuffer.h:486
const bool & getValue(Index i) const
Definition LeafBuffer.h:489
static Index size()
Definition LeafBuffer.h:507
WordType * data()
Return a pointer to the C-style array of words encoding the bits.
Definition LeafBuffer.h:511
LeafBuffer()
Definition LeafBuffer.h:481
void setValue(Index i, bool val)
Definition LeafBuffer.h:501
Array of fixed size 23Log2Dim that stores the voxel values of a LeafNode.
Definition LeafBuffer.h:31
LeafBuffer & operator=(const LeafBuffer &)
Copy the other buffer's values into this buffer.
Definition LeafBuffer.h:242
~LeafBuffer()
Destructor.
Definition LeafBuffer.h:190
LeafBuffer(PartialCreate, const ValueType &)
Construct a buffer but don't allocate memory for the full array of values.
Definition LeafBuffer.h:61
ValueType StorageType
Definition LeafBuffer.h:34
LeafBuffer(const ValueType &)
Construct a buffer populated with the specified value.
Definition LeafBuffer.h:178
LeafBuffer(const LeafBuffer &)
Copy constructor.
Definition LeafBuffer.h:206
void fill(const ValueType &)
Populate this buffer with a constant value.
Definition LeafBuffer.h:274
bool operator!=(const LeafBuffer &other) const
Return true if the contents of the other buffer are not exactly equal to the contents of this buffer.
Definition LeafBuffer.h:102
void swap(LeafBuffer &)
Exchange this buffer's values with the other buffer's values.
Definition LeafBuffer.h:302
bool isOutOfCore() const
Return true if this buffer's values have not yet been read from disk.
Definition LeafBuffer.h:71
Index memUsage() const
Return the memory footprint of this buffer in bytes.
Definition LeafBuffer.h:319
bool empty() const
Return true if memory for this buffer has not yet been allocated.
Definition LeafBuffer.h:80
Index memUsageIfLoaded() const
Definition LeafBuffer.h:336
void setValue(Index i, const ValueType &)
Set the i'th value of this buffer to the specified value.
Definition LeafBuffer.h:232
static Index size()
Return the number of values contained in this buffer.
Definition LeafBuffer.h:111
const ValueType * data() const
Return a const pointer to the array of voxel values.
Definition LeafBuffer.h:346
static const Index SIZE
Definition LeafBuffer.h:36
ValueType * data()
Return a pointer to the array of voxel values.
Definition LeafBuffer.h:362
const ValueType & getValue(Index i) const
Return a const reference to the i'th element of this buffer.
Definition LeafBuffer.h:88
bool allocate()
Allocate memory for this buffer if it has not already been allocated.
Definition LeafBuffer.h:82
LeafBuffer()
Default constructor.
Definition LeafBuffer.h:50
T ValueType
Definition LeafBuffer.h:33
const ValueType & operator[](Index i) const
Return a const reference to the i'th element of this buffer.
Definition LeafBuffer.h:90
bool operator==(const LeafBuffer &) const
Return true if the contents of the other buffer exactly equal the contents of this buffer.
Definition LeafBuffer.h:287
Templated block class to hold specific data types and a fixed number of values determined by Log2Dim....
Definition LeafNode.h:38
Bit mask for the internal and leaf nodes of VDB. This is a 64-bit implementation.
Definition NodeMasks.h:308
Index64 Word
Definition NodeMasks.h:316
static const Index32 WORD_COUNT
Definition NodeMasks.h:315
OPENVDB_API bool getHalfFloat(std::ios_base &)
Return true if floating-point values should be quantized to 16 bits when writing to the given stream ...
void readCompressedValues(std::istream &is, ValueT *destBuf, Index destCount, const MaskT &valueMask, bool fromHalf)
Definition Compression.h:465
OPENVDB_API void setStreamMetadataPtr(std::ios_base &, SharedPtr< StreamMetadata > &, bool transfer=true)
Associate the given stream with (a shared pointer to) an object that stores metadata (file format,...
bool isExactlyEqual(const T0 &a, const T1 &b)
Return true if a is exactly equal to b.
Definition Math.h:443
Index32 Index
Definition Types.h:54
std::shared_ptr< T > SharedPtr
Definition Types.h:114
Definition Exceptions.h:13
static pnanovdb_uint32_t allocate(pnanovdb_uint32_t *poffset, pnanovdb_uint32_t size, pnanovdb_uint32_t alignment)
Definition pnanovdb_validate_strides.h:20
#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
#define OPENVDB_USE_DELAYED_LOADING
Definition version.h.in:143